Merge pull request #87 from codecov/dana/git-service

add git service option to all commands and get its default value from repo's url

Author: dana-yaish

codecov_cli/commands/commit.py

@@ -5,6 +5,7 @@
 import click
 
 from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
+from codecov_cli.helpers.git import GitService
 from codecov_cli.services.commit import create_commit_logic
 
 logger = logging.getLogger("codecovcli")
@@ -50,10 +51,10 @@
     envvar="CODECOV_TOKEN",
 )
 @click.option(
-    "--service",
+    "--git-service",
     cls=CodecovOption,
-    fallback_field=FallbackFieldEnum.service,
-    help="Specify the service provider of the repo e.g. github",
+    fallback_field=FallbackFieldEnum.git_service,
+    type=click.Choice(service.value for service in GitService),
 )
 @click.pass_context
 def create_commit(
@@ -64,7 +65,7 @@ def create_commit(
     branch: typing.Optional[str],
     slug: typing.Optional[str],
     token: typing.Optional[uuid.UUID],
-    service: typing.Optional[str],
+    git_service: typing.Optional[str],
 ):
     logger.debug(
         "Starting create commit process",
@@ -76,8 +77,8 @@ def create_commit(
                 branch=branch,
                 slug=slug,
                 token=token,
-                service=service,
+                service=git_service,
             )
         ),
     )
-    create_commit_logic(commit_sha, parent_sha, pr, branch, slug, token, service)
+    create_commit_logic(commit_sha, parent_sha, pr, branch, slug, token, git_service)

codecov_cli/commands/create_report_result.py

@@ -4,6 +4,7 @@
 import click
 
 from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
+from codecov_cli.helpers.git import GitService
 from codecov_cli.services.report import create_report_results_logic
 
 logger = logging.getLogger("codecovcli")
@@ -29,10 +30,10 @@
     required=True,
 )
 @click.option(
-    "--service",
-    help="Git service provider, e.g. github",
+    "--git-service",
     cls=CodecovOption,
-    fallback_field=FallbackFieldEnum.service,
+    fallback_field=FallbackFieldEnum.git_service,
+    type=click.Choice(service.value for service in GitService),
 )
 @click.option(
     "-t",
@@ -47,15 +48,15 @@ def create_report_results(
     commit_sha: str,
     code: str,
     slug: str,
-    service: str,
+    git_service: str,
     token: uuid.UUID,
 ):
     logger.debug(
         "Creating report results",
         extra=dict(
             extra_log_attributes=dict(
-                commit_sha=commit_sha, code=code, slug=slug, service=service
+                commit_sha=commit_sha, code=code, slug=slug, service=git_service
             )
         ),
     )
-    create_report_results_logic(commit_sha, code, slug, service, token)
+    create_report_results_logic(commit_sha, code, slug, git_service, token)

codecov_cli/commands/get_report_results.py

@@ -5,6 +5,7 @@
 
 from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
 from codecov_cli.helpers.encoder import encode_slug
+from codecov_cli.helpers.git import GitService
 from codecov_cli.services.report import send_reports_result_get_request
 
 logger = logging.getLogger("codecovcli")
@@ -30,10 +31,10 @@
     required=True,
 )
 @click.option(
-    "--service",
-    help="Git service provider, e.g. github",
+    "--git-service",
     cls=CodecovOption,
-    fallback_field=FallbackFieldEnum.service,
+    fallback_field=FallbackFieldEnum.git_service,
+    type=click.Choice(service.value for service in GitService),
 )
 @click.option(
     "-t",
@@ -48,14 +49,14 @@ def get_report_results(
     commit_sha: str,
     code: str,
     slug: str,
-    service: str,
+    git_service: str,
     token: uuid.UUID,
 ):
     logger.debug(
         "Getting report results",
         extra=dict(
             extra_log_attributes=dict(
-                commit_sha=commit_sha, code=code, slug=slug, service=service
+                commit_sha=commit_sha, code=code, slug=slug, service=git_service
             )
         ),
     )
@@ -64,6 +65,6 @@ def get_report_results(
         commit_sha=commit_sha,
         report_code=code,
         encoded_slug=encoded_slug,
-        service=service,
+        service=git_service,
         token=token,
     )

codecov_cli/commands/report.py

@@ -4,6 +4,7 @@
 import click
 
 from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
+from codecov_cli.helpers.git import GitService
 from codecov_cli.services.report import create_report_logic
 
 logger = logging.getLogger("codecovcli")
@@ -29,10 +30,10 @@
     required=True,
 )
 @click.option(
-    "--service",
-    help="Git service provider, e.g. github",
+    "--git-service",
     cls=CodecovOption,
-    fallback_field=FallbackFieldEnum.service,
+    fallback_field=FallbackFieldEnum.git_service,
+    type=click.Choice(service.value for service in GitService),
 )
 @click.option(
     "-t",
@@ -43,17 +44,17 @@
 )
 @click.pass_context
 def create_report(
-    ctx, commit_sha: str, code: str, slug: str, service: str, token: uuid.UUID
+    ctx, commit_sha: str, code: str, slug: str, git_service: str, token: uuid.UUID
 ):
     logger.debug(
         "Starting create report process",
         extra=dict(
             extra_log_attributes=dict(
-                commit_sha=commit_sha, code=code, slug=slug, service=service
+                commit_sha=commit_sha, code=code, slug=slug, service=git_service
             )
         ),
     )
-    res = create_report_logic(commit_sha, code, slug, service, token)
+    res = create_report_logic(commit_sha, code, slug, git_service, token)
     if not res.error:
         logger.info(
             "Finished creating report successfully",

codecov_cli/commands/upload.py

@@ -7,6 +7,7 @@
 import click
 
 from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
+from codecov_cli.helpers.git import GitService
 from codecov_cli.services.legacy_upload import do_upload_logic
 
 logger = logging.getLogger("codecovcli")
@@ -161,6 +162,12 @@ def _turn_env_vars_into_dict(ctx, params, value):
     help="Don't upload files to Codecov",
 )
 @click.option("--use-new-uploader", "is_using_new_uploader", default=False)
+@click.option(
+    "--git-service",
+    cls=CodecovOption,
+    fallback_field=FallbackFieldEnum.git_service,
+    type=click.Choice(service.value for service in GitService),
+)
 @click.pass_context
 def do_upload(
     ctx: click.Context,
@@ -184,6 +191,7 @@ def do_upload(
     is_using_new_uploader: bool,
     fail_on_error: bool,
     dry_run: bool,
+    git_service: typing.Optional[str],
 ):
     versioning_system = ctx.obj["versioning_system"]
     codecov_yaml = ctx.obj["codecov_yaml"] or {}
@@ -210,6 +218,7 @@ def do_upload(
                 branch=branch,
                 slug=slug,
                 pull_request_number=pull_request_number,
+                git_service=git_service,
             )
         ),
     )
@@ -237,4 +246,5 @@ def do_upload(
         is_using_new_uploader=is_using_new_uploader,
         fail_on_error=fail_on_error,
         dry_run=dry_run,
+        git_service=git_service,
     )

codecov_cli/fallbacks.py

@@ -13,6 +13,7 @@ class FallbackFieldEnum(Enum):
     slug = auto()
     branch = auto()
     service = auto()
+    git_service = auto()
 
 
 class CodecovOption(click.Option):

codecov_cli/helpers/ci_adapters/base.py

@@ -16,6 +16,7 @@ def __init__(self):
             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(
@@ -96,3 +97,6 @@ def get_service_name(self):
         Returns: string
         """
         raise NotImplementedError("`get_service_name()` must be implemented.")
+
+    def _get_git_service(self):
+        return None

codecov_cli/helpers/git.py

@@ -1,8 +1,21 @@
+import logging
 import re
+from enum import Enum
 from urllib.parse import urlparse
 
 slug_regex = re.compile(r"[^/\s]+\/[^/\s]+$")
 
+logger = logging.getLogger("codecovcli")
+
+
+class GitService(Enum):
+    GITHUB = "github"
+    GITLAB = "gitlab"
+    BITBUCKET = "bitbucket"
+    GITHUB_ENTERPRISE = "github_enterprise"
+    GITLAB_ENTERPRISE = "gitlab_enterprise"
+    BITBUCKET_SERVER = "bitbucket_server"
+
 
 def parse_slug(remote_repo_url: str):
     """
@@ -29,3 +42,43 @@ def parse_slug(remote_repo_url: str):
         return None
 
     return path_to_parse
+
+
+def parse_git_service(remote_repo_url: str):
+    """
+    Extracts git service from git remote urls. returns None if the url is invalid
+
+    Possible cases we're considering:
+    - https://github.com/codecov/codecov-cli.git returns github
+    - [email protected]:codecov/codecov-cli.git returns github
+    - https://[email protected]/namespace-codecov/first_repo.git returns bitbucket
+    """
+    services = [service.value for service in GitService]
+    parsed_url = urlparse(remote_repo_url)
+    service = None
+
+    if remote_repo_url.startswith("https://"):
+        netloc = parsed_url.netloc
+        if "@" in netloc:
+            netloc = netloc.split("@", 1)[1]
+        if "." in netloc:
+            netloc = netloc.split(".", 1)[0]
+        service = netloc
+    elif remote_repo_url.startswith("git@"):
+        path = parsed_url.path
+        if "@" in path:
+            path = path.split("@", 1)[1]
+        if ":" in path:
+            path = path.split(":", 1)[0]
+        if "." in path:
+            path = path.split(".", 1)[0]
+        service = path
+
+    if service in services:
+        return service
+    else:
+        logger.warning(
+            f"Service not found: {service}. Possible services are {services}",
+            extra=dict(remote_repo_url=remote_repo_url),
+        )
+        return None

codecov_cli/helpers/versioning_systems.py

@@ -4,7 +4,7 @@
 from pathlib import Path
 
 from codecov_cli.fallbacks import FallbackFieldEnum
-from codecov_cli.helpers.git import parse_slug
+from codecov_cli.helpers.git import parse_git_service, parse_slug
 
 logger = logging.getLogger("codecovcli")
 
@@ -76,6 +76,24 @@ def get_fallback_value(self, fallback_field: FallbackFieldEnum):
 
             return parse_slug(remote_url)
 
+        if fallback_field == FallbackFieldEnum.git_service:
+            # if there are multiple remotes, we will prioritize using the one called 'origin' if it exsits, else we will use the first one in 'git remote' list
+
+            p = subprocess.run(["git", "remote"], capture_output=True)
+            if not p.stdout:
+                return None
+
+            remotes = p.stdout.decode().strip().splitlines()
+            remote_name = "origin" if "origin" in remotes else remotes[0]
+            p = subprocess.run(
+                ["git", "ls-remote", "--get-url", remote_name], capture_output=True
+            )
+            if not p.stdout:
+                return None
+
+            remote_url = p.stdout.decode().strip()
+            return parse_git_service(remote_url)
+
         return None
 
     def get_network_root(self):

codecov_cli/services/legacy_upload/__init__.py

@@ -47,6 +47,7 @@ def do_upload_logic(
     is_using_new_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(
@@ -64,7 +65,7 @@ def do_upload_logic(
     else:
         sender = LegacyUploadSender()
     logger.debug(f"Selected uploader to use: {type(sender)}")
-    service = (
+    ci_service = (
         ci_adapter.get_fallback_value(FallbackFieldEnum.service)
         if ci_adapter is not None
         else None
@@ -85,7 +86,8 @@ def do_upload_logic(
             build_url,
             job_code,
             flags,
-            service,
+            ci_service,
+            git_service,
         )
     else:
         logger.info("dry-run option activated. NOT sending data to Codecov.")