@stryker-mutator/core/src/reporters/ci/provider.ts

The extendable JavaScript mutation testing framework

import { objectUtils } from '../../utils/object-utils.js';

import { CircleProvider } from './circle-provider.js';
import { TravisProvider } from './travis-provider.js';
import { GithubActionsCIProvider } from './github-actions-provider.js';

/**
 * Represents an object that can provide information about a CI/CD provider.
 */
export interface CIProvider {
  /**
   * Determine the repository slug, including the git provider. I.E: github.com/stryker-mutator/stryker or bitbucket.org/org/name.
   */
  determineProject(): string | undefined;
  /**
   * Determine the current version. I.e. branch name, git sha, or tag name
   */
  determineVersion(): string | undefined;
}

/**
 * Return an appropriate instance of CiProvider.
 * @returns An instance of CiProvider, or `null` if it appears Stryker is not running in a CI/CD environment.
 */
export function determineCIProvider():
  | CircleProvider
  | GithubActionsCIProvider
  | TravisProvider
  | null {
  // By far the coolest env. variable from all those listed at
  // https://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables
  if (objectUtils.getEnvironmentVariable('HAS_JOSH_K_SEAL_OF_APPROVAL')) {
    return new TravisProvider();
  } else if (objectUtils.getEnvironmentVariable('CIRCLECI')) {
    return new CircleProvider();
  } else if (objectUtils.getEnvironmentVariable('GITHUB_ACTION')) {
    return new GithubActionsCIProvider();
  }
  // TODO: Add vsts and gitlab CI

  return null;
}