Merge pull request #146 from codecov/dana/empty-upload

create empty-upload command

Author: dana-yaish

codecov_cli/commands/empty_upload.py

@@ -0,0 +1,66 @@
+import logging
+import typing
+import uuid
+
+import click
+
+from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
+from codecov_cli.helpers.git import GitService
+from codecov_cli.services.empty_upload import empty_upload_logic
+
+logger = logging.getLogger("codecovcli")
+
+
+@click.command()
+@click.option(
+    "-C",
+    "--sha",
+    "--commit-sha",
+    "commit_sha",
+    help="Commit SHA (with 40 chars)",
+    cls=CodecovOption,
+    fallback_field=FallbackFieldEnum.commit_sha,
+    required=True,
+)
+@click.option(
+    "-r",
+    "--slug",
+    "slug",
+    cls=CodecovOption,
+    fallback_field=FallbackFieldEnum.slug,
+    help="owner/repo slug used instead of the private repo token in Self-hosted",
+    envvar="CODECOV_SLUG",
+)
+@click.option(
+    "-t",
+    "--token",
+    help="Codecov upload token",
+    type=click.UUID,
+    envvar="CODECOV_TOKEN",
+)
+@click.option(
+    "--git-service",
+    cls=CodecovOption,
+    fallback_field=FallbackFieldEnum.git_service,
+    type=click.Choice(service.value for service in GitService),
+)
+@click.pass_context
+def empty_upload(
+    ctx,
+    commit_sha: str,
+    slug: typing.Optional[str],
+    token: typing.Optional[uuid.UUID],
+    git_service: typing.Optional[str],
+):
+    logger.debug(
+        "Starting empty upload process",
+        extra=dict(
+            extra_log_attributes=dict(
+                commit_sha=commit_sha,
+                slug=slug,
+                token=token,
+                service=git_service,
+            )
+        ),
+    )
+    return empty_upload_logic(commit_sha, slug, token, git_service)

codecov_cli/main.py

@@ -7,6 +7,7 @@
 from codecov_cli.commands.base_picking import pr_base_picking
 from codecov_cli.commands.commit import create_commit
 from codecov_cli.commands.create_report_result import create_report_results
+from codecov_cli.commands.empty_upload import empty_upload
 from codecov_cli.commands.get_report_results import get_report_results
 from codecov_cli.commands.labelanalysis import label_analysis
 from codecov_cli.commands.report import create_report
@@ -61,6 +62,7 @@ def cli(
 cli.add_command(pr_base_picking)
 cli.add_command(label_analysis)
 cli.add_command(static_analysis)
+cli.add_command(empty_upload)
 
 
 def run():

codecov_cli/services/empty_upload/__init__.py

@@ -0,0 +1,21 @@
+import logging
+
+from codecov_cli.helpers.encoder import encode_slug
+from codecov_cli.helpers.request import (
+    get_token_header_or_fail,
+    log_warnings_and_errors_if_any,
+    send_post_request,
+)
+
+logger = logging.getLogger("codecovcli")
+
+
+def empty_upload_logic(commit_sha, slug, token, git_service):
+    encoded_slug = encode_slug(slug)
+    headers = get_token_header_or_fail(token)
+    url = f"https://api.codecov.io/upload/{git_service}/{encoded_slug}/commits/{commit_sha}/empty-upload"
+    sending_result = send_post_request(url=url, headers=headers)
+    if sending_result.status_code < 300 and sending_result.text:
+        logger.info(sending_result.text)
+    log_warnings_and_errors_if_any(sending_result, "Empty Upload")
+    return sending_result

tests/services/empty_upload/test_empty_upload.py

@@ -0,0 +1,91 @@
+import uuid
+
+from click.testing import CliRunner
+
+from codecov_cli.services.empty_upload import empty_upload_logic
+from codecov_cli.types import RequestError, RequestResult, RequestResultWarning
+from tests.test_helpers import parse_outstreams_into_log_lines
+
+
+def test_empty_upload_with_warnings(mocker):
+    mock_send_commit_data = mocker.patch(
+        "codecov_cli.services.empty_upload.send_post_request",
+        return_value=RequestResult(
+            error=None,
+            warnings=[RequestResultWarning(message="somewarningmessage")],
+            status_code=201,
+            text="",
+        ),
+    )
+    runner = CliRunner()
+    with runner.isolation() as outstreams:
+        res = empty_upload_logic(
+            "commit_sha",
+            "owner/repo",
+            uuid.uuid4(),
+            "service",
+        )
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
+    assert out_bytes == [
+        ("info", "Empty Upload process had 1 warning"),
+        ("warning", "Warning 1: somewarningmessage"),
+    ]
+    assert res == mock_send_commit_data.return_value
+    mock_send_commit_data.assert_called_once()
+
+
+def test_empty_upload_with_error(mocker):
+    mock_send_commit_data = mocker.patch(
+        "codecov_cli.services.empty_upload.send_post_request",
+        return_value=RequestResult(
+            error=RequestError(
+                code="HTTP Error 403",
+                description="Permission denied",
+                params={},
+            ),
+            warnings=[],
+            status_code=403,
+            text="Permission denied",
+        ),
+    )
+    runner = CliRunner()
+    with runner.isolation() as outstreams:
+        res = empty_upload_logic(
+            "commit_sha",
+            "owner/repo",
+            uuid.uuid4(),
+            "service",
+        )
+
+    print(outstreams)
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
+    assert out_bytes == [("error", "Empty Upload failed: Permission denied")]
+    assert res == mock_send_commit_data.return_value
+    mock_send_commit_data.assert_called_once()
+
+
+def test_empty_upload_200(mocker):
+    mocked_response = mocker.patch(
+        "codecov_cli.helpers.request.requests.post",
+        return_value=mocker.MagicMock(status_code=200),
+    )
+    token = uuid.uuid4()
+    res = empty_upload_logic("commit_sha", "owner/repo", token, "service")
+    assert res.error is None
+    assert res.warnings == []
+    mocked_response.assert_called_once()
+
+
+def test_empty_upload_403(mocker):
+    mocked_response = mocker.patch(
+        "codecov_cli.helpers.request.requests.post",
+        return_value=mocker.MagicMock(status_code=403, text="Permission denied"),
+    )
+    token = uuid.uuid4()
+    res = empty_upload_logic("commit_sha", "owner/repo", token, "service")
+    assert res.error == RequestError(
+        code="HTTP Error 403",
+        description="Permission denied",
+        params={},
+    )
+    mocked_response.assert_called_once()

tests/test_codecov_cli.py

@@ -11,6 +11,7 @@ def test_existing_commands():
         "create-report",
         "create-report-results",
         "do-upload",
+        "empty-upload",
         "get-report-results",
         "label-analysis",
         "pr-base-picking",