STONEBLD-1505 Deprecate anonymous ImageRegistry

Author: rnc

deploy/crds/base/jvmbuildservice.io_jbsconfigs.yaml

@@ -103,6 +103,21 @@ spec:
                 type: string
               prependTag:
                 type: string
+              registry:
+                properties:
+                  host:
+                    type: string
+                  insecure:
+                    type: boolean
+                  owner:
+                    type: string
+                  port:
+                    type: string
+                  prependTag:
+                    type: string
+                  repository:
+                    type: string
+                type: object
               relocationPatterns:
                 items:
                   properties:

java-components/resource-model/src/main/resources/crds/jvmbuildservice.io_jbsconfigs.yaml

@@ -103,6 +103,21 @@ spec:
                 type: string
               prependTag:
                 type: string
+              registry:
+                properties:
+                  host:
+                    type: string
+                  insecure:
+                    type: boolean
+                  owner:
+                    type: string
+                  port:
+                    type: string
+                  prependTag:
+                    type: string
+                  repository:
+                    type: string
+                type: object
               relocationPatterns:
                 items:
                   properties:

openshift-with-appstudio-test/e2e/util.go

@@ -295,7 +295,7 @@ func setupConfig(t *testing.T, namespace string, hermetic bool) *testArgs {
 				WorkerThreads: "100",
 				RequestCPU:    "10m",
 			},
-			ImageRegistry: v1alpha1.ImageRegistry{
+			Registry: v1alpha1.ImageRegistry{
 				Host:       "quay.io",
 				Owner:      owner,
 				Repository: "test-images",
@@ -878,7 +878,7 @@ func setupMinikube(t *testing.T, namespace string) *testArgs {
 				DisableTLS:    true,
 				Storage:       "756Mi",
 			},
-			ImageRegistry: v1alpha1.ImageRegistry{
+			Registry: v1alpha1.ImageRegistry{
 				Host:       devIp,
 				Owner:      owner,
 				Repository: "test-images",

pkg/apis/jvmbuildservice/v1alpha1/jbsconfig_types.go

@@ -40,8 +40,9 @@ type JBSConfigSpec struct {
 	MavenBaseLocations map[string]string `json:"mavenBaseLocations,omitempty"`
 
 	SharedRegistries []ImageRegistry `json:"sharedRegistries,omitempty"`
-	// TODO: STONEBLD-1505 use an explicit variable
-	ImageRegistry      `json:",inline"`
+	Registry         ImageRegistry   `json:"registry,omitempty"`
+	// Deprecated: Replaced by explicit declaration of Registry above.
+	ImageRegistry      `json:",inline,omitempty"`
 	CacheSettings      CacheSettings              `json:"cacheSettings,omitempty"`
 	BuildSettings      BuildSettings              `json:"buildSettings,omitempty"`
 	RelocationPatterns []RelocationPatternElement `json:"relocationPatterns,omitempty"`
@@ -120,7 +121,7 @@ type JBSConfig struct {
 }
 
 func (in *JBSConfig) ImageRegistry() ImageRegistry {
-	ret := in.Spec.ImageRegistry
+	ret := in.Spec.Registry
 	if ret.Host == "" {
 		ret.Host = "quay.io"
 	}

pkg/apis/jvmbuildservice/v1alpha1/zz_generated.deepcopy.go

@@ -626,10 +626,10 @@ func imageRegistryCommands(imageId string, recipe *v1alpha12.BuildRecipe, db *v1
 	if imageRegistry.Insecure {
 		registryArgs = append(registryArgs, "--registry-insecure")
 	}
-	if jbsConfig.ImageRegistry().PrependTag != "" {
+	if imageRegistry.PrependTag != "" {
 		registryArgs = append(registryArgs, "--registry-prepend-tag="+imageRegistry.PrependTag)
-		preBuildImageName = prependTagToImage(preBuildImageName, jbsConfig.Spec.ImageRegistry.PrependTag)
-		hermeticPreBuildImageName = prependTagToImage(hermeticPreBuildImageName, jbsConfig.Spec.ImageRegistry.PrependTag)
+		preBuildImageName = prependTagToImage(preBuildImageName, imageRegistry.PrependTag)
+		hermeticPreBuildImageName = prependTagToImage(hermeticPreBuildImageName, imageRegistry.PrependTag)
 	}
 	deployArgs = append(deployArgs, registryArgs...)
 	hermeticDeployArgs = append(hermeticDeployArgs, registryArgs...)

pkg/reconciler/dependencybuild/buildrecipeyaml.go

@@ -90,6 +90,10 @@ func (r *ReconcilerJBSConfig) Reconcile(ctx context.Context, request reconcile.R
 		// The object is being deleted.
 		return reconcile.Result{}, r.handlePossibleRepositoryCleanup(ctx, &jbsConfig, log)
 	}
+	err, done := r.handleDeprecatedRegistryDefinition(ctx, &jbsConfig)
+	if done || err != nil {
+		return reconcile.Result{}, err
+	}
 
 	//TODO do we eventually want to allow more than one JBSConfig per namespace?
 	if jbsConfig.Name == v1alpha1.JBSConfigName {
@@ -127,6 +131,32 @@ func (r *ReconcilerJBSConfig) Reconcile(ctx context.Context, request reconcile.R
 	return reconcile.Result{}, nil
 }
 
+func (r *ReconcilerJBSConfig) handleDeprecatedRegistryDefinition(ctx context.Context, config *v1alpha1.JBSConfig) (error, bool) {
+	// If anything is set in the deprecated anonymous struct, copy it over to the new one.
+	// Note that e.g. config.Spec.ImageRegistry.Host is equivalent to config.Spec.Host due to the anonymous definition
+	// and is only explicit here for clarity.
+	if config.Spec.ImageRegistry.Host != "" || config.Spec.ImageRegistry.Port != "" ||
+		config.Spec.ImageRegistry.Owner != "" || config.Spec.ImageRegistry.Repository != "" || config.Spec.PrependTag != "" {
+
+		config.Spec.Registry.Host = config.Spec.ImageRegistry.Host
+		config.Spec.Registry.Port = config.Spec.ImageRegistry.Port
+		config.Spec.Registry.Owner = config.Spec.ImageRegistry.Owner
+		config.Spec.Registry.Repository = config.Spec.ImageRegistry.Repository
+		config.Spec.Registry.Insecure = config.Spec.ImageRegistry.Insecure
+		config.Spec.Registry.PrependTag = config.Spec.ImageRegistry.PrependTag
+
+		// Clear the old one
+		config.Spec.ImageRegistry.Host = ""
+		config.Spec.ImageRegistry.Port = ""
+		config.Spec.ImageRegistry.Owner = ""
+		config.Spec.ImageRegistry.Repository = ""
+		config.Spec.ImageRegistry.PrependTag = ""
+
+		return r.client.Update(ctx, config), true
+	}
+	return nil, false
+}
+
 func (r *ReconcilerJBSConfig) handlePossibleRepositoryCleanup(ctx context.Context, jbsConfig *v1alpha1.JBSConfig, log logr.Logger) error {
 	if controllerutil.ContainsFinalizer(jbsConfig, ImageRepositoryFinalizer) {
 		robotAccountName := generateRobotAccountName(jbsConfig)

pkg/reconciler/jbsconfig/jbsconfig.go

@@ -60,7 +60,7 @@ func setupSecret() *corev1.Secret {
 
 func setupJBSConfig() *v1alpha1.JBSConfig {
 	jbsConfig := v1alpha1.JBSConfig{}
-	jbsConfig.Spec.Owner = "tests"
+	jbsConfig.Spec.Registry.Owner = "tests"
 	jbsConfig.Namespace = metav1.NamespaceDefault
 	jbsConfig.Name = v1alpha1.JBSConfigName
 	return &jbsConfig
@@ -280,3 +280,18 @@ func TestImageRegistryArrayToString(t *testing.T) {
 	g.Expect(ImageRegistriesToString(logr.Discard(), registries1)).To(Equal("quay.io,,nobody,foo,false,"))
 	g.Expect(ImageRegistriesToString(logr.Discard(), registries2)).To(Equal("quay.io,,nobody,foo,false,;quay.io,784,nobody,foo,false,foo"))
 }
+
+func TestDeprecatedRegistry(t *testing.T) {
+	g := NewGomegaWithT(t)
+	ctx := context.TODO()
+	jbsConfig := setupJBSConfig()
+	jbsConfig.Spec.Owner = "tests"
+	jbsConfig.Spec.Registry.Owner = ""
+	jbsConfig.Spec.EnableRebuilds = true
+	objs := []runtimeclient.Object{jbsConfig, setupSystemConfig()}
+	_, reconciler := setupClientAndReconciler(false, objs...)
+	_, res := reconciler.handleDeprecatedRegistryDefinition(ctx, jbsConfig)
+	g.Expect(res).To(Equal(true))
+	g.Expect(jbsConfig.Spec.ImageRegistry.Owner).To(Equal(""))
+	g.Expect(jbsConfig.Spec.Registry.Owner).To(Equal("tests"))
+}