codecov-cli 11.0.0__py3-none-any.whl

codecov_cli/helpers/args.py

@@ -0,0 +1,31 @@
+import json
+import logging
+from pathlib import PosixPath
+
+import click
+
+from codecov_cli import __version__
+
+logger = logging.getLogger("codecovcli")
+
+
+def get_cli_args(ctx: click.Context):
+    args = ctx.obj["cli_args"]
+    args["command"] = str(ctx.command.name)
+    args["version"] = f"cli-{__version__}"
+    args.update(ctx.params)
+    if "token" in args:
+        del args["token"]
+
+    filtered_args = {}
+    for k in args.keys():
+        try:
+            if isinstance(args[k], PosixPath):
+                filtered_args[k] = str(args[k])
+            else:
+                json.dumps(args[k])
+                filtered_args[k] = args[k]
+        except Exception:
+            continue
+
+    return filtered_args

codecov_cli/helpers/ci_adapters/__init__.py

@@ -0,0 +1,63 @@
+import logging
+from typing import Optional
+
+from codecov_cli.helpers.ci_adapters.appveyor_ci import AppveyorCIAdapter
+from codecov_cli.helpers.ci_adapters.azure_pipelines import AzurePipelinesCIAdapter
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+from codecov_cli.helpers.ci_adapters.bitbucket_ci import BitbucketAdapter
+from codecov_cli.helpers.ci_adapters.bitrise_ci import BitriseCIAdapter
+from codecov_cli.helpers.ci_adapters.buildkite import BuildkiteAdapter
+from codecov_cli.helpers.ci_adapters.circleci import CircleCICIAdapter
+from codecov_cli.helpers.ci_adapters.cirrus_ci import CirrusCIAdapter
+from codecov_cli.helpers.ci_adapters.cloudbuild import GoogleCloudBuildAdapter
+from codecov_cli.helpers.ci_adapters.codebuild import AWSCodeBuildCIAdapter
+from codecov_cli.helpers.ci_adapters.droneci import DroneCIAdapter
+from codecov_cli.helpers.ci_adapters.github_actions import GithubActionsCIAdapter
+from codecov_cli.helpers.ci_adapters.gitlab_ci import GitlabCIAdapter
+from codecov_cli.helpers.ci_adapters.heroku import HerokuCIAdapter
+from codecov_cli.helpers.ci_adapters.jenkins import JenkinsAdapter
+from codecov_cli.helpers.ci_adapters.local import LocalAdapter
+from codecov_cli.helpers.ci_adapters.teamcity import TeamcityAdapter
+from codecov_cli.helpers.ci_adapters.travis_ci import TravisCIAdapter
+from codecov_cli.helpers.ci_adapters.woodpeckerci import WoodpeckerCIAdapter
+
+logger = logging.getLogger("codecovcli")
+
+
+def get_ci_adapter(provider_name: str = None) -> Optional[CIAdapterBase]:
+    if provider_name:
+        for provider in get_ci_providers_list():
+            if provider.get_service_name().lower() == provider_name.lower():
+                logger.debug(f"Using ci service from provider name: {provider_name}")
+                return provider
+    else:
+        for provider in get_ci_providers_list():
+            if provider.detect():
+                logger.info(f"ci service found: {provider._get_service()}")
+                return provider
+    logger.warning("No ci adapter found")
+    return None
+
+
+def get_ci_providers_list():
+    return [
+        CircleCICIAdapter(),
+        GithubActionsCIAdapter(),
+        GitlabCIAdapter(),
+        BitbucketAdapter(),
+        BitriseCIAdapter(),
+        AppveyorCIAdapter(),
+        WoodpeckerCIAdapter(),
+        HerokuCIAdapter(),
+        DroneCIAdapter(),
+        BuildkiteAdapter(),
+        AzurePipelinesCIAdapter(),
+        JenkinsAdapter(),
+        CirrusCIAdapter(),
+        TeamcityAdapter(),
+        TravisCIAdapter(),
+        AWSCodeBuildCIAdapter(),
+        GoogleCloudBuildAdapter(),
+        # local adapter should always be the last one
+        LocalAdapter(),
+    ]

codecov_cli/helpers/ci_adapters/appveyor_ci.py

@@ -0,0 +1,54 @@
+import os
+
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+
+
+class AppveyorCIAdapter(CIAdapterBase):
+    # https://www.appveyor.com/docs/environment-variables/
+
+    def detect(self) -> bool:
+        return bool(os.getenv("CI")) and bool(os.getenv("APPVEYOR"))
+
+    def _get_commit_sha(self):
+        return os.getenv("APPVEYOR_PULL_REQUEST_HEAD_COMMIT") or os.getenv(
+            "APPVEYOR_REPO_COMMIT"
+        )
+
+    def _get_build_url(self):
+        url = os.getenv("APPVEYOR_URL")
+        repo_name = os.getenv("APPVEYOR_REPO_NAME")
+        build_id = os.getenv("APPVEYOR_BUILD_ID")
+        job_id = os.getenv("APPVEYOR_JOB_ID")
+
+        if url and repo_name and build_id and job_id:
+            return f"{url}/project/{repo_name}/builds/{build_id}/job/{job_id}"
+
+        return None
+
+    def _get_build_code(self):
+        return os.getenv("APPVEYOR_JOB_ID")
+
+    def _get_job_code(self):
+        account_name = os.getenv("APPVEYOR_ACCOUNT_NAME")
+        slug = os.getenv("APPVEYOR_PROJECT_SLUG")
+        build_version = os.getenv("APPVEYOR_BUILD_VERSION")
+
+        if account_name and slug and build_version:
+            return f"{account_name}/{slug}/{build_version}"
+
+        return None
+
+    def _get_pull_request_number(self):
+        return os.getenv("APPVEYOR_PULL_REQUEST_NUMBER")
+
+    def _get_slug(self):
+        return os.getenv("APPVEYOR_REPO_NAME")
+
+    def _get_branch(self):
+        return os.getenv("APPVEYOR_REPO_BRANCH")
+
+    def _get_service(self):
+        return "appveyor"
+
+    def get_service_name(self):
+        return "AppVeyor"

codecov_cli/helpers/ci_adapters/azure_pipelines.py

@@ -0,0 +1,44 @@
+import os
+
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+
+
+class AzurePipelinesCIAdapter(CIAdapterBase):
+    # https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#build-variables-devops-services
+
+    def detect(self) -> bool:
+        return bool(os.getenv("SYSTEM_TEAMFOUNDATIONCOLLECTIONURI"))
+
+    def _get_commit_sha(self):
+        return os.getenv("SYSTEM_PULLREQUEST_SOURCECOMMITID") or os.getenv(
+            "BUILD_SOURCEVERSION"
+        )
+
+    def _get_build_url(self):
+        if os.getenv("SYSTEM_TEAMPROJECT") and os.getenv("BUILD_BUILDID"):
+            return f"{os.getenv('SYSTEM_TEAMFOUNDATIONCOLLECTIONURI')}{os.getenv('SYSTEM_TEAMPROJECT')}/_build/results?buildId={os.getenv('BUILD_BUILDID')}"
+
+    def _get_build_code(self):
+        return os.getenv("BUILD_BUILDNUMBER")
+
+    def _get_job_code(self):
+        return os.getenv("BUILD_BUILDID")
+
+    def _get_pull_request_number(self):
+        return os.getenv("SYSTEM_PULLREQUEST_PULLREQUESTNUMBER") or os.getenv(
+            "SYSTEM_PULLREQUEST_PULLREQUESTID"
+        )
+
+    def _get_slug(self):
+        return os.getenv("BUILD_REPOSITORY_NAME")
+
+    def _get_branch(self):
+        branch = os.getenv("BUILD_SOURCEBRANCH")
+        if branch:
+            return branch.replace("refs/heads/", "")
+
+    def _get_service(self):
+        return "azure_pipelines"
+
+    def get_service_name(self):
+        return "AzurePipelines"

codecov_cli/helpers/ci_adapters/base.py

@@ -0,0 +1,102 @@
+import typing
+from abc import ABC
+
+from codecov_cli.fallbacks import FallbackFieldEnum
+
+
+class CIAdapterBase(ABC):
+    def __init__(self):
+        # If a fallbacker has extra fields, they should be added to this dictionary in the fallbacker's constructor.
+        self.fallback_to_method = {
+            FallbackFieldEnum.branch: self._get_branch,
+            FallbackFieldEnum.build_code: self._get_build_code,
+            FallbackFieldEnum.build_url: self._get_build_url,
+            FallbackFieldEnum.commit_sha: self._get_commit_sha,
+            FallbackFieldEnum.slug: self._get_slug,
+            FallbackFieldEnum.service: self._get_service,
+            FallbackFieldEnum.pull_request_number: self._get_pull_request_number,
+            FallbackFieldEnum.job_code: self._get_job_code,
+            FallbackFieldEnum.git_service: self._get_git_service,
+        }
+
+    def get_fallback_value(
+        self, fallback_field: FallbackFieldEnum
+    ) -> typing.Optional[str]:
+        if fallback_field not in self.fallback_to_method:
+            raise ValueError("The provided fallback_field is not valid")
+
+        return self.fallback_to_method[fallback_field]()
+
+    def detect(self) -> bool:
+        """
+        Detects if this CI provider is being used
+        Returns bool
+        """
+        raise NotImplementedError("`detect()` must be implemented.")
+
+    def _get_branch(self):
+        """
+        Determine the branch of the repository based on envs
+        Returns: string
+        """
+        raise NotImplementedError("`_get_branch()` must be implemented.")
+
+    def _get_commit_sha(self):
+        """
+        Determine the commit SHA that is being uploaded, based on envs
+        Returns: string
+        """
+        raise NotImplementedError("`_get_commit_sha()` must be implemented.")
+
+    def _get_slug(self):
+        """
+        Determine the slug (org/repo) based on envs
+        Returns: string
+        """
+        raise NotImplementedError("`_get_slug()` must be implemented.")
+
+    def _get_service(self):
+        """
+        The CI service name that gets sent to the Codecov uploader as part of the query string
+        It gets displayed in the Codecov UI
+        Returns: string
+        """
+        raise NotImplementedError("`_get_service()` must be implemented.")
+
+    def _get_build_url(self):
+        """
+        Determine the build URL for use in the Codecov UI
+        Returns: string
+        """
+        raise NotImplementedError("`_get_build_url()` must be implemented.")
+
+    def _get_build_code(self):
+        """
+        Determine the build number, based on envs
+        Returns: string
+        """
+        raise NotImplementedError("`_get_build_code()` must be implemented.")
+
+    def _get_job_code(self):
+        """
+        Determine the job number, based on envs
+        Returns: string
+        """
+        raise NotImplementedError("`_get_job_code()` must be implemented.")
+
+    def _get_pull_request_number(self):
+        """
+        Determine the PR number, based on envs
+        Returns: string
+        """
+        raise NotImplementedError("`_get_pull_request_number()` must be implemented.")
+
+    def get_service_name(self):
+        """
+        The CI Service name that gets displayed when running the uploader
+        Returns: string
+        """
+        raise NotImplementedError("`get_service_name()` must be implemented.")
+
+    def _get_git_service(self):
+        return None

codecov_cli/helpers/ci_adapters/bitbucket_ci.py

@@ -0,0 +1,42 @@
+import os
+
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+
+
+class BitbucketAdapter(CIAdapterBase):
+    # https://support.atlassian.com/bitbucket-cloud/docs/variables-and-secrets/
+
+    def detect(self) -> bool:
+        return bool(os.getenv("CI")) and bool(os.getenv("BITBUCKET_BUILD_NUMBER"))
+
+    def _get_commit_sha(self):
+        commit = os.getenv("BITBUCKET_COMMIT")
+
+        if not commit or len(commit) == 12:
+            return None
+
+        return commit
+
+    def _get_build_url(self):
+        return None
+
+    def _get_build_code(self):
+        return os.getenv("BITBUCKET_BUILD_NUMBER")
+
+    def _get_job_code(self):
+        return os.getenv("BITBUCKET_BUILD_NUMBER")
+
+    def _get_pull_request_number(self):
+        return os.getenv("BITBUCKET_PR_ID")
+
+    def _get_slug(self):
+        return os.getenv("BITBUCKET_REPO_FULL_NAME")
+
+    def _get_branch(self):
+        return os.getenv("BITBUCKET_BRANCH")
+
+    def _get_service(self):
+        return "bitbucket"
+
+    def get_service_name(self):
+        return "Bitbucket"

codecov_cli/helpers/ci_adapters/bitrise_ci.py

@@ -0,0 +1,37 @@
+import os
+
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+
+
+class BitriseCIAdapter(CIAdapterBase):
+    # https://devcenter.bitrise.io/en/references/available-environment-variables.html
+
+    def detect(self) -> bool:
+        return bool(os.getenv("CI")) and bool(os.getenv("BITRISE_IO"))
+
+    def _get_commit_sha(self):
+        return os.getenv("GIT_CLONE_COMMIT_HASH")
+
+    def _get_build_url(self):
+        return os.getenv("BITRISE_BUILD_URL")
+
+    def _get_build_code(self):
+        return os.getenv("BITRISE_BUILD_NUMBER")
+
+    def _get_job_code(self):
+        return None
+
+    def _get_pull_request_number(self):
+        return os.getenv("BITRISE_PULL_REQUEST")
+
+    def _get_slug(self):
+        return None
+
+    def _get_branch(self):
+        return os.getenv("BITRISE_GIT_BRANCH")
+
+    def _get_service(self):
+        return "bitrise"
+
+    def get_service_name(self):
+        return "Bitrise"

codecov_cli/helpers/ci_adapters/buildkite.py

@@ -0,0 +1,45 @@
+import os
+
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+
+
+class BuildkiteAdapter(CIAdapterBase):
+    # https://buildkite.com/docs/pipelines/environment-variables
+
+    def detect(self) -> bool:
+        return bool(os.getenv("BUILDKITE"))
+
+    def _get_branch(self):
+        return os.getenv("BUILDKITE_BRANCH")
+
+    def _get_build_code(self):
+        return os.getenv("BUILDKITE_BUILD_NUMBER")
+
+    def _get_build_url(self):
+        return os.getenv("BUILDKITE_BUILD_URL")
+
+    def _get_commit_sha(self):
+        return os.getenv("BUILDKITE_COMMIT")
+
+    def _get_slug(self):
+        org = os.getenv("BUILDKITE_ORGANIZATION_SLUG")
+        repo = os.getenv("BUILDKITE_PIPELINE_SLUG")
+        if org and repo:
+            return f"{org}/{repo}"
+        return None
+
+    def _get_service(self):
+        return "buildkite"
+
+    def _get_pull_request_number(self):
+        pr_number = os.getenv("BUILDKITE_PULL_REQUEST")
+        # The number of the pull request, if this branch is a pull request.
+        if pr_number != "false":
+            return pr_number
+        return None
+
+    def _get_job_code(self):
+        return os.getenv("BUILDKITE_JOB_ID")
+
+    def get_service_name(self):
+        return "BuildKite"

codecov_cli/helpers/ci_adapters/circleci.py

@@ -0,0 +1,47 @@
+import os
+
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+
+
+class CircleCICIAdapter(CIAdapterBase):
+    # https://circleci.com/docs/2.0/env-vars/#built-in-environment-variables
+    def detect(self) -> bool:
+        return bool(os.getenv("CI")) and bool(os.getenv("CIRCLECI"))
+
+    def _get_commit_sha(self):
+        return os.getenv("CIRCLE_SHA1")
+
+    def _get_build_url(self):
+        return os.getenv("CIRCLE_BUILD_URL")
+
+    def _get_build_code(self):
+        return os.getenv("CIRCLE_BUILD_NUM")
+
+    def _get_job_code(self):
+        return os.getenv("CIRCLE_NODE_INDEX")
+
+    def _get_pull_request_number(self):
+        return os.getenv("CIRCLE_PR_NUMBER")
+
+    def _get_slug(self):
+        project_username = os.getenv("CIRCLE_PROJECT_USERNAME")
+        project_repo_name = os.getenv("CIRCLE_PROJECT_REPONAME")
+
+        if project_repo_name and project_username:
+            return f"{project_username}/{project_repo_name}"
+
+        repo_url = os.getenv("CIRCLE_REPOSITORY_URL")
+
+        if repo_url:
+            return repo_url.split(":")[1].split(".git")[0]
+
+        return None
+
+    def _get_branch(self):
+        return os.getenv("CIRCLE_BRANCH")
+
+    def _get_service(self):
+        return "circleci"
+
+    def get_service_name(self):
+        return "CircleCI"

codecov_cli/helpers/ci_adapters/cirrus_ci.py

@@ -0,0 +1,36 @@
+import os
+
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+
+
+class CirrusCIAdapter(CIAdapterBase):
+    # https://cirrus-ci.org/guide/writing-tasks/#environment-variables
+    def detect(self) -> bool:
+        return bool(os.getenv("CIRRUS_CI"))
+
+    def _get_branch(self):
+        return os.getenv("CIRRUS_BRANCH")
+
+    def _get_build_code(self):
+        return os.getenv("CIRRUS_BUILD_ID")
+
+    def _get_build_url(self):
+        return None
+
+    def _get_commit_sha(self):
+        return os.getenv("CIRRUS_CHANGE_IN_REPO")
+
+    def _get_slug(self):
+        return os.getenv("CIRRUS_REPO_FULL_NAME")
+
+    def _get_service(self):
+        return "cirrus"
+
+    def _get_pull_request_number(self):
+        return os.getenv("CIRRUS_PR")
+
+    def _get_job_code(self):
+        return os.getenv("CIRRUS_TASK_ID")
+
+    def get_service_name(self):
+        return "CirrusCI"

codecov_cli/helpers/ci_adapters/cloudbuild.py

@@ -0,0 +1,70 @@
+import os
+
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+
+
+class GoogleCloudBuildAdapter(CIAdapterBase):
+    """
+    Google Cloud Build uses variable substitutions in the builds
+    https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values
+    For these to be available as environment variables, so this adapter
+    can read the values, you have to manually map the substitution variables to
+    environment variables on the build step, like this
+    env:
+    - '_PR_NUMBER=$_PR_NUMBER'
+    - 'BRANCH_NAME=$BRANCH_NAME'
+    - 'BUILD_ID=$BUILD_ID'
+    - 'COMMIT_SHA=$COMMIT_SHA'
+    - 'LOCATION=$LOCATION'
+    - 'PROJECT_ID=$PROJECT_ID'
+    - 'PROJECT_NUMBER=$PROJECT_NUMBER'
+    - 'REF_NAME=$REF_NAME'
+    - 'REPO_FULL_NAME=$REPO_FULL_NAME'
+    - 'TRIGGER_NAME=$TRIGGER_NAME'
+    Read more about manual substitution mapping here:
+    https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values#map_substitutions_manually
+    """
+
+    def detect(self) -> bool:
+        return all(
+            list(
+                map(os.getenv, ["LOCATION", "PROJECT_NUMBER", "PROJECT_ID", "BUILD_ID"])
+            )
+        )
+
+    def _get_branch(self):
+        return os.getenv("BRANCH_NAME")
+
+    def _get_build_code(self):
+        return os.getenv("BUILD_ID")
+
+    def _get_commit_sha(self):
+        return os.getenv("COMMIT_SHA")
+
+    def _get_slug(self):
+        return os.getenv("REPO_FULL_NAME")
+
+    def _get_build_url(self):
+        # to build the url, the environment variables LOCATION, PROJECT_ID and BUILD_ID are needed
+        if not all(list(map(os.getenv, ["LOCATION", "PROJECT_ID", "BUILD_ID"]))):
+            return None
+
+        location = os.getenv("LOCATION")
+        project_id = os.getenv("PROJECT_ID")
+        build_id = os.getenv("BUILD_ID")
+
+        return f"https://console.cloud.google.com/cloud-build/builds;region={location}/{build_id}?project={project_id}"
+
+    def _get_pull_request_number(self):
+        pr_num = os.getenv("_PR_NUMBER")
+        return pr_num if pr_num != "" else None
+
+    def _get_job_code(self):
+        job_code = os.getenv("TRIGGER_NAME")
+        return job_code if job_code != "" else None
+
+    def _get_service(self):
+        return "google_cloud_build"
+
+    def get_service_name(self):
+        return "GoogleCloudBuild"

codecov_cli/helpers/ci_adapters/codebuild.py

@@ -0,0 +1,49 @@
+import os
+import re
+
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+
+
+class AWSCodeBuildCIAdapter(CIAdapterBase):
+    # https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html
+    def detect(self) -> bool:
+        return bool(os.getenv("CODEBUILD_CI"))
+
+    def _get_branch(self):
+        branch = os.getenv("CODEBUILD_WEBHOOK_HEAD_REF")
+        if branch:
+            return re.sub(r"^refs\/heads\/", "", branch)
+        return None
+
+    def _get_build_code(self):
+        return os.getenv("CODEBUILD_BUILD_ID")
+
+    def _get_build_url(self):
+        return None
+
+    def _get_commit_sha(self):
+        return os.getenv("CODEBUILD_RESOLVED_SOURCE_VERSION")
+
+    def _get_slug(self):
+        slug = os.getenv("CODEBUILD_SOURCE_REPO_URL")
+        if slug:
+            slug = re.sub(r"^.*github.com\/", "", slug)
+            slug = re.sub(r"^.*gitlab.com\/", "", slug)
+            slug = re.sub(r"^.*bitbucket.com\/", "", slug)
+            return re.sub(r"\.git$", "", slug)
+        return None
+
+    def _get_service(self):
+        return "AWS CodeBuild"
+
+    def _get_pull_request_number(self):
+        pr = os.getenv("CODEBUILD_SOURCE_VERSION")
+        if pr and pr.startswith("pr/"):
+            return re.sub(r"^pr\/", "", pr)
+        return None
+
+    def _get_job_code(self):
+        return os.getenv("CODEBUILD_BUILD_ID")
+
+    def get_service_name(self):
+        return "AWSCodeBuild"

codecov_cli/helpers/ci_adapters/droneci.py

@@ -0,0 +1,36 @@
+import os
+
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+
+
+class DroneCIAdapter(CIAdapterBase):
+    # https://docs.drone.io/pipeline/environment/reference/
+    def detect(self) -> bool:
+        return bool(os.getenv("DRONE"))
+
+    def _get_branch(self):
+        return os.getenv("DRONE_BRANCH")
+
+    def _get_build_code(self):
+        return os.getenv("DRONE_BUILD_NUMBER")
+
+    def _get_build_url(self):
+        return os.getenv("DRONE_BUILD_LINK")
+
+    def _get_commit_sha(self):
+        return os.getenv("DRONE_COMMIT_SHA")
+
+    def _get_slug(self):
+        return os.getenv("DRONE_REPO")
+
+    def _get_service(self):
+        return "droneci"
+
+    def _get_pull_request_number(self):
+        return os.getenv("DRONE_PULL_REQUEST")
+
+    def _get_job_code(self):
+        return None
+
+    def get_service_name(self):
+        return "DroneCI"