Cache: Save only required files (fanal#51)

Author: knqyf263

.gitignore

@@ -17,3 +17,4 @@ vendor
 cmd/fanal/fanal
 *.tar
 *.gz
+*.db

analyzer/analyzer.go

@@ -7,14 +7,11 @@ import (
 	"io"
 	"os"
 
-	"github.com/aquasecurity/fanal/utils"
-
-	"github.com/aquasecurity/fanal/types"
-
-	"golang.org/x/xerrors"
-
 	"github.com/aquasecurity/fanal/extractor"
+	"github.com/aquasecurity/fanal/types"
+	"github.com/aquasecurity/fanal/utils"
 	godeptypes "github.com/aquasecurity/go-dep-parser/pkg/types"
+	"golang.org/x/xerrors"
 )
 
 var (

analyzer/analyzer_test.go

@@ -8,7 +8,6 @@ import (
 	"testing"
 
 	"github.com/aquasecurity/fanal/extractor"
-
 	"github.com/stretchr/testify/assert"
 )
 
@@ -93,6 +92,12 @@ func TestConfig_Analyze(t *testing.T) {
 		},
 	}
 
+	// cleanup global state from other tests
+	commandAnalyzers = []CommandAnalyzer{}
+	pkgAnalyzers = []PkgAnalyzer{}
+	osAnalyzers = []OSAnalyzer{}
+	libAnalyzers = []LibraryAnalyzer{}
+
 	for _, tc := range testCases {
 		RegisterOSAnalyzer(mockOSAnalyzer{})
 

cache/cache.go

@@ -1,57 +1,25 @@
 package cache
 
 import (
-	"io"
 	"os"
-	"path/filepath"
-	"strings"
 
 	"golang.org/x/xerrors"
 )
 
-var (
-	replacer = strings.NewReplacer("/", "_")
-)
-
 type Cache interface {
-	Get(key string) io.Reader
-	Set(key string, file io.Reader) (io.Reader, error)
 	Clear() error
 }
 
-type FSCache struct {
+type RealCache struct {
 	Directory string
 }
 
 func Initialize(cacheDir string) Cache {
-	return &FSCache{Directory: cacheDir}
-}
-
-func (fs FSCache) Get(key string) io.Reader {
-	filePath := filepath.Join(fs.Directory, replacer.Replace(key))
-	f, err := os.Open(filePath)
-	if err != nil {
-		return nil
-	}
-	return f
-}
-
-func (fs FSCache) Set(key string, file io.Reader) (io.Reader, error) {
-	filePath := filepath.Join(fs.Directory, replacer.Replace(key))
-	if err := os.MkdirAll(fs.Directory, os.ModePerm); err != nil {
-		return nil, xerrors.Errorf("failed to mkdir all: %w", err)
-	}
-	cacheFile, err := os.Create(filePath)
-	if err != nil {
-		return file, xerrors.Errorf("failed to create cache file: %w", err)
-	}
-
-	tee := io.TeeReader(file, cacheFile)
-	return tee, nil
+	return &RealCache{Directory: cacheDir}
 }
 
-func (fs FSCache) Clear() error {
-	if err := os.RemoveAll(fs.Directory); err != nil {
+func (rc RealCache) Clear() error {
+	if err := os.RemoveAll(rc.Directory); err != nil {
 		return xerrors.New("failed to remove cache")
 	}
 	return nil

cache/cache_test.go

@@ -1,40 +1,22 @@
 package cache
 
 import (
-	"bytes"
 	"io/ioutil"
 	"os"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 )
 
-func TestSetAndGetAndClear(t *testing.T) {
-	tempCacheDir, _ := ioutil.TempDir("", "TestCacheDir-*")
-	f, _ := ioutil.TempFile(tempCacheDir, "foo.bar.baz-*")
-
-	c := Initialize(tempCacheDir)
-
-	// set
-	expectedCacheContents := "foo bar baz"
-	var buf bytes.Buffer
-	buf.Write([]byte(expectedCacheContents))
-
-	r, err := c.Set(f.Name(), &buf)
-	assert.NoError(t, err)
-
-	b, _ := ioutil.ReadAll(r)
-	assert.Equal(t, expectedCacheContents, string(b))
-
-	// get
-	actualFile := c.Get(f.Name())
-	actualBytes, _ := ioutil.ReadAll(actualFile)
-	assert.Equal(t, expectedCacheContents, string(actualBytes))
-
-	// clear
+func TestRealCache_Clear(t *testing.T) {
+	d, _ := ioutil.TempDir("", "TestRealCache_Clear")
+	c := Initialize(d)
 	assert.NoError(t, c.Clear())
-
-	// confirm that no cachedir remains
-	_, err = os.Stat(tempCacheDir)
+	_, err := os.Stat(d)
 	assert.True(t, os.IsNotExist(err))
+
+	t.Run("sad path, cache dir doesn't exist", func(t *testing.T) {
+		c := Initialize(".")
+		assert.Equal(t, "failed to remove cache", c.Clear().Error())
+	})
 }

cmd/fanal/main.go

@@ -8,6 +8,10 @@ import (
 	"os"
 	"time"
 
+	"github.com/aquasecurity/fanal/cache"
+	"github.com/aquasecurity/fanal/utils"
+	"golang.org/x/xerrors"
+
 	"github.com/aquasecurity/fanal/analyzer"
 	_ "github.com/aquasecurity/fanal/analyzer/command/apk"
 	_ "github.com/aquasecurity/fanal/analyzer/library/bundler"
@@ -25,13 +29,10 @@ import (
 	_ "github.com/aquasecurity/fanal/analyzer/pkg/apk"
 	_ "github.com/aquasecurity/fanal/analyzer/pkg/dpkg"
 	_ "github.com/aquasecurity/fanal/analyzer/pkg/rpm"
-	"github.com/aquasecurity/fanal/cache"
 	"github.com/aquasecurity/fanal/extractor"
 	"github.com/aquasecurity/fanal/extractor/docker"
 	"github.com/aquasecurity/fanal/types"
-	"github.com/aquasecurity/fanal/utils"
 	"golang.org/x/crypto/ssh/terminal"
-	"golang.org/x/xerrors"
 )
 
 func main() {
@@ -46,11 +47,11 @@ func run() (err error) {
 	clearCache := flag.Bool("clear", false, "clear cache")
 	flag.Parse()
 
-	c := cache.Initialize(utils.CacheDir())
+	c := cache.Initialize(utils.CacheDir() + "/cache.db")
 
 	if *clearCache {
 		if err = c.Clear(); err != nil {
-			return xerrors.Errorf("error in cache clear: %w", err)
+			return xerrors.Errorf("%w", err)
 		}
 	}