smart-tests-cli 2.6.0__tar.gz → 2.7.0__tar.gz

{smart_tests_cli-2.6.0 → smart_tests_cli-2.7.0}/.github/workflows/publish.yml

@@ -45,13 +45,6 @@ jobs:
         run: uv build
       - name: Publish to PyPI
         run: uv publish --token ${{ secrets.SMART_TESTS_PYPI_API_TOKEN }}
-      - name: Actions for Discord
-        uses: Ilshidur/action-discord@0.3.2
-        env:
-          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
-        with:
-          args: "Smart Tests CLI ${{ needs.tagpr.outputs.tag }} is released! https://github.com/launchableinc/cli/releases/tag/${{ needs.tagpr.outputs.tag }}"
-
   docker:
     name: Push Docker image to Docker Hub
     needs: tagpr

{smart_tests_cli-2.6.0/smart_tests_cli.egg-info → smart_tests_cli-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smart-tests-cli
-Version: 2.6.0
+Version: 2.7.0
 Summary: Smart Tests CLI
 Author-email: CloudBees <support@cloudbees.com>
 License: Apache Software License v2

{smart_tests_cli-2.6.0 → smart_tests_cli-2.7.0}/smart_tests/__main__.py

@@ -14,10 +14,12 @@ from smart_tests.commands.inspect import inspect
 from smart_tests.commands.record import record
 from smart_tests.commands.stats import stats
 from smart_tests.commands.subset import subset
+from smart_tests.commands.update import update
 from smart_tests.commands.verify import verify
 
 cli = Group(name="cli", callback=Application)
 cli.add_command(record)
+cli.add_command(update)
 cli.add_command(subset)
 # TODO: main.add_command(split_subset)
 cli.add_command(verify)

{smart_tests_cli-2.6.0 → smart_tests_cli-2.7.0}/smart_tests/args4p/typer/__init__.py

@@ -33,9 +33,11 @@ def Argument(
     return _Argument(name=None, type=type, multiple=multiple, required=required, metavar=metavar, help=help, default=default)
 
 
-class Exit(Exception):
+class Exit(BaseException):
     '''
-    Raise this exception to exit the CLI with the given exit code
+    Raise this exception to exit the CLI with the given exit code.
+    Extends BaseException (not Exception) so that broad `except Exception` handlers in user code
+    do not accidentally swallow it — analogous to Java's Error vs Exception distinction.
     '''
 
     def __init__(self, code: int):

{smart_tests_cli-2.6.0 → smart_tests_cli-2.7.0}/smart_tests/commands/record/__init__.py

@@ -3,6 +3,7 @@ from ...app import Application
 from .attachment import attachment
 from .build import build
 from .commit import commit
+from .deployment import deployment
 from .session import session
 from .tests import tests
 
@@ -17,3 +18,4 @@ record.add_command(commit)
 record.add_command(tests)
 record.add_command(session)
 record.add_command(attachment)
+record.add_command(deployment)

{smart_tests_cli-2.6.0 → smart_tests_cli-2.7.0}/smart_tests/commands/record/build.py

@@ -87,6 +87,18 @@ def build(
         help="Set external link of a title and url",
         type=parse_key_value,
     )] = [],
+    components: Annotated[List[KeyValue], typer.Option(
+        "--component",
+        multiple=True,
+        help="Include another build as a named component. Format: NAME=BUILD_OR_ALIAS",
+        metavar="NAME=BUILDNAME",
+        type=parse_key_value,
+    )] = [],
+    include_environment: Annotated[str | None, typer.Option(
+        "--include-environment",
+        help="Include all services deployed to this environment as components. See 'record deployment' command.",
+        metavar="NAME",
+    )] = None,
 ):
 
     # Parse key-value pairs for commits
@@ -303,6 +315,34 @@ def build(
         def compute_links():
             return capture_links(link_options=links, env=os.environ)
 
+        def compute_components():
+            all_components = list(components)
+            if include_environment:
+                res = client.request("get", "builds/aliases",
+                                     params={"name": f"deployment:{include_environment}:*"})
+                res.raise_for_status()
+                json = res.json()
+                if len(json) == 0:
+                    warn_and_exit_if_fail_fast_mode(f"Error: no such environment: {include_environment}")
+                click.echo("Components in this environment:")
+                for alias_obj in json:
+                    service = alias_obj["alias"].split(":", 2)[2]
+                    point_to = alias_obj["buildName"]
+                    all_components.append(KeyValue(key=service, value=point_to))
+                    click.echo(f"  - {service} -> {point_to}")
+
+            for c in all_components:
+                if not c.key:
+                    click.echo("Component name must not be empty", err=True)
+                    raise typer.Exit(1)
+            names_seen: set = set()
+            for c in all_components:
+                if c.key in names_seen:
+                    click.echo(f"Duplicate component name: '{c.key}'", err=True)
+                    raise typer.Exit(1)
+                names_seen.add(c.key)
+            return [{"name": c.key, "build": c.value} for c in all_components]
+
         try:
             lineage = branch or ws[0].branch
             if lineage is None:
@@ -319,6 +359,7 @@ def build(
                 } for w in ws],
                 "links": compute_links(),
                 "timestamp": parsed_timestamp.isoformat() if parsed_timestamp else None,
+                "components": compute_components(),
             }
 
             res = client.request("post", "builds", payload=payload)

smart_tests_cli-2.7.0/smart_tests/commands/record/deployment.py

@@ -0,0 +1,47 @@
+from typing import Annotated
+
+import click
+
+import smart_tests.args4p.typer as typer
+from smart_tests import args4p
+from smart_tests.app import Application
+from smart_tests.utils.commands import Command
+from smart_tests.utils.fail_fast_mode import set_fail_fast_mode, warn_and_exit_if_fail_fast_mode
+from smart_tests.utils.smart_tests_client import SmartTestsClient
+from smart_tests.utils.tracking import TrackingClient
+
+
+@args4p.command(help="Record a deployment (sets alias deployment:{environment}:{service} -> build)")
+def deployment(
+    app: Application,
+    build_name: Annotated[str, typer.Option(
+        "--build",
+        help="Build name",
+        metavar="NAME",
+        required=True,
+    )],
+    environment: Annotated[str, typer.Option(
+        "--environment",
+        help="Deployment environment name",
+        metavar="NAME",
+        required=True,
+    )],
+    service: Annotated[str, typer.Option(
+        "--service",
+        help="Service name",
+        metavar="NAME",
+        required=True,
+    )],
+):
+    alias_name = f"deployment:{environment}:{service}"
+
+    tracking_client = TrackingClient(Command.RECORD_DEPLOYMENT, app=app)
+    client = SmartTestsClient(app=app, tracking_client=tracking_client)
+    set_fail_fast_mode(client.is_fail_fast_mode())
+
+    try:
+        res = client.request("put", f"builds/aliases/{alias_name}", payload={"build": build_name})
+        res.raise_for_status()
+        click.echo(f"Deployment of '{service}' in '{environment}' now points to build '{build_name}'")
+    except Exception as e:
+        warn_and_exit_if_fail_fast_mode(f"Failed to record deployment: {e}")

smart_tests_cli-2.7.0/smart_tests/commands/update/__init__.py

@@ -0,0 +1,11 @@
+from ... import args4p
+from ...app import Application
+from .alias import alias
+
+
+@args4p.group(help="Update Smart Tests resources")
+def update(app: Application):
+    return app
+
+
+update.add_command(alias)

smart_tests_cli-2.7.0/smart_tests/commands/update/alias.py

@@ -0,0 +1,48 @@
+from typing import Annotated
+
+import click
+
+import smart_tests.args4p.typer as typer
+from smart_tests import args4p
+from smart_tests.app import Application
+from smart_tests.utils.commands import Command
+from smart_tests.utils.fail_fast_mode import set_fail_fast_mode, warn_and_exit_if_fail_fast_mode
+from smart_tests.utils.smart_tests_client import SmartTestsClient
+from smart_tests.utils.tracking import TrackingClient
+
+
+@args4p.command(help="Point an alias at a build")
+def alias(
+    app: Application,
+    build_name: Annotated[str, typer.Option(
+        "--build",
+        help="Build name to point the alias at",
+        metavar="NAME",
+        required=True,
+    )],
+    alias_name: Annotated[str, typer.Option(
+        "--alias",
+        help="Alias name",
+        metavar="NAME",
+        required=True,
+    )],
+):
+    tracking_client = TrackingClient(Command.UPDATE_ALIAS, app=app)
+    client = SmartTestsClient(app=app, tracking_client=tracking_client)
+    set_fail_fast_mode(client.is_fail_fast_mode())
+
+    # TODO: It's not entirely clear to me which layer is responsible for URL encoding
+    # this validation logic was copied from record/build.py
+    if "/" in alias_name or "%2f" in alias_name.lower():
+        click.echo("--alias must not contain a slash and an encoded slash", err=True)
+        raise typer.Exit(1)
+    if "%25" in alias_name:
+        click.echo("--alias must not contain encoded % (%25)", err=True)
+        raise typer.Exit(1)
+
+    try:
+        res = client.request("put", f"builds/aliases/{alias_name}", payload={"build": build_name})
+        res.raise_for_status()
+        click.echo(f"Alias '{alias_name}' now points to build '{build_name}'")
+    except Exception as e:
+        warn_and_exit_if_fail_fast_mode(f"Failed to update alias: {e}")

{smart_tests_cli-2.6.0 → smart_tests_cli-2.7.0}/smart_tests/commands/verify.py

@@ -80,20 +80,12 @@ def verify(app_instance: Application):
     client = SmartTestsClient(tracking_client=tracking_client, app=app_instance)
     java = get_java_command()
 
-    # Print the system information first so that we can get them even if there's
-    # an issue.
-
-    click.echo("Organization: " + repr(org))
-    click.echo("Workspace: " + repr(workspace))
-    click.echo("Proxy: " + repr(os.getenv("HTTPS_PROXY")))
-    click.echo("Platform: " + repr(platform.platform()))
-    click.echo("Python version: " + repr(platform.python_version()))
-    click.echo("Java command: " + repr(java))
-    click.echo("smart-tests version: " + repr(version))
-
     # raise an error here after we print out the basic diagnostics if LAUNCHABLE_TOKEN is not set.
     ensure_org_workspace()
 
+    # Fetch display names from the verification endpoint
+    org_display = org
+    workspace_display = workspace
     try:
         res = client.request("get", "verification")
         if res.status_code == 401:
@@ -111,6 +103,15 @@ def verify(app_instance: Application):
             )
             raise typer.Exit(2)
         res.raise_for_status()
+
+        # Parse display names from response, with fallback to original values
+        try:
+            data = res.json()
+            org_display = data.get("organizationDisplayName", org)
+            workspace_display = data.get("workspaceDisplayName", workspace)
+        except Exception:
+            # If JSON parsing fails, continue with original values
+            pass
     except Exception as e:
         tracking_client.send_error_event(
             event_name=Tracking.ErrorEvent.INTERNAL_CLI_ERROR,
@@ -119,6 +120,15 @@ def verify(app_instance: Application):
         )
         client.print_exception_and_recover(e)
 
+    # Print the system information after fetching display names
+    click.echo("Organization: " + repr(org_display))
+    click.echo("Workspace: " + repr(workspace_display))
+    click.echo("Proxy: " + repr(os.getenv("HTTPS_PROXY")))
+    click.echo("Platform: " + repr(platform.platform()))
+    click.echo("Python version: " + repr(platform.python_version()))
+    click.echo("Java command: " + repr(java))
+    click.echo("smart-tests version: " + repr(version))
+
     if java is None:
         msg = "Java is not installed. Install Java version 8 or newer to use the Smart Tests CLI."
         tracking_client.send_error_event(

{smart_tests_cli-2.6.0 → smart_tests_cli-2.7.0}/smart_tests/utils/commands.py

@@ -10,6 +10,10 @@ class Command(Enum):
     COMMIT = 'COMMIT'
     DETECT_FLAKE = 'DETECT_FLAKE'
     GATE = 'GATE'
+    UPDATE_ALIAS = 'UPDATE_ALIAS'
+    RECORD_DEPLOYMENT = 'RECORD_DEPLOYMENT'
+
+    # when you add a new constant here, the server also needs to get a new constant in cli_tracking.proto
 
     def display_name(self):
         return self.value.lower().replace('_', ' ')

{smart_tests_cli-2.6.0 → smart_tests_cli-2.7.0/smart_tests_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smart-tests-cli
-Version: 2.6.0
+Version: 2.7.0
 Summary: Smart Tests CLI
 Author-email: CloudBees <support@cloudbees.com>
 License: Apache Software License v2

{smart_tests_cli-2.6.0 → smart_tests_cli-2.7.0}/smart_tests_cli.egg-info/SOURCES.txt

@@ -57,10 +57,13 @@ smart_tests/commands/record/attachment.py
 smart_tests/commands/record/build.py
 smart_tests/commands/record/case_event.py
 smart_tests/commands/record/commit.py
+smart_tests/commands/record/deployment.py
 smart_tests/commands/record/session.py
 smart_tests/commands/record/tests.py
 smart_tests/commands/stats/__init__.py
 smart_tests/commands/stats/test_sessions.py
+smart_tests/commands/update/__init__.py
+smart_tests/commands/update/alias.py
 smart_tests/docs/antora.yml
 smart_tests/docs/modules/ROOT/nav.adoc
 smart_tests/docs/modules/ROOT/assets/images/0607-inference.png
@@ -400,8 +403,11 @@ tests/commands/record/test_attachment.py
 tests/commands/record/test_build.py
 tests/commands/record/test_case_event.py
 tests/commands/record/test_commit.py
+tests/commands/record/test_deployment.py
 tests/commands/record/test_session.py
 tests/commands/record/test_tests.py
+tests/commands/update/__init__.py
+tests/commands/update/test_alias.py
 tests/data/adb/subset_result.json
 tests/data/ant/record_test_result.json
 tests/data/ant/subset_result.json

{smart_tests_cli-2.6.0 → smart_tests_cli-2.7.0}/tests/commands/record/test_build.py

@@ -71,7 +71,8 @@ class BuildTest(CliTestCase):
                     },
                 ],
                 "links": [],
-                "timestamp": None
+                "timestamp": None,
+                "components": []
             }, payload)
 
     @responses.activate
@@ -112,7 +113,8 @@ class BuildTest(CliTestCase):
                     },
                 ],
                 "links": [],
-                "timestamp": None
+                "timestamp": None,
+                "components": []
             }, payload)
 
     @responses.activate
@@ -151,7 +153,8 @@ class BuildTest(CliTestCase):
                         },
                     ],
                     "links": [],
-                    "timestamp": None
+                    "timestamp": None,
+                    "components": []
                 }, payload)
 
         finally:
@@ -191,7 +194,8 @@ class BuildTest(CliTestCase):
                     },
                 ],
                 "links": [],
-                'timestamp': None
+                'timestamp': None,
+                "components": []
             }, payload)
         responses.calls.reset()
 
@@ -223,7 +227,8 @@ class BuildTest(CliTestCase):
                     },
                 ],
                 "links": [],
-                "timestamp": None
+                "timestamp": None,
+                "components": []
             }, payload)
         responses.calls.reset()
 
@@ -255,7 +260,8 @@ class BuildTest(CliTestCase):
                     },
                 ],
                 "links": [],
-                "timestamp": None
+                "timestamp": None,
+                "components": []
             }, payload)
         responses.calls.reset()
         self.assertIn("Invalid repository name B in a --branch option.", result.output)
@@ -295,7 +301,8 @@ class BuildTest(CliTestCase):
                     },
                 ],
                 "links": [],
-                "timestamp": None
+                "timestamp": None,
+                "components": []
             }, payload)
         responses.calls.reset()
 
@@ -367,7 +374,8 @@ class BuildTest(CliTestCase):
                     },
                 ],
                 "links": [],
-                "timestamp": "2025-01-23T12:34:56+00:00"
+                "timestamp": "2025-01-23T12:34:56+00:00",
+                "components": []
             }, payload)
 
     @mock.patch.dict(os.environ, {"SMART_TESTS_TOKEN": CliTestCase.smart_tests_token})
@@ -412,7 +420,8 @@ class BuildTest(CliTestCase):
                     {"title": "url", "url": "https://smart-tests.test", "kind": "CUSTOM_LINK"},
                     {"title": "build", "url": "https://build.smart-tests.test", "kind": "CUSTOM_LINK"},
                 ],
-                "timestamp": None
+                "timestamp": None,
+                "components": []
             }, payload)
 
         # with invalid kind
@@ -505,3 +514,93 @@ class BuildTest(CliTestCase):
             "--build",
             self.build_name)
         self.assert_success(result)
+
+    @responses.activate
+    @mock.patch.dict(os.environ, {"SMART_TESTS_TOKEN": CliTestCase.smart_tests_token})
+    @mock.patch.dict(os.environ, {"GITHUB_ACTIONS": ""})
+    @mock.patch.dict(os.environ, {"GITHUB_PULL_REQUEST_URL": ""})
+    def test_with_components(self):
+        result = self.cli(
+            "record", "build",
+            "--build", self.build_name,
+            "--branch", "main",
+            "--no-commit-collection",
+            "--commit", ".=abc123",
+            "--component", "payment=staging-payment-svc",
+            "--component", "auth=staging-auth-svc",
+        )
+        self.assert_success(result)
+
+        payload = json.loads(responses.calls[1].request.body.decode())
+        self.assert_json_orderless_equal(
+            {
+                "buildNumber": "123",
+                "lineage": "main",
+                "commitHashes": [{"repositoryName": ".", "commitHash": "abc123", "branchName": ""}],
+                "links": [],
+                "timestamp": None,
+                "components": [
+                    {"name": "payment", "build": "staging-payment-svc"},
+                    {"name": "auth", "build": "staging-auth-svc"},
+                ],
+            }, payload)
+
+    @mock.patch.dict(os.environ, {"SMART_TESTS_TOKEN": CliTestCase.smart_tests_token})
+    def test_duplicate_component_name(self):
+        result = self.cli(
+            "record", "build",
+            "--build", self.build_name,
+            "--branch", "main",
+            "--no-commit-collection",
+            "--commit", ".=abc123",
+            "--component", "payment=svc-a",
+            "--component", "payment=svc-b",
+        )
+        self.assert_exit_code(result, 1)
+        self.assertIn("Duplicate component name: 'payment'", result.output)
+
+    @responses.activate
+    @mock.patch.dict(os.environ, {"SMART_TESTS_TOKEN": CliTestCase.smart_tests_token})
+    # to tests on GitHub Actions
+    @mock.patch.dict(os.environ, {"GITHUB_ACTIONS": ""})
+    @mock.patch.dict(os.environ, {"GITHUB_PULL_REQUEST_URL": ""})
+    def test_include_environment(self):
+        from smart_tests.utils.http_client import get_base_url
+        aliases_url = (
+            f"{get_base_url()}/intake/organizations/{self.organization}"
+            f"/workspaces/{self.workspace}/builds/aliases"
+        )
+        responses.add(responses.GET, aliases_url, json=[
+            {"alias": "deployment:staging:payment", "buildName": "payment-main-137"},
+            {"alias": "deployment:staging:auth", "buildName": "auth-main-42"},
+        ], status=200)
+
+        result = self.cli(
+            "record", "build",
+            "--build", self.build_name,
+            "--branch", "main",
+            "--no-commit-collection",
+            "--commit", ".=abc123",
+            "--repo-branch-map", ".=AIENG-404",
+            "--include-environment", "staging",
+        )
+        self.assert_success(result)
+
+        post_call = next(c for c in responses.calls if c.request.method == "POST" and "builds" in c.request.url)
+        payload = json.loads(post_call.request.body.decode())
+        self.assert_json_orderless_equal(
+            {
+                "buildNumber": "123",
+                "lineage": "main",
+                "commitHashes": [{"repositoryName": ".", "commitHash": "abc123", "branchName": "AIENG-404"}],
+                "links": [],
+                "timestamp": None,
+                "components": [
+                    {"name": "payment", "build": "payment-main-137"},
+                    {"name": "auth", "build": "auth-main-42"},
+                ],
+            }, payload)
+
+        from urllib.parse import unquote
+        get_call = next(c for c in responses.calls if c.request.method == "GET" and "aliases" in c.request.url)
+        self.assertIn("deployment:staging:*", unquote(get_call.request.url))

smart_tests_cli-2.7.0/tests/commands/record/test_deployment.py

@@ -0,0 +1,59 @@
+import json
+import os
+from unittest import mock
+
+import responses  # type: ignore
+
+from smart_tests.utils.http_client import get_base_url
+from tests.cli_test_case import CliTestCase
+
+
+class DeploymentTest(CliTestCase):
+    environment = "staging"
+    service = "payment"
+    build_name = "jenkins-main-135"
+    error_body = "Build 'jenkins-main-135' not found"
+
+    def deployment_url(self):
+        alias_name = f"deployment:{self.environment}:{self.service}"
+        return (
+            f"{get_base_url()}/intake/organizations/{self.organization}"
+            f"/workspaces/{self.workspace}/builds/aliases/{alias_name}"
+        )
+
+    @responses.activate
+    @mock.patch.dict(os.environ, {"SMART_TESTS_TOKEN": CliTestCase.smart_tests_token})
+    def test_record_deployment(self):
+        responses.add(responses.PUT, self.deployment_url(), json={}, status=200)
+
+        result = self.cli(
+            "record", "deployment",
+            "--build", self.build_name,
+            "--environment", self.environment,
+            "--service", self.service,
+        )
+        self.assert_success(result)
+
+        put_call = next(c for c in responses.calls if c.request.method == "PUT")
+        self.assert_json_orderless_equal(
+            {"build": self.build_name},
+            json.loads(put_call.request.body)
+        )
+        self.assertIn(self.service, result.output)
+        self.assertIn(self.environment, result.output)
+        self.assertIn(self.build_name, result.output)
+
+    @responses.activate
+    @mock.patch.dict(os.environ, {"SMART_TESTS_TOKEN": CliTestCase.smart_tests_token})
+    def test_record_deployment_build_not_found(self):
+        """Without fail-fast mode: prints warning in yellow, exits 0 (doesn't halt CI)."""
+        responses.add(responses.PUT, self.deployment_url(), json={"reason": self.error_body}, status=404)
+
+        result = self.cli(
+            "record", "deployment",
+            "--build", self.build_name,
+            "--environment", self.environment,
+            "--service", self.service,
+        )
+        self.assert_success(result)
+        self.assertIn(self.error_body, result.output)