smart-tests-cli 2.4.0__tar.gz → 2.4.2__tar.gz

smart_tests_cli-2.4.2/.dockerignore

@@ -0,0 +1,5 @@
+# Git files exclude config
+# Don't exclude entire .git because setuptools-scm need git metadata for package builds
+.git/config
+.gitignore
+.gitattributes

{smart_tests_cli-2.4.0 → smart_tests_cli-2.4.2}/PKG-INFO

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

{smart_tests_cli-2.4.0 → smart_tests_cli-2.4.2}/smart_tests/test_runners/smart_tests.py

@@ -169,16 +169,20 @@ class CommonRecordTestImpls:
                          source_roots: Annotated[list[str], typer.Argument(
                              multiple=True,
                              help="Source directories containing test report files"
-                         )]):
+                         )],
+                         file_path_attribute: Annotated[list[str], typer.Option(
+                             "--file-path-attribute",
+                             multiple=True,
+                             help="Attributes to look for file paths in test reports (e.g., name, classname, file, filepath)"
+                         )] = ["file", "filepath"]):
             def path_builder(
                 case: TestCase, suite: TestSuite, report_file: str
             ) -> TestPath:
                 def find_filename():
                     """look for what looks like file names from test reports"""
                     for e in [case, suite]:
-                        for a in ["file", "filepath"]:
-                            filepath = e._elem.attrib.get(a)
-                            if filepath:
+                        for a in file_path_attribute:
+                            if filepath := e._elem.attrib.get(a):
                                 return filepath
                     return None  # failing to find a test name
 
@@ -188,9 +192,9 @@ class CommonRecordTestImpls:
 
                 # default test path in `subset` expects to have this file name
                 test_path = [client.make_file_path_component(filepath)]
-                if suite.name:
+                if suite.name and suite.name != filepath:
                     test_path.append({"type": "testsuite", "name": suite.name})
-                if case.name:
+                if case.name and case.name != filepath:
                     test_path.append({"type": "testcase", "name": case.name})
                 return test_path
 

{smart_tests_cli-2.4.0 → smart_tests_cli-2.4.2}/smart_tests/utils/session.py

@@ -30,9 +30,23 @@ class SessionId:
         '''This is the method in which we parse the user input, so be defensive'''
         if id.startswith('@'):
             file_path = id[1:]
+            # Earlier versions of PowerShell write Unicode BOM when redirecting output to a file.
+            # https://github.com/PowerShell/PowerShell/issues/8592
+            # Since we tell people to redirect `record session` output to a file, here we can
+            # encounter such files. Here's the scheme to cope with this.
+            #
+            # First we try utf-8-sig, which handles UTF-8 BOM correctly.
+            # our session ID only uses ASCII chars, so unless the writer used non ascii compatible encoding
+            # (e.g., EBCDIC but those are very very unlikely), this will read the file correctly.
+            # If the writer used UTF-16 (e.g., legacy PowerShell on Windows), we'll get a decode error, and
+            # then we try UTF-16, which handles BOM correctly.
             try:
-                with open(file_path, 'r') as f:
-                    id = f.read().strip()
+                try:
+                    with open(file_path, 'r', encoding='utf-8-sig') as f:
+                        id = f.read().strip()
+                except UnicodeDecodeError:
+                    with open(file_path, 'r', encoding='utf-16') as f:
+                        id = f.read().strip()
             except FileNotFoundError:
                 raise BadCmdLineException(f"Session file '{file_path}' not found.")
             except IOError as e:

{smart_tests_cli-2.4.0 → smart_tests_cli-2.4.2}/smart_tests_cli.egg-info/PKG-INFO

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

{smart_tests_cli-2.4.0 → smart_tests_cli-2.4.2}/smart_tests_cli.egg-info/SOURCES.txt

@@ -1,5 +1,6 @@
 .bazelrc
 .bazelversion
+.dockerignore
 .editorconfig
 .gitignore
 .pre-commit-config.yaml
@@ -264,6 +265,10 @@ tests/data/cypress/subset_result.json
 tests/data/cypress/test-result.xml
 tests/data/dotnet/record_test_result.json
 tests/data/dotnet/test-result.xml
+tests/data/file/record_test_result.json
+tests/data/file/record_test_result_custom_attribute.json
+tests/data/file/result.xml
+tests/data/file/result_custom_attribute.xml
 tests/data/flutter/record_test_result.json
 tests/data/flutter/report.json
 tests/data/git_log_ingest/sample.out
@@ -379,6 +384,7 @@ tests/test_runners/test_cts.py
 tests/test_runners/test_cucumber.py
 tests/test_runners/test_cypress.py
 tests/test_runners/test_dotnet.py
+tests/test_runners/test_file.py
 tests/test_runners/test_go_test.py
 tests/test_runners/test_googletest.py
 tests/test_runners/test_gradle.py

smart_tests_cli-2.4.2/tests/data/file/record_test_result.json

@@ -0,0 +1,53 @@
+{
+  "events": [
+    {
+      "type": "case",
+      "testPath": [
+        {
+          "type": "file",
+          "name": "tests/test_example.py"
+        },
+        {
+          "type": "testsuite",
+          "name": "Suite 1"
+        },
+        {
+          "type": "testcase",
+          "name": "test_case_1"
+        }
+      ],
+      "duration": 0.5,
+      "status": 1,
+      "stdout": "",
+      "stderr": "",
+      "data": null
+    },
+    {
+      "type": "case",
+      "testPath": [
+        {
+          "type": "file",
+          "name": "tests/test_example.py"
+        },
+        {
+          "type": "testsuite",
+          "name": "Suite 1"
+        },
+        {
+          "type": "testcase",
+          "name": "test_case_2"
+        }
+      ],
+      "duration": 0.734,
+      "status": 1,
+      "stdout": "",
+      "stderr": "",
+      "data": null
+    }
+  ],
+  "testRunner": "file",
+  "group": "",
+  "noBuild": false,
+  "flavors": [],
+  "testSuite": ""
+}

smart_tests_cli-2.4.2/tests/data/file/record_test_result_custom_attribute.json

@@ -0,0 +1,45 @@
+{
+  "events": [
+    {
+      "type": "case",
+      "testPath": [
+        {
+          "type": "file",
+          "name": "tests/test_custom.py"
+        },
+        {
+          "type": "testsuite",
+          "name": "Suite 1"
+        }
+      ],
+      "duration": 0.5,
+      "status": 1,
+      "stdout": "",
+      "stderr": "",
+      "data": null
+    },
+    {
+      "type": "case",
+      "testPath": [
+        {
+          "type": "file",
+          "name": "tests/test_custom2.py"
+        },
+        {
+          "type": "testsuite",
+          "name": "Suite 1"
+        }
+      ],
+      "duration": 0.734,
+      "status": 1,
+      "stdout": "",
+      "stderr": "",
+      "data": null
+    }
+  ],
+  "testRunner": "file",
+  "group": "",
+  "noBuild": false,
+  "flavors": [],
+  "testSuite": ""
+}

smart_tests_cli-2.4.2/tests/data/file/result.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="Test Suite" time="1.234" tests="2" failures="0">
+  <testsuite name="Suite 1" timestamp="2025-10-27T01:20:06" tests="2" file="tests/test_example.py" time="1.234" failures="0">
+    <testcase name="test_case_1" time="0.500" classname="TestExample">
+    </testcase>
+    <testcase name="test_case_2" time="0.734" classname="TestExample">
+    </testcase>
+  </testsuite>
+</testsuites>

smart_tests_cli-2.4.2/tests/data/file/result_custom_attribute.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="Test Suite" time="1.234" tests="2" failures="0">
+  <testsuite name="Suite 1" timestamp="2025-10-27T01:20:06" tests="2" time="1.234" failures="0">
+    <testcase time="0.500" name="tests/test_custom.py">
+    </testcase>
+    <testcase time="0.734" name="tests/test_custom2.py">
+    </testcase>
+  </testsuite>
+</testsuites>

smart_tests_cli-2.4.2/tests/test_runners/test_file.py

@@ -0,0 +1,41 @@
+import os
+from unittest import mock
+
+import responses  # type: ignore
+
+from tests.cli_test_case import CliTestCase
+
+
+class FileTest(CliTestCase):
+    @responses.activate
+    @mock.patch.dict(os.environ, {"SMART_TESTS_TOKEN": CliTestCase.smart_tests_token})
+    def test_record_test_file(self):
+        result = self.cli(
+            "record",
+            "tests",
+            "--session",
+            self.session,
+            "file",
+            str(self.test_files_dir.joinpath("result.xml")),
+        )
+
+        self.assert_success(result)
+        self.assert_record_tests_payload("record_test_result.json")
+
+    @responses.activate
+    @mock.patch.dict(os.environ, {"SMART_TESTS_TOKEN": CliTestCase.smart_tests_token})
+    def test_record_test_file_with_custom_file_path_attribute(self):
+        """Test that --file-path-attribute option allows specifying custom attributes"""
+        result = self.cli(
+            "record",
+            "tests",
+            "--session",
+            self.session,
+            "file",
+            "--file-path-attribute",
+            "name",
+            str(self.test_files_dir.joinpath("result_custom_attribute.xml")),
+        )
+
+        self.assert_success(result)
+        self.assert_record_tests_payload("record_test_result_custom_attribute.json")

smart_tests_cli-2.4.2/tests/utils/test_session.py

@@ -0,0 +1,89 @@
+import os
+import tempfile
+from unittest import mock
+
+import responses
+
+from smart_tests.utils.http_client import get_base_url
+from smart_tests.utils.session import SessionId, TestSession, get_session
+from smart_tests.utils.smart_tests_client import SmartTestsClient
+from tests.cli_test_case import CliTestCase
+
+
+class TestTestSession(CliTestCase):
+    @mock.patch.dict(os.environ, {"SMART_TESTS_TOKEN": CliTestCase.smart_tests_token})
+    @responses.activate
+    def test_get_session(self):
+        client = SmartTestsClient(base_url=get_base_url())
+        responses.replace(
+            responses.GET,
+            f"{get_base_url()}/intake/organizations/{self.organization}/workspaces/{self.workspace}"
+            f"/builds/{self.build_name}/test_sessions/{self.session_id}",
+            json={
+                'id': self.session_id,
+                'buildId': 456,
+                'buildNumber': self.build_name,
+                'isObservation': True,
+                'name': 'dummy-name',
+            },
+            status=200)
+
+        test_session = get_session(SessionId(self.session), client)
+        self.assertEqual(test_session, TestSession(
+            id=self.session_id,
+            build_id=456,
+            build_name=self.build_name,
+            observation_mode=True,
+            name='dummy-name'))
+
+        # not found test session case
+        responses.replace(
+            responses.GET,
+            f"{get_base_url()}/intake/organizations/{self.organization}/workspaces/{self.workspace}"
+            f"/builds/{self.build_name}/test_sessions/{self.session_id}",
+            json={},
+            status=404)
+
+        with self.assertRaises(SystemExit) as cm:
+            get_session(SessionId(self.session), client)
+        self.assertEqual(cm.exception.code, 1)
+
+
+class TestSessionId(CliTestCase):
+    """Test SessionId initialization and file reading with various encodings"""
+
+    def setUp(self):
+        super().setUp()
+        # A valid session ID for testing
+        self.valid_session_id = f"builds/{self.build_name}/test_sessions/{self.session_id}"
+
+    def _assert_session_from_file(self, encoding: str, content: str):
+        """Helper method to test reading session ID from a file with specific encoding"""
+        with tempfile.NamedTemporaryFile(mode='w', encoding=encoding, delete=False, suffix='.txt') as f:
+            f.write(content)
+            temp_path = f.name
+
+        try:
+            session = SessionId(f"@{temp_path}")
+            self.assertEqual(str(session), self.valid_session_id)
+            self.assertEqual(session.build_part, self.build_name)
+            self.assertEqual(session.test_part, self.session_id)
+        finally:
+            os.unlink(temp_path)
+
+    def test_session_id_from_utf8_file_without_bom(self):
+        """Test reading session ID from a UTF-8 file without BOM"""
+        # also, extra NL
+        self._assert_session_from_file('utf-8', f"{self.valid_session_id}\n")
+
+    def test_session_id_from_utf8_file_with_bom(self):
+        """Test reading session ID from a UTF-8 file with BOM (UTF-8 signature)"""
+        self._assert_session_from_file('utf-8-sig', self.valid_session_id)
+
+    def test_session_id_from_utf16_le_file(self):
+        """Test reading session ID from a UTF-16 LE file with BOM (PowerShell default on Windows)"""
+        self._assert_session_from_file('utf-16-le', f'\ufeff{self.valid_session_id}')
+
+    def test_session_id_from_utf16_file(self):
+        """Test reading session ID from a UTF-16 file with BOM (using utf-16 encoding)"""
+        self._assert_session_from_file('utf-16', self.valid_session_id)

smart_tests_cli-2.4.0/tests/utils/test_session.py

@@ -1,48 +0,0 @@
-import os
-from unittest import mock
-
-import responses
-
-from smart_tests.utils.http_client import get_base_url
-from smart_tests.utils.session import SessionId, TestSession, get_session
-from smart_tests.utils.smart_tests_client import SmartTestsClient
-from tests.cli_test_case import CliTestCase
-
-
-class TestTestSession(CliTestCase):
-    @mock.patch.dict(os.environ, {"SMART_TESTS_TOKEN": CliTestCase.smart_tests_token})
-    @responses.activate
-    def test_get_session(self):
-        client = SmartTestsClient(base_url=get_base_url())
-        responses.replace(
-            responses.GET,
-            f"{get_base_url()}/intake/organizations/{self.organization}/workspaces/{self.workspace}"
-            f"/builds/{self.build_name}/test_sessions/{self.session_id}",
-            json={
-                'id': self.session_id,
-                'buildId': 456,
-                'buildNumber': self.build_name,
-                'isObservation': True,
-                'name': 'dummy-name',
-            },
-            status=200)
-
-        test_session = get_session(SessionId(self.session), client)
-        self.assertEqual(test_session, TestSession(
-            id=self.session_id,
-            build_id=456,
-            build_name=self.build_name,
-            observation_mode=True,
-            name='dummy-name'))
-
-        # not found test session case
-        responses.replace(
-            responses.GET,
-            f"{get_base_url()}/intake/organizations/{self.organization}/workspaces/{self.workspace}"
-            f"/builds/{self.build_name}/test_sessions/{self.session_id}",
-            json={},
-            status=404)
-
-        with self.assertRaises(SystemExit) as cm:
-            get_session(SessionId(self.session), client)
-        self.assertEqual(cm.exception.code, 1)