provider_template.ts

import { IServiceParams, UploaderEnvs, UploaderInputs } from '../types'

/**
 * Detects if this CI provider is being used
 *
 * @param {*} envs an object of enviromental variable key/value pairs
 * @returns boolean
 */

// eslint-disable-next-line @typescript-eslint/no-unused-vars
export function detect(envs: UploaderEnvs): boolean {
  return false
}

/**
 * Determine the build number, based on args and envs
 *
 * @param {args: {}, envs: {}} inputs an object of arguments and enviromental variable key/value pairs
 * @returns {string}
 */
function _getBuild(inputs: UploaderInputs): string {
  const { args } = inputs
  return args.build || ''
}

/**
 * Determine the build URL for use in the Codecov UI
 *
 * @param {args: {}, envs: {}} inputs an object of arguments and enviromental variable key/value pairs
 * @returns {string}
 */
// eslint-disable-next-line @typescript-eslint/no-unused-vars
function _getBuildURL(inputs: UploaderInputs): string {
  return ''
}

/**
 * Determine the branch of the repository, based on args and envs
 *
 * @param {args: {}, envs: {}} inputs an object of arguments and enviromental variable key/value pairs
 * @returns {string}
 */
function _getBranch(inputs: UploaderInputs): string {
  const { args } = inputs
  try {
    return args.branch || ''
  } catch (error) {
    throw new Error(
      `There was an error getting the branch name from git: ${error}`,
    )
  }
}

/**
 * Determine the job number, based on args or envs
 *
 * @param {*} envs an object of enviromental variable key/value pairs
 * @returns {string}
 */
// eslint-disable-next-line @typescript-eslint/no-unused-vars
function _getJob(envs: UploaderEnvs): string {
  return ''
}

/**
 * Determine the PR number, based on args and envs
 *
 * @param {args: {}, envs: {}} inputs an object of arguments and enviromental variable key/value pairs
 * @returns {string}
 */
// eslint-disable-next-line @typescript-eslint/no-unused-vars
function _getPR(inputs: UploaderInputs): string {
  const { args } = inputs
  try {
    return args.pr || ''
  } catch (error) {
    throw new Error(`There was an error getting the pr number: ${error}`)
  }
}

/**
 * The CI service name that gets sent to the Codecov uploader as part of the query string
 *
 * @returns {string}
 */
function _getService(): string {
  return ''
}

/**
 * The CI Service name that gets displayed when running the uploader
 *
 * @returns
 */
export function getServiceName(): string {
  return ''
}
/**
 * Determine the commit SHA that is being uploaded, based on args or envs
 *
 * @param {args: {}, envs: {}} inputs an object of arguments and enviromental variable key/value pairs
 * @returns {string}
 */
function _getSHA(inputs: UploaderInputs): string {
  const { args } = inputs
  try {
    return args.sha || ''
  } catch (error) {
    throw new Error(
      `There was an error getting the commit SHA from git: ${error}`,
    )
  }
}
/**
 * Determine the slug (org/repo) based on  args or envs
 *
 * @param {args: {}, envs: {}} inputs an object of arguments and enviromental variable key/value pairs
 * @returns {string}
 */
function _getSlug(inputs: UploaderInputs): string {
  const { args } = inputs
  try {
    return args.slug || ''
  } catch (error) {
    throw new Error(`There was an error getting the slug from git: ${error}`)
  }
}
/**
 * Generates and return the serviceParams object
 *
 * @param {args: {}, envs: {}} inputs an object of arguments and enviromental variable key/value pairs
 * @returns {{ branch: string, build: string, buildURL: string, commit: string, job: string, pr: string, service: string, slug: string }}
 */
export async function getServiceParams(inputs: UploaderInputs): Promise<IServiceParams> {
  return {
    branch: _getBranch(inputs),
    build: _getBuild(inputs),
    buildURL: _getBuildURL(inputs),
    commit: _getSHA(inputs),
    job: _getJob(inputs.envs),
    pr: _getPR(inputs),
    service: _getService(),
    slug: _getSlug(inputs),
  }
}

/**
 * Returns all the environment variables used by the provider
 *
 * @returns [{string}]
 */
export function getEnvVarNames(): string[] {
  return []
}