replace pkg.Scan() with interface

cmd/scan/scan-github.go

@@ -5,8 +5,8 @@ package scan
 import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/log"
-	"github.com/rumenvasilev/rvsecret/internal/pkg"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -26,7 +26,7 @@ var scanGithubCmd = &cobra.Command{
 			return err
 		}
 		log := log.NewLogger(cfg.Global.Debug, cfg.Global.Silent)
-		return pkg.Scan(cfg, log)
+		return scan.New(cfg, log).Do()
 	},
 }
 

cmd/scan/scan-gitlab.go

@@ -5,8 +5,8 @@ package scan
 import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/log"
-	"github.com/rumenvasilev/rvsecret/internal/pkg"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -22,7 +22,7 @@ var scanGitlabCmd = &cobra.Command{
 			return err
 		}
 		log := log.NewLogger(cfg.Global.Debug, cfg.Global.Silent)
-		return pkg.Scan(cfg, log)
+		return scan.New(cfg, log).Do()
 	},
 }
 

cmd/scan/scan-local-git-repo.go

@@ -5,8 +5,8 @@ package scan
 import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/log"
-	"github.com/rumenvasilev/rvsecret/internal/pkg"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -21,7 +21,7 @@ var scanLocalGitRepoCmd = &cobra.Command{
 			return err
 		}
 		log := log.NewLogger(cfg.Global.Debug, cfg.Global.Silent)
-		return pkg.Scan(cfg, log)
+		return scan.New(cfg, log).Do()
 	},
 }
 

cmd/scan/scan-localpath.go

@@ -5,8 +5,8 @@ package scan
 import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/log"
-	"github.com/rumenvasilev/rvsecret/internal/pkg"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -22,7 +22,7 @@ var scanLocalPathCmd = &cobra.Command{
 			return err
 		}
 		log := log.NewLogger(cfg.Global.Debug, cfg.Global.Silent)
-		return pkg.Scan(cfg, log)
+		return scan.New(cfg, log).Do()
 	},
 }
 

cmd/updateRules.go

@@ -3,7 +3,7 @@ package cmd
 import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/log"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/pkg/signatures"
 
 	"github.com/spf13/cobra"

internal/config/config.go

@@ -7,7 +7,7 @@ import (
 
 	"github.com/fatih/structs"
 	"github.com/mitchellh/go-homedir"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/util"
 	"github.com/rumenvasilev/rvsecret/version"
 	"github.com/spf13/cobra"

internal/core/findings.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/util"
 )
 

internal/core/git.go

@@ -9,7 +9,7 @@ import (
 	_coreapi "github.com/rumenvasilev/rvsecret/internal/core/api"
 	_github "github.com/rumenvasilev/rvsecret/internal/core/provider/github"
 	_gitlab "github.com/rumenvasilev/rvsecret/internal/core/provider/gitlab"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"gopkg.in/src-d/go-git.v4"
 	"gopkg.in/src-d/go-git.v4/plumbing"
 	"gopkg.in/src-d/go-git.v4/plumbing/object"

internal/core/session.go

@@ -18,7 +18,7 @@ import (
 	_coreapi "github.com/rumenvasilev/rvsecret/internal/core/api"
 	"github.com/rumenvasilev/rvsecret/internal/core/provider"
 	"github.com/rumenvasilev/rvsecret/internal/log"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/stats"
 	"github.com/rumenvasilev/rvsecret/internal/util"
 )

internal/core/signatures.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/rumenvasilev/rvsecret/internal/log"
 	"github.com/rumenvasilev/rvsecret/internal/matchfile"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/util"
 	"gopkg.in/src-d/go-git.v4/plumbing/object"
 	"gopkg.in/yaml.v2"

internal/pkg/save-config.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/log"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/util"
 	"gopkg.in/yaml.v3"
 )

internal/pkg/api/api.go → internal/pkg/scan/api/api.go

@@ -11,3 +11,7 @@ const (
 	Unknown          ScanType = "unknown" // for testing
 	UpdateSignatures ScanType = "update-signatures"
 )
+
+type Scanner interface {
+	Do() error
+}

internal/pkg/ghe/ghe.go → internal/pkg/scan/github/ghe.go

@@ -1,4 +1,4 @@
-package ghe
+package github
 
 import (
 	"fmt"
@@ -7,10 +7,18 @@ import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/core"
 	"github.com/rumenvasilev/rvsecret/internal/log"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/webserver"
 )
 
-func Scan(cfg *config.Config, log *log.Logger) error {
+type GHE struct {
+	Cfg *config.Config
+	Log *log.Logger
+}
+
+func (g GHE) Do() error {
+	cfg := g.Cfg
+	log := g.Log
 	// create session
 	sess, err := core.NewSessionWithConfig(cfg, log)
 	if err != nil {
@@ -102,3 +110,5 @@ func Scan(cfg *config.Config, log *log.Logger) error {
 	}
 	return nil
 }
+
+var _ api.Scanner = (*GHE)(nil)

internal/pkg/github/github.go → internal/pkg/scan/github/github.go

@@ -7,10 +7,18 @@ import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/core"
 	"github.com/rumenvasilev/rvsecret/internal/log"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/webserver"
 )
 
-func Scan(cfg *config.Config, log *log.Logger) error {
+type Github struct {
+	Cfg *config.Config
+	Log *log.Logger
+}
+
+func (g Github) Do() error {
+	cfg := g.Cfg
+	log := g.Log
 	// create session
 	sess, err := core.NewSessionWithConfig(cfg, log)
 	if err != nil {
@@ -86,3 +94,5 @@ func Scan(cfg *config.Config, log *log.Logger) error {
 	}
 	return nil
 }
+
+var _ api.Scanner = (*Github)(nil)

internal/pkg/gitlab/gitlab.go → internal/pkg/scan/gitlab/gitlab.go

@@ -6,11 +6,19 @@ import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/core"
 	"github.com/rumenvasilev/rvsecret/internal/log"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/webserver"
 	"github.com/spf13/viper"
 )
 
-func Scan(cfg *config.Config, log *log.Logger) error {
+type Gitlab struct {
+	Cfg *config.Config
+	Log *log.Logger
+}
+
+func (g Gitlab) Do() error {
+	cfg := g.Cfg
+	log := g.Log
 	// create session
 	sess, err := core.NewSessionWithConfig(cfg, log)
 	if err != nil {
@@ -48,3 +56,5 @@ func Scan(cfg *config.Config, log *log.Logger) error {
 	}
 	return nil
 }
+
+var _ api.Scanner = (*Gitlab)(nil)

internal/pkg/localgit/localgit.go → internal/pkg/scan/localgit/localgit.go

@@ -6,10 +6,18 @@ import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/core"
 	"github.com/rumenvasilev/rvsecret/internal/log"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/webserver"
 )
 
-func Scan(cfg *config.Config, log *log.Logger) error {
+type LocalGit struct {
+	Cfg *config.Config
+	Log *log.Logger
+}
+
+func (l LocalGit) Do() error {
+	cfg := l.Cfg
+	log := l.Log
 	// create session
 	sess, err := core.NewSessionWithConfig(cfg, log)
 	if err != nil {
@@ -47,3 +55,5 @@ func Scan(cfg *config.Config, log *log.Logger) error {
 	}
 	return nil
 }
+
+var _ api.Scanner = (*LocalGit)(nil)

internal/pkg/localpath/localpath.go → internal/pkg/scan/localpath/localpath.go

@@ -6,11 +6,19 @@ import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/core"
 	"github.com/rumenvasilev/rvsecret/internal/log"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/util"
 	"github.com/rumenvasilev/rvsecret/internal/webserver"
 )
 
-func Scan(cfg *config.Config, log *log.Logger) error {
+type Localpath struct {
+	Cfg *config.Config
+	Log *log.Logger
+}
+
+func (l Localpath) Do() error {
+	cfg := l.Cfg
+	log := l.Log
 	// exclude the .git directory from local scans as it is not handled properly here
 	cfg.Global.SkippablePath = util.AppendIfMissing(cfg.Global.SkippablePath, ".git/")
 
@@ -58,3 +66,5 @@ func Scan(cfg *config.Config, log *log.Logger) error {
 
 	return nil
 }
+
+var _ api.Scanner = (*Localpath)(nil)

internal/pkg/scan/scan.go

@@ -0,0 +1,36 @@
+package scan
+
+import (
+	"errors"
+
+	"github.com/rumenvasilev/rvsecret/internal/config"
+	"github.com/rumenvasilev/rvsecret/internal/log"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/github"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/gitlab"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/localgit"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/localpath"
+)
+
+func New(cfg *config.Config, log *log.Logger) api.Scanner {
+	switch cfg.Global.ScanType {
+	case api.LocalPath:
+		return localpath.Localpath{Cfg: cfg, Log: log}
+	case api.LocalGit:
+		return localgit.LocalGit{Cfg: cfg, Log: log}
+	case api.GithubEnterprise:
+		return github.GHE{Cfg: cfg, Log: log}
+	case api.Github:
+		return github.Github{Cfg: cfg, Log: log}
+	case api.Gitlab:
+		return gitlab.Gitlab{Cfg: cfg, Log: log}
+	default:
+		return Unsupported{}
+	}
+}
+
+type Unsupported struct{}
+
+func (u Unsupported) Do() error {
+	return errors.New("this type of scan is unsupported")
+}

internal/webserver/router.go

@@ -16,7 +16,7 @@ import (
 	"github.com/rumenvasilev/rvsecret/internal/config"
 	"github.com/rumenvasilev/rvsecret/internal/core"
 	"github.com/rumenvasilev/rvsecret/internal/log"
-	"github.com/rumenvasilev/rvsecret/internal/pkg/api"
+	"github.com/rumenvasilev/rvsecret/internal/pkg/scan/api"
 	"github.com/rumenvasilev/rvsecret/internal/util"
 )