codecov-cli 11.0.0__py3-none-any.whl

codecov_cli/commands/upload.py

@@ -0,0 +1,316 @@
+import logging
+import os
+import pathlib
+import typing
+import click
+import sentry_sdk
+
+from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
+from codecov_cli.helpers.args import get_cli_args
+from codecov_cli.helpers.options import global_options
+from codecov_cli.services.upload import do_upload_logic
+from codecov_cli.types import CommandContext
+from codecov_cli.helpers.upload_type import report_type_from_str, ReportType
+
+logger = logging.getLogger("codecovcli")
+
+
+def _turn_env_vars_into_dict(ctx, params, value):
+    return dict((v, os.getenv(v, None)) for v in value)
+
+
+_global_upload_options = [
+    click.option(
+        "--code",
+        "--report-code",
+        "report_code",
+        help="The code of the report. If unsure, leave default",
+        default="default",
+        hidden=True,
+    ),
+    click.option(
+        "--network-root-folder",
+        help="Root folder from which to consider paths on the network section",
+        type=click.Path(path_type=pathlib.Path),
+        default=pathlib.Path.cwd,
+        show_default="Current working directory",
+    ),
+    click.option(
+        "-s",
+        "--dir",
+        "--coverage-files-search-root-folder",
+        "--files-search-root-folder",
+        "files_search_root_folder",
+        help="Folder where to search for coverage files",
+        type=click.Path(path_type=pathlib.Path),
+        default=pathlib.Path.cwd,
+        show_default="Current Working Directory",
+    ),
+    click.option(
+        "--exclude",
+        "--coverage-files-search-exclude-folder",
+        "--files-search-exclude-folder",
+        "files_search_exclude_folders",
+        help="Folders to exclude from search",
+        type=click.Path(path_type=pathlib.Path),
+        multiple=True,
+        default=[],
+    ),
+    click.option(
+        "-f",
+        "--file",
+        "--coverage-files-search-direct-file",
+        "--files-search-direct-file",
+        "files_search_explicitly_listed_files",
+        help="Explicit files to upload. These will be added to the coverage files found for upload. If you wish to only upload the specified files, please consider using --disable-search to disable uploading other files.",
+        type=click.Path(path_type=pathlib.Path),
+        multiple=True,
+        default=[],
+    ),
+    click.option(
+        "--recurse-submodules",
+        help="Whether to enumerate files inside of submodules for path-fixing purposes. Off by default.",
+        is_flag=True,
+        default=False,
+    ),
+    click.option(
+        "--disable-search",
+        help="Disable search for coverage files. This is helpful when specifying what files you want to upload with the --file option.",
+        is_flag=True,
+        default=False,
+    ),
+    click.option(
+        "--disable-file-fixes",
+        help="Disable file fixes to ignore common lines from coverage (e.g. blank lines or empty brackets)",
+        is_flag=True,
+        default=False,
+    ),
+    click.option(
+        "-b",
+        "--build",
+        "--build-code",
+        "build_code",
+        cls=CodecovOption,
+        help="Specify the build number manually",
+        fallback_field=FallbackFieldEnum.build_code,
+    ),
+    click.option(
+        "--build-url",
+        "build_url",
+        cls=CodecovOption,
+        help="The URL of the build where this is running",
+        fallback_field=FallbackFieldEnum.build_url,
+    ),
+    click.option(
+        "--job-code",
+        cls=CodecovOption,
+        fallback_field=FallbackFieldEnum.job_code,
+    ),
+    click.option(
+        "-n",
+        "--name",
+        help="Custom defined name of the upload. Visible in Codecov UI",
+        cls=CodecovOption,
+        fallback_field=FallbackFieldEnum.build_code,
+    ),
+    click.option(
+        "-B",
+        "--branch",
+        help="Branch to which this commit belongs to",
+        cls=CodecovOption,
+        fallback_field=FallbackFieldEnum.branch,
+    ),
+    click.option(
+        "-P",
+        "--pr",
+        "--pull-request-number",
+        "pull_request_number",
+        help="Specify the pull request number manually. Used to override pre-existing CI environment variables",
+        cls=CodecovOption,
+        fallback_field=FallbackFieldEnum.pull_request_number,
+    ),
+    click.option(
+        "-e",
+        "--env",
+        "--env-var",
+        "env_vars",
+        multiple=True,
+        callback=_turn_env_vars_into_dict,
+        help="Specify environment variables to be included with this build.",
+    ),
+    click.option(
+        "-F",
+        "--flag",
+        "flags",
+        multiple=True,
+        default=[],
+        help="Flag the upload to group coverage metrics. Multiple flags allowed.",
+    ),
+    click.option(
+        "--plugin",
+        "plugin_names",
+        multiple=True,
+        default=["xcode", "gcov", "pycoverage"],
+    ),
+    click.option(
+        "-d",
+        "--dry-run",
+        "dry_run",
+        is_flag=True,
+        help="Don't upload files to Codecov",
+    ),
+    click.option(
+        "--legacy",
+        "--use-legacy-uploader",
+        "use_legacy_uploader",
+        is_flag=True,
+        help="Use the legacy upload endpoint",
+    ),
+    click.option(
+        "--handle-no-reports-found",
+        "handle_no_reports_found",
+        is_flag=True,
+        help="Raise no exceptions when no coverage reports found.",
+    ),
+    click.option(
+        "--report-type",
+        "report_type_str",
+        help="The type of the file to upload, coverage by default. Possible values are: testing, coverage.",
+        default="coverage",
+        type=click.Choice(["coverage", "test_results"]),
+    ),
+    click.option(
+        "--network-filter",
+        help="Specify a filter on the files listed in the network section of the Codecov report. This will only add files whose path begin with the specified filter. Useful for upload-specific path fixing",
+    ),
+    click.option(
+        "--network-prefix",
+        help="Specify a prefix on files listed in the network section of the Codecov report. Useful to help resolve path fixing",
+    ),
+    click.option(
+        "--gcov-args",
+        help="Extra arguments to pass to gcov",
+    ),
+    click.option(
+        "--gcov-ignore",
+        help="Paths to ignore during gcov gathering",
+    ),
+    click.option(
+        "--gcov-include",
+        help="Paths to include during gcov gathering",
+    ),
+    click.option(
+        "--gcov-executable",
+        help="gcov executable to run. Defaults to 'gcov'",
+    ),
+    click.option(
+        "--swift-project",
+        help="Specify the swift project",
+    ),
+]
+
+
+def global_upload_options(func):
+    for option in reversed(_global_upload_options):
+        func = option(func)
+    return func
+
+
+@click.command()
+@global_upload_options
+@global_options
+@click.pass_context
+def do_upload(
+    ctx: CommandContext,
+    commit_sha: str,
+    report_code: str,
+    branch: typing.Optional[str],
+    build_code: typing.Optional[str],
+    build_url: typing.Optional[str],
+    disable_file_fixes: bool,
+    disable_search: bool,
+    dry_run: bool,
+    env_vars: typing.Dict[str, str],
+    fail_on_error: bool,
+    files_search_exclude_folders: typing.List[pathlib.Path],
+    files_search_explicitly_listed_files: typing.List[pathlib.Path],
+    files_search_root_folder: pathlib.Path,
+    flags: typing.List[str],
+    gcov_args: typing.Optional[str],
+    gcov_executable: typing.Optional[str],
+    gcov_ignore: typing.Optional[str],
+    gcov_include: typing.Optional[str],
+    git_service: typing.Optional[str],
+    handle_no_reports_found: bool,
+    job_code: typing.Optional[str],
+    name: typing.Optional[str],
+    network_filter: typing.Optional[str],
+    network_prefix: typing.Optional[str],
+    network_root_folder: pathlib.Path,
+    plugin_names: typing.List[str],
+    pull_request_number: typing.Optional[str],
+    recurse_submodules: bool,
+    report_type_str: str,
+    slug: typing.Optional[str],
+    swift_project: typing.Optional[str],
+    token: typing.Optional[str],
+    use_legacy_uploader: bool,
+):
+    with sentry_sdk.start_transaction(op="task", name="Do Upload"):
+        with sentry_sdk.start_span(name="do_upload"):
+            versioning_system = ctx.obj["versioning_system"]
+            codecov_yaml = ctx.obj["codecov_yaml"] or {}
+            cli_config = codecov_yaml.get("cli", {})
+            ci_adapter = ctx.obj.get("ci_adapter")
+            enterprise_url = ctx.obj.get("enterprise_url")
+            args = get_cli_args(ctx)
+            logger.debug(
+                "Starting upload processing",
+                extra=dict(
+                    extra_log_attributes=args,
+                ),
+            )
+
+            report_type: ReportType = report_type_from_str(report_type_str)
+            do_upload_logic(
+                cli_config,
+                versioning_system,
+                ci_adapter,
+                branch=branch,
+                build_code=build_code,
+                build_url=build_url,
+                commit_sha=commit_sha,
+                disable_file_fixes=disable_file_fixes,
+                disable_search=disable_search,
+                dry_run=dry_run,
+                enterprise_url=enterprise_url,
+                env_vars=env_vars,
+                fail_on_error=fail_on_error,
+                files_search_exclude_folders=list(files_search_exclude_folders),
+                files_search_explicitly_listed_files=list(
+                    files_search_explicitly_listed_files
+                ),
+                files_search_root_folder=files_search_root_folder,
+                flags=flags,
+                gcov_args=gcov_args,
+                gcov_executable=gcov_executable,
+                gcov_ignore=gcov_ignore,
+                gcov_include=gcov_include,
+                git_service=git_service,
+                handle_no_reports_found=handle_no_reports_found,
+                job_code=job_code,
+                name=name,
+                network_filter=network_filter,
+                network_prefix=network_prefix,
+                network_root_folder=network_root_folder,
+                plugin_names=plugin_names,
+                pull_request_number=pull_request_number,
+                recurse_submodules=recurse_submodules,
+                report_code=report_code,
+                slug=slug,
+                swift_project=swift_project,
+                token=token,
+                report_type=report_type,
+                use_legacy_uploader=use_legacy_uploader,
+                args=args,
+            )

codecov_cli/commands/upload_coverage.py

@@ -0,0 +1,186 @@
+import logging
+import pathlib
+import typing
+
+import click
+import sentry_sdk
+
+from codecov_cli.commands.commit import create_commit
+from codecov_cli.commands.report import create_report
+from codecov_cli.commands.upload import do_upload, global_upload_options
+from codecov_cli.helpers.args import get_cli_args
+from codecov_cli.helpers.options import global_options
+from codecov_cli.opentelemetry import close_telem
+from codecov_cli.helpers.upload_type import report_type_from_str, ReportType
+from codecov_cli.services.upload_coverage import upload_coverage_logic
+from codecov_cli.types import CommandContext
+
+logger = logging.getLogger("codecovcli")
+
+
+# These options are the combined options of commit, report and upload commands
+@click.command()
+@global_options
+@global_upload_options
+@click.option(
+    "--parent-sha",
+    help="SHA (with 40 chars) of what should be the parent of this commit",
+)
+@click.pass_context
+def upload_coverage(
+    ctx: CommandContext,
+    branch: typing.Optional[str],
+    build_code: typing.Optional[str],
+    build_url: typing.Optional[str],
+    commit_sha: str,
+    disable_file_fixes: bool,
+    disable_search: bool,
+    dry_run: bool,
+    env_vars: typing.Dict[str, str],
+    fail_on_error: bool,
+    files_search_exclude_folders: typing.List[pathlib.Path],
+    files_search_explicitly_listed_files: typing.List[pathlib.Path],
+    files_search_root_folder: pathlib.Path,
+    flags: typing.List[str],
+    gcov_args: typing.Optional[str],
+    gcov_executable: typing.Optional[str],
+    gcov_ignore: typing.Optional[str],
+    gcov_include: typing.Optional[str],
+    git_service: typing.Optional[str],
+    handle_no_reports_found: bool,
+    job_code: typing.Optional[str],
+    name: typing.Optional[str],
+    network_filter: typing.Optional[str],
+    network_prefix: typing.Optional[str],
+    network_root_folder: pathlib.Path,
+    parent_sha: typing.Optional[str],
+    plugin_names: typing.List[str],
+    pull_request_number: typing.Optional[str],
+    recurse_submodules: bool,
+    report_code: str,
+    report_type_str: str,
+    slug: typing.Optional[str],
+    swift_project: typing.Optional[str],
+    token: typing.Optional[str],
+    use_legacy_uploader: bool,
+):
+    with sentry_sdk.start_transaction(op="task", name="Upload Coverage"):
+        with sentry_sdk.start_span(name="upload_coverage"):
+            args = get_cli_args(ctx)
+            logger.debug(
+                "Starting upload coverage",
+                extra=dict(
+                    extra_log_attributes=args,
+                ),
+            )
+
+            report_type = report_type_from_str(report_type_str)
+
+            if not use_legacy_uploader and report_type == ReportType.COVERAGE:
+                versioning_system = ctx.obj["versioning_system"]
+                codecov_yaml = ctx.obj["codecov_yaml"] or {}
+                cli_config = codecov_yaml.get("cli", {})
+                ci_adapter = ctx.obj.get("ci_adapter")
+                enterprise_url = ctx.obj.get("enterprise_url")
+                args = get_cli_args(ctx)
+                ctx.invoke(
+                    upload_coverage_logic,
+                    cli_config,
+                    versioning_system,
+                    ci_adapter,
+                    branch=branch,
+                    build_code=build_code,
+                    build_url=build_url,
+                    commit_sha=commit_sha,
+                    disable_file_fixes=disable_file_fixes,
+                    disable_search=disable_search,
+                    dry_run=dry_run,
+                    enterprise_url=enterprise_url,
+                    env_vars=env_vars,
+                    fail_on_error=fail_on_error,
+                    files_search_exclude_folders=files_search_exclude_folders,
+                    files_search_explicitly_listed_files=files_search_explicitly_listed_files,
+                    files_search_root_folder=files_search_root_folder,
+                    flags=flags,
+                    gcov_args=gcov_args,
+                    gcov_executable=gcov_executable,
+                    gcov_ignore=gcov_ignore,
+                    gcov_include=gcov_include,
+                    git_service=git_service,
+                    handle_no_reports_found=handle_no_reports_found,
+                    job_code=job_code,
+                    name=name,
+                    network_filter=network_filter,
+                    network_prefix=network_prefix,
+                    network_root_folder=network_root_folder,
+                    parent_sha=parent_sha,
+                    plugin_names=plugin_names,
+                    pull_request_number=pull_request_number,
+                    recurse_submodules=recurse_submodules,
+                    report_code=report_code,
+                    slug=slug,
+                    swift_project=swift_project,
+                    token=token,
+                    report_type=report_type,
+                    use_legacy_uploader=use_legacy_uploader,
+                    args=args,
+                )
+            else:
+                ctx.invoke(
+                    create_commit,
+                    commit_sha=commit_sha,
+                    parent_sha=parent_sha,
+                    pull_request_number=pull_request_number,
+                    branch=branch,
+                    slug=slug,
+                    token=token,
+                    git_service=git_service,
+                    fail_on_error=True,
+                )
+                if report_type == ReportType.COVERAGE:
+                    ctx.invoke(
+                        create_report,
+                        token=token,
+                        code=report_code,
+                        fail_on_error=True,
+                        commit_sha=commit_sha,
+                        slug=slug,
+                        git_service=git_service,
+                    )
+                ctx.invoke(
+                    do_upload,
+                    branch=branch,
+                    build_code=build_code,
+                    build_url=build_url,
+                    commit_sha=commit_sha,
+                    disable_file_fixes=disable_file_fixes,
+                    disable_search=disable_search,
+                    dry_run=dry_run,
+                    env_vars=env_vars,
+                    fail_on_error=fail_on_error,
+                    files_search_exclude_folders=files_search_exclude_folders,
+                    files_search_explicitly_listed_files=files_search_explicitly_listed_files,
+                    files_search_root_folder=files_search_root_folder,
+                    flags=flags,
+                    gcov_args=gcov_args,
+                    gcov_executable=gcov_executable,
+                    gcov_ignore=gcov_ignore,
+                    gcov_include=gcov_include,
+                    git_service=git_service,
+                    handle_no_reports_found=handle_no_reports_found,
+                    job_code=job_code,
+                    name=name,
+                    network_filter=network_filter,
+                    network_prefix=network_prefix,
+                    network_root_folder=network_root_folder,
+                    plugin_names=plugin_names,
+                    pull_request_number=pull_request_number,
+                    recurse_submodules=recurse_submodules,
+                    report_code=report_code,
+                    report_type_str=report_type_str,
+                    slug=slug,
+                    swift_project=swift_project,
+                    token=token,
+                    use_legacy_uploader=use_legacy_uploader,
+                )
+    close_telem()

codecov_cli/commands/upload_process.py

@@ -0,0 +1,133 @@
+import logging
+import pathlib
+import typing
+
+import click
+import sentry_sdk
+
+from codecov_cli.commands.commit import create_commit
+from codecov_cli.commands.report import create_report
+from codecov_cli.commands.upload import do_upload, global_upload_options
+from codecov_cli.helpers.args import get_cli_args
+from codecov_cli.helpers.options import global_options
+from codecov_cli.helpers.upload_type import report_type_from_str, ReportType
+from codecov_cli.types import CommandContext
+
+logger = logging.getLogger("codecovcli")
+
+
+# These options are the combined options of commit, report and upload commands
+@click.command()
+@global_options
+@global_upload_options
+@click.option(
+    "--parent-sha",
+    help="SHA (with 40 chars) of what should be the parent of this commit",
+)
+@click.pass_context
+def upload_process(
+    ctx: CommandContext,
+    branch: typing.Optional[str],
+    build_code: typing.Optional[str],
+    build_url: typing.Optional[str],
+    commit_sha: str,
+    disable_file_fixes: bool,
+    disable_search: bool,
+    dry_run: bool,
+    env_vars: typing.Dict[str, str],
+    fail_on_error: bool,
+    files_search_exclude_folders: typing.List[pathlib.Path],
+    files_search_explicitly_listed_files: typing.List[pathlib.Path],
+    files_search_root_folder: pathlib.Path,
+    flags: typing.List[str],
+    gcov_args: typing.Optional[str],
+    gcov_executable: typing.Optional[str],
+    gcov_ignore: typing.Optional[str],
+    gcov_include: typing.Optional[str],
+    git_service: typing.Optional[str],
+    handle_no_reports_found: bool,
+    job_code: typing.Optional[str],
+    name: typing.Optional[str],
+    network_filter: typing.Optional[str],
+    network_prefix: typing.Optional[str],
+    network_root_folder: pathlib.Path,
+    parent_sha: typing.Optional[str],
+    plugin_names: typing.List[str],
+    pull_request_number: typing.Optional[str],
+    recurse_submodules: bool,
+    report_code: str,
+    report_type_str: str,
+    slug: typing.Optional[str],
+    swift_project: typing.Optional[str],
+    token: typing.Optional[str],
+    use_legacy_uploader: bool,
+):
+    with sentry_sdk.start_transaction(op="task", name="Upload Process"):
+        with sentry_sdk.start_span(name="upload_process"):
+            args = get_cli_args(ctx)
+            logger.debug(
+                "Starting upload process",
+                extra=dict(
+                    extra_log_attributes=args,
+                ),
+            )
+
+            ctx.invoke(
+                create_commit,
+                commit_sha=commit_sha,
+                parent_sha=parent_sha,
+                pull_request_number=pull_request_number,
+                branch=branch,
+                slug=slug,
+                token=token,
+                git_service=git_service,
+                fail_on_error=True,
+            )
+
+            report_type = report_type_from_str(report_type_str)
+            if report_type == ReportType.COVERAGE:
+                ctx.invoke(
+                    create_report,
+                    token=token,
+                    code=report_code,
+                    fail_on_error=True,
+                    commit_sha=commit_sha,
+                    slug=slug,
+                    git_service=git_service,
+                )
+            ctx.invoke(
+                do_upload,
+                branch=branch,
+                build_code=build_code,
+                build_url=build_url,
+                commit_sha=commit_sha,
+                disable_file_fixes=disable_file_fixes,
+                disable_search=disable_search,
+                dry_run=dry_run,
+                env_vars=env_vars,
+                fail_on_error=fail_on_error,
+                files_search_exclude_folders=files_search_exclude_folders,
+                files_search_explicitly_listed_files=files_search_explicitly_listed_files,
+                files_search_root_folder=files_search_root_folder,
+                flags=flags,
+                gcov_args=gcov_args,
+                gcov_executable=gcov_executable,
+                gcov_ignore=gcov_ignore,
+                gcov_include=gcov_include,
+                git_service=git_service,
+                handle_no_reports_found=handle_no_reports_found,
+                job_code=job_code,
+                name=name,
+                network_filter=network_filter,
+                network_prefix=network_prefix,
+                network_root_folder=network_root_folder,
+                plugin_names=plugin_names,
+                pull_request_number=pull_request_number,
+                recurse_submodules=recurse_submodules,
+                report_code=report_code,
+                report_type_str=report_type_str,
+                slug=slug,
+                swift_project=swift_project,
+                token=token,
+                use_legacy_uploader=use_legacy_uploader,
+            )

codecov_cli/fallbacks.py

@@ -0,0 +1,41 @@
+import typing
+from enum import Enum, auto
+
+import click
+
+
+class FallbackFieldEnum(Enum):
+    branch = auto()
+    build_code = auto()
+    build_url = auto()
+    commit_sha = auto()
+    git_service = auto()
+    job_code = auto()
+    pull_request_number = auto()
+    service = auto()
+    slug = auto()
+
+
+class CodecovOption(click.Option):
+    def __init__(self, *args, **kwargs):
+        self.fallback_field = kwargs.pop("fallback_field", None)
+        super().__init__(*args, **kwargs)
+
+    def get_default(
+        self, ctx: click.Context, call: bool = True
+    ) -> typing.Optional[typing.Union[typing.Any, typing.Callable[[], typing.Any]]]:
+        res = super().get_default(ctx, call=call)
+        if res is not None:
+            return res
+        if self.fallback_field is not None:
+            if ctx.obj.get("ci_adapter") is not None:
+                res = ctx.obj.get("ci_adapter").get_fallback_value(self.fallback_field)
+                if res is not None:
+                    return res
+            if ctx.obj.get("versioning_system") is not None:
+                res = ctx.obj.get("versioning_system").get_fallback_value(
+                    self.fallback_field
+                )
+                if res is not None:
+                    return res
+        return None