[java] create CI Tool classes instead of using a map of constants (#335)

* [java] create CI Tool classes instead of using a map of constants

* [java] update CI Tool classes to look for user overrides

Author: titusfortner

java/main/src/main/java/com/saucelabs/saucebindings/CITools.java

@@ -1,48 +1,38 @@
 package com.saucelabs.saucebindings;
 
-import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
+import com.saucelabs.saucebindings.citools.Bamboo;
+import com.saucelabs.saucebindings.citools.CITool;
+import com.saucelabs.saucebindings.citools.CircleCI;
+import com.saucelabs.saucebindings.citools.DefaultTool;
+import com.saucelabs.saucebindings.citools.GitHub;
+import com.saucelabs.saucebindings.citools.GitLab;
+import com.saucelabs.saucebindings.citools.Jenkins;
+import com.saucelabs.saucebindings.citools.TeamCity;
+import com.saucelabs.saucebindings.citools.TravisCI;
 import java.util.Map;
+import java.util.function.Supplier;
 
 /**
  * Determines the information a test needs based on what CI Tool is being used. It does not need to
  * be initialized.
  */
 public abstract class CITools {
-  private static String ciToolName;
+  private static CITool ciTool;
 
   /** Map of CI Tools and what Environment variable, if present, indicates its usage. */
-  public static final Map<String, String> KNOWN_TOOLS =
+  public static final Map<String, Supplier<CITool>> KNOWN_TOOLS =
       ImmutableMap.of(
-          "Bamboo", "bamboo_agentId",
-          "Circle", "CIRCLE_JOB",
-          "Github", "GITHUB_SHA",
-          "GitLab", "CI",
-          "Jenkins", "JENKINS_HOME",
-          "TeamCity", "TEAMCITY_PROJECT_NAME",
-          "Travis", "TRAVIS_JOB_ID");
-
-  /** The Build Name and Build Number values to properly differentiate test runs. */
-  public static final Map<String, ImmutableList<String>> BUILD_VALUES =
-      ImmutableMap.of(
-          "Bamboo", ImmutableList.of("bamboo_shortJobName", "bamboo_buildNumber"),
-          "Circle", ImmutableList.of("CIRCLE_JOB", "CIRCLE_BUILD_NUM"),
-          "Github", ImmutableList.of("GITHUB_JOB", "GITHUB_RUN_NUMBER"),
-          "GitLab", ImmutableList.of("CI_JOB_NAME", "CI_JOB_ID"),
-          "Jenkins", ImmutableList.of("BUILD_NAME", "BUILD_NUMBER"),
-          "TeamCity", ImmutableList.of("TEAMCITY_PROJECT_NAME", "BUILD_NUMBER"),
-          "Travis", ImmutableList.of("TRAVIS_JOB_NAME", "TRAVIS_JOB_NUMBER"));
+          "bamboo_agentId", Bamboo::new,
+          "CIRCLE_JOB", CircleCI::new,
+          "GITHUB_SHA", GitHub::new,
+          "CI", GitLab::new,
+          "JENKINS_HOME", Jenkins::new,
+          "TEAMCITY_PROJECT_NAME", TeamCity::new,
+          "TRAVIS_JOB_ID", TravisCI::new);
 
   public static String getCiToolName() {
-    if (ciToolName == null) {
-      for (Map.Entry<String, String> tool : KNOWN_TOOLS.entrySet()) {
-        if (SystemManager.get(tool.getValue()) != null) {
-          ciToolName = tool.getKey();
-          return ciToolName;
-        }
-      }
-    }
-    return ciToolName == null ? "unknown" : ciToolName;
+    return getCiTool().getClientPlatform();
   }
 
   /**
@@ -51,11 +41,7 @@ public static String getCiToolName() {
    * @return the constant name of the build
    */
   public static String getBuildName() {
-    if (!getCiToolName().equalsIgnoreCase("unknown")) {
-      String buildNameKey = BUILD_VALUES.get(getCiToolName()).get(0);
-      return SystemManager.get(buildNameKey);
-    }
-    return "Default Build Name";
+    return getCiTool().getBuildName();
   }
 
   /**
@@ -64,10 +50,24 @@ public static String getBuildName() {
    * @return the variable number of the current build
    */
   public static String getBuildNumber() {
-    if (!getCiToolName().equalsIgnoreCase("unknown")) {
-      String buildNumberKey = BUILD_VALUES.get(getCiToolName()).get(1);
-      return SystemManager.get(buildNumberKey);
+    return getCiTool().getBuildNumber();
+  }
+
+  private static CITool getCiTool() {
+    if (ciTool != null) {
+      return ciTool;
+    } else if (SystemManager.get("SAUCE_CLIENT_PLATFORM") != null) {
+      // Override the CI Tool lookup when this environment variable is set.
+      return new DefaultTool();
+    } else {
+      for (Map.Entry<String, Supplier<CITool>> tool : KNOWN_TOOLS.entrySet()) {
+        if (System.getenv(tool.getKey()) != null) {
+          ciTool = tool.getValue().get();
+          return ciTool;
+        }
+      }
+      ciTool = new DefaultTool();
+      return ciTool;
     }
-    return String.valueOf(System.currentTimeMillis());
   }
 }

java/main/src/main/java/com/saucelabs/saucebindings/SystemManager.java

@@ -26,10 +26,17 @@ public static String get(String key, String errorMessage) {
    * @return the value of the provided field name
    */
   public static String get(String key) {
+    String systemPropertyKey = key.toLowerCase().replace("_", ".");
+    String systemEnvKey = key.toUpperCase().replace(".", "_");
+
     if (System.getProperty(key) != null) {
-      return System.getProperty(key);
+      return System.getProperty(systemPropertyKey);
     } else if (System.getenv(key) != null) {
       return System.getenv(key);
+    } else if (System.getProperty(systemPropertyKey) != null) {
+      return System.getProperty(systemPropertyKey);
+    } else if (System.getenv(systemEnvKey) != null) {
+      return System.getenv(systemEnvKey);
     } else {
       return null;
     }

java/main/src/main/java/com/saucelabs/saucebindings/citools/Bamboo.java

@@ -0,0 +1,23 @@
+package com.saucelabs.saucebindings.citools;
+
+import com.saucelabs.saucebindings.SystemManager;
+
+public class Bamboo implements CITool {
+
+  @Override
+  public String getClientPlatform() {
+    return "Bamboo";
+  }
+
+  @Override
+  public String getBuildName() {
+    String buildName = SystemManager.get("SAUCE_BUILD_NAME");
+    return buildName != null ? buildName : System.getenv("bamboo_shortJobName");
+  }
+
+  @Override
+  public String getBuildNumber() {
+    String buildNumber = SystemManager.get("SAUCE_BUILD_NUMBER");
+    return buildNumber != null ? buildNumber : System.getenv("bamboo_buildNumber");
+  }
+}

java/main/src/main/java/com/saucelabs/saucebindings/citools/CITool.java

@@ -0,0 +1,9 @@
+package com.saucelabs.saucebindings.citools;
+
+public interface CITool {
+  String getClientPlatform();
+
+  String getBuildName();
+
+  String getBuildNumber();
+}

java/main/src/main/java/com/saucelabs/saucebindings/citools/CircleCI.java

@@ -0,0 +1,23 @@
+package com.saucelabs.saucebindings.citools;
+
+import com.saucelabs.saucebindings.SystemManager;
+
+public class CircleCI implements CITool {
+
+  @Override
+  public String getClientPlatform() {
+    return "Circle CI";
+  }
+
+  @Override
+  public String getBuildName() {
+    String buildName = SystemManager.get("SAUCE_BUILD_NAME");
+    return buildName != null ? buildName : System.getenv("CIRCLE_JOB");
+  }
+
+  @Override
+  public String getBuildNumber() {
+    String buildNumber = SystemManager.get("SAUCE_BUILD_NUMBER");
+    return buildNumber != null ? buildNumber : System.getenv("CIRCLE_BUILD_NUM");
+  }
+}

java/main/src/main/java/com/saucelabs/saucebindings/citools/DefaultTool.java

@@ -0,0 +1,24 @@
+package com.saucelabs.saucebindings.citools;
+
+import com.saucelabs.saucebindings.SystemManager;
+
+public class DefaultTool implements CITool {
+
+  @Override
+  public String getClientPlatform() {
+    String clientPlatform = SystemManager.get("SAUCE_CLIENT_PLATFORM");
+    return clientPlatform != null ? clientPlatform : "Unknown";
+  }
+
+  @Override
+  public String getBuildName() {
+    String buildName = SystemManager.get("SAUCE_BUILD_NAME");
+    return buildName != null ? buildName : "Undefined Build Name";
+  }
+
+  @Override
+  public String getBuildNumber() {
+    String buildNumber = SystemManager.get("SAUCE_BUILD_NUMBER");
+    return buildNumber != null ? buildNumber : String.valueOf(System.currentTimeMillis());
+  }
+}

java/main/src/main/java/com/saucelabs/saucebindings/citools/GitHub.java

@@ -0,0 +1,26 @@
+package com.saucelabs.saucebindings.citools;
+
+import com.saucelabs.saucebindings.SystemManager;
+
+public class GitHub implements CITool {
+
+  @Override
+  public String getClientPlatform() {
+    return "GitHub";
+  }
+
+  @Override
+  public String getBuildName() {
+    String buildName = SystemManager.get("SAUCE_BUILD_NAME");
+    String workflow = System.getenv("GITHUB_WORKFLOW");
+    String jobName = System.getenv("GITHUB_JOB");
+
+    return buildName != null ? buildName : workflow + " / " + jobName;
+  }
+
+  @Override
+  public String getBuildNumber() {
+    String buildNumber = SystemManager.get("SAUCE_BUILD_NUMBER");
+    return buildNumber != null ? buildNumber : System.getenv("GITHUB_RUN_NUMBER");
+  }
+}

java/main/src/main/java/com/saucelabs/saucebindings/citools/GitLab.java

@@ -0,0 +1,23 @@
+package com.saucelabs.saucebindings.citools;
+
+import com.saucelabs.saucebindings.SystemManager;
+
+public class GitLab implements CITool {
+
+  @Override
+  public String getClientPlatform() {
+    return "GitLab";
+  }
+
+  @Override
+  public String getBuildName() {
+    String buildName = SystemManager.get("SAUCE_BUILD_NAME");
+    return buildName != null ? buildName : System.getenv("CI_JOB_NAME");
+  }
+
+  @Override
+  public String getBuildNumber() {
+    String buildNumber = SystemManager.get("SAUCE_BUILD_NUMBER");
+    return buildNumber != null ? buildNumber : System.getenv("CI_JOB_ID");
+  }
+}

java/main/src/main/java/com/saucelabs/saucebindings/citools/Jenkins.java

@@ -0,0 +1,23 @@
+package com.saucelabs.saucebindings.citools;
+
+import com.saucelabs.saucebindings.SystemManager;
+
+public class Jenkins implements CITool {
+
+  @Override
+  public String getClientPlatform() {
+    return "Jenkins";
+  }
+
+  @Override
+  public String getBuildName() {
+    String buildName = SystemManager.get("SAUCE_BUILD_NAME");
+    return buildName != null ? buildName : System.getenv("BUILD_NAME");
+  }
+
+  @Override
+  public String getBuildNumber() {
+    String buildNumber = SystemManager.get("SAUCE_BUILD_NUMBER");
+    return buildNumber != null ? buildNumber : System.getenv("BUILD_NUMBER");
+  }
+}

java/main/src/main/java/com/saucelabs/saucebindings/citools/TeamCity.java

@@ -0,0 +1,23 @@
+package com.saucelabs.saucebindings.citools;
+
+import com.saucelabs.saucebindings.SystemManager;
+
+public class TeamCity implements CITool {
+
+  @Override
+  public String getClientPlatform() {
+    return "Team City";
+  }
+
+  @Override
+  public String getBuildName() {
+    String buildName = SystemManager.get("SAUCE_BUILD_NAME");
+    return buildName != null ? buildName : System.getenv("TEAMCITY_PROJECT_NAME");
+  }
+
+  @Override
+  public String getBuildNumber() {
+    String buildNumber = SystemManager.get("SAUCE_BUILD_NUMBER");
+    return buildNumber != null ? buildNumber : System.getenv("BUILD_NUMBER");
+  }
+}

java/main/src/main/java/com/saucelabs/saucebindings/citools/TravisCI.java

@@ -0,0 +1,23 @@
+package com.saucelabs.saucebindings.citools;
+
+import com.saucelabs.saucebindings.SystemManager;
+
+public class TravisCI implements CITool {
+
+  @Override
+  public String getClientPlatform() {
+    return "Travis CI";
+  }
+
+  @Override
+  public String getBuildName() {
+    String buildName = SystemManager.get("SAUCE_BUILD_NAME");
+    return buildName != null ? buildName : System.getenv("TRAVIS_JOB_NAME");
+  }
+
+  @Override
+  public String getBuildNumber() {
+    String buildNumber = SystemManager.get("SAUCE_BUILD_NUMBER");
+    return buildNumber != null ? buildNumber : System.getenv("TRAVIS_JOB_NUMBER");
+  }
+}