Merge pull request #1147 from cloudbees-oss/AIENG-234

restore --link option to the build command

Author: Konboi

smart_tests/commands/record/build.py

@@ -6,6 +6,7 @@
 import typer
 from tabulate import tabulate
 
+from smart_tests.commands.record.session import KeyValue, LinkKind, parse_key_value
 from smart_tests.utils.link import CIRCLECI_KEY, GITHUB_ACTIONS_KEY, JENKINS_URL_KEY, capture_link
 from smart_tests.utils.tracking import Tracking, TrackingClient
 
@@ -71,6 +72,11 @@ def build(
         help="Used to overwrite the build time when importing historical data. "
              "Note: Format must be `YYYY-MM-DDThh:mm:ssTZD` or `YYYY-MM-DDThh:mm:ss` (local timezone applied)"
     )] = None,
+    links: Annotated[List[KeyValue], typer.Option(
+        "--link",
+        help="Set external link of a title and url",
+        parser=parse_key_value,
+    )] = [],
 ):
     app = ctx.obj
 
@@ -283,9 +289,16 @@ def synthesize_workspaces() -> List[Workspace]:
 
     # send all the data to server and obtain build_id, or none if the service is down, to recover
     def send(ws: List[Workspace]) -> str | None:
+        # TODO(Konboi): port forward #1128
         # figure out all the CI links to capture
         def compute_links():
             _links = capture_link(os.environ)
+            for k, v in links:
+                _links.append({
+                    "title": k,
+                    "url": v,
+                    "kind": LinkKind.CUSTOM_LINK.name,
+                })
             return _links
 
         try:

smart_tests/commands/record/session.py

@@ -45,7 +45,7 @@ def session(
     )] = False,
     links: Annotated[List[KeyValue], typer.Option(
         "--link",
-        help="Set external link of atitle and url",
+        help="Set external link of a title and url",
         parser=parse_key_value,
     )] = [],
     is_no_build: Annotated[bool, typer.Option(

tests/commands/record/test_build.py

@@ -384,3 +384,33 @@ def test_repo_branch_map_requires_no_commit_collection(self):
             ".=main")
         self.assert_exit_code(result, 1)
         self.assertIn("--no-commit-collection must be specified when --repo-branch-map is used", result.stdout)
+
+    @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_with_link(self):
+        result = self.cli(
+            "record", "build", "--build", self.build_name,
+            '--link', 'url=https://smart-tests.test',
+            '--link', 'build:https://build.smart-tests.test',
+            # set these options for easy to check payload
+            "--no-commit-collection",
+            "--branch", "main",
+            "--commit", "app=abc12",
+        )
+
+        self.assert_exit_code(result, 0)
+        payload = json.loads(responses.calls[1].request.body.decode())
+        self.assert_json_orderless_equal(
+            {
+                "buildNumber": "123",
+                "lineage": "main",
+                "commitHashes": [{"repositoryName": "app", "commitHash": "abc12", "branchName": ""}],
+                "links": [
+                    {"title": "url", "url": "https://smart-tests.test", "kind": "CUSTOM_LINK"},
+                    {"title": "build", "url": "https://build.smart-tests.test", "kind": "CUSTOM_LINK"},
+                ],
+                "timestamp": None
+            }, payload)