centralise the name of the image to build in the controller (rh-ecosystem-edge#88)

The name of the image to build is assumed to be km.ContainerImage in
several places in the code, this commit centralises that assumption
into a single point in Reconcile(). In the future this will allow us to
determine the image the stage produces once E.g if we add signing
(or other) intermediate stages to the image build process.

Author: chr15p

controllers/module_reconciler.go

@@ -147,7 +147,7 @@ func (r *ModuleReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
 	}
 
 	for kernelVersion, m := range mappings {
-		requeue, err := r.handleBuild(ctx, mod, m, kernelVersion)
+		requeue, err := r.handleBuild(ctx, mod, m, kernelVersion, m.ContainerImage)
 		if err != nil {
 			return res, fmt.Errorf("failed to handle build for kernel version %s: %w", kernelVersion, err)
 		}
@@ -260,17 +260,18 @@ func (r *ModuleReconciler) getNodesListBySelector(ctx context.Context, mod *kmmv
 func (r *ModuleReconciler) handleBuild(ctx context.Context,
 	mod *kmmv1beta1.Module,
 	km *kmmv1beta1.KernelMapping,
-	kernelVersion string) (bool, error) {
+	kernelVersion string,
+	containerImage string) (bool, error) {
 	if mod.Spec.ModuleLoader.Container.Build == nil && km.Build == nil {
 		return false, nil
 	}
 
-	logger := log.FromContext(ctx, "kernel version", kernelVersion, "image", km.ContainerImage)
+	logger := log.FromContext(ctx, "kernel version", kernelVersion, "image", containerImage)
 	logger.Info("Trying to pull the output image")
 
-	exists, err := r.checkImageExists(ctx, mod, km)
+	exists, err := r.checkImageExists(ctx, mod, km, containerImage)
 	if err != nil {
-		return false, fmt.Errorf("failed to check image existence for kernel %s: %w", kernelVersion, err)
+		return false, fmt.Errorf("failed to check existence of image %s for kernel %s: %w", containerImage, kernelVersion, err)
 	}
 	if exists {
 		logger.Info("Image already exists; skipping build")
@@ -279,7 +280,7 @@ func (r *ModuleReconciler) handleBuild(ctx context.Context,
 
 	logger.Info("Image not pull-able; building in-cluster")
 
-	buildRes, err := r.buildAPI.Sync(log.IntoContext(ctx, logger), *mod, *km, kernelVersion, true)
+	buildRes, err := r.buildAPI.Sync(log.IntoContext(ctx, logger), *mod, *km, kernelVersion, containerImage, true)
 	if err != nil {
 		return false, fmt.Errorf("could not synchronize the build: %w", err)
 	}
@@ -294,10 +295,10 @@ func (r *ModuleReconciler) handleBuild(ctx context.Context,
 	return buildRes.Requeue, nil
 }
 
-func (r *ModuleReconciler) checkImageExists(ctx context.Context, mod *kmmv1beta1.Module, km *kmmv1beta1.KernelMapping) (bool, error) {
+func (r *ModuleReconciler) checkImageExists(ctx context.Context, mod *kmmv1beta1.Module, km *kmmv1beta1.KernelMapping, imageName string) (bool, error) {
 	registryAuthGetter := r.authFactory.NewRegistryAuthGetterFrom(mod)
 	pullOptions := module.GetRelevantPullOptions(mod, km)
-	imageAvailable, err := r.registry.ImageExists(ctx, km.ContainerImage, pullOptions, registryAuthGetter)
+	imageAvailable, err := r.registry.ImageExists(ctx, imageName, pullOptions, registryAuthGetter)
 	if err != nil {
 		return false, fmt.Errorf("could not check if the image is available: %v", err)
 	}

controllers/module_reconciler_test.go

@@ -745,7 +745,7 @@ var _ = Describe("ModuleReconciler_handleBuild", func() {
 			mockSU,
 		)
 
-		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion)
+		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion, km.ContainerImage)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(res).To(BeFalse())
 	})
@@ -796,7 +796,7 @@ var _ = Describe("ModuleReconciler_handleBuild", func() {
 			mockSU,
 		)
 
-		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion)
+		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion, km.ContainerImage)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(res).To(BeFalse())
 	})
@@ -840,7 +840,7 @@ var _ = Describe("ModuleReconciler_handleBuild", func() {
 			mockSU,
 		)
 
-		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion)
+		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion, km.ContainerImage)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(res).To(BeFalse())
 	})
@@ -865,7 +865,7 @@ var _ = Describe("ModuleReconciler_handleBuild", func() {
 				NewRegistryAuthGetterFrom(mod).
 				Return(authGetter),
 			mockRegistry.EXPECT().ImageExists(context.Background(), imageName, nil, authGetter).Return(false, nil),
-			mockBM.EXPECT().Sync(gomock.Any(), *mod, *km, gomock.Any(), true).Return(buildRes, nil),
+			mockBM.EXPECT().Sync(gomock.Any(), *mod, *km, gomock.Any(), km.ContainerImage, true).Return(buildRes, nil),
 			mockMetrics.EXPECT().SetCompletedStage(mod.Name, mod.Namespace, kernelVersion, metrics.BuildStage, false),
 		)
 
@@ -882,7 +882,7 @@ var _ = Describe("ModuleReconciler_handleBuild", func() {
 			mockSU,
 		)
 
-		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion)
+		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion, km.ContainerImage)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(res).To(BeTrue())
 	})
@@ -907,7 +907,7 @@ var _ = Describe("ModuleReconciler_handleBuild", func() {
 				NewRegistryAuthGetterFrom(mod).
 				Return(authGetter),
 			mockRegistry.EXPECT().ImageExists(context.Background(), imageName, nil, authGetter).Return(false, nil),
-			mockBM.EXPECT().Sync(gomock.Any(), *mod, *km, gomock.Any(), true).Return(buildRes, nil),
+			mockBM.EXPECT().Sync(gomock.Any(), *mod, *km, gomock.Any(), km.ContainerImage, true).Return(buildRes, nil),
 			mockMetrics.EXPECT().SetCompletedStage(mod.Name, mod.Namespace, kernelVersion, metrics.BuildStage, false),
 		)
 
@@ -924,7 +924,7 @@ var _ = Describe("ModuleReconciler_handleBuild", func() {
 			mockSU,
 		)
 
-		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion)
+		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion, km.ContainerImage)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(res).To(BeTrue())
 	})
@@ -949,7 +949,7 @@ var _ = Describe("ModuleReconciler_handleBuild", func() {
 				NewRegistryAuthGetterFrom(mod).
 				Return(authGetter),
 			mockRegistry.EXPECT().ImageExists(context.Background(), imageName, nil, authGetter).Return(false, nil),
-			mockBM.EXPECT().Sync(gomock.Any(), *mod, *km, gomock.Any(), true).Return(buildRes, nil),
+			mockBM.EXPECT().Sync(gomock.Any(), *mod, *km, gomock.Any(), km.ContainerImage, true).Return(buildRes, nil),
 			mockMetrics.EXPECT().SetCompletedStage(mod.Name, mod.Namespace, kernelVersion, metrics.BuildStage, true),
 		)
 
@@ -966,7 +966,7 @@ var _ = Describe("ModuleReconciler_handleBuild", func() {
 			mockSU,
 		)
 
-		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion)
+		res, err := mr.handleBuild(context.Background(), mod, km, kernelVersion, km.ContainerImage)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(res).To(BeFalse())
 	})

internal/build/buildconfig/manager.go

@@ -34,10 +34,10 @@ func NewManager(client client.Client, maker Maker, ocpBuildsHelper OpenShiftBuil
 	}
 }
 
-func (bcm *buildConfigManager) Sync(ctx context.Context, mod kmmv1beta1.Module, m kmmv1beta1.KernelMapping, targetKernel string, pushImage bool) (build.Result, error) {
+func (bcm *buildConfigManager) Sync(ctx context.Context, mod kmmv1beta1.Module, m kmmv1beta1.KernelMapping, targetKernel, targetImage string, pushImage bool) (build.Result, error) {
 	logger := log.FromContext(ctx)
 
-	buildConfigTemplate, err := bcm.maker.MakeBuildConfigTemplate(mod, m, targetKernel, m.ContainerImage, pushImage)
+	buildConfigTemplate, err := bcm.maker.MakeBuildConfigTemplate(mod, m, targetKernel, targetImage, pushImage)
 	if err != nil {
 		return build.Result{}, fmt.Errorf("could not make BuildConfig template: %v", err)
 	}

internal/build/buildconfig/manager_test.go

@@ -81,7 +81,7 @@ var _ = Describe("Manager_Sync", func() {
 			mockKubeClient.EXPECT().Create(ctx, &buildConfig),
 		)
 
-		res, err := m.Sync(ctx, mod, mapping, targetKernel, true)
+		res, err := m.Sync(ctx, mod, mapping, targetKernel, mapping.ContainerImage, true)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(res.Status).To(BeEquivalentTo(build.StatusCreated))
 		Expect(res.Requeue).To(BeTrue())
@@ -131,7 +131,7 @@ var _ = Describe("Manager_Sync", func() {
 				mockOpenShiftBuildsHelper.EXPECT().GetLatestBuild(ctx, namespace, buildConfigName).Return(&b, nil),
 			)
 
-			res, err := m.Sync(ctx, mod, mapping, targetKernel, true)
+			res, err := m.Sync(ctx, mod, mapping, targetKernel, mapping.ContainerImage, true)
 
 			if expectError {
 				Expect(err).To(HaveOccurred())

internal/build/manager.go

@@ -22,5 +22,5 @@ type Result struct {
 //go:generate mockgen -source=manager.go -package=build -destination=mock_manager.go
 
 type Manager interface {
-	Sync(ctx context.Context, mod kmmv1beta1.Module, m kmmv1beta1.KernelMapping, targetKernel string, pushImage bool) (Result, error)
+	Sync(ctx context.Context, mod kmmv1beta1.Module, m kmmv1beta1.KernelMapping, targetKernel string, targetImage string, pushImage bool) (Result, error)
 }