Enable Labels in Container Config

jib-core/src/integration-test/java/com/google/cloud/tools/jib/builder/BuildStepsIntegrationTest.java

@@ -31,6 +31,7 @@
 import com.google.cloud.tools.jib.image.InvalidImageReferenceException;
 import com.google.cloud.tools.jib.registry.LocalRegistry;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
 import com.google.common.io.Resources;
 import java.io.IOException;
 import java.net.URISyntaxException;
@@ -147,15 +148,23 @@ public void testSteps_forBuildToDockerDaemon()
             new Caches.Initializer(cacheDirectory, false, cacheDirectory, false))
         .run();
 
+    String dockerContainerConfig = new Command("docker", "inspect", "testdocker").run();
     Assert.assertThat(
-        new Command("docker", "inspect", "testdocker").run(),
+        dockerContainerConfig,
         CoreMatchers.containsString(
             "            \"ExposedPorts\": {\n"
                 + "                \"1000/tcp\": {},\n"
                 + "                \"2000/tcp\": {},\n"
                 + "                \"2001/tcp\": {},\n"
                 + "                \"2002/tcp\": {},\n"
                 + "                \"3000/udp\": {}"));
+    Assert.assertThat(
+        dockerContainerConfig,
+        CoreMatchers.containsString(
+            "            \"Labels\": {\n"
+                + "                \"key1\": \"value1\",\n"
+                + "                \"key2\": \"value2\"\n"
+                + "            }"));
     Assert.assertEquals(
         "Hello, world. An argument.\n", new Command("docker", "run", "testdocker").run());
   }
@@ -199,6 +208,7 @@ private BuildConfiguration getBuildConfiguration(
             .setProgramArguments(Collections.singletonList("An argument."))
             .setExposedPorts(
                 ExposedPortsParser.parse(Arrays.asList("1000", "2000-2002/tcp", "3000/udp")))
+            .setLabels(ImmutableMap.of("key1", "value1", "key2", "value2"))
             .build();
     return BuildConfiguration.builder(logger)
         .setBaseImageConfiguration(baseImageConfiguration)

jib-core/src/main/java/com/google/cloud/tools/jib/builder/steps/BuildImageStep.java

@@ -114,6 +114,7 @@ private Image<CachedLayer> afterCachedLayersSteps()
         imageBuilder.setEntrypoint(containerConfiguration.getEntrypoint());
         imageBuilder.setJavaArguments(containerConfiguration.getProgramArguments());
         imageBuilder.setExposedPorts(containerConfiguration.getExposedPorts());
+        imageBuilder.setLabels(containerConfiguration.getLabels());
       }
 
       // Gets the container configuration content descriptor.

jib-core/src/main/java/com/google/cloud/tools/jib/configuration/ContainerConfiguration.java

@@ -37,6 +37,7 @@ public static class Builder {
     @Nullable private ImmutableList<String> programArguments;
     @Nullable private ImmutableMap<String, String> environmentMap;
     @Nullable private ImmutableList<Port> exposedPorts;
+    @Nullable private ImmutableMap<String, String> labels;
 
     /**
      * Sets the image creation time.
@@ -98,6 +99,23 @@ public Builder setExposedPorts(@Nullable List<Port> exposedPorts) {
       return this;
     }
 
+    /**
+     * Sets the container's labels.
+     *
+     * @param labels the map of labels
+     * @return this
+     */
+    public Builder setLabels(@Nullable Map<String, String> labels) {
+      if (labels == null) {
+        this.labels = null;
+      } else {
+        Preconditions.checkArgument(!Iterables.any(labels.keySet(), Objects::isNull));
+        Preconditions.checkArgument(!Iterables.any(labels.values(), Objects::isNull));
+        this.labels = ImmutableMap.copyOf(labels);
+      }
+      return this;
+    }
+
     /**
      * Sets the container entrypoint.
      *
@@ -121,7 +139,7 @@ public Builder setEntrypoint(@Nullable List<String> entrypoint) {
      */
     public ContainerConfiguration build() {
       return new ContainerConfiguration(
-          creationTime, entrypoint, programArguments, environmentMap, exposedPorts);
+          creationTime, entrypoint, programArguments, environmentMap, exposedPorts, labels);
     }
 
     private Builder() {}
@@ -141,18 +159,21 @@ public static Builder builder() {
   @Nullable private final ImmutableList<String> programArguments;
   @Nullable private final ImmutableMap<String, String> environmentMap;
   @Nullable private final ImmutableList<Port> exposedPorts;
+  @Nullable private final ImmutableMap<String, String> labels;
 
   private ContainerConfiguration(
       Instant creationTime,
       @Nullable ImmutableList<String> entrypoint,
       @Nullable ImmutableList<String> programArguments,
       @Nullable ImmutableMap<String, String> environmentMap,
-      @Nullable ImmutableList<Port> exposedPorts) {
+      @Nullable ImmutableList<Port> exposedPorts,
+      @Nullable ImmutableMap<String, String> labels) {
     this.creationTime = creationTime;
     this.entrypoint = entrypoint;
     this.programArguments = programArguments;
     this.environmentMap = environmentMap;
     this.exposedPorts = exposedPorts;
+    this.labels = labels;
   }
 
   public Instant getCreationTime() {
@@ -178,4 +199,9 @@ public ImmutableMap<String, String> getEnvironmentMap() {
   public ImmutableList<Port> getExposedPorts() {
     return exposedPorts;
   }
+
+  @Nullable
+  public ImmutableMap<String, String> getLabels() {
+    return labels;
+  }
 }

jib-core/src/main/java/com/google/cloud/tools/jib/image/Image.java

@@ -37,6 +37,7 @@ public static class Builder<T extends Layer> {
     @Nullable private ImmutableList<String> entrypoint;
     @Nullable private ImmutableList<String> javaArguments;
     @Nullable private ImmutableList<Port> exposedPorts;
+    @Nullable private ImmutableMap<String, String> labels;
 
     /**
      * Sets the image creation time.
@@ -110,15 +111,26 @@ public Builder<T> setJavaArguments(@Nullable List<String> javaArguments) {
      * @param exposedPorts the list of exposed ports to add
      * @return this
      */
-    public Builder<T> setExposedPorts(@Nullable ImmutableList<Port> exposedPorts) {
+    public Builder<T> setExposedPorts(@Nullable List<Port> exposedPorts) {
       if (exposedPorts == null) {
         this.exposedPorts = null;
       } else {
-        this.exposedPorts = exposedPorts;
+        this.exposedPorts = ImmutableList.copyOf(exposedPorts);
       }
       return this;
     }
 
+    /**
+     * Sets the items in the "Labels" field in the container configuration.
+     *
+     * @param labels that map of labels to add
+     * @return this
+     */
+    public Builder<T> setLabels(@Nullable Map<String, String> labels) {
+      this.labels = (labels == null) ? null : ImmutableMap.copyOf(labels);
+      return this;
+    }
+
     /**
      * Adds a layer to the image.
      *
@@ -138,7 +150,8 @@ public Image<T> build() {
           environmentBuilder.build(),
           entrypoint,
           javaArguments,
-          exposedPorts);
+          exposedPorts,
+          labels);
     }
   }
 
@@ -164,19 +177,24 @@ public static <T extends Layer> Builder<T> builder() {
   /** Ports that the container listens on. */
   @Nullable private final ImmutableList<Port> exposedPorts;
 
+  /** Labels on the container configuration */
+  @Nullable private final ImmutableMap<String, String> labels;
+
   private Image(
       @Nullable Instant created,
       ImageLayers<T> layers,
       @Nullable ImmutableMap<String, String> environment,
       @Nullable ImmutableList<String> entrypoint,
       @Nullable ImmutableList<String> javaArguments,
-      @Nullable ImmutableList<Port> exposedPorts) {
+      @Nullable ImmutableList<Port> exposedPorts,
+      @Nullable ImmutableMap<String, String> labels) {
     this.created = created;
     this.layers = layers;
     this.environment = environment;
     this.entrypoint = entrypoint;
     this.javaArguments = javaArguments;
     this.exposedPorts = exposedPorts;
+    this.labels = labels;
   }
 
   @Nullable
@@ -204,6 +222,11 @@ public ImmutableList<Port> getExposedPorts() {
     return exposedPorts;
   }
 
+  @Nullable
+  public ImmutableMap<String, String> getLabels() {
+    return labels;
+  }
+
   public ImmutableList<T> getLayers() {
     return layers.getLayers();
   }

jib-core/src/main/java/com/google/cloud/tools/jib/image/json/ContainerConfigurationTemplate.java

@@ -40,6 +40,7 @@
  *     "Entrypoint": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"],
  *     "Cmd": ["arg1", "arg2"]
  *     "ExposedPorts": { "6000/tcp":{}, "8000/tcp":{}, "9000/tcp":{} }
+ *     "Labels": { "com.example.label": "value" }
  *   },
  *   "rootfs": {
  *     "diff_ids": [
@@ -87,6 +88,9 @@ private static class ConfigurationObjectTemplate implements JsonTemplate {
 
     /** Network ports the container exposes. */
     @Nullable private Map<String, Map<?, ?>> ExposedPorts;
+
+    /** Labels. */
+    @Nullable private Map<String, String> Labels;
   }
 
   /**
@@ -125,6 +129,10 @@ public void setContainerExposedPorts(@Nullable Map<String, Map<?, ?>> exposedPor
     config.ExposedPorts = exposedPorts;
   }
 
+  public void setContainerLabels(@Nullable Map<String, String> labels) {
+    config.Labels = labels;
+  }
+
   public void addLayerDiffId(DescriptorDigest diffId) {
     rootfs.diff_ids.add(diffId);
   }
@@ -158,6 +166,11 @@ List<String> getContainerCmd() {
     return config.ExposedPorts;
   }
 
+  @Nullable
+  Map<String, String> getContainerLabels() {
+    return config.Labels;
+  }
+
   @VisibleForTesting
   DescriptorDigest getLayerDiffId(int index) {
     return rootfs.diff_ids.get(index);

jib-core/src/main/java/com/google/cloud/tools/jib/image/json/ImageToJsonTranslator.java

@@ -130,6 +130,9 @@ public Blob getContainerConfigurationBlob() {
     // Sets the exposed ports.
     template.setContainerExposedPorts(portListToMap(image.getExposedPorts()));
 
+    // Sets the labels.
+    template.setContainerLabels(image.getLabels());
+
     // Serializes into JSON.
     return JsonTemplateMapper.toBlob(template);
   }

jib-core/src/test/java/com/google/cloud/tools/jib/configuration/BuildConfigurationTest.java

@@ -60,6 +60,7 @@ public void testBuilder() {
     Map<String, String> expectedEnvironment = ImmutableMap.of("key", "value");
     ImmutableList<Port> expectedExposedPorts =
         ImmutableList.of(new Port(1000, Protocol.TCP), new Port(2000, Protocol.TCP));
+    Map<String, String> expectedLabels = ImmutableMap.of("key1", "value1", "key2", "value2");
     Class<? extends BuildableManifestTemplate> expectedTargetFormat = OCIManifestTemplate.class;
     CacheConfiguration expectedApplicationLayersCacheConfiguration =
         CacheConfiguration.forPath(Paths.get("application/layers"));
@@ -90,6 +91,7 @@ public void testBuilder() {
             .setProgramArguments(expectedJavaArguments)
             .setEnvironment(expectedEnvironment)
             .setExposedPorts(expectedExposedPorts)
+            .setLabels(expectedLabels)
             .build();
     BuildConfiguration.Builder buildConfigurationBuilder =
         BuildConfiguration.builder(Mockito.mock(JibLogger.class))
@@ -134,6 +136,7 @@ public void testBuilder() {
         expectedEnvironment, buildConfiguration.getContainerConfiguration().getEnvironmentMap());
     Assert.assertEquals(
         expectedExposedPorts, buildConfiguration.getContainerConfiguration().getExposedPorts());
+    Assert.assertEquals(expectedLabels, buildConfiguration.getContainerConfiguration().getLabels());
     Assert.assertEquals(expectedTargetFormat, buildConfiguration.getTargetFormat());
     Assert.assertEquals(
         expectedApplicationLayersCacheConfiguration,
@@ -250,6 +253,16 @@ public void testBuilder_nullValues() {
       Assert.assertNull(ex.getMessage());
     }
 
+    // Labels element should not be null.
+    Map<String, String> badLabels = new HashMap<>();
+    badLabels.put("label-key", null);
+    try {
+      ContainerConfiguration.builder().setLabels(badLabels);
+      Assert.fail("The IllegalArgumentException should be thrown.");
+    } catch (IllegalArgumentException ex) {
+      Assert.assertNull(ex.getMessage());
+    }
+
     // Environment keys element should not be null.
     Map<String, String> nullKeyMap = new HashMap<>();
     nullKeyMap.put(null, "value");

jib-core/src/test/java/com/google/cloud/tools/jib/image/json/ContainerConfigurationTemplateTest.java

@@ -57,6 +57,7 @@ public void testToJson() throws IOException, URISyntaxException, DigestException
             ImmutableMap.of(),
             "3000/udp",
             ImmutableMap.of()));
+    containerConfigJson.setContainerLabels(ImmutableMap.of("key1", "value1", "key2", "value2"));
 
     containerConfigJson.addLayerDiffId(
         DescriptorDigest.fromDigest(
@@ -85,6 +86,9 @@ public void testFromJson() throws IOException, URISyntaxException, DigestExcepti
         Arrays.asList("some", "entrypoint", "command"),
         containerConfigJson.getContainerEntrypoint());
     Assert.assertEquals(Arrays.asList("arg1", "arg2"), containerConfigJson.getContainerCmd());
+    Assert.assertEquals(
+        ImmutableMap.of("key1", "value1", "key2", "value2"),
+        containerConfigJson.getContainerLabels());
     Assert.assertEquals(
         DescriptorDigest.fromDigest(
             "sha256:8c662931926fa990b41da3c9f42663a537ccd498130030f9149173a0493832ad"),

jib-core/src/test/java/com/google/cloud/tools/jib/image/json/ImageToJsonTranslatorTest.java

@@ -65,6 +65,7 @@ public void setUp() throws DigestException, LayerPropertyNotFoundException {
             new Port(1000, Protocol.TCP),
             new Port(2000, Protocol.TCP),
             new Port(3000, Protocol.UDP)));
+    testImageBuilder.setLabels(ImmutableMap.of("key1", "value1", "key2", "value2"));
 
     DescriptorDigest fakeDigest =
         DescriptorDigest.fromDigest(

jib-core/src/test/resources/json/containerconfig.json

@@ -1 +1 @@
-{"created":"1970-01-01T00:00:20Z","architecture":"amd64","os":"linux","config":{"Env":["VAR1=VAL1","VAR2=VAL2"],"Entrypoint":["some","entrypoint","command"],"Cmd":["arg1","arg2"],"ExposedPorts":{"1000/tcp":{},"2000/tcp":{},"3000/udp":{}}},"rootfs":{"type":"layers","diff_ids":["sha256:8c662931926fa990b41da3c9f42663a537ccd498130030f9149173a0493832ad"]}}
+{"created":"1970-01-01T00:00:20Z","architecture":"amd64","os":"linux","config":{"Env":["VAR1=VAL1","VAR2=VAL2"],"Entrypoint":["some","entrypoint","command"],"Cmd":["arg1","arg2"],"ExposedPorts":{"1000/tcp":{},"2000/tcp":{},"3000/udp":{}},"Labels":{"key1":"value1","key2":"value2"}},"rootfs":{"type":"layers","diff_ids":["sha256:8c662931926fa990b41da3c9f42663a537ccd498130030f9149173a0493832ad"]}}

jib-core/src/test/resources/json/translated_ocimanifest.json

@@ -1 +1 @@
-{"schemaVersion":2,"mediaType":"application/vnd.oci.image.manifest.v1+json","config":{"mediaType":"application/vnd.oci.image.config.v1+json","digest":"sha256:1bc0730d8135d29caa0e0c5b502164195afcab6494e1b024e419dc9d591d778d","size":353},"layers":[{"mediaType":"application/vnd.oci.image.layer.v1.tar+gzip","digest":"sha256:8c662931926fa990b41da3c9f42663a537ccd498130030f9149173a0493832ad","size":1000}]}
+{"schemaVersion":2,"mediaType":"application/vnd.oci.image.manifest.v1+json","config":{"mediaType":"application/vnd.oci.image.config.v1+json","digest":"sha256:b988b86bf80435bdfe7b2f361f5e5838bdf2abd5dcb5ff298122504f8fb80e95","size":396},"layers":[{"mediaType":"application/vnd.oci.image.layer.v1.tar+gzip","digest":"sha256:8c662931926fa990b41da3c9f42663a537ccd498130030f9149173a0493832ad","size":1000}]}

jib-core/src/test/resources/json/translated_v22manifest.json

@@ -1 +1 @@
-{"schemaVersion":2,"mediaType":"application/vnd.docker.distribution.manifest.v2+json","config":{"mediaType":"application/vnd.docker.container.image.v1+json","digest":"sha256:1bc0730d8135d29caa0e0c5b502164195afcab6494e1b024e419dc9d591d778d","size":353},"layers":[{"mediaType":"application/vnd.docker.image.rootfs.diff.tar.gzip","digest":"sha256:8c662931926fa990b41da3c9f42663a537ccd498130030f9149173a0493832ad","size":1000}]}
+{"schemaVersion":2,"mediaType":"application/vnd.docker.distribution.manifest.v2+json","config":{"mediaType":"application/vnd.docker.container.image.v1+json","digest":"sha256:b988b86bf80435bdfe7b2f361f5e5838bdf2abd5dcb5ff298122504f8fb80e95","size":396},"layers":[{"mediaType":"application/vnd.docker.image.rootfs.diff.tar.gzip","digest":"sha256:8c662931926fa990b41da3c9f42663a537ccd498130030f9149173a0493832ad","size":1000}]}