trcli 1.14.2__tar.gz → 1.14.3__tar.gz

{trcli-1.14.2 → trcli-1.14.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: trcli
-Version: 1.14.2
+Version: 1.14.3
 License-File: LICENSE.md
 Requires-Dist: click<8.2.2,>=8.1.0
 Requires-Dist: pyyaml<7.0.0,>=6.0.0

{trcli-1.14.2 → trcli-1.14.3}/README.md

@@ -33,7 +33,7 @@ trcli
 ```
 You should get something like this:
 ```
-TestRail CLI v1.14.2
+TestRail CLI v1.14.3
 Copyright 2025 Gurock Software GmbH - www.gurock.com
 Supported and loaded modules:
     - parse_junit: JUnit XML Files (& Similar)
@@ -44,6 +44,7 @@ Supported and loaded modules:
     - parse_openapi: OpenAPI YML Files
     - add_run: Create a new test run
     - labels: Manage labels (add, update, delete, list)
+    - results: Manage test results (list, update)
     - references: Manage references (cases and runs)
 ```
 
@@ -51,7 +52,7 @@ CLI general reference
 --------
 ```shell
 $ trcli --help
-TestRail CLI v1.14.2
+TestRail CLI v1.14.3
 Copyright 2025 Gurock Software GmbH - www.gurock.com
 Usage: trcli [OPTIONS] COMMAND [ARGS]...
 
@@ -92,6 +93,7 @@ Commands:
   export_gherkin Export BDD test case from TestRail as .feature file
   import_gherkin Upload Gherkin .feature file to TestRail
   labels         Manage labels in TestRail
+  results        Manage test results in TestRail
   parse_cucumber Parse Cucumber JSON results and upload to TestRail
   parse_junit    Parse JUnit report and upload results to TestRail
   parse_openapi  Parse OpenAPI spec and create cases in TestRail
@@ -1357,6 +1359,75 @@ tests are run across parallel, independent test nodes, all nodes should report t
 First, use the `add_run` command to create a new run; then, pass the run title and id to each of the test nodes, which
 will be used to upload all results into the same test run.
 
+#### Managing Test Results
+
+The `results` command provides comprehensive test result management capabilities with two subcommands: `list` and `update`.
+
+##### Listing Test Results
+
+Retrieve test results from TestRail with flexible filtering options:
+
+```bash
+# List results for a specific test
+trcli -c myconfig.yml results list --test-id 1001
+
+# List all results for a run
+trcli -c myconfig.ymlresults list --run-id 100
+
+# List results for a specific case within a run
+trcli -c myconfig.ymlresults list --case-id 200 --run-id 100
+
+# Use pagination
+trcli -c myconfig.yml results list --test-id 1001 --offset 10 --limit 50
+
+# Output as JSON for processing
+trcli results list --test-id 1001 --json-output
+
+# Show all fields including custom fields in detail
+trcli results list --run-id 100 --show-all-fields
+```
+
+**Filtering options:**
+- `--test-id`: Get results for a specific test (mutually exclusive with other filters)
+- `--run-id`: Get results for all tests in a run (can be used alone or with --case-id)
+- `--case-id`: Get results for a specific case (requires --run-id)
+- `--offset`: Pagination offset (default: 0)
+- `--limit`: Pagination limit (default: 250)
+- `--json-output`: Output raw JSON response from API
+- `--show-all-fields`: Show all fields including custom fields in detail
+
+##### Updating Test Results
+
+Update existing test results after they have been created. Useful for re-run scenarios, adding comments, linking defects, or correcting result data:
+
+```bash
+# Update test result status and add comment
+trcli -c myconfig.yml results update --result-id 12345 --status-id 5 --comment "Test failed due to timeout"
+
+# Update multiple fields at once
+trcli -c myconfig.yml results update --result-id 12345 \
+  --status-id 1 \
+  --comment "Passed after retry" \
+  --elapsed "45s" \
+  --defects "BUG-456" \
+  --version "2.1.0"
+
+# Update custom fields (JSON format)
+trcli -c myconfig.yml results update --result-id 12345 \
+  --custom-fields '{"custom_test_environment": "Production", "custom_browser": "Chrome"}'
+
+# Assign result to a user
+trcli -c myconfig.yml results update --result-id 12345 --assignedto-id 7 --comment "Needs investigation"
+```
+
+**Status IDs:** 1=Passed, 2=Blocked, 3=Untested, 4=Retest, 5=Failed
+
+For complete documentation:
+```bash
+trcli results list --help
+trcli results update --help
+```
+
 #### Labels Management
 
 The TestRail CLI provides comprehensive label management capabilities using the `labels` command. Labels help categorize and organize your test management assets efficiently, making it easier to filter and manage test cases, runs, and projects.
@@ -2109,7 +2180,7 @@ Options:
 ### Reference
 ```shell
 $ trcli add_run --help
-TestRail CLI v1.14.2
+TestRail CLI v1.14.3
 Copyright 2025 Gurock Software GmbH - www.gurock.com
 Usage: trcli add_run [OPTIONS]
 
@@ -2319,7 +2390,7 @@ providing you with a solid base of test cases, which you can further expand on T
 ### Reference
 ```shell
 $ trcli parse_openapi --help
-TestRail CLI v1.14.2
+TestRail CLI v1.14.3
 Copyright 2025 Gurock Software GmbH - www.gurock.com
 Usage: trcli parse_openapi [OPTIONS]
 

{trcli-1.14.2 → trcli-1.14.3}/tests/test_api_request_handler.py

@@ -1380,7 +1380,8 @@ class TestApiRequestHandler:
         request_id_to_result_id = {id(report_results[0]): 2001}
 
         # Call upload_attachments
-        api_request_handler.upload_attachments(report_results, request_id_to_result_id)
+        total_attachments = sum(len(r["attachments"]) for r in report_results)
+        api_request_handler.upload_attachments(report_results, request_id_to_result_id, total_attachments)
 
         # Verify the request was made (case-insensitive comparison)
         assert requests_mock.last_request.url.lower() == create_url("add_attachment_to_result/2001").lower()
@@ -1400,7 +1401,8 @@ class TestApiRequestHandler:
         request_id_to_result_id = {id(report_results[0]): 2001}
 
         # Call upload_attachments
-        api_request_handler.upload_attachments(report_results, request_id_to_result_id)
+        total_attachments = sum(len(r["attachments"]) for r in report_results)
+        api_request_handler.upload_attachments(report_results, request_id_to_result_id, total_attachments)
 
         # Verify the request was made (case-insensitive comparison)
         assert requests_mock.last_request.url.lower() == create_url("add_attachment_to_result/2001").lower()
@@ -1413,7 +1415,8 @@ class TestApiRequestHandler:
         request_id_to_result_id = {id(report_results[0]): 2001}
 
         # Call upload_attachments - should not raise exception
-        api_request_handler.upload_attachments(report_results, request_id_to_result_id)
+        total_attachments = sum(len(r["attachments"]) for r in report_results)
+        api_request_handler.upload_attachments(report_results, request_id_to_result_id, total_attachments)
 
     @pytest.mark.api_handler
     def test_upload_attachments_empty_run_scenario(
@@ -1446,7 +1449,8 @@ class TestApiRequestHandler:
         request_id_to_result_id = {id(report_results[0]): 5001, id(report_results[1]): 5002}
 
         # Call upload_attachments
-        api_request_handler.upload_attachments(report_results, request_id_to_result_id)
+        total_attachments = sum(len(r["attachments"]) for r in report_results)
+        api_request_handler.upload_attachments(report_results, request_id_to_result_id, total_attachments)
 
         # Verify both attachments were uploaded correctly
         history = requests_mock.request_history
@@ -1487,7 +1491,8 @@ class TestApiRequestHandler:
         }
 
         # Call upload_attachments
-        api_request_handler.upload_attachments(report_results, request_id_to_result_id)
+        total_attachments = sum(len(r["attachments"]) for r in report_results)
+        api_request_handler.upload_attachments(report_results, request_id_to_result_id, total_attachments)
 
         # Verify both attachments were uploaded correctly
         history = requests_mock.request_history
@@ -1563,3 +1568,340 @@ class TestApiRequestHandler:
         assert stats["miss_count"] == 1
         assert stats["hit_count"] == 1
         assert stats["hit_rate"] == 50.0  # 1 hit out of 2 total requests
+
+    def test_edit_result_success(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test successfully editing a result with all fields"""
+        result_id = 12345
+        mocked_response = {
+            "id": result_id,
+            "status_id": 5,
+            "comment": "Test failed due to timeout",
+            "version": "2.0.1",
+            "elapsed": "30s",
+            "defects": "BUG-123,BUG-456",
+            "assignedto_id": 7,
+            "custom_field1": "custom_value",
+        }
+
+        requests_mock.post(create_url(f"edit_result/{result_id}"), json=mocked_response)
+
+        success, error = api_request_handler.edit_result(
+            result_id=result_id,
+            status_id=5,
+            comment="Test failed due to timeout",
+            version="2.0.1",
+            elapsed="30s",
+            defects="BUG-123,BUG-456",
+            assignedto_id=7,
+            custom_fields={"custom_field1": "custom_value"},
+        )
+
+        assert success is True
+        assert error is None
+        assert requests_mock.call_count == 1
+
+        # Verify request body
+        request_body = requests_mock.last_request.json()
+        assert request_body["status_id"] == 5
+        assert request_body["comment"] == "Test failed due to timeout"
+        assert request_body["version"] == "2.0.1"
+        assert request_body["elapsed"] == "30s"
+        assert request_body["defects"] == "BUG-123,BUG-456"
+        assert request_body["assignedto_id"] == 7
+        assert request_body["custom_field1"] == "custom_value"
+
+    def test_edit_result_partial_fields(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test editing a result with only some fields"""
+        result_id = 12345
+        mocked_response = {
+            "id": result_id,
+            "status_id": 1,
+            "comment": "Test passed after retry",
+        }
+
+        requests_mock.post(create_url(f"edit_result/{result_id}"), json=mocked_response)
+
+        success, error = api_request_handler.edit_result(
+            result_id=result_id,
+            status_id=1,
+            comment="Test passed after retry",
+        )
+
+        assert success is True
+        assert error is None
+
+        # Verify only provided fields are in request
+        request_body = requests_mock.last_request.json()
+        assert request_body["status_id"] == 1
+        assert request_body["comment"] == "Test passed after retry"
+        assert "version" not in request_body
+        assert "elapsed" not in request_body
+        assert "defects" not in request_body
+
+    def test_edit_result_api_error(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test edit_result when API returns an error"""
+        result_id = 12345
+        error_message = "Field :status_id is not a valid status."
+
+        requests_mock.post(
+            create_url(f"edit_result/{result_id}"),
+            json={"error": error_message},
+            status_code=400,
+        )
+
+        success, error = api_request_handler.edit_result(
+            result_id=result_id,
+            status_id=999,  # Invalid status ID
+        )
+
+        assert success is False
+        assert error_message in error
+
+    def test_edit_result_no_fields_provided(self, api_request_handler: ApiRequestHandler):
+        """Test edit_result when no fields are provided"""
+        result_id = 12345
+
+        success, error = api_request_handler.edit_result(result_id=result_id)
+
+        assert success is False
+        assert error == "No fields provided to update"
+
+    def test_edit_result_custom_fields_only(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test editing a result with only custom fields"""
+        result_id = 12345
+        mocked_response = {
+            "id": result_id,
+            "custom_automation_type": "Automated",
+            "custom_test_environment": "Production",
+        }
+
+        requests_mock.post(create_url(f"edit_result/{result_id}"), json=mocked_response)
+
+        success, error = api_request_handler.edit_result(
+            result_id=result_id,
+            custom_fields={
+                "custom_automation_type": "Automated",
+                "custom_test_environment": "Production",
+            },
+        )
+
+        assert success is True
+        assert error is None
+
+        # Verify custom fields are in request
+        request_body = requests_mock.last_request.json()
+        assert request_body["custom_automation_type"] == "Automated"
+        assert request_body["custom_test_environment"] == "Production"
+
+    def test_get_results_success(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test successfully retrieving results for a test"""
+        test_id = 1001
+        mocked_response = {
+            "offset": 0,
+            "limit": 250,
+            "size": 2,
+            "_links": {"next": None, "prev": None},
+            "results": [
+                {
+                    "id": 1,
+                    "test_id": test_id,
+                    "status_id": 1,
+                    "created_on": 1234567890,
+                    "created_by": 1,
+                    "comment": "Test passed",
+                },
+                {
+                    "id": 2,
+                    "test_id": test_id,
+                    "status_id": 5,
+                    "created_on": 1234567900,
+                    "created_by": 2,
+                    "comment": "Test failed",
+                },
+            ],
+        }
+
+        requests_mock.get(create_url(f"get_results/{test_id}&offset=0&limit=250"), json=mocked_response)
+
+        results, error = api_request_handler.get_results(test_id, offset=0, limit=250)
+
+        assert error is None
+        assert len(results) == 2
+        assert results[0]["id"] == 1
+        assert results[0]["status_id"] == 1
+        assert results[1]["id"] == 2
+        assert results[1]["status_id"] == 5
+
+    def test_get_results_with_pagination(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test retrieving results with custom pagination"""
+        test_id = 1001
+        mocked_response = {
+            "offset": 10,
+            "limit": 5,
+            "size": 1,
+            "_links": {"next": None, "prev": None},
+            "results": [
+                {
+                    "id": 11,
+                    "test_id": test_id,
+                    "status_id": 1,
+                    "created_on": 1234567890,
+                    "created_by": 1,
+                },
+            ],
+        }
+
+        requests_mock.get(create_url(f"get_results/{test_id}&offset=10&limit=5"), json=mocked_response)
+
+        results, error = api_request_handler.get_results(test_id, offset=10, limit=5)
+
+        assert error is None
+        assert len(results) == 1
+        assert results[0]["id"] == 11
+
+    def test_get_results_api_error(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test get_results when API returns an error"""
+        test_id = 1001
+        error_message = "Field :test_id is not a valid test."
+
+        requests_mock.get(
+            create_url(f"get_results/{test_id}&offset=0&limit=250"),
+            json={"error": error_message},
+            status_code=400,
+        )
+
+        results, error = api_request_handler.get_results(test_id)
+
+        assert len(results) == 0
+        assert error_message in error
+
+    def test_get_results_for_case_success(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test successfully retrieving results for a case in a run"""
+        run_id = 100
+        case_id = 200
+        mocked_response = {
+            "offset": 0,
+            "limit": 250,
+            "size": 1,
+            "_links": {"next": None, "prev": None},
+            "results": [
+                {
+                    "id": 1,
+                    "test_id": 5001,
+                    "status_id": 1,
+                    "created_on": 1234567890,
+                    "created_by": 1,
+                    "comment": "Test passed",
+                },
+            ],
+        }
+
+        requests_mock.get(
+            create_url(f"get_results_for_case/{run_id}/{case_id}&offset=0&limit=250"), json=mocked_response
+        )
+
+        results, error = api_request_handler.get_results_for_case(run_id, case_id, offset=0, limit=250)
+
+        assert error is None
+        assert len(results) == 1
+        assert results[0]["id"] == 1
+        assert results[0]["test_id"] == 5001
+
+    def test_get_results_for_case_api_error(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test get_results_for_case when API returns an error"""
+        run_id = 100
+        case_id = 200
+        error_message = "Field :case_id is not a valid case."
+
+        requests_mock.get(
+            create_url(f"get_results_for_case/{run_id}/{case_id}&offset=0&limit=250"),
+            json={"error": error_message},
+            status_code=400,
+        )
+
+        results, error = api_request_handler.get_results_for_case(run_id, case_id)
+
+        assert len(results) == 0
+        assert error_message in error
+
+    def test_get_results_for_run_success(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test successfully retrieving results for all tests in a run"""
+        run_id = 100
+        mocked_response = {
+            "offset": 0,
+            "limit": 250,
+            "size": 2,
+            "_links": {"next": None, "prev": None},
+            "results": [
+                {
+                    "id": 1,
+                    "test_id": 5001,
+                    "status_id": 1,
+                    "created_on": 1234567890,
+                    "created_by": 1,
+                    "comment": "Test passed",
+                },
+                {
+                    "id": 2,
+                    "test_id": 5002,
+                    "status_id": 5,
+                    "created_on": 1234567900,
+                    "created_by": 2,
+                    "comment": "Test failed",
+                },
+            ],
+        }
+
+        requests_mock.get(create_url(f"get_results_for_run/{run_id}&offset=0&limit=250"), json=mocked_response)
+
+        results, error = api_request_handler.get_results_for_run(run_id, offset=0, limit=250)
+
+        assert error is None
+        assert len(results) == 2
+        assert results[0]["id"] == 1
+        assert results[0]["test_id"] == 5001
+        assert results[1]["id"] == 2
+        assert results[1]["test_id"] == 5002
+
+    def test_get_results_for_run_with_pagination(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test retrieving run results with custom pagination"""
+        run_id = 100
+        mocked_response = {
+            "offset": 10,
+            "limit": 5,
+            "size": 1,
+            "_links": {"next": None, "prev": None},
+            "results": [
+                {
+                    "id": 11,
+                    "test_id": 5011,
+                    "status_id": 1,
+                    "created_on": 1234567890,
+                    "created_by": 1,
+                },
+            ],
+        }
+
+        requests_mock.get(create_url(f"get_results_for_run/{run_id}&offset=10&limit=5"), json=mocked_response)
+
+        results, error = api_request_handler.get_results_for_run(run_id, offset=10, limit=5)
+
+        assert error is None
+        assert len(results) == 1
+        assert results[0]["id"] == 11
+
+    def test_get_results_for_run_api_error(self, api_request_handler: ApiRequestHandler, requests_mock):
+        """Test get_results_for_run when API returns an error"""
+        run_id = 100
+        error_message = "Field :run_id is not a valid run."
+
+        requests_mock.get(
+            create_url(f"get_results_for_run/{run_id}&offset=0&limit=250"),
+            json={"error": error_message},
+            status_code=400,
+        )
+
+        results, error = api_request_handler.get_results_for_run(run_id)
+
+        assert len(results) == 0
+        assert error_message in error

trcli-1.14.3/trcli/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.14.3"

{trcli-1.14.2 → trcli-1.14.3}/trcli/api/api_request_handler.py

@@ -286,13 +286,80 @@ class ApiRequestHandler:
     ) -> Tuple[bool, str, List[str], List[str], List[str]]:
         return self.case_handler.update_existing_case_references(case_id, junit_refs, case_fields, strategy)
 
-    def upload_attachments(self, report_results: List[Dict], request_id_to_result_id: Dict[int, int]):
-        return self.result_handler.upload_attachments(report_results, request_id_to_result_id)
+    def upload_attachments(
+        self, report_results: List[Dict], request_id_to_result_id: Dict[int, int], total_attachments: int
+    ):
+        return self.result_handler.upload_attachments(report_results, request_id_to_result_id, total_attachments)
 
     def add_results(self, run_id: int) -> Tuple[List, str, int]:
         return self.result_handler.add_results(run_id)
 
+    def get_results(self, test_id: int, offset: int = 0, limit: int = 250) -> Tuple[List[Dict], str]:
+        """
+        Get test results for a specific test.
+
+        :param test_id: TestRail test ID
+        :param offset: Pagination offset (default: 0)
+        :param limit: Pagination limit (default: 250)
+        :returns: Tuple of (results_list, error_message)
+        """
+        return self.result_handler.get_results(test_id, offset, limit)
+
+    def get_results_for_run(self, run_id: int, offset: int = 0, limit: int = 250) -> Tuple[List[Dict], str]:
+        """
+        Get test results for all tests in a run.
+
+        :param run_id: TestRail run ID
+        :param offset: Pagination offset (default: 0)
+        :param limit: Pagination limit (default: 250)
+        :returns: Tuple of (results_list, error_message)
+        """
+        return self.result_handler.get_results_for_run(run_id, offset, limit)
+
+    def get_results_for_case(
+        self, run_id: int, case_id: int, offset: int = 0, limit: int = 250
+    ) -> Tuple[List[Dict], str]:
+        """
+        Get test results for a specific case in a run.
+
+        :param run_id: TestRail run ID
+        :param case_id: TestRail case ID
+        :param offset: Pagination offset (default: 0)
+        :param limit: Pagination limit (default: 250)
+        :returns: Tuple of (results_list, error_message)
+        """
+        return self.result_handler.get_results_for_case(run_id, case_id, offset, limit)
+
+    def edit_result(
+        self,
+        result_id: int,
+        status_id: int = None,
+        comment: str = None,
+        version: str = None,
+        elapsed: str = None,
+        defects: str = None,
+        assignedto_id: int = None,
+        custom_fields: Dict = None,
+    ) -> Tuple[bool, str]:
+        """
+        Edit an existing test result.
+
+        :param result_id: TestRail result ID to edit
+        :param status_id: Test status ID (1=Passed, 2=Blocked, 3=Untested, 4=Retest, 5=Failed)
+        :param comment: Comment/notes for the result
+        :param version: Version or build tested against
+        :param elapsed: Time elapsed (e.g., "1m 5s" or "65s")
+        :param defects: Comma-separated list of defect IDs
+        :param assignedto_id: User ID to assign the test to
+        :param custom_fields: Dictionary of custom field values
+        :returns: Tuple of (success, error_message)
+        """
+        return self.result_handler.edit_result(
+            result_id, status_id, comment, version, elapsed, defects, assignedto_id, custom_fields
+        )
+
     def handle_futures(self, futures, action_string, progress_bar) -> Tuple[list, str]:
+        responses_by_request = {} if action_string == "add_results" else None
         responses = []
         error_message = ""
         try:
@@ -300,10 +367,11 @@ class ApiRequestHandler:
                 arguments = futures[future]
                 response = future.result()
                 if not response.error_message:
-                    responses.append(response)
                     if action_string == "add_results":
+                        responses_by_request[id(arguments)] = response
                         progress_bar.update(len(arguments["results"]))
                     else:
+                        responses.append(response)
                         if action_string == "add_case":
                             arguments = arguments.to_dict()
                             arguments.pop("case_id")
@@ -323,6 +391,11 @@ class ApiRequestHandler:
         except KeyboardInterrupt:
             self.__cancel_running_futures(futures, action_string)
             raise KeyboardInterrupt
+
+        if action_string == "add_results" and responses_by_request:
+            request_bodies = list(futures.values())
+            responses = [responses_by_request[id(req)] for req in request_bodies if id(req) in responses_by_request]
+
         return responses, error_message
 
     def close_run(self, run_id: int) -> Tuple[dict, str]: