fix(s3/cache): HeadObject bucketName was missing.

Add unit testing

Author: oranmoshai

cache/s3.go

@@ -110,7 +110,9 @@ func (c S3Cache) GetArtifact(artifactID string) (types.ArtifactInfo, error) {
 }
 
 func (c S3Cache) getIndex(key string, keyType string) error {
-	_, err := c.s3Client.HeadObject(&s3.HeadObjectInput{Key: aws.String(fmt.Sprintf("%s/%s/%s.index", keyType, c.prefix, key))})
+	_, err := c.s3Client.HeadObject(&s3.HeadObjectInput{
+		Key:    aws.String(fmt.Sprintf("%s/%s/%s.index", keyType, c.prefix, key)),
+		Bucket: &c.bucketName})
 	if err != nil {
 		return xerrors.Errorf("failed to get index from the cache: %w", err)
 	}

cache/s3_test.go

@@ -1,14 +1,14 @@
-package cache_test
+package cache
 
 import (
-	"testing"
-	"time"
-
-	"github.com/aquasecurity/fanal/cache"
 	"github.com/aquasecurity/fanal/types"
 	"github.com/aws/aws-sdk-go/service/s3"
 	"github.com/aws/aws-sdk-go/service/s3/s3iface"
 	"github.com/aws/aws-sdk-go/service/s3/s3manager"
+	"golang.org/x/xerrors"
+	"reflect"
+	"testing"
+	"time"
 )
 
 type mockS3Client struct {
@@ -19,9 +19,8 @@ func (m *mockS3Client) PutObject(*s3.PutObjectInput) (*s3.PutObjectOutput, error
 	return &s3.PutObjectOutput{}, nil
 }
 
-func (m *mockS3Client) WaitUntilObjectExists(*s3.HeadObjectInput) error {
-	return nil
-
+func (m *mockS3Client) HeadObject(*s3.HeadObjectInput) (*s3.HeadObjectOutput, error) {
+	return &s3.HeadObjectOutput{}, nil
 }
 
 func TestS3Cache_PutBlob(t *testing.T) {
@@ -63,7 +62,7 @@ func TestS3Cache_PutBlob(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			c := cache.NewS3Cache(tt.fields.BucketName, tt.fields.Prefix, tt.fields.S3, tt.fields.Downloader)
+			c := NewS3Cache(tt.fields.BucketName, tt.fields.Prefix, tt.fields.S3, tt.fields.Downloader)
 			if err := c.PutBlob(tt.args.blobID, tt.args.blobInfo); (err != nil) != tt.wantErr {
 				t.Errorf("S3Cache.PutBlob() error = %v, wantErr %v", err, tt.wantErr)
 			}
@@ -116,10 +115,116 @@ func TestS3Cache_PutArtifact(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			c := cache.NewS3Cache(tt.fields.BucketName, tt.fields.Prefix, tt.fields.S3, tt.fields.Downloader)
+			c := NewS3Cache(tt.fields.BucketName, tt.fields.Prefix, tt.fields.S3, tt.fields.Downloader)
 			if err := c.PutArtifact(tt.args.artifactID, tt.args.artifactConfig); (err != nil) != tt.wantErr {
 				t.Errorf("S3Cache.PutArtifact() error = %v, wantErr %v", err, tt.wantErr)
 			}
 		})
 	}
 }
+
+func TestS3Cache_getIndex(t *testing.T) {
+	mockSvc := &mockS3Client{}
+
+	type fields struct {
+		S3         s3iface.S3API
+		Downloader *s3manager.Downloader
+		BucketName string
+		Prefix     string
+	}
+	type args struct {
+		key     string
+		keyType string
+	}
+	tests := []struct {
+		name    string
+		fields  fields
+		args    args
+		wantErr bool
+	}{
+		{
+			name: "happy path",
+			fields: fields{
+				S3:         mockSvc,
+				BucketName: "test",
+				Prefix:     "prefix",
+			},
+			args: args{
+				key:     "key",
+				keyType: "artifactBucket",
+			},
+			wantErr: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			c := NewS3Cache(tt.fields.BucketName, tt.fields.Prefix, tt.fields.S3, tt.fields.Downloader)
+			if err := c.getIndex(tt.args.key, tt.args.keyType); (err != nil) != tt.wantErr {
+				t.Errorf("S3Cache.getIndex() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}
+
+type mockS3ClientMissingBlobs struct {
+	s3iface.S3API
+}
+
+func (m *mockS3ClientMissingBlobs) PutObject(*s3.PutObjectInput) (*s3.PutObjectOutput, error) {
+	return &s3.PutObjectOutput{}, nil
+}
+
+func (m *mockS3ClientMissingBlobs) HeadObject(*s3.HeadObjectInput) (*s3.HeadObjectOutput, error) {
+	return &s3.HeadObjectOutput{}, xerrors.Errorf("the object doesn't exist in S3")
+}
+
+func TestS3Cache_MissingBlobs(t *testing.T) {
+	mockSvc := &mockS3ClientMissingBlobs{}
+
+	type fields struct {
+		S3         s3iface.S3API
+		Downloader *s3manager.Downloader
+		BucketName string
+		Prefix     string
+	}
+	type args struct {
+		artifactID string
+		blobIDs    []string
+	}
+	tests := []struct {
+		name            string
+		fields          fields
+		args            args
+		want            bool
+		wantStringSlice []string
+		wantErr         bool
+	}{{
+		name: "happy path",
+		fields: fields{
+			S3:         mockSvc,
+			BucketName: "test",
+			Prefix:     "prefix",
+		},
+		args:            args{artifactID: "sha256:58701fd185bda36cab0557bb6438661831267aa4a9e0b54211c4d5317a48aff4", blobIDs: []string{"sha256:24df0d4e20c0f42d3703bf1f1db2bdd77346c7956f74f423603d651e8e5ae8a7"}},
+		want:            true,
+		wantStringSlice: []string{"sha256:24df0d4e20c0f42d3703bf1f1db2bdd77346c7956f74f423603d651e8e5ae8a7"},
+		wantErr:         false,
+	},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			c := NewS3Cache(tt.fields.BucketName, tt.fields.Prefix, tt.fields.S3, tt.fields.Downloader)
+			got, got1, err := c.MissingBlobs(tt.args.artifactID, tt.args.blobIDs)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("S3Cache.MissingBlobs() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if got != tt.want {
+				t.Errorf("S3Cache.MissingBlobs() got = %v, want %v", got, tt.want)
+			}
+			if !reflect.DeepEqual(got1, tt.wantStringSlice) {
+				t.Errorf("S3Cache.MissingBlobs() got1 = %v, want %v", got1, tt.wantStringSlice)
+			}
+		})
+	}
+}