Add unit tests for run image resolution

Co-authored-by: Johannes Dillmann <[email protected]> Co-authored-by: Philipp Stehle <[email protected]> Signed-off-by: Ralf Pannemans <[email protected]>
buildpacks · Mar 1, 2023 · b358a97 · b358a97
1 parent 935885c
commit b358a97
Show file tree

Hide file tree

Showing 9 changed files with 179 additions and 31 deletions.
diff --git a/cmd/lifecycle/analyzer.go b/cmd/lifecycle/analyzer.go
@@ -66,6 +66,7 @@ func (a *analyzeCmd) Args(nargs int, args []string) error {
 		return cmd.FailErrCode(err, cmd.CodeForInvalidArgs, "parse arguments")
 	}
 	a.LifecycleInputs.OutputImageRef = args[0]
+	a.LifecycleInputs.AccessChecker = &platform.AccessCheckerImpl{}
 	if err := platform.ResolveInputs(platform.Analyze, a.LifecycleInputs, cmd.DefaultLogger); err != nil {
 		return cmd.FailErrCode(err, cmd.CodeForInvalidArgs, "resolve inputs")
 	}

diff --git a/cmd/lifecycle/rebaser.go b/cmd/lifecycle/rebaser.go
@@ -160,7 +160,7 @@ func (r *rebaseCmd) setAppImage() error {
 		if md.Stack.RunImage.Image == "" {
 			return cmd.FailErrCode(errors.New("-run-image is required when there is no stack metadata available"), cmd.CodeForInvalidArgs, "parse arguments")
 		}
-		r.RunImageRef, err = md.Stack.BestRunImageMirror(registry)
+		r.RunImageRef, err = md.Stack.BestRunImageMirror(registry, &platform.AccessCheckerImpl{})
 		if err != nil {
 			return err
 		}

diff --git a/platform/files.go b/platform/files.go
@@ -7,6 +7,7 @@ import (
 	"os"
 
 	"github.com/BurntSushi/toml"
+	"github.com/google/go-containerregistry/pkg/authn"
 	"github.com/google/go-containerregistry/pkg/name"
 	"github.com/pkg/errors"
 
@@ -282,50 +283,75 @@ type RunImageMetadata struct {
 	Mirrors []string `toml:"mirrors" json:"mirrors,omitempty"`
 }
 
-func (rm *RunImageMetadata) BestRunImageMirror(registry string) (string, error) {
+//go:generate mockgen -package testmock -destination ../testmock/access_checker.go github.com/buildpacks/lifecycle/platform AccessChecker
+type AccessChecker interface {
+	CheckReadAccess(repo string, keychain authn.Keychain) (bool, error)
+}
+
+type AccessCheckerImpl struct{}
+
+var _ AccessChecker = &AccessCheckerImpl{}
+
+func (a *AccessCheckerImpl) CheckReadAccess(repo string, keychain authn.Keychain) (bool, error) {
+	img, err := remote.NewImage(repo, keychain)
+	if err != nil {
+		return false, errors.Wrap(err, "failed to parse image reference")
+	}
+
+	return img.CheckReadAccess(), nil
+}
+
+func (rm *RunImageMetadata) BestRunImageMirror(registry string, accessChecker AccessChecker) (string, error) {
 	if rm.Image == "" {
 		return "", errors.New("missing run-image metadata")
 	}
 
 	runImageMirrors := []string{rm.Image}
 	runImageMirrors = append(runImageMirrors, rm.Mirrors...)
-	runImageRef := byRegistry(registry, runImageMirrors)
-	if runImageRef != "" {
-		// Found run image in the registry of the target image
-		return runImageRef, nil
-	}
 
 	keychain, err := auth.DefaultKeychain(runImageMirrors...)
 	if err != nil {
-		return "", errors.Wrap(err, "failed to get registry credentials")
+		return "", errors.Wrap(err, "unable to create keychain")
+	}
+
+	runImageRef := byRegistry(registry, runImageMirrors, accessChecker, keychain)
+	if runImageRef != "" {
+		return runImageRef, nil
 	}
 
 	for _, image := range runImageMirrors {
-		img, err := remote.NewImage(image, keychain)
+		ok, err := accessChecker.CheckReadAccess(image, keychain)
 		if err != nil {
-			return "", errors.Wrap(err, "failed to parse image reference")
+			return "", err
 		}
 
-		if img.CheckReadAccess() {
+		if ok {
 			return image, nil
 		}
 	}
 
-	return "", errors.Wrap(err, "failed to find accessible run image")
+	return "", errors.New("failed to find accessible run image")
 }
 
-func (sm *StackMetadata) BestRunImageMirror(registry string) (string, error) {
-	return sm.RunImage.BestRunImageMirror(registry)
+func (sm *StackMetadata) BestRunImageMirror(registry string, accessChecker AccessChecker) (string, error) {
+	return sm.RunImage.BestRunImageMirror(registry, accessChecker)
 }
 
-func byRegistry(reg string, imgs []string) string {
-	for _, img := range imgs {
-		ref, err := name.ParseReference(img, name.WeakValidation)
+func byRegistry(reg string, repos []string, accessChecker AccessChecker, keychain authn.Keychain) string {
+	for _, repo := range repos {
+		ref, err := name.ParseReference(repo, name.WeakValidation)
 		if err != nil {
 			continue
 		}
 		if reg == ref.Context().RegistryStr() {
-			return img
+			ok, err := accessChecker.CheckReadAccess(repo, keychain)
+			if err != nil {
+				return ""
+			}
+
+			if ok {
+				return repo
+			}
 		}
 	}
 

diff --git a/platform/files_test.go b/platform/files_test.go
@@ -3,13 +3,15 @@ package platform_test
 import (
 	"testing"
 
+	"github.com/golang/mock/gomock"
 	"github.com/google/go-cmp/cmp"
 	"github.com/sclevine/spec"
 
 	"github.com/buildpacks/lifecycle/api"
 	"github.com/buildpacks/lifecycle/buildpack"
 	"github.com/buildpacks/lifecycle/platform"
 	h "github.com/buildpacks/lifecycle/testhelpers"
+	"github.com/buildpacks/lifecycle/testmock"
 )
 
 func TestFiles(t *testing.T) {
@@ -97,6 +99,8 @@ func testFiles(t *testing.T, when spec.G, it spec.S) {
 	when("stack.toml", func() {
 		when("BestRunImageMirror", func() {
 			var stackMD *platform.StackMetadata
+			var accessCheckerDefaultMock *testmock.MockAccessChecker
+			var ctrl *gomock.Controller
 
 			it.Before(func() {
 				stackMD = &platform.StackMetadata{RunImage: platform.RunImageMetadata{
@@ -107,37 +111,83 @@ func testFiles(t *testing.T, when spec.G, it spec.S) {
 						"gcr.io/org/repo",
 					},
 				}}
+				ctrl = gomock.NewController(t)
+				accessCheckerDefaultMock = testmock.NewMockAccessChecker(ctrl)
+				accessCheckerDefaultMock.EXPECT().CheckReadAccess(gomock.Any(), gomock.Any()).Return(false, nil).AnyTimes()
+			})
+
+			it.After(func() {
+				if ctrl != nil {
+					ctrl.Finish()
+				}
 			})
 
 			when("repoName is dockerhub", func() {
 				it("returns the dockerhub image", func() {
-					name, err := stackMD.BestRunImageMirror("index.docker.io")
+					accessCheckerMock := testmock.NewMockAccessChecker(ctrl)
+					accessCheckerMock.EXPECT().CheckReadAccess("myorg/myrepo", gomock.Any()).Return(true, nil).AnyTimes()
+					accessCheckerMock.EXPECT().CheckReadAccess(gomock.Any(), gomock.Any()).Return(false, nil).AnyTimes()
+
+					name, err := stackMD.BestRunImageMirror("index.docker.io", accessCheckerMock)
 					h.AssertNil(t, err)
 					h.AssertEq(t, name, "myorg/myrepo")
 				})
 			})
 
 			when("registry is gcr.io", func() {
 				it("returns the gcr.io image", func() {
-					name, err := stackMD.BestRunImageMirror("gcr.io")
+					accessCheckerMock := testmock.NewMockAccessChecker(ctrl)
+					accessCheckerMock.EXPECT().CheckReadAccess("gcr.io/org/repo", gomock.Any()).Return(true, nil).AnyTimes()
+					accessCheckerMock.EXPECT().CheckReadAccess(gomock.Any(), gomock.Any()).Return(false, nil).AnyTimes()
+
+					name, err := stackMD.BestRunImageMirror("gcr.io", accessCheckerMock)
 					h.AssertNil(t, err)
 					h.AssertEq(t, name, "gcr.io/org/repo")
 				})
 
 				when("registry is zonal.gcr.io", func() {
 					it("returns the gcr image", func() {
-						name, err := stackMD.BestRunImageMirror("zonal.gcr.io")
+						accessCheckerMock := testmock.NewMockAccessChecker(ctrl)
+						accessCheckerMock.EXPECT().CheckReadAccess("zonal.gcr.io/org/repo", gomock.Any()).Return(true, nil).AnyTimes()
+						accessCheckerMock.EXPECT().CheckReadAccess(gomock.Any(), gomock.Any()).Return(false, nil).AnyTimes()
+
+						name, err := stackMD.BestRunImageMirror("zonal.gcr.io", accessCheckerMock)
 						h.AssertNil(t, err)
 						h.AssertEq(t, name, "zonal.gcr.io/org/repo")
 					})
 				})
 
 				when("registry is missingzone.gcr.io", func() {
 					it("returns the run image", func() {
-						name, err := stackMD.BestRunImageMirror("missingzone.gcr.io")
+						accessCheckerMock := testmock.NewMockAccessChecker(ctrl)
+						accessCheckerMock.EXPECT().CheckReadAccess("first.com/org/repo", gomock.Any()).Return(true, nil).AnyTimes()
+						accessCheckerMock.EXPECT().CheckReadAccess(gomock.Any(), gomock.Any()).Return(false, nil).AnyTimes()
+
+						name, err := stackMD.BestRunImageMirror("missingzone.gcr.io", accessCheckerMock)
 						h.AssertNil(t, err)
 						h.AssertEq(t, name, "first.com/org/repo")
 					})
+
+					it("returns first mirror if run image is not readable", func() {
+						accessCheckerMock := testmock.NewMockAccessChecker(ctrl)
+						accessCheckerMock.EXPECT().CheckReadAccess("myorg/myrepo", gomock.Any()).Return(true, nil).AnyTimes()
+						accessCheckerMock.EXPECT().CheckReadAccess(gomock.Any(), gomock.Any()).Return(false, nil).AnyTimes()
+
+						name, err := stackMD.BestRunImageMirror("missingzone.gcr.io", accessCheckerMock)
+						h.AssertNil(t, err)
+						h.AssertEq(t, name, "myorg/myrepo")
+					})
+
+					it("returns the first readable mirror", func() {
+						accessCheckerMock := testmock.NewMockAccessChecker(ctrl)
+						accessCheckerMock.EXPECT().CheckReadAccess("zonal.gcr.io/org/repo", gomock.Any()).Return(true, nil).AnyTimes()
+						accessCheckerMock.EXPECT().CheckReadAccess("gcr.io/org/repo", gomock.Any()).Return(true, nil).AnyTimes()
+						accessCheckerMock.EXPECT().CheckReadAccess(gomock.Any(), gomock.Any()).Return(false, nil).AnyTimes()
+
+						name, err := stackMD.BestRunImageMirror("missingzone.gcr.io", accessCheckerMock)
+						h.AssertNil(t, err)
+						h.AssertEq(t, name, "zonal.gcr.io/org/repo")
+					})
 				})
 			})
 
@@ -147,7 +197,11 @@ func testFiles(t *testing.T, when spec.G, it spec.S) {
 				})
 
 				it("skips over it", func() {
-					name, err := stackMD.BestRunImageMirror("gcr.io")
+					accessCheckerMock := testmock.NewMockAccessChecker(ctrl)
+					accessCheckerMock.EXPECT().CheckReadAccess("gcr.io/myorg/myrepo", gomock.Any()).Return(true, nil).AnyTimes()
+					accessCheckerMock.EXPECT().CheckReadAccess(gomock.Any(), gomock.Any()).Return(false, nil).AnyTimes()
+
+					name, err := stackMD.BestRunImageMirror("gcr.io", accessCheckerMock)
 					h.AssertNil(t, err)
 					h.AssertEq(t, name, "gcr.io/myorg/myrepo")
 				})

diff --git a/platform/lifecycle_inputs.go b/platform/lifecycle_inputs.go
@@ -14,6 +14,7 @@ import (
 // Fields are the cumulative total of inputs across all lifecycle phases and all supported Platform APIs.
 type LifecycleInputs struct {
 	PlatformAPI           *api.Version
+	AccessChecker         AccessChecker
 	AnalyzedPath          string
 	AppDir                string
 	BuildConfigDir        string

diff --git a/platform/resolve_analyze_inputs_test.go b/platform/resolve_analyze_inputs_test.go
@@ -6,6 +6,7 @@ import (
 
 	"github.com/apex/log"
 	"github.com/apex/log/handlers/memory"
+	"github.com/golang/mock/gomock"
 	"github.com/sclevine/spec"
 	"github.com/sclevine/spec/report"
 
@@ -15,6 +16,7 @@ import (
 	llog "github.com/buildpacks/lifecycle/log"
 	"github.com/buildpacks/lifecycle/platform"
 	h "github.com/buildpacks/lifecycle/testhelpers"
+	"github.com/buildpacks/lifecycle/testmock"
 )
 
 func TestAnalyzeInputs(t *testing.T) {
@@ -26,16 +28,22 @@ func TestAnalyzeInputs(t *testing.T) {
 func testResolveAnalyzeInputs(platformAPI string) func(t *testing.T, when spec.G, it spec.S) {
 	return func(t *testing.T, when spec.G, it spec.S) {
 		var (
-			inputs     *platform.LifecycleInputs
-			logHandler *memory.Handler
-			logger     llog.Logger
+			accessCheckerMock *testmock.MockAccessChecker
+			ctrl              *gomock.Controller
+			inputs            *platform.LifecycleInputs
+			logHandler        *memory.Handler
+			logger            llog.Logger
 		)
 
 		it.Before(func() {
 			inputs = platform.NewLifecycleInputs(api.MustParse(platformAPI), "some-layers-dir")
 			inputs.OutputImageRef = "some-output-image" // satisfy validation
 			logHandler = memory.New()
 			logger = &log.Logger{Handler: logHandler}
+			ctrl = gomock.NewController(t)
+			accessCheckerMock = testmock.NewMockAccessChecker(ctrl)
+			accessCheckerMock.EXPECT().CheckReadAccess(gomock.Any(), gomock.Any()).Return(true, nil).AnyTimes()
+			inputs.AccessChecker = accessCheckerMock
 		})
 
 		when("latest Platform API(s)", func() {

diff --git a/platform/resolve_create_inputs_test.go b/platform/resolve_create_inputs_test.go
@@ -6,6 +6,7 @@ import (
 
 	"github.com/apex/log"
 	"github.com/apex/log/handlers/memory"
+	"github.com/golang/mock/gomock"
 	"github.com/sclevine/spec"
 	"github.com/sclevine/spec/report"
 
@@ -15,6 +16,7 @@ import (
 	llog "github.com/buildpacks/lifecycle/log"
 	"github.com/buildpacks/lifecycle/platform"
 	h "github.com/buildpacks/lifecycle/testhelpers"
+	"github.com/buildpacks/lifecycle/testmock"
 )
 
 func TestCreateInputs(t *testing.T) {
@@ -26,9 +28,11 @@ func TestCreateInputs(t *testing.T) {
 func testResolveCreateInputs(platformAPI string) func(t *testing.T, when spec.G, it spec.S) {
 	return func(t *testing.T, when spec.G, it spec.S) {
 		var (
-			inputs     *platform.LifecycleInputs
-			logHandler *memory.Handler
-			logger     llog.Logger
+			accessCheckerMock *testmock.MockAccessChecker
+			ctrl              *gomock.Controller
+			inputs            *platform.LifecycleInputs
+			logHandler        *memory.Handler
+			logger            llog.Logger
 		)
 
 		it.Before(func() {
@@ -37,6 +41,10 @@ func testResolveCreateInputs(platformAPI string) func(t *testing.T, when spec.G,
 			inputs.RunImageRef = "some-run-image"       // satisfy validation
 			logHandler = memory.New()
 			logger = &log.Logger{Handler: logHandler}
+			ctrl = gomock.NewController(t)
+			accessCheckerMock = testmock.NewMockAccessChecker(ctrl)
+			accessCheckerMock.EXPECT().CheckReadAccess(gomock.Any(), gomock.Any()).Return(true, nil).AnyTimes()
+			inputs.AccessChecker = accessCheckerMock
 		})
 
 		when("latest Platform API(s)", func() {

diff --git a/platform/resolve_inputs.go b/platform/resolve_inputs.go
@@ -179,7 +179,7 @@ func fillRunImageFromRunTOMLIfNeeded(i *LifecycleInputs, logger log.Logger) erro
 	if len(runMD.Images) == 0 {
 		return errors.New(ErrRunImageRequiredWhenNoRunMD)
 	}
-	i.RunImageRef, err = runMD.Images[0].BestRunImageMirror(targetRegistry)
+	i.RunImageRef, err = runMD.Images[0].BestRunImageMirror(targetRegistry, i.AccessChecker)
 	if err != nil {
 		return errors.New(ErrRunImageRequiredWhenNoRunMD)
 	}
@@ -200,7 +200,7 @@ func fillRunImageFromStackTOMLIfNeeded(i *LifecycleInputs, logger log.Logger) er
 	if err != nil {
 		return err
 	}
-	i.RunImageRef, err = stackMD.BestRunImageMirror(targetRegistry)
+	i.RunImageRef, err = stackMD.BestRunImageMirror(targetRegistry, i.AccessChecker)
 	if err != nil {
 		return errors.New(ErrRunImageRequiredWhenNoStackMD)
 	}