playwright: add support for test file prefixes in JSON reports

Author: ono-max

launchable/test_runners/playwright.py

@@ -3,7 +3,9 @@
 # https://playwright.dev/
 #
 import json
+import os
 from typing import Dict, Generator, List
+from pathlib import Path
 
 import click
 from junitparser import TestCase, TestSuite  # type: ignore
@@ -173,13 +175,54 @@ def parse_func(self, report_file: str) -> Generator[CaseEvent, None, None]:
             click.echo("Can't find test results from {}. Make sure to confirm report file.".format(
                 report_file), err=True)
 
+        test_prefix = self._compute_test_prefix(data)
         for s in suites:
             # The title of the root suite object contains the file name.
-            test_file = str(s.get("title", ""))
+            test_file = self._resolve_test_file(str(s.get("title", "")), test_prefix)
 
             for event in self._parse_suites(test_file, s, []):
                 yield event
 
+    def _compute_test_prefix(self, report: Dict) -> str:
+        """
+        Playwright JSON stores test `file` paths relative to `config.rootDir`.
+        Our CLI wants paths relative to the Playwright config directory
+        (usually the project/repo root), so we compute:
+            relpath(root_dir, base_dir)
+        where base_dir = dirname(configFile).
+
+        Example:
+            configFile = /repo/playwright.config.ts
+            rootDir    = /repo/tests
+            relpath(...) -> "tests"
+        """
+        config: Dict = report.get("config", {})
+        config_file = str(config.get("configFile", ""))
+        root_dir = str(config.get("rootDir", ""))
+        if not config_file or not root_dir:
+            return ""
+
+        base_dir = Path(config_file).parent
+        try:
+            test_prefix = Path(root_dir).relative_to(base_dir).as_posix()
+        except ValueError:
+            return ""
+
+        if test_prefix == ".":
+            return ""
+
+        return test_prefix
+
+    def _resolve_test_file(self, test_file: str, test_prefix: str) -> str:
+        if not test_prefix or not test_file:
+            return test_file
+
+        # Guard against duplicate paths when report data is already prefixed.
+        if test_file.startswith(test_prefix):
+            return test_file
+
+        return Path(test_prefix, test_file).as_posix()
+
     def _parse_suites(self, test_file: str, suite: Dict[str, Dict], test_case_names: List[str] = []) -> List:
         events = []
 

tests/data/playwright/report_with_prefix.json

@@ -0,0 +1,64 @@
+{
+  "config": {
+    "configFile": "/repo/playwright.config.ts",
+    "rootDir": "/repo/packages/e2e"
+  },
+  "suites": [
+    {
+      "title": "tests/a.spec.ts",
+      "specs": [],
+      "suites": [
+        {
+          "title": "smoke",
+          "specs": [
+            {
+              "title": "passes",
+              "line": 10,
+              "tests": [
+                {
+                  "results": [
+                    {
+                      "status": "passed",
+                      "duration": 12,
+                      "stdout": [],
+                      "errors": []
+                    }
+                  ]
+                }
+              ]
+            }
+          ],
+          "suites": []
+        }
+      ]
+    },
+    {
+      "title": "packages/e2e/tests/b.spec.ts",
+      "specs": [],
+      "suites": [
+        {
+          "title": "smoke",
+          "specs": [
+            {
+              "title": "already prefixed",
+              "line": 20,
+              "tests": [
+                {
+                  "results": [
+                    {
+                      "status": "passed",
+                      "duration": 15,
+                      "stdout": [],
+                      "errors": []
+                    }
+                  ]
+                }
+              ]
+            }
+          ],
+          "suites": []
+        }
+      ]
+    }
+  ]
+}

tests/test_runners/test_playwright.py

@@ -64,3 +64,20 @@ def _test_test_path_status(payload, test_path: str, status: CaseEvent) -> bool:
                  'playwright', '--json', str(self.test_files_dir.joinpath("report.json")))
         json_payload = json.loads(gzip.decompress(self.find_request('/events', 1).request.body).decode())
         self.assertEqual(_test_test_path_status(json_payload, target_test_path, CaseEvent.TEST_FAILED), True)
+
+    @responses.activate
+    @mock.patch.dict(os.environ,
+                     {"LAUNCHABLE_TOKEN": CliTestCase.launchable_token})
+    def test_record_test_with_json_option_adds_prefix_from_config(self):
+        report_file = str(self.test_files_dir.joinpath("report_with_prefix.json"))
+
+        result = self.cli('record', 'tests', '--session', self.session,
+                          'playwright', '--json', report_file)
+
+        print(result.output)
+        self.assert_success(result)
+
+        payload = json.loads(gzip.decompress(self.find_request('/events').request.body).decode())
+        test_paths = [unparse_test_path(event.get("testPath")) for event in payload.get("events")]
+        self.assertIn("file=packages/e2e/tests/a.spec.ts#testcase=smoke › passes", test_paths)
+        self.assertIn("file=packages/e2e/tests/b.spec.ts#testcase=smoke › already prefixed", test_paths)