v2/release: use gomock generated mock interfaces.

Author: r4f4

v2/internal/pkg/release/local_stored_collector_test.go

@@ -2,6 +2,7 @@ package release
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -10,13 +11,17 @@ import (
 
 	"github.com/containers/image/v5/types"
 	"github.com/google/uuid"
+	"github.com/otiai10/copy"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/mock"
+	"go.uber.org/mock/gomock"
+
 	"github.com/openshift/oc-mirror/v2/internal/pkg/api/v2alpha1"
 	"github.com/openshift/oc-mirror/v2/internal/pkg/common"
 	clog "github.com/openshift/oc-mirror/v2/internal/pkg/log"
+	"github.com/openshift/oc-mirror/v2/internal/pkg/manifest"
+	manifestmock "github.com/openshift/oc-mirror/v2/internal/pkg/manifest/mock"
 	"github.com/openshift/oc-mirror/v2/internal/pkg/mirror"
-	"github.com/otiai10/copy"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/mock"
 )
 
 type MockMirror struct {
@@ -43,12 +48,74 @@ func TestReleaseLocalStoredCollector(t *testing.T) {
 	tempDir := t.TempDir()
 	defer os.RemoveAll(tempDir)
 
+	mockCtrl := gomock.NewController(t)
+	defer mockCtrl.Finish()
+
+	defaultImageIndex := &v2alpha1.OCISchema{
+		SchemaVersion: 2,
+		Manifests: []v2alpha1.OCIManifest{
+			{
+				MediaType: "application/vnd.oci.image.manifest.v1+json",
+				Digest:    "sha256:3ef0b0141abd1548f60c4f3b23ecfc415142b0e842215f38e98610a3b2e52419",
+				Size:      567,
+			},
+		},
+	}
+
+	defaultImageManifest := &v2alpha1.OCISchema{
+		SchemaVersion: 2,
+		Manifests: []v2alpha1.OCIManifest{
+			{
+				MediaType: "application/vnd.oci.image.manifest.v1+json",
+				Digest:    "sha256:3ef0b0141abd1548f60c4f3b23ecfc415142b0e842215f38e98610a3b2e52419",
+				Size:      567,
+			},
+		},
+		Config: v2alpha1.OCIManifest{
+			MediaType: "application/vnd.oci.image.manifest.v1+json",
+			Digest:    "sha256:3ef0b0141abd1548f60c4f3b23ecfc415142b0e842215f38e98610a3b2e52419",
+			Size:      567,
+		},
+	}
+
+	defaultReleaseSchema := []v2alpha1.RelatedImage{
+		{Name: "agent-installer-api-server", Type: v2alpha1.TypeOCPReleaseContent, Image: "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:f30638f60452062aba36a26ee6c036feead2f03b28f2c47f2b0a991e4182331e"},
+		{Name: "agent-installer-node-agent", Type: v2alpha1.TypeOCPReleaseContent, Image: "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:955faaa822dc107f4dffa6a7e457f8d57a65d10949f74f6780ddd63c115e31e5"},
+		{Name: "agent-installer-orchestrator", Type: v2alpha1.TypeOCPReleaseContent, Image: "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:4949b93b3fd0f6b22197402ba22c2775eba408b53d30ac2e3ab2dda409314f5e"},
+		{Name: "apiserver-network-proxy", Type: v2alpha1.TypeOCPReleaseContent, Image: "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:2a0dd75b1b327a0c5b17145fc71beb2bf805e6cc3b8fc3f672ce06772caddf21"},
+	}
+
 	// this test should cover over 80% M2D
 	t.Run("Testing ReleaseImageCollector - Mirror to disk: should pass", func(t *testing.T) {
 		ctx := context.Background()
-		manifest := &MockManifest{Log: log}
 
-		ex := setupCollector_MirrorToDisk(tempDir, log, manifest)
+		manifestMock := manifestmock.NewMockManifestInterface(mockCtrl)
+
+		manifestMock.
+			EXPECT().
+			GetImageIndex(gomock.Any()).
+			Return(defaultImageIndex, nil).
+			AnyTimes()
+
+		manifestMock.
+			EXPECT().
+			GetImageManifest(gomock.Any()).
+			Return(defaultImageManifest, nil).
+			AnyTimes()
+
+		manifestMock.
+			EXPECT().
+			ExtractLayersOCI(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).
+			Return(nil).
+			AnyTimes()
+
+		manifestMock.
+			EXPECT().
+			GetReleaseSchema(gomock.Any()).
+			Return(defaultReleaseSchema, nil).
+			AnyTimes()
+
+		ex := setupCollector_MirrorToDisk(tempDir, log, manifestMock)
 
 		err := copy.Copy(common.TestFolder+"working-dir-fake/hold-release/ocp-release/4.14.1-x86_64", filepath.Join(ex.Opts.Global.WorkingDir, releaseImageExtractDir, "ocp-release/4.13.10-x86_64"))
 		if err != nil {
@@ -112,13 +179,12 @@ func TestReleaseLocalStoredCollector(t *testing.T) {
 	})
 
 	t.Run("Testing ReleaseImageCollector - Disk to mirror : should pass", func(t *testing.T) {
-
 		os.RemoveAll(common.TestFolder + "hold-release/")
 		os.RemoveAll(common.TestFolder + "release-images")
 		os.RemoveAll(common.TestFolder + "tmp/")
 
 		ex := setupCollector_DiskToMirror(tempDir, log)
-		//copy tests/hold-test-fake to working-dir
+		// copy tests/hold-test-fake to working-dir
 		err := copy.Copy(common.TestFolder+"working-dir-fake/hold-release/ocp-release/4.14.1-x86_64", filepath.Join(ex.Opts.Global.WorkingDir, releaseImageExtractDir, "ocp-release/4.13.10-x86_64"))
 		if err != nil {
 			t.Fatalf("should not fail")
@@ -187,7 +253,6 @@ func TestReleaseLocalStoredCollector(t *testing.T) {
 	})
 
 	t.Run("Testing ReleaseImageCollector with real GetReleaseReferenceImages - Disk to mirror : should pass", func(t *testing.T) {
-
 		os.RemoveAll(common.TestFolder + "hold-release/")
 		os.RemoveAll(common.TestFolder + "release-images")
 		os.RemoveAll(common.TestFolder + "tmp/")
@@ -217,9 +282,15 @@ func TestReleaseLocalStoredCollector(t *testing.T) {
 	})
 
 	t.Run("Testing ReleaseImageCollector : should fail image index", func(t *testing.T) {
-		manifest := &MockManifest{Log: log, FailImageIndex: true}
+		manifestMock := manifestmock.NewMockManifestInterface(mockCtrl)
 
-		ex := setupCollector_MirrorToDisk(tempDir, log, manifest)
+		manifestMock.
+			EXPECT().
+			GetImageIndex(gomock.Any()).
+			Return(nil, errors.New("force-fail image index")).
+			AnyTimes()
+
+		ex := setupCollector_MirrorToDisk(tempDir, log, manifestMock)
 		res, err := ex.ReleaseImageCollector(context.Background())
 		if err == nil {
 			t.Fatalf("should fail")
@@ -228,8 +299,21 @@ func TestReleaseLocalStoredCollector(t *testing.T) {
 	})
 
 	t.Run("Testing ReleaseImageCollector : should fail image manifest", func(t *testing.T) {
-		manifest := &MockManifest{Log: log, FailImageManifest: true}
-		ex := setupCollector_MirrorToDisk(tempDir, log, manifest)
+		manifestMock := manifestmock.NewMockManifestInterface(mockCtrl)
+
+		manifestMock.
+			EXPECT().
+			GetImageIndex(gomock.Any()).
+			Return(defaultImageIndex, nil).
+			AnyTimes()
+
+		manifestMock.
+			EXPECT().
+			GetImageManifest(gomock.Any()).
+			Return(nil, errors.New("force-fail image manifest")).
+			AnyTimes()
+
+		ex := setupCollector_MirrorToDisk(tempDir, log, manifestMock)
 
 		res, err := ex.ReleaseImageCollector(context.Background())
 		if err == nil {
@@ -239,16 +323,34 @@ func TestReleaseLocalStoredCollector(t *testing.T) {
 	})
 
 	t.Run("Testing ReleaseImageCollector : should fail extract", func(t *testing.T) {
-		manifest := &MockManifest{Log: log, FailExtract: true}
-		ex := setupCollector_MirrorToDisk(tempDir, log, manifest)
+		manifestMock := manifestmock.NewMockManifestInterface(mockCtrl)
+
+		manifestMock.
+			EXPECT().
+			GetImageIndex(gomock.Any()).
+			Return(defaultImageIndex, nil).
+			AnyTimes()
+
+		manifestMock.
+			EXPECT().
+			GetImageManifest(gomock.Any()).
+			Return(defaultImageManifest, nil).
+			AnyTimes()
+
+		manifestMock.
+			EXPECT().
+			ExtractLayersOCI(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).
+			Return(errors.New("force-fail extract OCI")).
+			AnyTimes()
+
+		ex := setupCollector_MirrorToDisk(tempDir, log, manifestMock)
 
 		res, err := ex.ReleaseImageCollector(context.Background())
 		if err == nil {
 			t.Fatalf("should fail")
 		}
 		log.Debug("completed test related images %v ", res)
 	})
-
 }
 
 func TestGraphImage(t *testing.T) {
@@ -265,7 +367,6 @@ func TestGraphImage(t *testing.T) {
 		}
 		assert.Equal(t, ex.Opts.Destination+"/"+graphImageName+":latest", res)
 	})
-
 }
 
 func TestReleaseImage(t *testing.T) {
@@ -279,7 +380,7 @@ func TestReleaseImage(t *testing.T) {
 		os.RemoveAll(common.TestFolder + "tmp/")
 
 		ex := setupCollector_DiskToMirror(tempDir, log)
-		//copy tests/hold-test-fake to working-dir
+		// copy tests/hold-test-fake to working-dir
 		err := copy.Copy(common.TestFolder+"working-dir-fake/hold-release/ocp-release/4.14.1-x86_64", filepath.Join(ex.Opts.Global.WorkingDir, releaseImageExtractDir, "ocp-release/4.13.9-x86_64"))
 		if err != nil {
 			t.Fatalf("should not fail")
@@ -544,8 +645,7 @@ func setupCollector_DiskToMirror(tempDir string, log clog.PluggableLoggerInterfa
 	return ex
 }
 
-func setupCollector_MirrorToDisk(tempDir string, log clog.PluggableLoggerInterface, manifest *MockManifest) *LocalStorageCollector {
-
+func setupCollector_MirrorToDisk(tempDir string, log clog.PluggableLoggerInterface, manifest manifest.ManifestInterface) *LocalStorageCollector {
 	globalM2D := &mirror.GlobalOptions{
 		SecurePolicy: false,
 		WorkingDir:   tempDir,
@@ -781,21 +881,27 @@ type ManifestMock struct {
 func (o *ManifestMock) GetImageIndex(dir string) (*v2alpha1.OCISchema, error) {
 	return &v2alpha1.OCISchema{}, nil
 }
+
 func (o *ManifestMock) GetImageManifest(file string) (*v2alpha1.OCISchema, error) {
 	return &v2alpha1.OCISchema{}, nil
 }
+
 func (o *ManifestMock) GetOperatorConfig(file string) (*v2alpha1.OperatorConfigSchema, error) {
 	return &v2alpha1.OperatorConfigSchema{}, nil
 }
+
 func (o *ManifestMock) ExtractLayersOCI(filePath, toPath, label string, oci *v2alpha1.OCISchema) error {
 	return nil
 }
+
 func (o *ManifestMock) GetReleaseSchema(filePath string) ([]v2alpha1.RelatedImage, error) {
 	return []v2alpha1.RelatedImage{}, nil
 }
+
 func (o *ManifestMock) ConvertIndexToSingleManifest(dir string, oci *v2alpha1.OCISchema) error {
 	return nil
 }
+
 func (o *ManifestMock) GetDigest(ctx context.Context, sourceCtx *types.SystemContext, imgRef string) (string, error) {
 	args := o.Called(ctx, sourceCtx, imgRef)
 	return args.String(0), args.Error(1)