Added support for build number in Github Actions

Author: mahasv

src/main/java/pl/project13/core/cibuild/GitHubBuildServerData.java

@@ -17,6 +17,7 @@
 
 package pl.project13.core.cibuild;
 
+import pl.project13.core.GitCommitPropertyConstant;
 import pl.project13.core.log.LogInterface;
 
 import javax.annotation.Nonnull;
@@ -39,7 +40,9 @@ public static boolean isActiveServer(Map<String, String> env) {
 
   @Override
   void loadBuildNumber(@Nonnull Properties properties) {
-    // This information is not reliably available on GitHub Actions
+    String buildNumber = env.getOrDefault("GITHUB_RUN_NUMBER", "");
+
+    maybePut(properties, GitCommitPropertyConstant.BUILD_NUMBER, () -> buildNumber);
   }
 
   @Override

src/test/java/pl/project13/core/GitCommitIdTestCallback.java

@@ -18,6 +18,7 @@
 package pl.project13.core;
 
 import pl.project13.core.git.GitDescribeConfig;
+import pl.project13.core.log.DummyLogInterface;
 import pl.project13.core.log.LogInterface;
 import pl.project13.core.util.BuildFileChangeListener;
 
@@ -34,7 +35,7 @@
 public class GitCommitIdTestCallback {
   private Map<String, String> systemEnv = System.getenv();
   private String projectVersion = "dummy-version";
-  private LogInterface logInterface = createDummyLogInterface();
+  private LogInterface logInterface = new DummyLogInterface();
   private String dateFormat = "yyyy-MM-dd'T'HH:mm:ssZ";
   private String dateFormatTimeZone = TimeZone.getDefault().getID();
   private String prefixDot = "git.";
@@ -362,33 +363,4 @@ private GitDescribeConfig createGitDescribeConfig(boolean forceLongFormat, int a
     gitDescribeConfig.setAbbrev(abbrev);
     return gitDescribeConfig;
   }
-
-  private LogInterface createDummyLogInterface() {
-    return new LogInterface() {
-      @Override
-      public void debug(String msg) {
-        // ignore
-      }
-
-      @Override
-      public void info(String msg) {
-        // ignore
-      }
-
-      @Override
-      public void warn(String msg) {
-        // ignore
-      }
-
-      @Override
-      public void error(String msg) {
-        // ignore
-      }
-
-      @Override
-      public void error(String msg, Throwable t) {
-        // ignore
-      }
-    };
-  }
 }

src/test/java/pl/project13/core/cibuild/BuildServerDataProviderTest.java

@@ -0,0 +1,79 @@
+package pl.project13.core.cibuild;
+
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+import pl.project13.core.GitCommitPropertyConstant;
+import pl.project13.core.log.DummyLogInterface;
+
+import java.util.Map;
+import java.util.Properties;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class BuildServerDataProviderTest {
+  @Test
+  void shouldSelectGithubAsDataProvider() {
+    Map<String, String> environment = Map.of("GITHUB_ACTIONS", "true");
+
+    BuildServerDataProvider provider = BuildServerDataProvider.getBuildServerProvider(environment, new DummyLogInterface());
+
+    assertThat(provider).isInstanceOf(GitHubBuildServerData.class);
+  }
+
+  @Nested
+  class GithubProviderTests {
+    @Test
+    void shouldVerifyOnGithubEnvironment() {
+      Map<String, String> environment = Map.of("GITHUB_ACTIONS", "true");
+
+      assertThat(GitHubBuildServerData.isActiveServer(environment)).isTrue();
+    }
+
+    @Test
+    void shouldLoadBuildNumber() {
+      Properties properties = new Properties();
+      Map<String, String> environment = Map.of("GITHUB_RUN_NUMBER", "123");
+      GitHubBuildServerData provider = new GitHubBuildServerData(new DummyLogInterface(), environment);
+
+      provider.loadBuildNumber(properties);
+
+      assertThat(properties).containsEntry(GitCommitPropertyConstant.BUILD_NUMBER, "123");
+    }
+
+    @Test
+    void shouldLoadBuildNumberAsEmptyIfNotAvailable() {
+      Properties properties = new Properties();
+      Map<String, String> environment = Map.of();
+      GitHubBuildServerData provider = new GitHubBuildServerData(new DummyLogInterface(), environment);
+
+      provider.loadBuildNumber(properties);
+
+      assertThat(properties).containsEntry(GitCommitPropertyConstant.BUILD_NUMBER, "");
+    }
+
+    @Test
+    void shouldLoadBranchNameForPullRequestBuild() {
+      Map<String, String> environment = Map.of("GITHUB_REF", "refs/pull/feature_branch",
+          "GITHUB_HEAD_REF", "feature_branch");
+      GitHubBuildServerData provider = new GitHubBuildServerData(new DummyLogInterface(), environment);
+
+      assertThat(provider.getBuildBranch()).isEqualTo("feature_branch");
+    }
+
+    @Test
+    void shouldLoadBranchNameForBranchBuild() {
+      Map<String, String> environment = Map.of("GITHUB_REF", "refs/heads/feature_branch");
+      GitHubBuildServerData provider = new GitHubBuildServerData(new DummyLogInterface(), environment);
+
+      assertThat(provider.getBuildBranch()).isEqualTo("feature_branch");
+    }
+
+    @Test
+    void shouldLoadBranchNameAsEmptyIfNotAvailable() {
+      Map<String, String> environment = Map.of();
+      GitHubBuildServerData provider = new GitHubBuildServerData(new DummyLogInterface(), environment);
+
+      assertThat(provider.getBuildBranch()).isEmpty();
+    }
+  }
+}

src/test/java/pl/project13/core/log/DummyLogInterface.java

@@ -0,0 +1,28 @@
+package pl.project13.core.log;
+
+public class DummyLogInterface implements LogInterface {
+  @Override
+  public void debug(String msg) {
+    // ignore
+  }
+
+  @Override
+  public void info(String msg) {
+    // ignore
+  }
+
+  @Override
+  public void warn(String msg) {
+    // ignore
+  }
+
+  @Override
+  public void error(String msg) {
+    // ignore
+  }
+
+  @Override
+  public void error(String msg, Throwable t) {
+    // ignore
+  }
+}