Add container creation timestamp configuration

jib-gradle-plugin/CHANGELOG.md

@@ -6,10 +6,13 @@ All notable changes to this project will be documented in this file.
 ### Added
 
 - Can now set timestamps (last modified time) of the files in the built image with `jib.container.filesModificationTime`. The value should either be `EPOCH_PLUS_SECOND` to set the timestamps to Epoch + 1 second (default behavior), or an ISO 8601 date time parsable with [`DateTimeFormatter.ISO_DATE_TIME`](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html) such as `2019-07-15T10:15:30+09:00` or `2011-12-03T22:42:05Z` ([#1818](https://github.com/GoogleContainerTools/jib/pull/1818))
+- Can now set container creation timestamp with `jib.container.creationTime`. The value should be `EPOCH_PLUS_SECOND`, `USE_CURRENT_TIMESTAMP`, or an ISO 8601 date time ([#1609](https://github.com/GoogleContainerTools/jib/issues/1609))
 
 ### Changed
 
 - When building to a registry, Jib now skips downloading and caching base image layers that already exist in the target registry. This feature will be particularly useful in CI/CD environments. However, if you want to force caching base image layers locally, set the system property `-Djib.alwaysCacheBaseImage=true` ([#1840](https://github.com/GoogleContainerTools/jib/pull/1840))
+- `jib.container.useCurrentTimestamp` has been deprecated in favor of `jib.container.creationTime` with `USE_CURRENT_TIMESTAMP`
+- Default container creation time is changed from epoch to epoch + 1 second
 
 ### Fixed
 

jib-gradle-plugin/src/integration-test/java/com/google/cloud/tools/jib/gradle/EmptyProjectIntegrationTest.java

@@ -67,7 +67,7 @@ public void testBuild_empty() throws IOException, InterruptedException, DigestEx
             + System.nanoTime();
     Assert.assertEquals("", JibRunHelper.buildAndRun(emptyTestProject, targetImage));
     assertDockerInspect(targetImage);
-    JibRunHelper.assertCreationTimeEpoch(targetImage);
+    JibRunHelper.assertCreationTimeEpochPlusOne(targetImage);
   }
 
   @Test
@@ -87,9 +87,7 @@ public void testDockerDaemon_empty() throws IOException, InterruptedException, D
     String targetImage = "emptyimage:gradle" + System.nanoTime();
     Assert.assertEquals(
         "", JibRunHelper.buildToDockerDaemonAndRun(emptyTestProject, targetImage, "build.gradle"));
-    Assert.assertEquals(
-        "1970-01-01T00:00:00Z",
-        new Command("docker", "inspect", "-f", "{{.Created}}", targetImage).run().trim());
+    JibRunHelper.assertCreationTimeEpochPlusOne(targetImage);
     assertDockerInspect(targetImage);
   }
 

jib-gradle-plugin/src/integration-test/java/com/google/cloud/tools/jib/gradle/JibRunHelper.java

@@ -87,8 +87,8 @@ static void buildAndRunAdditionalTag(
 
     Assert.assertEquals(expectedOutput, pullAndRunBuiltImage(imageReference));
     Assert.assertEquals(expectedOutput, pullAndRunBuiltImage(additionalImageReference));
-    assertCreationTimeEpoch(imageReference);
-    assertCreationTimeEpoch(additionalImageReference);
+    assertCreationTimeEpochPlusOne(imageReference);
+    assertCreationTimeEpochPlusOne(additionalImageReference);
   }
 
   static BuildResult buildToDockerDaemon(
@@ -138,10 +138,10 @@ static void assertBuildSuccess(BuildResult buildResult, String taskName, String
     Assert.assertThat(buildResult.getOutput(), CoreMatchers.containsString(successMessage));
   }
 
-  static void assertCreationTimeEpoch(String imageReference)
+  static void assertCreationTimeEpochPlusOne(String imageReference)
       throws IOException, InterruptedException {
     Assert.assertEquals(
-        "1970-01-01T00:00:00Z",
+        "1970-01-01T00:00:01Z",
         new Command("docker", "inspect", "-f", "{{.Created}}", imageReference).run().trim());
   }
 

jib-gradle-plugin/src/integration-test/java/com/google/cloud/tools/jib/gradle/SingleProjectIntegrationTest.java

@@ -70,6 +70,14 @@ private static void assertSimpleCreationTimeIsAfter(Instant before, String image
     Assert.assertTrue(parsed.isAfter(before) || parsed.equals(before));
   }
 
+  private static void assertSimpleCreationTimeIsEqual(Instant match, String imageReference)
+      throws IOException, InterruptedException {
+    String inspect =
+        new Command("docker", "inspect", "-f", "{{.Created}}", imageReference).run().trim();
+    Instant parsed = Instant.parse(inspect);
+    Assert.assertEquals(match, parsed);
+  }
+
   private static void assertWorkingDirectory(String expected, String imageReference)
       throws IOException, InterruptedException {
     Assert.assertEquals(
@@ -131,11 +139,11 @@ private static void assertDockerInspect(String imageReference)
                 + "            }"));
   }
 
-  private static void assertExtraDirectoryDeprecationWarning(String pomXml)
+  private static void assertExtraDirectoryDeprecationWarning(String buildFile)
       throws DigestException, IOException, InterruptedException {
     String targetImage = "localhost:6000/simpleimage:gradle" + System.nanoTime();
     BuildResult buildResult =
-        JibRunHelper.buildToDockerDaemon(simpleTestProject, targetImage, pomXml);
+        JibRunHelper.buildToDockerDaemon(simpleTestProject, targetImage, buildFile);
     Assert.assertEquals(
         "Hello, world. \n1970-01-01T00:00:01Z\nrw-r--r--\nrw-r--r--\nfoo\ncat\n"
             + "1970-01-01T00:00:01Z\n1970-01-01T00:00:01Z\n",
@@ -209,13 +217,12 @@ public void testBuild_simple() throws IOException, InterruptedException, DigestE
               "No classes files were found - did you compile your project?"));
     }
 
-    Instant beforeBuild = Instant.now();
     Assert.assertEquals(
         "Hello, world. An argument.\n1970-01-01T00:00:01Z\nrw-r--r--\nrw-r--r--\nfoo\ncat\n"
             + "1970-01-01T00:00:01Z\n1970-01-01T00:00:01Z\n",
         JibRunHelper.buildAndRun(simpleTestProject, targetImage));
     assertDockerInspect(targetImage);
-    assertSimpleCreationTimeIsAfter(beforeBuild, targetImage);
+    JibRunHelper.assertCreationTimeEpochPlusOne(targetImage);
     assertWorkingDirectory("/home", targetImage);
     assertEntrypoint(
         "[java -cp /d1:/d2:/app/resources:/app/classes:/app/libs/* com.test.HelloWorld]",
@@ -342,12 +349,11 @@ public void testBuild_complex_sameFromAndToRegistry() throws IOException, Interr
   @Test
   public void testDockerDaemon_simple() throws IOException, InterruptedException, DigestException {
     String targetImage = "simpleimage:gradle" + System.nanoTime();
-    Instant beforeBuild = Instant.now();
     Assert.assertEquals(
         "Hello, world. An argument.\n1970-01-01T00:00:01Z\nrw-r--r--\nrw-r--r--\nfoo\ncat\n"
             + "1970-01-01T00:00:01Z\n1970-01-01T00:00:01Z\n",
         JibRunHelper.buildToDockerDaemonAndRun(simpleTestProject, targetImage, "build.gradle"));
-    assertSimpleCreationTimeIsAfter(beforeBuild, targetImage);
+    JibRunHelper.assertCreationTimeEpochPlusOne(targetImage);
     assertDockerInspect(targetImage);
     assertWorkingDirectory("/home", targetImage);
   }
@@ -379,13 +385,45 @@ public void testBuild_skipDownloadingBaseImageLayers() throws IOException, Inter
   }
 
   @Test
-  public void testDockerDaemon_filesModificationTimeCustom()
+  public void testDockerDaemon_timestampCustom()
       throws DigestException, IOException, InterruptedException {
     String targetImage = "simpleimage:gradle" + System.nanoTime();
     Assert.assertEquals(
         "Hello, world. \n2011-12-03T01:15:30Z\n",
         JibRunHelper.buildToDockerDaemonAndRun(
-            simpleTestProject, targetImage, "build-files-modification-time-custom.gradle"));
+            simpleTestProject, targetImage, "build-timestamps-custom.gradle"));
+    assertSimpleCreationTimeIsEqual(Instant.parse("2013-11-04T21:29:30Z"), targetImage);
+  }
+
+  @Test
+  public void testDockerDaemon_timestampDeprecated()
+      throws DigestException, IOException, InterruptedException {
+    Instant beforeBuild = Instant.now();
+    String targetImage = "simpleimage:gradle" + System.nanoTime();
+    BuildResult buildResult =
+        JibRunHelper.buildToDockerDaemon(
+            simpleTestProject, targetImage, "build-usecurrent-deprecated.gradle");
+    assertSimpleCreationTimeIsAfter(beforeBuild, targetImage);
+    Assert.assertThat(
+        buildResult.getOutput(),
+        CoreMatchers.containsString(
+            "'jib.container.useCurrentTimestamp' is deprecated; use 'jib.container.creationTime' with the value 'USE_CURRENT_TIMESTAMP' instead"));
+  }
+
+  @Test
+  public void testDockerDaemon_timestampFail()
+      throws InterruptedException, IOException, DigestException {
+    try {
+      String targetImage = "simpleimage:gradle" + System.nanoTime();
+      JibRunHelper.buildToDockerDaemonAndRun(
+          simpleTestProject, targetImage, "build-usecurrent-deprecated2.gradle");
+      Assert.fail();
+    } catch (UnexpectedBuildFailure ex) {
+      Assert.assertThat(
+          ex.getMessage(),
+          CoreMatchers.containsString(
+              "You cannot configure both 'jib.container.useCurrentTimestamp' and 'jib.container.creationTime'"));
+    }
   }
 
   @Test
@@ -420,7 +458,6 @@ public void testBuildTar_simple() throws IOException, InterruptedException {
 
     String outputPath =
         simpleTestProject.getProjectRoot().resolve("build").resolve("jib-image.tar").toString();
-    Instant beforeBuild = Instant.now();
     BuildResult buildResult =
         simpleTestProject.build(
             "clean",
@@ -438,7 +475,7 @@ public void testBuildTar_simple() throws IOException, InterruptedException {
             + "1970-01-01T00:00:01Z\n1970-01-01T00:00:01Z\n",
         new Command("docker", "run", "--rm", targetImage).run());
     assertDockerInspect(targetImage);
-    assertSimpleCreationTimeIsAfter(beforeBuild, targetImage);
+    assertSimpleCreationTimeIsEqual(Instant.EPOCH.plusSeconds(1), targetImage);
     assertWorkingDirectory("/home", targetImage);
   }
 }

jib-gradle-plugin/src/integration-test/resources/gradle/projects/simple/build-files-modification-time-custom.gradle → jib-gradle-plugin/src/integration-test/resources/gradle/projects/simple/build-timestamps-custom.gradle

@@ -17,4 +17,5 @@ dependencies {
 jib {
   to.image = System.getProperty("_TARGET_IMAGE")
   container.filesModificationTime = '2011-12-03T10:15:30+09:00'
+  container.creationTime = '2013-11-05T06:29:30+09:00'
 }

jib-gradle-plugin/src/integration-test/resources/gradle/projects/simple/build-usecurrent-deprecated.gradle

@@ -0,0 +1,20 @@
+plugins {
+  id 'java'
+  id 'com.google.cloud.tools.jib'
+}
+
+sourceCompatibility = 1.8
+targetCompatibility = 1.8
+
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  compile files('libs/dependency-1.0.0.jar')
+}
+
+jib {
+  to.image = System.getProperty("_TARGET_IMAGE")
+  container.useCurrentTimestamp = true
+}

jib-gradle-plugin/src/integration-test/resources/gradle/projects/simple/build-usecurrent-deprecated2.gradle

@@ -0,0 +1,21 @@
+plugins {
+  id 'java'
+  id 'com.google.cloud.tools.jib'
+}
+
+sourceCompatibility = 1.8
+targetCompatibility = 1.8
+
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  compile files('libs/dependency-1.0.0.jar')
+}
+
+jib {
+  to.image = System.getProperty("_TARGET_IMAGE")
+  container.useCurrentTimestamp = true
+  container.creationTime = 'USE_CURRENT_TIMESTAMP'
+}

jib-gradle-plugin/src/integration-test/resources/gradle/projects/simple/build.gradle

@@ -20,7 +20,7 @@ jib {
     credHelper = 'gcr'
   }
   container {
-    useCurrentTimestamp = true
+    creationTime = 'EPOCH_PLUS_SECOND'
     args = ['An argument.']
     ports = ['1000/tcp', '2000-2003/udp']
     labels = [key1:'value1', key2:'value2']

jib-gradle-plugin/src/integration-test/resources/gradle/projects/simple/complex-build.gradle

@@ -30,7 +30,7 @@ jib {
     }
   }
   container {
-    useCurrentTimestamp = true
+    creationTime = 'USE_CURRENT_TIMESTAMP'
     args = ['An argument.']
     mainClass = 'com.test.HelloWorld'
     jvmFlags = ['-Xms512m', '-Xdebug']

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildDockerTask.java

@@ -26,6 +26,7 @@
 import com.google.cloud.tools.jib.plugins.common.InvalidAppRootException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerVolumeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerizingModeException;
+import com.google.cloud.tools.jib.plugins.common.InvalidCreationTimeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidFilesModificationTimeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
 import com.google.cloud.tools.jib.plugins.common.JibBuildRunner;
@@ -172,6 +173,14 @@ public void buildDocker()
               + ex.getInvalidFilesModificationTime(),
           ex);
 
+    } catch (InvalidCreationTimeException ex) {
+      throw new GradleException(
+          "container.creationTime should be an ISO 8601 date-time (see "
+              + "DateTimeFormatter.ISO_DATE_TIME) or a special keyword (\"EPOCH_PLUS_SECOND\", "
+              + "\"USE_CURRENT_TIMESTAMP\"): "
+              + ex.getInvalidCreationTime(),
+          ex);
+
     } catch (IncompatibleBaseImageJavaVersionException ex) {
       throw new GradleException(
           HelpfulSuggestions.forIncompatibleBaseImageJavaVesionForGradle(

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildImageTask.java

@@ -25,6 +25,7 @@
 import com.google.cloud.tools.jib.plugins.common.InvalidAppRootException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerVolumeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerizingModeException;
+import com.google.cloud.tools.jib.plugins.common.InvalidCreationTimeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidFilesModificationTimeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
 import com.google.cloud.tools.jib.plugins.common.JibBuildRunner;
@@ -152,6 +153,14 @@ public void buildImage()
               + ex.getInvalidFilesModificationTime(),
           ex);
 
+    } catch (InvalidCreationTimeException ex) {
+      throw new GradleException(
+          "container.creationTime should be an ISO 8601 date-time (see "
+              + "DateTimeFormatter.ISO_DATE_TIME) or a special keyword (\"EPOCH_PLUS_SECOND\", "
+              + "\"USE_CURRENT_TIMESTAMP\"): "
+              + ex.getInvalidCreationTime(),
+          ex);
+
     } catch (IncompatibleBaseImageJavaVersionException ex) {
       throw new GradleException(
           HelpfulSuggestions.forIncompatibleBaseImageJavaVesionForGradle(

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildTarTask.java

@@ -24,6 +24,7 @@
 import com.google.cloud.tools.jib.plugins.common.InvalidAppRootException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerVolumeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerizingModeException;
+import com.google.cloud.tools.jib.plugins.common.InvalidCreationTimeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidFilesModificationTimeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
 import com.google.cloud.tools.jib.plugins.common.JibBuildRunner;
@@ -170,6 +171,14 @@ public void buildTar()
               + ex.getInvalidFilesModificationTime(),
           ex);
 
+    } catch (InvalidCreationTimeException ex) {
+      throw new GradleException(
+          "container.creationTime should be an ISO 8601 date-time (see "
+              + "DateTimeFormatter.ISO_DATE_TIME) or a special keyword (\"EPOCH_PLUS_SECOND\", "
+              + "\"USE_CURRENT_TIMESTAMP\"): "
+              + ex.getInvalidCreationTime(),
+          ex);
+
     } catch (IncompatibleBaseImageJavaVersionException ex) {
       throw new GradleException(
           HelpfulSuggestions.forIncompatibleBaseImageJavaVesionForGradle(

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/ContainerParameters.java

@@ -48,6 +48,7 @@ public class ContainerParameters {
   @Nullable private String user;
   @Nullable private String workingDirectory;
   private String filesModificationTime = "EPOCH_PLUS_SECOND";
+  private String creationTime = "EPOCH_PLUS_SECOND";
 
   @Input
   @Optional
@@ -261,4 +262,17 @@ public String getFilesModificationTime() {
   public void setFilesModificationTime(String filesModificationTime) {
     this.filesModificationTime = filesModificationTime;
   }
+
+  @Input
+  @Optional
+  public String getCreationTime() {
+    if (System.getProperty(PropertyNames.CONTAINER_CREATION_TIME) != null) {
+      return System.getProperty(PropertyNames.CONTAINER_CREATION_TIME);
+    }
+    return creationTime;
+  }
+
+  public void setCreationTime(String creationTime) {
+    this.creationTime = creationTime;
+  }
 }

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/GradleRawConfiguration.java

@@ -155,6 +155,11 @@ public String getFilesModificationTime() {
     return jibExtension.getContainer().getFilesModificationTime();
   }
 
+  @Override
+  public String getCreationTime() {
+    return jibExtension.getContainer().getCreationTime();
+  }
+
   @Override
   public List<Path> getExtraDirectories() {
     return jibExtension.getExtraDirectories().getPaths();

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/TaskCommon.java

@@ -89,6 +89,17 @@ static void checkDeprecatedUsage(JibExtension jibExtension, Logger logger) {
             "You cannot configure both 'jib.extraDirectory.path' and 'jib.extraDirectories.paths'");
       }
     }
+
+    if (jibExtension.getContainer().getUseCurrentTimestamp()) {
+      if (!jibExtension.getContainer().getCreationTime().equals("EPOCH_PLUS_SECOND")) {
+        throw new IllegalArgumentException(
+            "You cannot configure both 'jib.container.useCurrentTimestamp' and "
+                + "'jib.container.creationTime'");
+      }
+      logger.warn(
+          "'jib.container.useCurrentTimestamp' is deprecated; use 'jib.container.creationTime' "
+              + "with the value 'USE_CURRENT_TIMESTAMP' instead");
+    }
   }
 
   /**