feat(cache): add DeleteBlobs to ArtifactCache (fanal#426)

Author: afdesk

artifact/artifact.go

@@ -30,4 +30,5 @@ func (o *Option) Sort() {
 
 type Artifact interface {
 	Inspect(ctx context.Context) (reference types.ArtifactReference, err error)
+	Clean(reference types.ArtifactReference) error
 }

artifact/image/image.go

@@ -120,6 +120,10 @@ func (a Artifact) Inspect(ctx context.Context) (types.ArtifactReference, error)
 	}, nil
 }
 
+func (Artifact) Clean(_ types.ArtifactReference) error {
+	return nil
+}
+
 func (a Artifact) calcCacheKeys(imageID string, diffIDs []string) (string, []string, map[string]string, error) {
 	// Pass an empty config scanner option so that the cache key can be the same, even when policies are updated.
 	imageKey, err := cache.CalcKey(imageID, a.analyzer.ImageConfigAnalyzerVersions(), nil, artifact.Option{}, config.ScannerOption{})

artifact/local/fs.go

@@ -165,3 +165,7 @@ func (a Artifact) Inspect(ctx context.Context) (types.ArtifactReference, error)
 		BlobIDs: []string{cacheKey},
 	}, nil
 }
+
+func (a Artifact) Clean(reference types.ArtifactReference) error {
+	return a.cache.DeleteBlobs(reference.BlobIDs)
+}

artifact/mock_artifact.go

@@ -81,6 +81,10 @@ func (a Artifact) Inspect(ctx context.Context) (types.ArtifactReference, error)
 	return ref, nil
 }
 
+func (Artifact) Clean(_ types.ArtifactReference) error {
+	return nil
+}
+
 func newURL(rawurl string) (*url.URL, error) {
 	u, err := url.Parse(rawurl)
 	if err != nil {

artifact/remote/git.go

@@ -28,6 +28,9 @@ type ArtifactCache interface {
 
 	// PutBlob stores blob information such as layer information in local cache
 	PutBlob(blobID string, blobInfo types.BlobInfo) (err error)
+
+	// DeleteBlobs removes blobs by IDs
+	DeleteBlobs(blobIDs []string) error
 }
 
 // LocalArtifactCache always uses local cache

cache/cache.go

@@ -5,9 +5,11 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/aquasecurity/fanal/types"
+	"github.com/hashicorp/go-multierror"
 	bolt "go.etcd.io/bbolt"
 	"golang.org/x/xerrors"
+
+	"github.com/aquasecurity/fanal/types"
 )
 
 var _ Cache = &FSCache{}
@@ -113,6 +115,24 @@ func (fs FSCache) GetArtifact(artifactID string) (types.ArtifactInfo, error) {
 	return info, nil
 }
 
+// DeleteBlobs removes blobs by IDs
+func (fs FSCache) DeleteBlobs(blobIDs []string) error {
+	var errs error
+	err := fs.db.Update(func(tx *bolt.Tx) error {
+		bucket := tx.Bucket([]byte(blobBucket))
+		for _, blobID := range blobIDs {
+			if err := bucket.Delete([]byte(blobID)); err != nil {
+				errs = multierror.Append(errs, err)
+			}
+		}
+		return nil
+	})
+	if err != nil {
+		return xerrors.Errorf("DB delete error: %w", err)
+	}
+	return errs
+}
+
 // PutArtifact stores artifact information such as image metadata in local cache
 func (fs FSCache) PutArtifact(artifactID string, artifactInfo types.ArtifactInfo) (err error) {
 	b, err := json.Marshal(artifactInfo)

cache/fs.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 
 	"github.com/go-redis/redis/v8"
+	"github.com/hashicorp/go-multierror"
 	"golang.org/x/xerrors"
 
 	"github.com/aquasecurity/fanal/types"
@@ -50,6 +51,16 @@ func (c RedisCache) PutBlob(blobID string, blobInfo types.BlobInfo) error {
 	}
 	return nil
 }
+func (c RedisCache) DeleteBlobs(blobIDs []string) error {
+	var errs error
+	for _, blobID := range blobIDs {
+		key := fmt.Sprintf("%s::%s::%s", redisPrefix, artifactBucket, blobID)
+		if err := c.client.Del(context.TODO(), key).Err(); err != nil {
+			errs = multierror.Append(errs, err)
+		}
+	}
+	return errs
+}
 
 func (c RedisCache) GetArtifact(artifactID string) (types.ArtifactInfo, error) {
 	key := fmt.Sprintf("%s::%s::%s", redisPrefix, artifactBucket, artifactID)