refactor: inject filesystem walker

Signed-off-by: knqyf263 <knqyf263@gmail.com>

pkg/commands/artifact/run.go

@@ -18,6 +18,7 @@ import (
 	"github.com/aquasecurity/trivy/pkg/fanal/artifact"
 	"github.com/aquasecurity/trivy/pkg/fanal/cache"
 	ftypes "github.com/aquasecurity/trivy/pkg/fanal/types"
+	"github.com/aquasecurity/trivy/pkg/fanal/walker"
 	"github.com/aquasecurity/trivy/pkg/flag"
 	"github.com/aquasecurity/trivy/pkg/javadb"
 	"github.com/aquasecurity/trivy/pkg/log"
@@ -72,6 +73,9 @@ type ScannerConfig struct {
 
 	// Artifact options
 	ArtifactOption artifact.Option
+
+	// Walk options
+	WalkerOption walker.Option
 }
 
 type Runner interface {
@@ -625,8 +629,6 @@ func initScannerConfig(opts flag.Options, cacheClient cache.Cache) (ScannerConfi
 		},
 		ArtifactOption: artifact.Option{
 			DisabledAnalyzers: disabledAnalyzers(opts),
-			SkipFiles:         opts.SkipFiles,
-			SkipDirs:          opts.SkipDirs,
 			FilePatterns:      opts.FilePatterns,
 			Offline:           opts.OfflineScan,
 			Parallel:          opts.Parallel,
@@ -665,6 +667,10 @@ func initScannerConfig(opts flag.Options, cacheClient cache.Cache) (ScannerConfi
 				ClassifierConfidenceLevel: opts.LicenseConfidenceLevel,
 			},
 		},
+		WalkerOption: walker.Option{
+			SkipFiles: opts.SkipFiles,
+			SkipDirs:  opts.SkipDirs,
+		},
 	}, scanOptions, nil
 }
 

pkg/fanal/artifact/artifact.go

@@ -4,18 +4,16 @@ import (
 	"context"
 	"sort"
 
-	"github.com/aquasecurity/trivy/pkg/custom"
 	"github.com/aquasecurity/trivy/pkg/fanal/analyzer"
 	"github.com/aquasecurity/trivy/pkg/fanal/types"
+	"github.com/aquasecurity/trivy/pkg/fanal/walker"
 	"github.com/aquasecurity/trivy/pkg/misconf"
 )
 
 type Option struct {
 	AnalyzerGroup     analyzer.Group // It is empty in OSS
 	DisabledAnalyzers []analyzer.Type
 	DisabledHandlers  []types.HandlerType
-	SkipFiles         []string
-	SkipDirs          []string
 	FilePatterns      []string
 	Parallel          int
 	NoProgress        bool
@@ -40,7 +38,7 @@ type Option struct {
 	SecretScannerOption  analyzer.SecretScannerOption
 	LicenseScannerOption analyzer.LicenseScannerOption
 
-	CustomOption custom.Option
+	WalkerOption walker.Option
 }
 
 func (o *Option) Init() {
@@ -74,8 +72,8 @@ func (o *Option) Sort() {
 	sort.Slice(o.DisabledAnalyzers, func(i, j int) bool {
 		return o.DisabledAnalyzers[i] < o.DisabledAnalyzers[j]
 	})
-	sort.Strings(o.SkipFiles)
-	sort.Strings(o.SkipDirs)
+	sort.Strings(o.WalkerOption.SkipFiles)
+	sort.Strings(o.WalkerOption.SkipDirs)
 	sort.Strings(o.FilePatterns)
 }
 

pkg/fanal/artifact/image/image.go

@@ -64,7 +64,7 @@ func NewArtifact(img types.Image, c cache.ArtifactCache, opt artifact.Option) (a
 	return Artifact{
 		image:          img,
 		cache:          c,
-		walker:         walker.NewLayerTar(opt.SkipFiles, opt.SkipDirs),
+		walker:         walker.NewLayerTar(opt.WalkerOption),
 		analyzer:       a,
 		configAnalyzer: ca,
 		handlerManager: handlerManager,

pkg/fanal/artifact/local/fs.go

@@ -10,6 +10,7 @@ import (
 	"strings"
 	"sync"
 
+	"github.com/google/wire"
 	"github.com/opencontainers/go-digest"
 	"golang.org/x/sync/semaphore"
 	"golang.org/x/xerrors"
@@ -20,20 +21,25 @@ import (
 	"github.com/aquasecurity/trivy/pkg/fanal/handler"
 	"github.com/aquasecurity/trivy/pkg/fanal/types"
 	"github.com/aquasecurity/trivy/pkg/fanal/walker"
-	"github.com/aquasecurity/trivy/pkg/log"
+)
+
+var ArtifactSet = wire.NewSet(
+	walker.NewFS,
+	wire.Bind(new(walker.FSWalker), new(*walker.FS)),
+	NewArtifact,
 )
 
 type Artifact struct {
 	rootPath       string
 	cache          cache.ArtifactCache
-	walker         walker.FS
+	walker         walker.FSWalker
 	analyzer       analyzer.AnalyzerGroup
 	handlerManager handler.Manager
 
 	artifactOption artifact.Option
 }
 
-func NewArtifact(rootPath string, c cache.ArtifactCache, opt artifact.Option) (artifact.Artifact, error) {
+func NewArtifact(rootPath string, c cache.ArtifactCache, w walker.FSWalker, opt artifact.Option) (artifact.Artifact, error) {
 	opt.Init()
 
 	handlerManager, err := handler.NewManager(opt)
@@ -47,71 +53,15 @@ func NewArtifact(rootPath string, c cache.ArtifactCache, opt artifact.Option) (a
 	}
 
 	return Artifact{
-		rootPath: filepath.ToSlash(filepath.Clean(rootPath)),
-		cache:    c,
-		walker: walker.NewFS(buildPathsToSkip(rootPath, opt.SkipFiles), buildPathsToSkip(rootPath, opt.SkipDirs),
-			opt.CustomOption),
+		rootPath:       filepath.ToSlash(filepath.Clean(rootPath)),
+		cache:          c,
+		walker:         w,
 		analyzer:       a,
 		handlerManager: handlerManager,
 		artifactOption: opt,
 	}, nil
 }
 
-// buildPathsToSkip builds correct patch for skipDirs and skipFiles
-func buildPathsToSkip(base string, paths []string) []string {
-	var relativePaths []string
-	absBase, err := filepath.Abs(base)
-	if err != nil {
-		log.Logger.Warnf("Failed to get an absolute path of %s: %s", base, err)
-		return nil
-	}
-	for _, path := range paths {
-		// Supports three types of flag specification.
-		// All of them are converted into the relative path from the root directory.
-		// 1. Relative skip dirs/files from the root directory
-		//     The specified dirs and files will be used as is.
-		//       e.g. $ trivy fs --skip-dirs bar ./foo
-		//     The skip dir from the root directory will be `bar/`.
-		// 2. Relative skip dirs/files from the working directory
-		//     The specified dirs and files wll be converted to the relative path from the root directory.
-		//       e.g. $ trivy fs --skip-dirs ./foo/bar ./foo
-		//     The skip dir will be converted to `bar/`.
-		// 3. Absolute skip dirs/files
-		//     The specified dirs and files wll be converted to the relative path from the root directory.
-		//       e.g. $ trivy fs --skip-dirs /bar/foo/baz ./foo
-		//     When the working directory is
-		//       3.1 /bar: the skip dir will be converted to `baz/`.
-		//       3.2 /hoge : the skip dir will be converted to `../../bar/foo/baz/`.
-
-		absSkipPath, err := filepath.Abs(path)
-		if err != nil {
-			log.Logger.Warnf("Failed to get an absolute path of %s: %s", base, err)
-			continue
-		}
-		rel, err := filepath.Rel(absBase, absSkipPath)
-		if err != nil {
-			log.Logger.Warnf("Failed to get a relative path from %s to %s: %s", base, path, err)
-			continue
-		}
-
-		var relPath string
-		switch {
-		case !filepath.IsAbs(path) && strings.HasPrefix(rel, ".."):
-			// #1: Use the path as is
-			relPath = path
-		case !filepath.IsAbs(path) && !strings.HasPrefix(rel, ".."):
-			// #2: Use the relative path from the root directory
-			relPath = rel
-		case filepath.IsAbs(path):
-			// #3: Use the relative path from the root directory
-			relPath = rel
-		}
-		relPath = filepath.ToSlash(relPath)
-		relativePaths = append(relativePaths, relPath)
-	}
-	return relativePaths
-}
-
 func (a Artifact) Inspect(ctx context.Context) (types.ArtifactReference, error) {
 	var wg sync.WaitGroup
 	result := analyzer.NewAnalysisResult()
@@ -127,7 +77,7 @@ func (a Artifact) Inspect(ctx context.Context) (types.ArtifactReference, error)
 		return types.ArtifactReference{}, xerrors.Errorf("failed to prepare filesystem for post analysis: %w", err)
 	}
 
-	err = a.walker.Walk(a.rootPath, func(filePath string, info os.FileInfo, opener analyzer.Opener) error {
+	err = a.walker.Walk(a.rootPath, a.artifactOption.WalkerOption, func(filePath string, info os.FileInfo, opener analyzer.Opener) error {
 		dir := a.rootPath
 
 		// When the directory is the same as the filePath, a file was given