refactor (jkube-kit/config/resource) : Deprecate jkube.io annotatio…

…n prefix in favor of `jkube.eclipse.org` for JKubeAnnotations (eclipse-jkube#1273)

+ Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org`
+ Add `jkube.useOldJKubePrefix` flag to switch to `jkube.io`
  annotation prefix in case any user is interested in this.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>

CHANGELOG.md

@@ -21,6 +21,7 @@ Usage:
 ./scripts/extract-changelog-for-version.sh 1.3.37 5
 ```
 ### 1.11-SNAPSHOT
+* Fix #1273: Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org` for JKubeAnnotations
 * Fix #1439: Add hint to use jkube.domain if createExternalUrls is used without domain
 * Fix #1459: Route Generation should support `8443` as default web port
 * Fix #1546: Migrate to JUnit5 testing framework

jkube-kit/config/resource/src/main/java/org/eclipse/jkube/kit/config/resource/JKubeAnnotations.java

@@ -36,21 +36,36 @@ public enum JKubeAnnotations {
     SCM_TAG("scm-tag"),
     SCM_URL("scm-url"),
 
-    TARGET_PLATFORM("target-platform");
+    TARGET_PLATFORM("target-platform"),
+    ICON_URL("iconUrl");
+
+    private static final String JKUBE_ANNOTATION_PREFIX = "jkube.eclipse.org";
+    /**
+     * @deprecated in favor of <code>jkube.eclipse.org</code>
+     */
+    @Deprecated
+    private static final String DEPRECATED_JKUBE_ANNOTATION_PREFIX = "jkube.io";
 
     private final String annotation;
 
     JKubeAnnotations(String anno) {
-        this.annotation = "jkube.io/" + anno;
+        this.annotation = "/" + anno;
     }
 
-    public String value() {
-        return annotation;
+    public String value(boolean useDeprecatedPrefix) {
+        return getAnnotationPrefix(useDeprecatedPrefix) + annotation;
     }
 
     @Override
     public String toString() {
-        return value();
+        return value(false);
+    }
+
+    public static String getAnnotationPrefix(boolean useDeprecatedPrefix) {
+        if (useDeprecatedPrefix) {
+            return DEPRECATED_JKUBE_ANNOTATION_PREFIX;
+        }
+        return JKUBE_ANNOTATION_PREFIX;
     }
 }
 

jkube-kit/config/resource/src/main/java/org/eclipse/jkube/kit/config/resource/ResourceConfig.java

@@ -77,6 +77,7 @@ public class ResourceConfig {
   private IngressConfig ingress;
   private String routeDomain;
   private String restartPolicy;
+  private boolean useLegacyJKubePrefix;
 
   public static ResourceConfigBuilder toBuilder(ResourceConfig original) {
     return Optional.ofNullable(original).orElse(new ResourceConfig()).toBuilder();

jkube-kit/config/resource/src/test/java/org/eclipse/jkube/kit/config/resource/JKubeAnnotationsTest.java

@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) 2019 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at:
+ *
+ *     https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.jkube.kit.config.resource;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class JKubeAnnotationsTest {
+  @Test
+  void value_withUseDeprecatedPrefixFalse_shouldReturnJKubeEclipseOrgPrefix() {
+    // Given + When
+    String result = JKubeAnnotations.GIT_COMMIT.value(false);
+    // Then
+    assertThat(result).isEqualTo("jkube.eclipse.org/git-commit");
+  }
+
+  @Test
+  void value_withUseDeprecatedPrefixTrue_shouldReturnJKubeIoPrefix() {
+    // Given + When
+    String result = JKubeAnnotations.GIT_COMMIT.value(true);
+    // Then
+    assertThat(result).isEqualTo("jkube.io/git-commit");
+  }
+
+  @Test
+  void toString_whenInvoked_shouldUseJkubeEclipseOrgPrefix() {
+    // Given + When
+    String result = JKubeAnnotations.GIT_BRANCH.toString();
+    // Then
+    assertThat(result).isEqualTo("jkube.eclipse.org/git-branch");
+  }
+}

jkube-kit/enricher/api/src/main/java/org/eclipse/jkube/kit/enricher/api/BaseEnricher.java

@@ -54,6 +54,7 @@ public class BaseEnricher implements Enricher {
     public static final String JKUBE_ENFORCED_REPLICAS = "jkube.replicas";
     public static final String JKUBE_DEFAULT_IMAGE_PULL_POLICY = "IfNotPresent";
     public static final String JKUBE_ENFORCED_IMAGE_PULL_POLICY = "jkube.imagePullPolicy";
+    private static final String JKUBE_USE_OLD_PREFIX = "jkube.useLegacyJKubePrefix";
 
     private final EnricherConfig config;
     private final String name;
@@ -230,6 +231,18 @@ protected void setProcessingInstruction(String key, List<String> containerNames)
         enricherContext.setProcessingInstructions(processingInstructionsMap);
     }
 
+    protected boolean shouldUseLegacyJKubePrefix() {
+        String valueFromProperties = getValueFromConfig(JKUBE_USE_OLD_PREFIX, null);
+        if (StringUtils.isNotBlank(valueFromProperties)) {
+            return Boolean.parseBoolean(valueFromProperties);
+        }
+        ResourceConfig resourceConfig = getConfiguration().getResource();
+        if (resourceConfig != null) {
+            return resourceConfig.isUseLegacyJKubePrefix();
+        }
+        return false;
+    }
+
     /**
      * Getting a property value from configuration
      *

jkube-kit/enricher/api/src/test/java/org/eclipse/jkube/kit/enricher/api/BaseEnricherTest.java

@@ -66,4 +66,33 @@ void getImagePullPolicy_whenPullPolicySpecifiedViaProperty_shouldReturnPullPolic
     // Then
     assertThat(value).isEqualTo("Always");
   }
+
+  @Test
+  void shouldUseLegacyJKubePrefix_whenPropertyProvided_thenReturnTrue() {
+    // Given
+    when(context.getProperty("jkube.useLegacyJKubePrefix")).thenReturn("true");
+    // When
+    boolean value = baseEnricher.shouldUseLegacyJKubePrefix();
+    // Then
+    assertThat(value).isTrue();
+  }
+
+  @Test
+  void shouldUseLegacyJKubePrefix_whenResourceConfigProvided_thenReturnTrue() {
+    // Given
+    when(context.getConfiguration().getResource()).thenReturn(resourceConfig);
+    when(resourceConfig.isUseLegacyJKubePrefix()).thenReturn(true);
+    // When
+    boolean value = baseEnricher.shouldUseLegacyJKubePrefix();
+    // Then
+    assertThat(value).isTrue();
+  }
+
+  @Test
+  void shouldUseLegacyJKubePrefix_whenNothingProvided_thenReturnFalse() {
+    // Given + When
+    boolean value = baseEnricher.shouldUseLegacyJKubePrefix();
+    // Then
+    assertThat(value).isFalse();
+  }
 }

jkube-kit/enricher/generic/src/main/java/org/eclipse/jkube/enricher/generic/GitEnricher.java

@@ -55,6 +55,7 @@ public GitEnricher(JKubeEnricherContext buildContext) {
 
     private Map<String, String> getAnnotations(PlatformMode platformMode) {
         final Map<String, String> annotations = new HashMap<>();
+        boolean useDeprecatedAnnotationPrefix = shouldUseLegacyJKubePrefix();
         if (GitUtil.findGitFolder(getContext().getProjectDirectory()) != null) {
             try (Repository repository = GitUtil.getGitRepository(getContext().getProjectDirectory())) {
                 // Git annotations (if git is used as SCM)
@@ -64,7 +65,7 @@ private Map<String, String> getAnnotations(PlatformMode platformMode) {
                         log.warn("Could not detect any git remote");
                     }
 
-                    annotations.putAll(getAnnotations(platformMode, gitRemoteUrl, repository.getBranch(), GitUtil.getGitCommitId(repository)));
+                    annotations.putAll(getAnnotations(platformMode, gitRemoteUrl, repository.getBranch(), GitUtil.getGitCommitId(repository), useDeprecatedAnnotationPrefix));
                 }
                 return annotations;
             } catch (IOException | GitAPIException e) {
@@ -135,11 +136,11 @@ public void visit(JobBuilder builder) {
         });
     }
 
-    protected static Map<String, String> getAnnotations(PlatformMode platformMode, String gitRemoteUrl, String branch, String commitId) {
+    protected static Map<String, String> getAnnotations(PlatformMode platformMode, String gitRemoteUrl, String branch, String commitId, boolean useDeprecatedAnnotationPrefix) {
         Map<String, String> annotationsToBeAdded = new HashMap<>();
-        annotationsToBeAdded.putAll(addAnnotation(JKubeAnnotations.GIT_BRANCH.value(), branch));
-        annotationsToBeAdded.putAll(addAnnotation(JKubeAnnotations.GIT_COMMIT.value(), commitId));
-        annotationsToBeAdded.putAll(addAnnotation(JKubeAnnotations.GIT_URL.value(), gitRemoteUrl));
+        annotationsToBeAdded.putAll(addAnnotation(JKubeAnnotations.GIT_BRANCH.value(useDeprecatedAnnotationPrefix), branch));
+        annotationsToBeAdded.putAll(addAnnotation(JKubeAnnotations.GIT_COMMIT.value(useDeprecatedAnnotationPrefix), commitId));
+        annotationsToBeAdded.putAll(addAnnotation(JKubeAnnotations.GIT_URL.value(useDeprecatedAnnotationPrefix), gitRemoteUrl));
         if (platformMode.equals(PlatformMode.openshift)) {
             annotationsToBeAdded.putAll(addAnnotation(OpenShiftAnnotations.VCS_URI.value(), gitRemoteUrl));
             annotationsToBeAdded.putAll(addAnnotation(OpenShiftAnnotations.VCS_REF.value(), branch));

jkube-kit/enricher/generic/src/main/java/org/eclipse/jkube/enricher/generic/MavenIssueManagementEnricher.java

@@ -111,16 +111,17 @@ public void visit(JobBuilder builder) {
 
     private Map<String, String> getAnnotations() {
         Map<String, String> annotations = new HashMap<>();
-
+        boolean useDeprecatedAnnotationPrefix = shouldUseLegacyJKubePrefix();
+
         if (getContext() instanceof JKubeEnricherContext) {
             JKubeEnricherContext jkubeEnricherContext = (JKubeEnricherContext) getContext();
             JavaProject rootProject = jkubeEnricherContext.getProject();
             if (hasIssueManagement(rootProject)) {
                 String system = rootProject.getIssueManagementSystem();
                 String url = rootProject.getIssueManagementUrl();
                 if (StringUtils.isNotEmpty(system) && StringUtils.isNotEmpty(url)) {
-                    annotations.put(JKubeAnnotations.ISSUE_SYSTEM.value(), system);
-                    annotations.put(JKubeAnnotations.ISSUE_TRACKER_URL.value(), url);
+                    annotations.put(JKubeAnnotations.ISSUE_SYSTEM.value(useDeprecatedAnnotationPrefix), system);
+                    annotations.put(JKubeAnnotations.ISSUE_TRACKER_URL.value(useDeprecatedAnnotationPrefix), url);
                 }
             }
         }

jkube-kit/enricher/generic/src/main/java/org/eclipse/jkube/enricher/generic/MavenScmEnricher.java

@@ -54,6 +54,7 @@ public MavenScmEnricher(JKubeEnricherContext buildContext) {
 
     private Map<String, String> getAnnotations() {
         Map<String, String> annotations = new HashMap<>();
+        boolean useDeprecatedAnnotationPrefix = shouldUseLegacyJKubePrefix();
 
         if (getContext() instanceof JKubeEnricherContext) {
             JKubeEnricherContext jkubeEnricherContext = (JKubeEnricherContext) getContext();
@@ -63,10 +64,10 @@ private Map<String, String> getAnnotations() {
                 String tag = rootProject.getScmTag();
 
                 if (StringUtils.isNotEmpty(tag)) {
-                    annotations.put(JKubeAnnotations.SCM_TAG.value(), tag);
+                    annotations.put(JKubeAnnotations.SCM_TAG.value(useDeprecatedAnnotationPrefix), tag);
                 }
                 if (StringUtils.isNotEmpty(url)) {
-                    annotations.put(JKubeAnnotations.SCM_URL.value(), url);
+                    annotations.put(JKubeAnnotations.SCM_URL.value(useDeprecatedAnnotationPrefix), url);
                 }
             }
         }

jkube-kit/enricher/generic/src/main/java/org/eclipse/jkube/enricher/generic/openshift/AutoTLSEnricher.java

@@ -26,6 +26,7 @@
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import org.eclipse.jkube.kit.common.Configs;
+import org.eclipse.jkube.kit.config.resource.JKubeAnnotations;
 import org.eclipse.jkube.kit.config.resource.PlatformMode;
 import org.eclipse.jkube.kit.enricher.api.BaseEnricher;
 import org.eclipse.jkube.kit.enricher.api.JKubeEnricherContext;
@@ -54,9 +55,9 @@ public class AutoTLSEnricher extends BaseEnricher {
     private enum Config implements Configs.Config {
 
         TLS_SECRET_NAME("tlsSecretName", null),
-        TLS_SECRET_VOLUME_MOUNT_POINT("tlsSecretVolumeMountPoint", "/var/run/secrets/jkube.io/tls-pem"),
+        TLS_SECRET_VOLUME_MOUNT_POINT("tlsSecretVolumeMountPoint", "/var/run/secrets/%s/tls-pem"),
         TLS_SECRET_VOLUME_NAME("tlsSecretVolumeName", "tls-pem"),
-        JKS_VOLUME_MOUNT_POINT("jksVolumeMountPoint", "/var/run/secrets/jkube.io/tls-jks"),
+        JKS_VOLUME_MOUNT_POINT("jksVolumeMountPoint", "/var/run/secrets/%s/tls-jks"),
         JKS_VOLUME_NAME("jksVolumeName", "tls-jks"),
         PEM_TO_JKS_INIT_CONTAINER_IMAGE("pemToJKSInitContainerImage", "jimmidyson/pemtokeystore:v0.1.0"),
         PEM_TO_JKS_INIT_CONTAINER_NAME("pemToJKSInitContainerName", "tls-jks-converter"),
@@ -156,15 +157,17 @@ private boolean isVolumeAlreadyExists(List<Volume> volumes, String volumeName) {
             public void visit(ContainerBuilder builder) {
                 String tlsSecretVolumeName = getConfig(Config.TLS_SECRET_VOLUME_NAME);
                 if (!isVolumeMountAlreadyExists(builder.buildVolumeMounts(), tlsSecretVolumeName)) {
+                    String mountPath = resolveMountPointLocation(getConfig(Config.TLS_SECRET_VOLUME_MOUNT_POINT));
                     builder.addNewVolumeMount().withName(tlsSecretVolumeName)
-                            .withMountPath(getConfig(Config.TLS_SECRET_VOLUME_MOUNT_POINT)).withReadOnly(true)
+                            .withMountPath(mountPath).withReadOnly(true)
                             .endVolumeMount();
                 }
 
                 String jksVolumeName = getConfig(Config.JKS_VOLUME_NAME);
                 if (!isVolumeMountAlreadyExists(builder.buildVolumeMounts(), jksVolumeName)) {
+                    String mountPath = resolveMountPointLocation(getConfig(Config.JKS_VOLUME_MOUNT_POINT));
                     builder.addNewVolumeMount().withName(jksVolumeName)
-                            .withMountPath(getConfig(Config.JKS_VOLUME_MOUNT_POINT)).withReadOnly(true).endVolumeMount();
+                            .withMountPath(mountPath).withReadOnly(true).endVolumeMount();
                 }
             }
 
@@ -176,6 +179,10 @@ private boolean isVolumeMountAlreadyExists(List<VolumeMount> volumes, String vol
                 }
                 return false;
             }
+
+            private String resolveMountPointLocation(String configValue) {
+                return String.format(configValue, JKubeAnnotations.getAnnotationPrefix(shouldUseLegacyJKubePrefix()));
+            }
         });
 
         builder.accept(new TypedVisitor<ServiceBuilder>() {

jkube-kit/enricher/generic/src/test/java/org/eclipse/jkube/enricher/generic/GitEnricherTest.java

@@ -34,7 +34,7 @@ void getAnnotations_addedInKubernetesPlatformMode() {
         Map<String, String> annotations;
 
         // When
-        annotations = GitEnricher.getAnnotations(PlatformMode.kubernetes, GIT_REMOTE_URL, GIT_BRANCH, GIT_COMMIT_ID);
+        annotations = GitEnricher.getAnnotations(PlatformMode.kubernetes, GIT_REMOTE_URL, GIT_BRANCH, GIT_COMMIT_ID, true);
 
         // Then
         assertJkubeAnnotations(annotations);
@@ -46,7 +46,7 @@ void getAnnotations_addedInOpenShiftPlatformMode() {
         Map<String, String> annotations;
 
         // When
-        annotations = GitEnricher.getAnnotations(PlatformMode.openshift, GIT_REMOTE_URL, GIT_BRANCH, GIT_COMMIT_ID);
+        annotations = GitEnricher.getAnnotations(PlatformMode.openshift, GIT_REMOTE_URL, GIT_BRANCH, GIT_COMMIT_ID, true);
 
         // Then
         assertJkubeAnnotations(annotations);
@@ -60,7 +60,7 @@ void getAnnotations_addedWithAllNullValues() {
         Map<String, String> annotations;
 
         // When
-        annotations = GitEnricher.getAnnotations(PlatformMode.kubernetes, null, null, null);
+        annotations = GitEnricher.getAnnotations(PlatformMode.kubernetes, null, null, null, true);
 
         // Then
         assertThat(annotations).isEmpty();
@@ -72,15 +72,15 @@ void getAnnotations_addedWithNullCommitValues() {
         Map<String, String> annotations;
 
         // When
-        annotations = GitEnricher.getAnnotations(PlatformMode.kubernetes, GIT_REMOTE_URL, GIT_BRANCH, null);
+        annotations = GitEnricher.getAnnotations(PlatformMode.kubernetes, GIT_REMOTE_URL, GIT_BRANCH, null, true);
 
         // Then
         assertJkubeAnnotationsRemoteUrlAndBranch(annotations);
     }
 
     private void assertJkubeAnnotations(Map<String, String> annotations) {
         assertJkubeAnnotationsRemoteUrlAndBranch(annotations);
-        assertThat(annotations).containsEntry(JKubeAnnotations.GIT_COMMIT.value(),GIT_COMMIT_ID);
+        assertThat(annotations).containsEntry(JKubeAnnotations.GIT_COMMIT.value(true), GIT_COMMIT_ID);
     }
 
     private void assertJkubeAnnotationsRemoteUrlAndBranch(Map<String, String> annotations) {

jkube-kit/enricher/generic/src/test/java/org/eclipse/jkube/enricher/generic/MavenIssueManagementEnricherTest.java

@@ -61,8 +61,8 @@ void mavenIssueManagementAll() {
         Map<String, String> scmAnnotations = builder.buildFirstItem().getMetadata().getAnnotations();
         assertThat(scmAnnotations).isNotNull()
             .hasSize(2)
-            .containsEntry(JKubeAnnotations.ISSUE_SYSTEM.value(), "GitHub")
-            .containsEntry(JKubeAnnotations.ISSUE_TRACKER_URL.value(), "https://github.com/reactiverse/vertx-maven-plugin/issues/");
+            .containsEntry(JKubeAnnotations.ISSUE_SYSTEM.value(false), "GitHub")
+            .containsEntry(JKubeAnnotations.ISSUE_TRACKER_URL.value(false), "https://github.com/reactiverse/vertx-maven-plugin/issues/");
     }
 
     @DisplayName("maven issue management")

jkube-kit/enricher/generic/src/test/java/org/eclipse/jkube/enricher/generic/MavenScmEnricherTest.java

@@ -57,8 +57,8 @@ void mavenScmAll() {
         assertThat(scmAnnotations)
           .isNotNull()
           .hasSize(2)
-          .containsEntry("jkube.io/scm-tag", "HEAD")
-          .containsEntry("jkube.io/scm-url", "git://github.com/jkubeio/kubernetes-maven-plugin.git");
+          .containsEntry("jkube.eclipse.org/scm-tag", "HEAD")
+          .containsEntry("jkube.eclipse.org/scm-url", "git://github.com/jkubeio/kubernetes-maven-plugin.git");
 
     }
 
@@ -78,8 +78,8 @@ void mavenScmOnlyDevConnection() {
         Map<String, String> scmAnnotations = builder.buildFirstItem().getMetadata().getAnnotations();
         assertThat(scmAnnotations).isNotNull()
           .hasSize(1)
-          .containsEntry("jkube.io/scm-url", "git://github.com/jkubeio/kubernetes-maven-plugin.git")
-          .doesNotContainKey("jkube.io/scm-tag");
+          .containsEntry("jkube.eclipse.org/scm-url", "git://github.com/jkubeio/kubernetes-maven-plugin.git")
+          .doesNotContainKey("jkube.eclipse.org/scm-tag");
     }
 
     @Test
@@ -99,8 +99,8 @@ void mavenScmOnlyUrl() {
       Map<String, String> scmAnnotations = builder.buildFirstItem().getMetadata().getAnnotations();
       assertThat(scmAnnotations).isNotNull()
           .hasSize(1)
-          .containsEntry("jkube.io/scm-url", "scm:git:git://github.com/jkubeio/kubernetes-maven-plugin.git")
-          .doesNotContainKey("jkube.io/scm-tag");
+          .containsEntry("jkube.eclipse.org/scm-url", "scm:git:git://github.com/jkubeio/kubernetes-maven-plugin.git")
+          .doesNotContainKey("jkube.eclipse.org/scm-tag");
     }
 
     @Test