fix: configurable rebranding

- accept unbranded --yml-path in the new cli
- add configurable rebranding for options expecting env vars
    - make the branding configurable through the click context user
      data obj
    - add the BrandedOption and CodecovBrandedOption classes for
      having env vars for the options follow the branding passed in
      the context
- also makes the codecov-cli source in the prevent-cli pyproject
  editable

Author: joseph-sentry

codecov-cli/codecov_cli/branding.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class Branding(Enum):
+    CODECOV = "codecov"
+    PREVENT = "prevent"

codecov-cli/codecov_cli/commands/base_picking.py

@@ -4,7 +4,12 @@
 import click
 import sentry_sdk
 
-from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
+from codecov_cli.fallbacks import (
+    CodecovOption,
+    FallbackFieldEnum,
+    BrandedOption,
+    BrandedCodecovOption,
+)
 from codecov_cli.helpers.args import get_cli_args
 from codecov_cli.helpers.encoder import slug_without_subgroups_is_invalid
 from codecov_cli.services.commit.base_picking import base_picking_logic
@@ -29,16 +34,17 @@
 )
 @click.option(
     "--slug",
-    cls=CodecovOption,
+    cls=BrandedCodecovOption,
     fallback_field=FallbackFieldEnum.slug,
     help="owner/repo slug",
-    envvar="CODECOV_SLUG",
+    envvar="SLUG",
 )
 @click.option(
     "-t",
     "--token",
+    cls=BrandedOption,
     help="Codecov upload token",
-    envvar="CODECOV_TOKEN",
+    envvar="TOKEN",
 )
 @click.option(
     "--service",

codecov-cli/codecov_cli/fallbacks.py

@@ -39,3 +39,18 @@ def get_default(
                 if res is not None:
                     return res
         return None
+
+
+class BrandedOption(click.Option):
+    def resolve_envvar_value(self, ctx: click.Context) -> str | None:
+        actual_var = self.envvar
+        self.envvar = [
+            f"{brand.value.upper()}_{actual_var}" for brand in ctx.obj["branding"]
+        ]
+        res = super().resolve_envvar_value(ctx)
+        self.envvar = actual_var
+        return res
+
+
+class BrandedCodecovOption(CodecovOption, BrandedOption):
+    pass

codecov-cli/codecov_cli/helpers/options.py

@@ -1,6 +1,11 @@
 import click
 
-from codecov_cli.fallbacks import CodecovOption, FallbackFieldEnum
+from codecov_cli.fallbacks import (
+    CodecovOption,
+    FallbackFieldEnum,
+    BrandedCodecovOption,
+    BrandedOption,
+)
 from codecov_cli.helpers.git import GitService
 
 _global_options = [
@@ -31,16 +36,17 @@
         "-t",
         "--token",
         help="Codecov upload token",
-        envvar="CODECOV_TOKEN",
+        cls=BrandedOption,
+        envvar="TOKEN",
     ),
     click.option(
         "-r",
         "--slug",
         "slug",
-        cls=CodecovOption,
+        cls=BrandedCodecovOption,
         fallback_field=FallbackFieldEnum.slug,
         help="owner/repo slug used instead of the private repo token in Self-hosted",
-        envvar="CODECOV_SLUG",
+        envvar="SLUG",
     ),
 ]
 

codecov-cli/codecov_cli/main.py

@@ -23,6 +23,7 @@
 from codecov_cli.helpers.config import load_cli_config
 from codecov_cli.helpers.logging_utils import configure_logger
 from codecov_cli.helpers.versioning_systems import get_versioning_system
+from codecov_cli.branding import Branding
 
 logger = logging.getLogger("codecovcli")
 
@@ -70,7 +71,7 @@ def cli(
         ctx.default_map = {ctx.invoked_subcommand: {"token": token}}
     ctx.obj["enterprise_url"] = enterprise_url
     ctx.obj["disable_telem"] = disable_telem
-
+    ctx.obj["branding"] = [Branding.CODECOV]
     init_telem(ctx.obj)
 
 

codecov-cli/tests/test_fallbacks.py

@@ -0,0 +1,33 @@
+import click
+
+from codecov_cli.fallbacks import BrandedOption
+from codecov_cli.branding import Branding
+
+from click.testing import CliRunner
+
+
+@click.group()
+@click.pass_context
+def cli(ctx):
+    ctx.obj = {}
+    ctx.obj["branding"] = [Branding.CODECOV, Branding.PREVENT]
+
+
+@cli.command()
+@click.option("--test", cls=BrandedOption, envvar="TEST")
+@click.pass_context
+def hello_world(ctx, test):
+    click.echo(f"{test}")
+
+
+def test_branded_option():
+    runner = CliRunner()
+
+    result = runner.invoke(cli, ["hello-world"], env={"CODECOV_TEST": "hello_codecov"})
+    assert result.output == "hello_codecov\n"
+
+    result = runner.invoke(cli, ["hello-world"], env={"PREVENT_TEST": "hello_prevent"})
+    assert result.output == "hello_prevent\n"
+
+    result = runner.invoke(cli, ["hello-world"])
+    assert result.output == "None\n"

codecov-cli/uv.lock

@@ -3,9 +3,7 @@ name = "prevent-cli"
 version = "0.1.0"
 description = "Add your description here"
 readme = "README.md"
-authors = [
-    { name = "joseph-sentry", email = "joseph.sawaya@sentry.io" }
-]
+authors = [{ name = "joseph-sentry", email = "joseph.sawaya@sentry.io" }]
 requires-python = ">=3.9"
 dependencies = [
     "click==8.*",
@@ -30,9 +28,8 @@ requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools]
-package-dir = {"" = "src"}
+package-dir = { "" = "src" }
 packages = ["prevent_cli"]
 
 [tool.uv.sources]
-codecov-cli = {path = "../codecov-cli"}
-
+codecov-cli = { path = "../codecov-cli", editable = true }

prevent-cli/pyproject.toml

@@ -21,6 +21,7 @@
 from codecov_cli.helpers.config import load_cli_config
 from codecov_cli.helpers.logging_utils import configure_logger
 from codecov_cli.helpers.versioning_systems import get_versioning_system
+from codecov_cli.branding import Branding
 
 logger = logging.getLogger("codecovcli")
 
@@ -34,6 +35,7 @@
     ),
 )
 @click.option(
+    "--yml-path",
     "--codecov-yml-path",
     type=click.Path(path_type=pathlib.Path),
     default=None,
@@ -50,7 +52,7 @@
 def cli(
     ctx: click.Context,
     auto_load_params_from: typing.Optional[str],
-    codecov_yml_path: pathlib.Path,
+    yml_path: pathlib.Path,
     enterprise_url: str,
     verbose: bool = False,
     disable_telem: bool = False,
@@ -61,13 +63,18 @@ def cli(
     ctx.help_option_names = ["-h", "--help"]
     ctx.obj["ci_adapter"] = get_ci_adapter(auto_load_params_from)
     ctx.obj["versioning_system"] = get_versioning_system()
-    ctx.obj["codecov_yaml"] = load_cli_config(codecov_yml_path)
+    ctx.obj["codecov_yaml"] = load_cli_config(yml_path)
     if ctx.obj["codecov_yaml"] is None:
         logger.debug("No codecov_yaml found")
-    elif (token := ctx.obj["codecov_yaml"].get("codecov", {}).get("token")) is not None:
-        ctx.default_map = {ctx.invoked_subcommand: {"token": token}}
+    else:
+        token = ctx.obj["codecov_yaml"].get("codecov", {}).get("token") or ctx.obj[
+            "codecov_yaml"
+        ].get("prevent", {}).get("token")
+        if token is not None:
+            ctx.default_map = {ctx.invoked_subcommand: {"token": token}}
     ctx.obj["enterprise_url"] = enterprise_url
     ctx.obj["disable_telem"] = disable_telem
+    ctx.obj["branding"] = [Branding.PREVENT, Branding.CODECOV]
 
     init_telem(ctx.obj)