wip

Author: Tomasz-Smelcerz-SAP

internal/repository/oci/credential/resolver.go

@@ -0,0 +1,6 @@
+package oci
+
+// compiled only when running tests.
+func SetCraneWrapper(r *RepositoryReader, cWrap craneWrapper) {
+	r.cWrapper = cWrap
+}

internal/repository/oci/credential/resolver_test.go

@@ -22,9 +22,9 @@ var (
 // RepositoryReader provides basic support to read data from OCI repositories.
 type RepositoryReader struct {
 	keyChainLookup spec.KeyChainLookup
-	hostref    string
+	hostref        string
 	insecure       bool
-	craneClient    CraneClient
+	cWrapper       craneWrapper // in runtime delegates to crane package functions
 }
 
 // NewRepository creates a new RepositoryReader for the given hostref.
@@ -45,9 +45,9 @@ func NewRepository(kcl spec.KeyChainLookup, hostref string, insecure bool) (*Rep
 
 	return &RepositoryReader{
 		keyChainLookup: kcl,
-		hostref:    hostref,
+		hostref:        hostref,
 		insecure:       insecure,
-		craneClient:    &craneClient{},
+		cWrapper:       &defaultCraneWrapper{},
 	}, nil
 }
 
@@ -59,7 +59,7 @@ func (s *RepositoryReader) GetConfigFile(ctx context.Context, name, tag string)
 		return nil, fmt.Errorf("failed to get standard options: %w", err)
 	}
 	ref := s.toImageRef(name, tag)
-	configBytes, err := s.craneClient.Config(ref, options...)
+	configBytes, err := s.cWrapper.Config(ref, options...)
 	if err != nil {
 		return nil, fmt.Errorf("failed to get config file for ref=%q: %w", ref, err)
 	}
@@ -75,7 +75,7 @@ func (s *RepositoryReader) PullLayer(ctx context.Context, name, tag, digest stri
 	}
 	ref := s.toImageRef(name, tag)
 	refWithDigest := fmt.Sprintf("%s@%s", ref, digest)
-	configBytes, err := s.craneClient.PullLayer(refWithDigest, options...)
+	configBytes, err := s.cWrapper.PullLayer(refWithDigest, options...)
 	if err != nil {
 		return nil, fmt.Errorf("failed to pull layer for ref=%q: %w", refWithDigest, err)
 	}
@@ -101,18 +101,19 @@ func (s *RepositoryReader) stdOptions(ctx context.Context) ([]crane.Option, erro
 	return options, nil
 }
 
-// CraneClient defines the subset of crane functions used by RepositoryReader.
-type CraneClient interface {
+// craneWrapper is a subset of crane package functions used by RepositoryReader.
+// It is introduced to facilitate testing.
+type craneWrapper interface {
 	Config(ref string, opt ...crane.Option) ([]byte, error)
 	PullLayer(ref string, opt ...crane.Option) (containerregistryv1.Layer, error)
 }
 
-type craneClient struct{}
+type defaultCraneWrapper struct{}
 
-func (c *craneClient) Config(ref string, opt ...crane.Option) ([]byte, error) {
-	return crane.Config(ref, opt...) //nolint:wrapcheck // the craneClient wrapper is ment not to wrap errors
+func (c *defaultCraneWrapper) Config(ref string, opt ...crane.Option) ([]byte, error) {
+	return crane.Config(ref, opt...) //nolint:wrapcheck // the crane wrapper should be transparent
 }
 
-func (c *craneClient) PullLayer(ref string, opt ...crane.Option) (containerregistryv1.Layer, error) {
-	return crane.PullLayer(ref, opt...) //nolint:wrapcheck // the craneClient wrapper is ment not to wrap errors
+func (c *defaultCraneWrapper) PullLayer(ref string, opt ...crane.Option) (containerregistryv1.Layer, error) {
+	return crane.PullLayer(ref, opt...) //nolint:wrapcheck // the crane wrapper should be transparent
 }

internal/repository/oci/export_test.go

@@ -1,4 +1,4 @@
-package oci
+package oci_test
 
 import (
 	"context"
@@ -13,6 +13,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/kyma-project/lifecycle-manager/internal/manifest/spec"
+	"github.com/kyma-project/lifecycle-manager/internal/repository/oci"
 )
 
 func TestNewRepository(t *testing.T) {
@@ -62,7 +63,7 @@ func TestNewRepository(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			_, err := NewRepository(tt.kcl, tt.hostPort, tt.insecure)
+			_, err := oci.NewRepository(tt.kcl, tt.hostPort, tt.insecure)
 			if (err != nil) != tt.expectErr {
 				t.Errorf("NewRepository() error = %v, expectErr %v", err, tt.expectErr)
 			}
@@ -76,9 +77,9 @@ func TestGetConfigFile(t *testing.T) {
 		mcc := mockCraneClient{
 			configResult: []byte("mock config data"),
 		}
-		repo, err := NewRepository(nil, "europe-docker.pkg.dev/kyma-project/prod", true)
+		repo, err := oci.NewRepository(nil, "europe-docker.pkg.dev/kyma-project/prod", true)
 		require.NoError(t, err)
-		repo.craneClient = &mcc
+		oci.SetCraneWrapper(repo, &mcc)
 		// when
 		configData, err := repo.GetConfigFile(t.Context(), "test-name", "test-version")
 		// then
@@ -92,7 +93,7 @@ func TestGetConfigFile(t *testing.T) {
 
 	t.Run("should return an error from KeyChain Lookup", func(t *testing.T) {
 		// given
-		repo, err := NewRepository(&errorKeyChainLookup{}, "dummy", false)
+		repo, err := oci.NewRepository(&errorKeyChainLookup{}, "dummy", false)
 		require.NoError(t, err)
 		// when
 		_, err = repo.GetConfigFile(t.Context(), "test-name", "test-version")
@@ -108,9 +109,9 @@ func TestGetConfigFile(t *testing.T) {
 			configResult: []byte("mock config data"),
 		}
 		mkcl := &mockKeyChainLookup{}
-		repo, err := NewRepository(mkcl, "europe-docker.pkg.dev/kyma-project/prod", false)
+		repo, err := oci.NewRepository(mkcl, "europe-docker.pkg.dev/kyma-project/prod", false)
 		require.NoError(t, err)
-		repo.craneClient = &mcc
+		oci.SetCraneWrapper(repo, &mcc)
 		assert.Nil(t, mkcl.ctx)
 		// when
 		configData, err := repo.GetConfigFile(t.Context(), "test-name", "test-version")
@@ -122,9 +123,9 @@ func TestGetConfigFile(t *testing.T) {
 
 	t.Run("should return an error from craneClient.Config", func(t *testing.T) {
 		// given
-		repo, err := NewRepository(nil, "europe-docker.pkg.dev/kyma-project/prod", true)
+		repo, err := oci.NewRepository(nil, "europe-docker.pkg.dev/kyma-project/prod", true)
 		require.NoError(t, err)
-		repo.craneClient = &mockCraneClient{}
+		oci.SetCraneWrapper(repo, &mockCraneClient{})
 		// when
 		_, err = repo.GetConfigFile(t.Context(), "test-name", "test-version")
 		// then
@@ -142,9 +143,9 @@ func TestPullLayer(t *testing.T) {
 			pullResult: mockLayer,
 		}
 
-		repo, err := NewRepository(nil, "europe-docker.pkg.dev/kyma-project/prod", true)
+		repo, err := oci.NewRepository(nil, "europe-docker.pkg.dev/kyma-project/prod", true)
 		require.NoError(t, err)
-		repo.craneClient = &mcc
+		oci.SetCraneWrapper(repo, &mcc)
 
 		layer, err := repo.PullLayer(t.Context(), "test-name", "test-version", "sha256:abcdef1234567890")
 		require.NoError(t, err)
@@ -156,17 +157,17 @@ func TestPullLayer(t *testing.T) {
 	})
 
 	t.Run("should return an error from KeyChain Lookup", func(t *testing.T) {
-		repo, err := NewRepository(&errorKeyChainLookup{}, "europe-docker.pkg.dev/kyma-project/prod", false)
+		repo, err := oci.NewRepository(&errorKeyChainLookup{}, "europe-docker.pkg.dev/kyma-project/prod", false)
 		require.NoError(t, err)
 		_, err = repo.PullLayer(t.Context(), "test-name", "test-version", "sha256:abcdef1234567890")
 		require.Error(t, err)
 		assert.ErrorIs(t, err, errKeyChain)
 	})
 
 	t.Run("should return an error from craneClient.PullLayer", func(t *testing.T) {
-		repo, err := NewRepository(nil, "europe-docker.pkg.dev/kyma-project/prod", true)
+		repo, err := oci.NewRepository(nil, "europe-docker.pkg.dev/kyma-project/prod", true)
 		require.NoError(t, err)
-		repo.craneClient = &mockCraneClient{}
+		oci.SetCraneWrapper(repo, &mockCraneClient{})
 		_, err = repo.PullLayer(t.Context(), "test-name", "test-version", "sha256:abcdef1234567890")
 		require.Error(t, err)
 		require.ErrorIs(t, err, errMockPull)