Add labels to maven config (#867)

GoogleContainerTools · Aug 22, 2018 · f61cf97 · f61cf97
1 parent 57d18e6
commit f61cf97
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 11 deletions.
diff --git a/jib-maven-plugin/CHANGELOG.md b/jib-maven-plugin/CHANGELOG.md
@@ -5,6 +5,8 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+- `<container><labels>` configuration parameter for configuring labels ([#751](https://github.com/GoogleContainerTools/jib/issues/751))
+
 ### Changed
 
 ### Fixed

diff --git a/jib-maven-plugin/src/main/java/com/google/cloud/tools/jib/maven/JibPluginConfiguration.java b/jib-maven-plugin/src/main/java/com/google/cloud/tools/jib/maven/JibPluginConfiguration.java
@@ -129,6 +129,8 @@ public static class ContainerParameters {
     private String format = "Docker";
 
     @Parameter private List<String> ports = Collections.emptyList();
+
+    @Parameter private Map<String, String> labels = Collections.emptyMap();
   }
 
   @Nullable
@@ -273,6 +275,10 @@ List<String> getExposedPorts() {
     return container.ports;
   }
 
+  Map<String, String> getLabels() {
+    return container.labels;
+  }
+
   String getFormat() {
     return Preconditions.checkNotNull(container.format);
   }
@@ -319,11 +325,6 @@ void setProject(MavenProject project) {
     this.project = project;
   }
 
-  @VisibleForTesting
-  void setTargetImage(@Nullable String targetImage) {
-    this.to.image = targetImage;
-  }
-
   @VisibleForTesting
   void setExtraDirectory(String extraDirectory) {
     this.extraDirectory = extraDirectory;

diff --git a/...n-plugin/src/main/java/com/google/cloud/tools/jib/maven/PluginConfigurationProcessor.java b/...n-plugin/src/main/java/com/google/cloud/tools/jib/maven/PluginConfigurationProcessor.java
@@ -110,7 +110,8 @@ static PluginConfigurationProcessor processCommonConfiguration(
                     jibPluginConfiguration.getJvmFlags(), mainClass))
             .setProgramArguments(jibPluginConfiguration.getArgs())
             .setEnvironment(jibPluginConfiguration.getEnvironment())
-            .setExposedPorts(ExposedPortsParser.parse(jibPluginConfiguration.getExposedPorts()));
+            .setExposedPorts(ExposedPortsParser.parse(jibPluginConfiguration.getExposedPorts()))
+            .setLabels(jibPluginConfiguration.getLabels());
     if (jibPluginConfiguration.getUseCurrentTimestamp()) {
       logger.warn(
           "Setting image creation time to current time; your image may not be reproducible.");

diff --git a/...plugin/src/test/java/com/google/cloud/tools/jib/maven/BuildDockerMojoIntegrationTest.java b/...plugin/src/test/java/com/google/cloud/tools/jib/maven/BuildDockerMojoIntegrationTest.java
@@ -56,15 +56,23 @@ private static String buildToDockerDaemonAndRun(Path projectRoot, String imageRe
     verifier.executeGoal("jib:" + BuildDockerMojo.GOAL_NAME);
     verifier.verifyErrorFreeLog();
 
+    String dockerInspect = new Command("docker", "inspect", imageReference).run();
     Assert.assertThat(
-        new Command("docker", "inspect", imageReference).run(),
+        dockerInspect,
         CoreMatchers.containsString(
             "            \"ExposedPorts\": {\n"
                 + "                \"1000/tcp\": {},\n"
                 + "                \"2000/udp\": {},\n"
                 + "                \"2001/udp\": {},\n"
                 + "                \"2002/udp\": {},\n"
                 + "                \"2003/udp\": {}"));
+    Assert.assertThat(
+        dockerInspect,
+        CoreMatchers.containsString(
+            "            \"Labels\": {\n"
+                + "                \"key1\": \"value1\",\n"
+                + "                \"key2\": \"value2\"\n"
+                + "            }"));
     return new Command("docker", "run", imageReference).run();
   }
 

diff --git a/...-plugin/src/test/java/com/google/cloud/tools/jib/maven/BuildImageMojoIntegrationTest.java b/...-plugin/src/test/java/com/google/cloud/tools/jib/maven/BuildImageMojoIntegrationTest.java
@@ -96,7 +96,7 @@ private static String buildAndRun(Path projectRoot, String imageReference, boole
     verifier.verifyErrorFreeLog();
 
     new Command("docker", "pull", imageReference).run();
-    assertHasExposedPorts(imageReference);
+    assertDockerInspectParameters(imageReference);
     return new Command("docker", "run", imageReference).run();
   }
 
@@ -117,25 +117,33 @@ private static String buildAndRunComplex(
 
     // Verify output
     targetRegistry.pull(imageReference);
-    assertHasExposedPorts(imageReference);
+    assertDockerInspectParameters(imageReference);
     Instant buildTime =
         Instant.parse(
             new Command("docker", "inspect", "-f", "{{.Created}}", imageReference).run().trim());
     Assert.assertTrue(buildTime.isAfter(before) || buildTime.equals(before));
     return new Command("docker", "run", imageReference).run();
   }
 
-  private static void assertHasExposedPorts(String imageReference)
+  private static void assertDockerInspectParameters(String imageReference)
       throws IOException, InterruptedException {
+    String dockerInspect = new Command("docker", "inspect", imageReference).run();
     Assert.assertThat(
-        new Command("docker", "inspect", imageReference).run(),
+        dockerInspect,
         CoreMatchers.containsString(
             "            \"ExposedPorts\": {\n"
                 + "                \"1000/tcp\": {},\n"
                 + "                \"2000/udp\": {},\n"
                 + "                \"2001/udp\": {},\n"
                 + "                \"2002/udp\": {},\n"
                 + "                \"2003/udp\": {}"));
+    Assert.assertThat(
+        dockerInspect,
+        CoreMatchers.containsString(
+            "            \"Labels\": {\n"
+                + "                \"key1\": \"value1\",\n"
+                + "                \"key2\": \"value2\"\n"
+                + "            }"));
   }
 
   private static float getBuildTimeFromVerifierLog(Verifier verifier) throws IOException {

diff --git a/jib-maven-plugin/src/test/resources/projects/default-target/pom.xml b/jib-maven-plugin/src/test/resources/projects/default-target/pom.xml
@@ -44,6 +44,10 @@
               <port>1000/tcp</port>
               <port>2000-2003/udp</port>
             </ports>
+            <labels>
+              <key1>value1</key1>
+              <key2>value2</key2>
+            </labels>
           </container>
           <!-- Does not have tests use user-level cache for base image layers. -->
           <useOnlyProjectCache>true</useOnlyProjectCache>

diff --git a/jib-maven-plugin/src/test/resources/projects/empty/pom.xml b/jib-maven-plugin/src/test/resources/projects/empty/pom.xml
@@ -36,6 +36,10 @@
               <port>1000/tcp</port>
               <port>2000-2003/udp</port>
             </ports>
+            <labels>
+              <key1>value1</key1>
+              <key2>value2</key2>
+            </labels>
           </container>
           <!-- Does not have tests use user-level cache for base image layers. -->
           <useOnlyProjectCache>true</useOnlyProjectCache>

diff --git a/jib-maven-plugin/src/test/resources/projects/simple/pom-complex.xml b/jib-maven-plugin/src/test/resources/projects/simple/pom-complex.xml
@@ -66,6 +66,10 @@
               <port>1000/tcp</port>
               <port>2000-2003/udp</port>
             </ports>
+            <labels>
+              <key1>value1</key1>
+              <key2>value2</key2>
+            </labels>
             <format>Docker</format>
           </container>
           <allowInsecureRegistries>true</allowInsecureRegistries>

diff --git a/jib-maven-plugin/src/test/resources/projects/simple/pom.xml b/jib-maven-plugin/src/test/resources/projects/simple/pom.xml
@@ -48,6 +48,10 @@
               <port>1000/tcp</port>
               <port>2000-2003/udp</port>
             </ports>
+            <labels>
+              <key1>value1</key1>
+              <key2>value2</key2>
+            </labels>
           </container>
           <!-- Does not have tests use user-level cache for base image layers. -->
           <useOnlyProjectCache>true</useOnlyProjectCache>