Merge pull request #369 from secustor/implement_build_number

add build number support (git.build.number & git.build.number.unique)

Author: TheSnoozer

README.md

@@ -559,6 +559,8 @@ git.build.user.email=${git.build.user.email}
 git.build.time=${git.build.time}
 git.build.host=${git.build.host}
 git.build.version=${git.build.version}
+git.build.number=${git.build.number}
+git.build.number.unique=${git.build.number.unique}
 ```
 
 The `git` prefix may be configured in the plugin declaration above.
@@ -598,6 +600,8 @@ Start out with with adding the above steps to your project, next paste this **gi
         <property name="buildTime" value="${git.build.time}"/>
         <property name="buildHost" value="${git.build.host}"/>
         <property name="buildVersion" value="${git.build.version}"/>
+        <property name="buildNumber" value="${git.build.number}"/>
+        <property name="buildNumberUnique" value="${git.build.number.unique}"/>
     </bean>
 </beans>
 ```
@@ -637,7 +641,9 @@ public class GitRepositoryState {
   String buildUserEmail;          // =${git.build.user.email}
   String buildTime;               // =${git.build.time}
   String buildHost;               // =${git.build.host}
-  String buildVersion             // =${git.build.version}
+  String buildVersion;            // =${git.build.version}
+  String buildNumber;             // =${git.build.number}
+  String buildNumberUnique;       // =${git.build.number.unique}
 
   public GitRepositoryState() {
   }
@@ -763,6 +769,8 @@ public GitRepositoryState(Properties properties)
   this.buildTime = String.valueOf(properties.get("git.build.time"));
   this.buildHost = String.valueOf(properties.get("git.build.host"));
   this.buildVersion = String.valueOf(properties.get("git.build.version"));
+  this.buildNumber = String.valueOf(properties.get("git.build.number"));
+  this.buildNumberUnique = String.valueOf(properties.get("git.build.number.unique"));
 }
 ```
 
@@ -780,6 +788,17 @@ If you need the actual *build time* then simply use the a filtered properties fi
 git.build.time=${git.build.time}
 ```
 
+Note on git.build.number variables
+ ------------------------------------
+The `git.build.number` variables are available on some hosted CIs and can be used to identify the "number" of the build.
+Refer to the table below to see which values are supported by which CIs.
+  
+ 
+ | variable                  | description                             | supported CIs                                             |    
+ | ------------------------- | ----------------------------------------|:---------------------------------------------------------:|   
+ |`git.build.number`         | holds a project specific build number   | Bamboo, Hudson, Jenkins, TeamCity, Travis, Gitlab CI (Gitlab >8.10 & Gitlab CI >0.5)|        
+ |`git.build.number.unique`  | holds a system wide unique build number | TeamCity, Travis, Gitlab CI (Gitlab >11.0)                          |
+
 Yet another way to use the plugin
 =================================
 

src/main/java/pl/project13/maven/git/GitCommitIdMojo.java

@@ -25,17 +25,13 @@
 import java.io.InputStreamReader;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
-import java.net.InetAddress;
-import java.net.UnknownHostException;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.text.SimpleDateFormat;
-import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
-import java.util.TimeZone;
 import java.util.regex.Pattern;
 
 import org.apache.maven.execution.MavenSession;
@@ -55,6 +51,7 @@
 import com.google.common.io.Files;
 import java.io.OutputStream;
 
+import pl.project13.maven.git.build.BuildServerDataProvider;
 import pl.project13.maven.git.log.LoggerBridge;
 import pl.project13.maven.git.log.MavenLoggerBridge;
 import pl.project13.maven.git.util.PropertyManager;
@@ -308,12 +305,12 @@ public class GitCommitIdMojo extends AbstractMojo {
   /**
    * Allow to tell the plugin what commit should be used as reference to generate the properties from.
    * By default this property is simply set to <p>HEAD</p> which should reference to the latest commit in your repository.
-   * 
+   *
    * In general this property can be set to something generic like <p>HEAD^1</p> or point to a branch or tag-name.
    * To support any kind or use-case this configuration can also be set to an entire commit-hash or it's abbreviated version.
-   * 
+   *
    * A use-case for this feature can be found in https://github.com/ktoso/maven-git-commit-id-plugin/issues/338.
-   * 
+   *
    * Please note that for security purposes not all references might be allowed as configuration.
    * If you have a specific use-case that is currently not white listed feel free to file an issue.
    * @since 2.2.4
@@ -406,8 +403,7 @@ public void execute() throws MojoExecutionException {
         prefixDot = trimmedPrefix.equals("") ? "" : trimmedPrefix + ".";
 
         loadGitData(properties);
-        loadBuildVersionAndTimeData(properties);
-        loadBuildHostData(properties);
+        loadBuildData(properties);
         loadShortDescribe(properties);
         propertiesReplacer.performReplacement(properties, replacementProperties);
         propertiesFilterer.filter(properties, includeOnlyProperties, this.prefixDot);
@@ -430,6 +426,17 @@ public void execute() throws MojoExecutionException {
     }
   }
 
+  private void loadBuildData(Properties properties) {
+    BuildServerDataProvider buildServerDataProvider = BuildServerDataProvider.getBuildServerProvider(System.getenv(),log);
+    buildServerDataProvider
+        .setDateFormat(dateFormat)
+        .setDateFormatTimeZone(dateFormatTimeZone)
+        .setProject(project)
+        .setPrefixDot(prefixDot);
+
+    buildServerDataProvider.loadBuildData(properties);
+  }
+
   private void publishPropertiesInto(MavenProject target) {
     target.getProperties().putAll(properties);
   }
@@ -476,26 +483,6 @@ private void logProperties() {
     }
   }
 
-  void loadBuildVersionAndTimeData(@NotNull Properties properties) {
-    Date buildDate = new Date();
-    SimpleDateFormat smf = new SimpleDateFormat(dateFormat);
-    if (dateFormatTimeZone != null) {
-      smf.setTimeZone(TimeZone.getTimeZone(dateFormatTimeZone));
-    }
-    put(properties, GitCommitPropertyConstant.BUILD_TIME, smf.format(buildDate));
-    put(properties, GitCommitPropertyConstant.BUILD_VERSION, project.getVersion());
-  }
-
-  void loadBuildHostData(@NotNull Properties properties) {
-    String buildHost = null;
-    try {
-      buildHost = InetAddress.getLocalHost().getHostName();
-    } catch (UnknownHostException e) {
-      log.info("Unable to get build host, skipping property {}. Error message: {}", GitCommitPropertyConstant.BUILD_HOST, e.getMessage());
-    }
-    put(properties, GitCommitPropertyConstant.BUILD_HOST, buildHost);
-  }
-
   void loadShortDescribe(@NotNull Properties properties) {
     //removes git hash part from describe
     String commitDescribe = properties.getProperty(prefixDot + GitCommitPropertyConstant.COMMIT_DESCRIBE);

src/main/java/pl/project13/maven/git/GitCommitPropertyConstant.java

@@ -15,6 +15,8 @@ public class GitCommitPropertyConstant {
   public static final String BUILD_TIME = "build.time";
   public static final String BUILD_VERSION = "build.version";
   public static final String BUILD_HOST = "build.host";
+  public static final String BUILD_NUMBER = "build.number";
+  public static final String BUILD_NUMBER_UNIQUE = "build.number.unique";
   public static final String COMMIT_AUTHOR_NAME = "commit.user.name";
   public static final String COMMIT_AUTHOR_EMAIL = "commit.user.email";
   public static final String COMMIT_MESSAGE_FULL = "commit.message.full";

src/main/java/pl/project13/maven/git/GitDataProvider.java

@@ -19,6 +19,8 @@
 
 import org.apache.http.client.utils.URIBuilder;
 import org.jetbrains.annotations.NotNull;
+import pl.project13.maven.git.build.BuildServerDataProvider;
+import pl.project13.maven.git.build.UnknownBuildServerData;
 import pl.project13.maven.git.log.LoggerBridge;
 import pl.project13.maven.git.util.PropertyManager;
 
@@ -167,57 +169,20 @@ void validateAbbrevLength(int abbrevLength) throws GitCommitIdExecutionException
    * @param env environment settings
    * @return results of getBranchName() or, if in Jenkins/Hudson, value of GIT_BRANCH
    */
-  protected String determineBranchName(Map<String, String> env) throws GitCommitIdExecutionException {
-    if (runningOnBuildServer(env)) {
-      return determineBranchNameOnBuildServer(env);
+  protected String determineBranchName(@NotNull Map<String, String> env) throws GitCommitIdExecutionException {
+    BuildServerDataProvider buildServerDataProvider = BuildServerDataProvider.getBuildServerProvider(env,log);
+    if (!(buildServerDataProvider instanceof UnknownBuildServerData)) {
+      String branchName = buildServerDataProvider.getBuildBranch();
+      if (isNullOrEmpty(branchName)) {
+        log.info("Detected that running on CI environment, but using repository branch, no GIT_BRANCH detected.");
+        return getBranchName();
+      }
+      return branchName;
     } else {
       return getBranchName();
     }
   }
 
-  /**
-   * Detects if we're running on Jenkins or Hudson, based on expected env variables.
-   *
-   * TODO: How can we detect Bamboo, TeamCity etc? Pull requests welcome.
-   *
-   * @param env environment settings
-   * @return true if running
-   * @see <a href="https://wiki.jenkins-ci.org/display/JENKINS/Building+a+software+project#Buildingasoftwareproject-JenkinsSetEnvironmentVariables">JenkinsSetEnvironmentVariables</a>
-   * @see <a href="https://docs.gitlab.com/ce/ci/variables/#predefined-variables-environment-variables">GitlabCIVariables</a>
-   */
-  private boolean runningOnBuildServer(Map<String, String> env) {
-    return env.containsKey("HUDSON_URL") || env.containsKey("JENKINS_URL") || env.containsKey("CI") ||
-           env.containsKey("HUDSON_HOME") || env.containsKey("JENKINS_HOME");
-  }
-
-  /**
-   * Is "Jenkins aware", and prefers {@code GIT_LOCAL_BRANCH} over {@code GIT_BRANCH} to getting the branch via git if that environment variables are set.
-   * The {@code GIT_LOCAL_BRANCH} and {@code GIT_BRANCH} variables are set by Jenkins/Hudson when put in detached HEAD state, but it still knows which branch was cloned.
-   * If the above fails the environment will be checked for a Gitlab CI environment (>0.4 Runner && >9.0 Gitlab). Is this the case the {@code CI_COMMIT_REF_NAME} will be read out which holds the branch name or tag name if a tag is built.
-   */
-  protected String determineBranchNameOnBuildServer(Map<String, String> env) throws GitCommitIdExecutionException {
-    String environmentBasedLocalBranch = env.get("GIT_LOCAL_BRANCH");
-    if (!isNullOrEmpty(environmentBasedLocalBranch)) {
-      log.info("Using environment variable based branch name. GIT_LOCAL_BRANCH = {}", environmentBasedLocalBranch);
-      return environmentBasedLocalBranch;
-    }
-
-    String environmentBasedBranch = env.get("GIT_BRANCH");
-    if (!isNullOrEmpty(environmentBasedBranch)) {
-      log.info("Using environment variable based branch name. GIT_BRANCH = {}", environmentBasedBranch);
-      return environmentBasedBranch;
-    }
-
-    environmentBasedBranch = env.get("CI_COMMIT_REF_NAME");
-    if (!isNullOrEmpty(environmentBasedBranch)) {
-      log.info("Using environment variable based branch name. CI_COMMIT_REF_NAME = {}", environmentBasedBranch);
-      return environmentBasedBranch;
-    }
-
-    log.info("Detected that running on CI environment, but using repository branch, no GIT_BRANCH detected.");
-    return getBranchName();
-  }
-
   protected SimpleDateFormat getSimpleDateFormatWithTimeZone() {
     SimpleDateFormat smf = new SimpleDateFormat(dateFormat);
     if (dateFormatTimeZone != null) {

src/main/java/pl/project13/maven/git/build/BambooBuildServerData.java

@@ -0,0 +1,33 @@
+package pl.project13.maven.git.build;
+
+import org.jetbrains.annotations.NotNull;
+import pl.project13.maven.git.GitCommitPropertyConstant;
+import pl.project13.maven.git.log.LoggerBridge;
+
+import java.util.Map;
+import java.util.Properties;
+
+public class BambooBuildServerData extends BuildServerDataProvider {
+
+  BambooBuildServerData(LoggerBridge log, @NotNull Map<String, String> env) {
+    super(log, env);
+  }
+
+  public static boolean isActiveServer(Map<String, String> env) {
+    return env.containsKey("BAMBOO_BUILDKEY");
+  }
+
+  @Override
+  void loadBuildNumber(@NotNull Properties properties) {
+    String buildNumber = env.get("BAMBOO_BUILDNUMBER");
+
+    put(properties, GitCommitPropertyConstant.BUILD_NUMBER, buildNumber == null ? "" : buildNumber);
+  }
+
+  @Override
+  public String getBuildBranch() {
+    String environmentBasedBranch = env.get("BAMBOO_PLANREPOSITORY_BRANCH");
+    log.info("Using environment variable based branch name. BAMBOO_PLANREPOSITORY_BRANCH = {}", environmentBasedBranch);
+    return environmentBasedBranch;
+  }
+}