com.saucelabs.saucebindings.CITools Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sauce_bindings Show documentation

Java library which provides tools for interacting with Sauce Labs

The newest version!

package com.saucelabs.saucebindings;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import java.util.Map;

/**
 * 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 buildName = "Default Build Name";
  private static String buildNumber = String.valueOf(System.currentTimeMillis());
  private static Boolean buildInfoStored = false;

  /** Map of CI Tools and what Environment variable, if present, indicates its usage. */
  public static final Map 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> BUILD_VALUES =
      ImmutableMap.of(
          "Bamboo", ImmutableList.of("bamboo_shortJobName", "bamboo_buildNumber"),
          "Circle", ImmutableList.of("CIRCLE_JOB", "CIRCLE_BUILD_NUM"),
          "Github", ImmutableList.of("GITHUB_WORKFLOW", "GITHUB_SHA"),
          "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"));

  private static void storeBuildInfo() {
    if (buildInfoStored) {
      return;
    }

    for (Map.Entry tool : KNOWN_TOOLS.entrySet()) {
      if (SystemManager.get(tool.getValue()) != null) {
        buildName = BUILD_VALUES.get(tool.getKey()).get(0);
        buildNumber = BUILD_VALUES.get(tool.getKey()).get(1);
        buildInfoStored = true;
        break;
      }
    }
  }

  /**
   * The default build name based on CI Tool.
   *
   * @return the constant name of the build
   */
  public static String getBuildName() {
    storeBuildInfo();
    return buildName;
  }

  /**
   * The default build number based on CI Tool.
   *
   * @return the variable number of the current build
   */
  public static String getBuildNumber() {
    storeBuildInfo();
    return buildNumber;
  }
}