feat (jkube-kit/generator) : Add configuration option in BaseGenerato…

…r to add tags (eclipse-jkube#1188)

Right now there isn't a way to add tags to BuildConfiguration while
using zero config mode in generators. Adding a configuration field in
BaseGenerator which would expect comma separated tags which can be
picked up by Generator while building opinionated Image configuration

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.8.0-SNAPSHOT
+* Fix #1188: Add support for specifying multiple tags in Zero configuration mode
 * Fix #1194: jkube controller name configuration ignored when using resource fragments
 * Fix #1201: ThorntailV2Generator works with Gradle Plugins
 * Fix #1208: Allow env variables to be passed to a webapp generator s2i builder

jkube-kit/doc/src/main/asciidoc/inc/generator/_options_common.adoc

@@ -45,6 +45,10 @@ or already added by a generator which has been run previously.
 | *registry*
 | A optional Docker registry used when doing Docker builds. It has no effect for OpenShift S2I builds.
 | `jkube.generator.registry`
+
+| *tags*
+| A comma separated list of additional tags you want to tag your image with
+| `jkube.generator.tags`
 |===
 
 When used as properties they can be directly referenced with the property names above.

jkube-kit/generator/api/src/main/java/org/eclipse/jkube/generator/api/support/BaseGenerator.java

@@ -15,10 +15,12 @@
 
 import java.io.IOException;
 import java.time.LocalDateTime;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 import org.eclipse.jkube.generator.api.FromSelector;
 import org.eclipse.jkube.generator.api.Generator;
@@ -74,7 +76,10 @@ enum Config implements Configs.Config {
         FROM_MODE("fromMode", null),
 
         // Optional registry
-        REGISTRY("registry", null);
+        REGISTRY("registry", null),
+
+        // Tags
+        TAGS("tags", null);
 
         @Getter
         protected String key;
@@ -227,6 +232,16 @@ protected void addLatestTagIfSnapshot(BuildConfiguration.BuildConfigurationBuild
         }
     }
 
+    protected void addTagsFromConfig(BuildConfiguration.BuildConfigurationBuilder buildConfigurationBuilder) {
+        String commaSeparatedTags = getConfig(Config.TAGS);
+        if (StringUtils.isNotBlank(commaSeparatedTags)) {
+            List<String> tags = Arrays.stream(commaSeparatedTags.split(","))
+                .map(String::trim)
+                .collect(Collectors.toList());
+            buildConfigurationBuilder.tags(tags);
+        }
+    }
+
     private boolean containsBuildConfiguration(List<ImageConfiguration> configs) {
         for (ImageConfiguration imageConfig : configs) {
             if (imageConfig.getBuildConfiguration() != null) {

jkube-kit/generator/api/src/test/java/org/eclipse/jkube/generator/api/support/BaseGeneratorTest.java

@@ -36,8 +36,8 @@
 import org.junit.Test;
 import org.junit.rules.TemporaryFolder;
 
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.Assertions.entry;
+import static org.assertj.core.api.AssertionsForClassTypes.entry;
+import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNull;
@@ -353,6 +353,22 @@ public void addLatestTagIfSnapshot() {
     assertTrue(tags.get(0).endsWith("latest"));
   }
 
+  @Test
+  public void addTagsFromConfig() {
+    new Expectations() {{
+        ctx.getProject();
+        result = project;
+    }};
+    BuildConfiguration.BuildConfigurationBuilder builder = BuildConfiguration.builder();
+    properties.put("jkube.generator.test-generator.tags", " tag-1, tag-2 , other-tag");
+    BaseGenerator generator = createGenerator(null);
+    generator.addTagsFromConfig(builder);
+    BuildConfiguration config = builder.build();
+    assertThat(config.getTags())
+        .hasSize(3)
+        .containsExactlyInAnyOrder("tag-1", "tag-2", "other-tag");
+  }
+
   public void inKubernetes() {
     // @formatter:off
     new Expectations() {{

jkube-kit/generator/java-exec/src/main/java/org/eclipse/jkube/generator/javaexec/JavaExecGenerator.java

@@ -154,6 +154,7 @@ protected BuildConfiguration.BuildConfigurationBuilder initImageBuildConfigurati
       addPrometheusPort(buildBuilder);
 
       addLatestTagIfSnapshot(buildBuilder);
+      addTagsFromConfig(buildBuilder);
       buildBuilder.workdir(getBuildWorkdir());
       buildBuilder.entryPoint(getBuildEntryPoint());
       return buildBuilder;

jkube-kit/generator/karaf/src/main/java/org/eclipse/jkube/generator/karaf/KarafGenerator.java

@@ -76,6 +76,7 @@ public List<ImageConfiguration> customize(List<ImageConfiguration> configs, bool
       buildBuilder.assembly(createDefaultAssembly());
     }
     addLatestTagIfSnapshot(buildBuilder);
+    addTagsFromConfig(buildBuilder);
     imageBuilder
         .name(getImageName())
         .alias(getAlias())

jkube-kit/generator/webapp/src/main/java/org/eclipse/jkube/generator/webapp/WebAppGenerator.java

@@ -128,6 +128,7 @@ public List<ImageConfiguration> customize(List<ImageConfiguration> configs, bool
       buildBuilder.assembly(createAssembly(handler));
     }
     addLatestTagIfSnapshot(buildBuilder);
+    addTagsFromConfig(buildBuilder);
     imageBuilder
         .name(getImageName())
         .alias(getAlias())