Merge pull request #511 from ryantse/optional-build-information

TheSnoozer · web-flow · commit 6beb37dabb91 · 2020-08-03T20:33:52.000+02:00
Build system information should be optionally set
diff --git a/core/src/main/java/pl/project13/core/GitDataProvider.java b/core/src/main/java/pl/project13/core/GitDataProvider.java
@@ -245,7 +245,7 @@ protected SimpleDateFormat getSimpleDateFormatWithTimeZone() {
   protected void maybePut(@Nonnull Properties properties, String key, SupplierEx<String> value)
           throws GitCommitIdExecutionException {
     String keyWithPrefix = prefixDot + key;
-    if (properties.containsKey(keyWithPrefix)) {
+    if (properties.stringPropertyNames().contains(keyWithPrefix)) {
       String propertyValue = properties.getProperty(keyWithPrefix);
       log.info("Using cached {} with value {}", keyWithPrefix, propertyValue);
     } else if (PropertiesFilterer.isIncluded(keyWithPrefix, includeOnlyProperties, excludeProperties)) {
diff --git a/core/src/main/java/pl/project13/core/PropertiesFileGenerator.java b/core/src/main/java/pl/project13/core/PropertiesFileGenerator.java
@@ -75,8 +75,8 @@ public void maybeGeneratePropertiesFile(@Nonnull Properties localProperties, Fil
 
           final String buildTimeProperty = prefixDot + GitCommitPropertyConstant.BUILD_TIME;
 
-          propertiesCopy.remove(buildTimeProperty);
-          persistedProperties.remove(buildTimeProperty);
+          propertiesCopy.setProperty(buildTimeProperty, null);
+          persistedProperties.setProperty(buildTimeProperty, null);
 
           shouldGenerate = !propertiesCopy.equals(persistedProperties);
         } catch (CannotReadFileException ex) {
diff --git a/core/src/main/java/pl/project13/core/cibuild/AwsCodeBuildBuildServerData.java b/core/src/main/java/pl/project13/core/cibuild/AwsCodeBuildBuildServerData.java
@@ -40,10 +40,10 @@ public static boolean isActiveServer(Map<String, String> env) {
   @Override
   void loadBuildNumber(@Nonnull Properties properties) {
     String buildNumber = env.getOrDefault("CODEBUILD_BUILD_NUMBER", "");
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);
 
     String buildArn = env.get("CODEBUILD_BUILD_ID");
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, buildArn);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, () -> buildArn);
   }
 
   @Override
diff --git a/core/src/main/java/pl/project13/core/cibuild/AzureDevOpsBuildServerData.java b/core/src/main/java/pl/project13/core/cibuild/AzureDevOpsBuildServerData.java
@@ -41,7 +41,7 @@ public static boolean isActiveServer(@Nonnull Map<String, String> env) {
   void loadBuildNumber(@Nonnull Properties properties) {
     String buildNumber = env.getOrDefault("BUILD_BUILDNUMBER", "");
 
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);
   }
 
   @Override
diff --git a/core/src/main/java/pl/project13/core/cibuild/BambooBuildServerData.java b/core/src/main/java/pl/project13/core/cibuild/BambooBuildServerData.java
@@ -40,7 +40,7 @@ void loadBuildNumber(@Nonnull Properties properties) {
     String buildNumber = Optional.ofNullable(env.get("bamboo.buildNumber"))
             .orElseGet(() -> env.getOrDefault("BAMBOO_BUILDNUMBER", ""));
 
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);
   }
 
   @Override
diff --git a/core/src/main/java/pl/project13/core/cibuild/BuildServerDataProvider.java b/core/src/main/java/pl/project13/core/cibuild/BuildServerDataProvider.java
@@ -166,15 +166,9 @@ private void loadBuildHostData(@Nonnull Properties properties) {
     maybePut(properties, GitCommitPropertyConstant.BUILD_HOST, buildHostSupplier);
   }
 
-  protected void put(@Nonnull Properties properties, @Nonnull String key, String value) {
-    String keyWithPrefix = prefixDot + key;
-    log.info("Collected {} with value {}", keyWithPrefix, value);
-    PropertyManager.putWithoutPrefix(properties, keyWithPrefix, value);
-  }
-
   protected void maybePut(@Nonnull Properties properties, @Nonnull String key, Supplier<String> supplier) {
     String keyWithPrefix = prefixDot + key;
-    if (properties.containsKey(keyWithPrefix)) {
+    if (properties.stringPropertyNames().contains(keyWithPrefix)) {
       String propertyValue = properties.getProperty(keyWithPrefix);
       log.info("Using cached {} with value {}", keyWithPrefix, propertyValue);
     } else if (PropertiesFilterer.isIncluded(keyWithPrefix, includeOnlyProperties, excludeProperties)) {
diff --git a/core/src/main/java/pl/project13/core/cibuild/CircleCiBuildServerData.java b/core/src/main/java/pl/project13/core/cibuild/CircleCiBuildServerData.java
@@ -40,7 +40,7 @@ public static boolean isActiveServer(Map<String, String> env) {
   @Override
   void loadBuildNumber(@Nonnull Properties properties) {
     String buildNumber = env.getOrDefault("CIRCLE_BUILD_NUM", "");
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);
   }
 
   @Override
diff --git a/core/src/main/java/pl/project13/core/cibuild/GitlabBuildServerData.java b/core/src/main/java/pl/project13/core/cibuild/GitlabBuildServerData.java
@@ -46,8 +46,8 @@ void loadBuildNumber(@Nonnull Properties properties) {
     // CI_PIPELINE_IID will be present if in a Gitlab CI environment (Gitlab >11.0) and contains the project specific build number
     String buildNumber = env.getOrDefault("CI_PIPELINE_IID", "");
 
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, uniqueBuildNumber);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, () -> uniqueBuildNumber);
   }
 
   @Override
diff --git a/core/src/main/java/pl/project13/core/cibuild/HudsonJenkinsBuildServerData.java b/core/src/main/java/pl/project13/core/cibuild/HudsonJenkinsBuildServerData.java
@@ -42,7 +42,7 @@ public static boolean isActiveServer(@Nonnull Map<String, String> env) {
   void loadBuildNumber(@Nonnull Properties properties) {
     String buildNumber = env.getOrDefault("BUILD_NUMBER", "");
 
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);
   }
 
   @Override
diff --git a/core/src/main/java/pl/project13/core/cibuild/TeamCityBuildServerData.java b/core/src/main/java/pl/project13/core/cibuild/TeamCityBuildServerData.java
@@ -54,8 +54,8 @@ void loadBuildNumber(@Nonnull Properties properties) {
     String buildNumber = env.getOrDefault("BUILD_NUMBER", "");
     String buildNumberUnique = teamcitySystemProperties.getProperty("teamcity.build.id", "");
 
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, buildNumberUnique);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, () -> buildNumberUnique);
   }
 
   @Override
diff --git a/core/src/main/java/pl/project13/core/cibuild/TravisBuildServerData.java b/core/src/main/java/pl/project13/core/cibuild/TravisBuildServerData.java
@@ -42,8 +42,8 @@ void loadBuildNumber(@Nonnull Properties properties) {
     String buildNumber = env.getOrDefault("TRAVIS_BUILD_NUMBER", "");
     String uniqueBuildNumber = env.getOrDefault("TRAVIS_BUILD_ID", "");
 
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);
-    put(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, uniqueBuildNumber);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, () -> uniqueBuildNumber);
   }
 
   @Override
diff --git a/core/src/main/java/pl/project13/core/util/PropertyManager.java b/core/src/main/java/pl/project13/core/util/PropertyManager.java
@@ -30,7 +30,7 @@ public static void putWithoutPrefix(@Nonnull Properties properties, String key,
     if (!isNotEmpty(value)) {
       value = "Unknown";
     }
-    properties.put(key, value);
+    properties.setProperty(key, value);
   }
 
   private static boolean isNotEmpty(@Nullable String value) {
diff --git a/maven/src/main/java/pl/project13/maven/git/GitCommitIdMojo.java b/maven/src/main/java/pl/project13/maven/git/GitCommitIdMojo.java
@@ -564,7 +564,9 @@ private void loadBuildData(Properties properties) {
   }
 
   private void publishPropertiesInto(Properties p) {
-    p.putAll(properties);
+    for (String propertyName : properties.stringPropertyNames()) {
+      p.setProperty(propertyName, properties.getProperty(propertyName));
+    }
   }
 
   /**
@@ -603,9 +605,8 @@ private File lookupGitDirectory() throws GitCommitIdExecutionException {
   }
 
   private void logProperties() {
-    for (Object key : properties.keySet()) {
-      String keyString = key.toString();
-      log.info("including property {} in results", keyString);
+    for (String propertyName : properties.stringPropertyNames()) {
+      log.info("including property {} in results", propertyName);
     }
   }
 
diff --git a/maven/src/main/java/pl/project13/maven/git/PropertiesReplacer.java b/maven/src/main/java/pl/project13/maven/git/PropertiesReplacer.java
@@ -50,21 +50,18 @@ public void performReplacement(Properties properties, List<ReplacementProperty>
   }
 
   private void performReplacementOnAllGeneratedProperties(Properties properties, ReplacementProperty replacementProperty) {
-    Map<Object, Object> propertiesToBeAdded = new HashMap<>();
-    for (Map.Entry<Object, Object> entry : properties.entrySet()) {
-      String key = (String)entry.getKey();
-      String content = (String)entry.getValue();
+    for (String propertyName : properties.stringPropertyNames()) {
+      String content = properties.getProperty(propertyName);
       String result = performReplacement(replacementProperty, content);
       if ((replacementProperty.getPropertyOutputSuffix() != null) && (!replacementProperty.getPropertyOutputSuffix().isEmpty())) {
-        String newPropertyKey = key + "." + replacementProperty.getPropertyOutputSuffix();
-        propertiesToBeAdded.put(newPropertyKey, result);
-        log.info("apply replace on property " + key + " and save to " + newPropertyKey + ": original value '" + content + "' with '" + result + "'");
+        String newPropertyKey = propertyName + "." + replacementProperty.getPropertyOutputSuffix();
+        properties.setProperty(newPropertyKey, result);
+        log.info("apply replace on property " + propertyName + " and save to " + newPropertyKey + ": original value '" + content + "' with '" + result + "'");
       } else {
-        entry.setValue(result);
-        log.info("apply replace on property " + key + ": original value '" + content + "' with '" + result + "'");
+        properties.setProperty(propertyName, result);
+        log.info("apply replace on property " + propertyName + ": original value '" + content + "' with '" + result + "'");
       }
     }
-    properties.putAll(propertiesToBeAdded);
   }
 
   private void performReplacementOnSingleProperty(Properties properties, ReplacementProperty replacementProperty, String propertyKey) {

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public static boolean isActiveServer(@Nonnull Map<String, String> env) {`
`41`	`41`	`void loadBuildNumber(@Nonnull Properties properties) {`
`42`	`42`	`String buildNumber = env.getOrDefault("BUILD_BUILDNUMBER", "");`
`43`	`43`
`44`		`- put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);`
	`44`	`+ maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ void loadBuildNumber(@Nonnull Properties properties) {`
`40`	`40`	`String buildNumber = Optional.ofNullable(env.get("bamboo.buildNumber"))`
`41`	`41`	`.orElseGet(() -> env.getOrDefault("BAMBOO_BUILDNUMBER", ""));`
`42`	`42`
`43`		`- put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);`
	`43`	`+ maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public static boolean isActiveServer(Map<String, String> env) {`
`40`	`40`	`@Override`
`41`	`41`	`void loadBuildNumber(@Nonnull Properties properties) {`
`42`	`42`	`String buildNumber = env.getOrDefault("CIRCLE_BUILD_NUM", "");`
`43`		`- put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);`
	`43`	`+ maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,8 @@ void loadBuildNumber(@Nonnull Properties properties) {`
`46`	`46`	`// CI_PIPELINE_IID will be present if in a Gitlab CI environment (Gitlab >11.0) and contains the project specific build number`
`47`	`47`	`String buildNumber = env.getOrDefault("CI_PIPELINE_IID", "");`
`48`	`48`
`49`		`- put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);`
`50`		`- put(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, uniqueBuildNumber);`
	`49`	`+ maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);`
	`50`	`+ maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, () -> uniqueBuildNumber);`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public static boolean isActiveServer(@Nonnull Map<String, String> env) {`
`42`	`42`	`void loadBuildNumber(@Nonnull Properties properties) {`
`43`	`43`	`String buildNumber = env.getOrDefault("BUILD_NUMBER", "");`
`44`	`44`
`45`		`- put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);`
	`45`	`+ maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -54,8 +54,8 @@ void loadBuildNumber(@Nonnull Properties properties) {`
`54`	`54`	`String buildNumber = env.getOrDefault("BUILD_NUMBER", "");`
`55`	`55`	`String buildNumberUnique = teamcitySystemProperties.getProperty("teamcity.build.id", "");`
`56`	`56`
`57`		`- put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber);`
`58`		`- put(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, buildNumberUnique);`
	`57`	`+ maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);`
	`58`	`+ maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER_UNIQUE, () -> buildNumberUnique);`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`@Override`