Change default uploader + refactor upload service. (#99)

* Change default uploader + refactor upload service.

The objective change in this commit is making the default value of `--use-new-uploader` option in the `do-upload` command `True` (so we use the new uploader by default).

But it bothered me taht the upload logic - which is the same between new and old upload endpoints, differing only in the upload sender - was in a module  `services.legacy_upload`. So I moved all files to `services.upload` and put the legacy upload sender in `services.upload.legacy_upload_sender`, and that is as of now the only truly legacy thing in the odecov-cli upload service process.

* Make `use-legacy-upload` a flag option.

Now adding `--use-legacy-uploader` to the `do-upload` command will use the legacy upload sender.
Otherwise the upload sender will be used.

Author: giovanni-guidini

codecov_cli/commands/upload.py

@@ -8,7 +8,7 @@
 
 from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
 from codecov_cli.helpers.git import GitService
-from codecov_cli.services.legacy_upload import do_upload_logic
+from codecov_cli.services.upload import do_upload_logic
 
 logger = logging.getLogger("codecovcli")
 
@@ -161,7 +161,13 @@ def _turn_env_vars_into_dict(ctx, params, value):
     is_flag=True,
     help="Don't upload files to Codecov",
 )
-@click.option("--use-new-uploader", "is_using_new_uploader", default=False)
+@click.option(
+    "--legacy",
+    "--use-legacy-uploader",
+    "use_legacy_uploader",
+    is_flag=True,
+    help="Use the legacy upload endpoint",
+)
 @click.option(
     "--git-service",
     cls=CodecovOption,
@@ -188,7 +194,7 @@ def do_upload(
     branch: typing.Optional[str],
     slug: typing.Optional[str],
     pull_request_number: typing.Optional[str],
-    is_using_new_uploader: bool,
+    use_legacy_uploader: bool,
     fail_on_error: bool,
     dry_run: bool,
     git_service: typing.Optional[str],
@@ -243,7 +249,7 @@ def do_upload(
         branch=branch,
         slug=slug,
         pull_request_number=pull_request_number,
-        is_using_new_uploader=is_using_new_uploader,
+        use_legacy_uploader=use_legacy_uploader,
         fail_on_error=fail_on_error,
         dry_run=dry_run,
         git_service=git_service,

codecov_cli/services/legacy_upload/__init__.py

@@ -0,0 +1,99 @@
+import logging
+import typing
+import uuid
+from pathlib import Path
+
+import click
+
+from codecov_cli.fallbacks import FallbackFieldEnum
+from codecov_cli.helpers.ci_adapters.base import CIAdapterBase
+from codecov_cli.helpers.request import log_warnings_and_errors_if_any
+from codecov_cli.helpers.versioning_systems import VersioningSystemInterface
+from codecov_cli.plugins import select_preparation_plugins
+from codecov_cli.services.upload.coverage_file_finder import select_coverage_file_finder
+from codecov_cli.services.upload.legacy_upload_sender import LegacyUploadSender
+from codecov_cli.services.upload.network_finder import select_network_finder
+from codecov_cli.services.upload.upload_collector import UploadCollector
+from codecov_cli.services.upload.upload_sender import UploadSender
+from codecov_cli.types import RequestResult
+
+logger = logging.getLogger("codecovcli")
+
+
+def do_upload_logic(
+    cli_config: typing.Dict,
+    versioning_system: VersioningSystemInterface,
+    ci_adapter: CIAdapterBase,
+    *,
+    commit_sha: str,
+    report_code: str,
+    build_code: typing.Optional[str],
+    build_url: typing.Optional[str],
+    job_code: typing.Optional[str],
+    env_vars: typing.Dict[str, str],
+    flags: typing.List[str],
+    name: typing.Optional[str],
+    network_root_folder: Path,
+    coverage_files_search_root_folder: Path,
+    coverage_files_search_exclude_folders: typing.List[Path],
+    coverage_files_search_explicitly_listed_files: typing.List[Path],
+    plugin_names: typing.List[str],
+    token: uuid.UUID,
+    branch: typing.Optional[str],
+    slug: typing.Optional[str],
+    pull_request_number: typing.Optional[str],
+    use_legacy_uploader: bool = False,
+    fail_on_error: bool = False,
+    dry_run: bool = False,
+    git_service: typing.Optional[str],
+):
+    preparation_plugins = select_preparation_plugins(cli_config, plugin_names)
+    coverage_file_selector = select_coverage_file_finder(
+        coverage_files_search_root_folder,
+        coverage_files_search_exclude_folders,
+        coverage_files_search_explicitly_listed_files,
+    )
+    network_finder = select_network_finder(versioning_system)
+    collector = UploadCollector(
+        preparation_plugins, network_finder, coverage_file_selector
+    )
+    upload_data = collector.generate_upload_data()
+    if use_legacy_uploader:
+        sender = LegacyUploadSender()
+    else:
+        sender = UploadSender()
+    logger.debug(f"Selected uploader to use: {type(sender)}")
+    ci_service = (
+        ci_adapter.get_fallback_value(FallbackFieldEnum.service)
+        if ci_adapter is not None
+        else None
+    )
+
+    if not dry_run:
+        sending_result = sender.send_upload_data(
+            upload_data,
+            commit_sha,
+            token,
+            env_vars,
+            report_code,
+            name,
+            branch,
+            slug,
+            pull_request_number,
+            build_code,
+            build_url,
+            job_code,
+            flags,
+            ci_service,
+            git_service,
+        )
+    else:
+        logger.info("dry-run option activated. NOT sending data to Codecov.")
+        sending_result = RequestResult(
+            error=None,
+            warnings=None,
+            status_code=200,
+            text="Data NOT sent to Codecov because of dry-run option",
+        )
+    log_warnings_and_errors_if_any(sending_result, "Upload", fail_on_error)
+    return sending_result

codecov_cli/services/upload/__init__.py

@@ -6,8 +6,8 @@
 from collections import namedtuple
 from fnmatch import fnmatch
 
-from codecov_cli.services.legacy_upload.coverage_file_finder import CoverageFileFinder
-from codecov_cli.services.legacy_upload.network_finder import NetworkFinder
+from codecov_cli.services.upload.coverage_file_finder import CoverageFileFinder
+from codecov_cli.services.upload.network_finder import NetworkFinder
 from codecov_cli.types import (
     PreparationPluginInterface,
     UploadCollectionResult,

codecov_cli/services/legacy_upload/coverage_file_finder.py renamed to codecov_cli/services/upload/coverage_file_finder.py

@@ -6,7 +6,7 @@
 from responses import matchers
 
 from codecov_cli import __version__ as codecov_cli_version
-from codecov_cli.services.legacy_upload.upload_sender import LegacyUploadSender
+from codecov_cli.services.upload.legacy_upload_sender import LegacyUploadSender
 from codecov_cli.types import UploadCollectionResult
 from tests.data import reports_examples
 
@@ -243,7 +243,7 @@ def test_generate_network_section_empty_result(self):
     def test_format_coverage_file(self, mocker):
         fake_result_file = mocker.MagicMock()
         mocker.patch(
-            "codecov_cli.services.legacy_upload.upload_sender.UploadCollectionResultFile",
+            "codecov_cli.services.upload.upload_sender.UploadCollectionResultFile",
             return_value=fake_result_file,
         )
 
@@ -269,7 +269,7 @@ def test_format_coverage_file(self, mocker):
     def test_generate_coverage_files_section(self, mocker):
 
         mocker.patch(
-            "codecov_cli.services.legacy_upload.LegacyUploadSender._format_coverage_file",
+            "codecov_cli.services.upload.LegacyUploadSender._format_coverage_file",
             side_effect=lambda file_bytes: file_bytes,
         )
 
@@ -290,15 +290,15 @@ def test_generate_coverage_files_section(self, mocker):
 
     def test_generate_payload_overall(self, mocker):
         mocker.patch(
-            "codecov_cli.services.legacy_upload.LegacyUploadSender._generate_env_vars_section",
+            "codecov_cli.services.upload.LegacyUploadSender._generate_env_vars_section",
             return_value=reports_examples.env_section,
         )
         mocker.patch(
-            "codecov_cli.services.legacy_upload.LegacyUploadSender._generate_network_section",
+            "codecov_cli.services.upload.LegacyUploadSender._generate_network_section",
             return_value=reports_examples.network_section,
         )
         mocker.patch(
-            "codecov_cli.services.legacy_upload.LegacyUploadSender._generate_coverage_files_section",
+            "codecov_cli.services.upload.LegacyUploadSender._generate_coverage_files_section",
             return_value=reports_examples.coverage_file_section_simple,
         )
 

codecov_cli/services/legacy_upload/upload_sender.py renamed to codecov_cli/services/upload/legacy_upload_sender.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from codecov_cli.services.legacy_upload.network_finder import NetworkFinder
+from codecov_cli.services.upload.network_finder import NetworkFinder
 
 
 def test_find_files(mocker, tmp_path):

codecov_cli/services/legacy_upload/network_finder.py renamed to codecov_cli/services/upload/network_finder.py

@@ -1,13 +1,13 @@
 from pathlib import Path
 
-from codecov_cli.services.legacy_upload.coverage_file_finder import CoverageFileFinder
+from codecov_cli.services.upload.coverage_file_finder import CoverageFileFinder
 from codecov_cli.types import UploadCollectionResultFile
 
 
 class TestCoverageFileFinder(object):
     def test_find_coverage_files_mocked_search_files(self, mocker):
         mocker.patch(
-            "codecov_cli.services.legacy_upload.coverage_file_finder.search_files",
+            "codecov_cli.services.upload.coverage_file_finder.search_files",
             return_value=[],
         )
         assert CoverageFileFinder().find_coverage_files() == []
@@ -18,7 +18,7 @@ def test_find_coverage_files_mocked_search_files(self, mocker):
         ]
 
         mocker.patch(
-            "codecov_cli.services.legacy_upload.coverage_file_finder.search_files",
+            "codecov_cli.services.upload.coverage_file_finder.search_files",
             return_value=coverage_files_paths,
         )