trcli 1.13.2__tar.gz → 1.13.4__tar.gz

{trcli-1.13.2 → trcli-1.13.4}/PKG-INFO

@@ -1,16 +1,20 @@
 Metadata-Version: 2.4
 Name: trcli
-Version: 1.13.2
+Version: 1.13.4
 License-File: LICENSE.md
 Requires-Dist: click<8.2.2,>=8.1.0
 Requires-Dist: pyyaml<7.0.0,>=6.0.0
 Requires-Dist: junitparser<4.0.0,>=3.1.0
 Requires-Dist: pyserde==0.12.*
 Requires-Dist: requests<3.0.0,>=2.31.0
+Requires-Dist: urllib3<3.0.0,>=1.26.0
+Requires-Dist: charset-normalizer<4.0.0,>=2.0.0
+Requires-Dist: chardet<6.0.0,>=5.0.0
 Requires-Dist: tqdm<5.0.0,>=4.65.0
 Requires-Dist: humanfriendly<11.0.0,>=10.0.0
 Requires-Dist: openapi-spec-validator<1.0.0,>=0.5.0
 Requires-Dist: beartype<1.0.0,>=0.17.0
+Requires-Dist: packaging>=20.0
 Requires-Dist: prance
 Dynamic: description
 Dynamic: license-file

{trcli-1.13.2 → trcli-1.13.4}/README.md

@@ -33,7 +33,7 @@ trcli
 ```
 You should get something like this:
 ```
-TestRail CLI v1.13.2
+TestRail CLI v1.13.4
 Copyright 2025 Gurock Software GmbH - www.gurock.com
 Supported and loaded modules:
     - parse_junit: JUnit XML Files (& Similar)
@@ -51,7 +51,7 @@ CLI general reference
 --------
 ```shell
 $ trcli --help
-TestRail CLI v1.13.2
+TestRail CLI v1.13.4
 Copyright 2025 Gurock Software GmbH - www.gurock.com
 Usage: trcli [OPTIONS] COMMAND [ARGS]...
 
@@ -97,6 +97,7 @@ Commands:
   parse_openapi  Parse OpenAPI spec and create cases in TestRail
   parse_robot    Parse Robot Framework report and upload results to TestRail
   references     Manage references in TestRail
+  update         Update TRCLI to the latest version from PyPI.
 ```
 
 Uploading automated test results
@@ -190,9 +191,140 @@ Options:
 | `<testsuite>`      | section         |
 | `<testcase>`       | case            |
 
-For further detail, please refer to the 
+For further detail, please refer to the
 [JUnit to TestRail mapping](https://support.gurock.com/hc/en-us/articles/12989737200276) documentation.
 
+### Using Glob Patterns for Multiple Files
+
+TRCLI supports glob patterns to process multiple report files in a single command. This feature is available for **JUnit XML**, **Robot Framework**, and **Cucumber JSON** parsers.
+
+#### Important: Shell Quoting Requirement
+
+**Glob patterns must be quoted** to prevent shell from expanding them prematurely. Without quotes, the shell will expand the pattern before passing it to TRCLI, causing unexpected errors.
+
+```bash
+# CORRECT - Pattern quoted (TRCLI handles the expansion)
+trcli parse_junit -f "reports/*.xml" --title "Test Results"
+```
+
+#### Supported Glob Patterns
+
+**Standard wildcards:**
+```bash
+# Match all XML files in directory
+-f "reports/*.xml"
+
+# Match files with specific prefix
+-f "target/surefire-reports/TEST-*.xml"
+
+# Match files with specific suffix
+-f "build/test-results/*-report.xml"
+```
+
+**Recursive search** (matches subdirectories):
+```bash
+# Search all subdirectories recursively
+-f "test-results/**/*.xml"
+
+# Match specific pattern in any subdirectory
+-f "**/robot-output-*.xml"
+```
+
+#### How File Merging Works
+
+When a glob pattern matches **multiple files**, TRCLI automatically:
+
+1. **Expands the pattern** to find all matching files
+2. **Parses each file** individually
+3. **Merges test results** into a single combined report
+4. **Writes merged file** to current directory:
+   - JUnit: `Merged-JUnit-report.xml`
+   - Robot Framework: `Merged-Robot-report.xml`
+   - Cucumber: `merged_cucumber.json`
+5. **Processes the merged file** as a single test run upload
+
+When a pattern matches **only one file**, TRCLI processes it directly without merging.
+
+#### Examples
+
+**JUnit XML - Multiple test suites:**
+```bash
+# Merge all JUnit XML files from Maven surefire reports
+trcli -y \
+  -h https://example.testrail.com \
+  --project "My Project" \
+  parse_junit \
+  -f "target/surefire-reports/junitreports/*.xml" \
+  --title "Merged Test Results"
+
+# Merge test results from multiple modules
+trcli parse_junit \
+  -f "build/test-results/**/*.xml" \
+  --title "All Module Tests" \
+  --case-matcher auto
+```
+
+**Robot Framework - Multiple output files:**
+```bash
+# Merge multiple Robot Framework test runs
+trcli -y \
+  -h https://example.testrail.com \
+  --project "My Project" \
+  parse_robot \
+  -f "reports/robot-*.xml" \
+  --title "Merged Robot Tests"
+
+# Recursive search for all Robot outputs
+trcli parse_robot \
+  -f "test-results/**/output.xml" \
+  --title "All Robot Results" \
+  --case-matcher property
+```
+
+**Cucumber JSON - Multiple test runs:**
+```bash
+# Merge multiple Cucumber JSON reports
+trcli -y \
+  -h https://example.testrail.com \
+  --project "My Project" \
+  parse_cucumber \
+  -f "reports/cucumber-*.json" \
+  --title "Merged Cucumber Tests"
+
+# Recursive search for all Cucumber JSON results
+trcli parse_cucumber \
+  -f "test-results/**/cucumber.json" \
+  --title "All Cucumber Results" \
+  --case-matcher auto
+```
+
+#### Troubleshooting
+
+**Error: "Got unexpected extra argument"**
+- **Cause:** Glob pattern not quoted - shell expanded it before TRCLI
+- **Solution:** Add quotes around the pattern: `-f "reports/*.xml"`
+
+**Error: "File not found"**
+- **Cause:** No files match the glob pattern
+- **Solution:** Verify the pattern and file paths:
+  ```bash
+  # Check what files match your pattern
+  ls reports/*.xml
+
+  # Use absolute path if relative path doesn't work
+  trcli parse_junit -f "/full/path/to/reports/*.xml"
+  ```
+
+**Pattern matches nothing in subdirectories:**
+- **Cause:** Need recursive glob (`**`)
+- **Solution:** Use `**` for recursive matching: `-f "reports/**/*.xml"`
+
+#### Limitations
+
+1. Glob patterns are expanded by Python's `glob` module (not shell), so some advanced bash features may not work
+2. Very large numbers of files (100+) may cause performance issues during merging
+3. Merged files are created in the current working directory
+
 ### Uploading test results
 To submit test case results, the TestRail CLI will attempt to match the test cases in your automation suite to test cases in TestRail.
 There are 2 mechanisms to match test cases:
@@ -1509,7 +1641,7 @@ Options:
 ### Reference
 ```shell
 $ trcli add_run --help
-TestRail CLI v1.13.2
+TestRail CLI v1.13.4
 Copyright 2025 Gurock Software GmbH - www.gurock.com
 Usage: trcli add_run [OPTIONS]
 
@@ -1526,6 +1658,8 @@ Options:
   --run-end-date         The expected or scheduled end date of this test run in MM/DD/YYYY format
   --run-assigned-to-id   The ID of the user the test run should be assigned
                          to.  [x>=1]
+  --clear-run-assigned-to-id  Clear the assignee of the test run (only valid
+                         when updating with --run-id).
   --run-include-all      Use this option to include all test cases in this test run.
   --auto-close-run       Use this option to automatically close the created run.
   --run-case-ids         Comma separated list of test case IDs to include in
@@ -1598,6 +1732,39 @@ trcli -y -h https://example.testrail.io/ --project "My Project" \
 - **Action Requirements**: `update` and `delete` actions require an existing run (--run-id must be provided)
 - **Validation**: Invalid reference formats are rejected with clear error messages
 
+### Managing Assignees in Test Runs
+
+The `add_run` command supports comprehensive assignee management for test runs. You can assign runs to users when creating or updating them, and clear assignees when needed.
+
+#### Assigning Runs to Users
+
+When creating a new test run or updating an existing one, you can assign it to a user using the `--run-assigned-to-id` option:
+
+```bash
+# Create a new run and assign to user ID 5
+trcli -y -h https://example.testrail.io/ --project "My Project" \
+  add_run --title "My Test Run" --run-assigned-to-id 5
+
+# Update an existing run and change the assignee
+trcli -y -h https://example.testrail.io/ --project "My Project" \
+  add_run --run-id 123 --title "My Test Run" --run-assigned-to-id 10
+```
+
+#### Clearing Assignees from Test Runs
+
+To remove the assignee from an existing test run, use the `--clear-run-assigned-to-id` flag:
+
+```bash
+# Clear the assignee from an existing run
+trcli -y -h https://example.testrail.io/ --project "My Project" \
+  add_run --run-id 123 --title "My Test Run" --clear-run-assigned-to-id
+```
+
+#### Assignee Management Rules
+
+- **Update Mode Only**: The `--clear-run-assigned-to-id` flag can only be used when updating an existing run (requires `--run-id`)
+- **Mutually Exclusive**: You cannot use both `--run-assigned-to-id` and `--clear-run-assigned-to-id` in the same command
+
 #### Examples
 
 **Complete Workflow Example:**
@@ -1633,7 +1800,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.13.2
+TestRail CLI v1.13.4
 Copyright 2025 Gurock Software GmbH - www.gurock.com
 Usage: trcli parse_openapi [OPTIONS]
 

{trcli-1.13.2 → trcli-1.13.4}/setup.py

@@ -21,10 +21,14 @@ setup(
         "junitparser>=3.1.0,<4.0.0",
         "pyserde==0.12.*",
         "requests>=2.31.0,<3.0.0",
+        "urllib3>=1.26.0,<3.0.0",
+        "charset-normalizer>=2.0.0,<4.0.0",
+        "chardet>=5.0.0,<6.0.0",
         "tqdm>=4.65.0,<5.0.0",
         "humanfriendly>=10.0.0,<11.0.0",
         "openapi-spec-validator>=0.5.0,<1.0.0",
         "beartype>=0.17.0,<1.0.0",
+        "packaging>=20.0",
         "prance",  # Does not use semantic versioning
     ],
     entry_points="""

{trcli-1.13.2 → trcli-1.13.4}/tests/test_cmd_add_run.py

@@ -42,9 +42,11 @@ class TestCmdAddRun:
         environment.run_assigned_to_id = assigned_to_id
         environment.run_case_ids = case_ids
         environment.run_include_all = True
-        expected_string = (f"run_assigned_to_id: {assigned_to_id}\nrun_case_ids: '{case_ids}'\n"
-                           f"run_description: {description}\nrun_id: {run_id}\n"
-                           f"run_include_all: true\nrun_refs: {refs}\ntitle: {title}\n")
+        expected_string = (
+            f"run_assigned_to_id: {assigned_to_id}\nrun_case_ids: '{case_ids}'\n"
+            f"run_description: {description}\nrun_id: {run_id}\n"
+            f"run_include_all: true\nrun_refs: {refs}\ntitle: {title}\n"
+        )
         cmd_add_run.write_run_to_file(environment, run_id)
         mock_open_file.assert_called_with(file, "a")
         mock_open_file.return_value.__enter__().write.assert_called_once_with(expected_string)
@@ -52,35 +54,31 @@ class TestCmdAddRun:
     def test_cli_validation_refs_too_long(self):
         """Test that references validation fails when exceeding 250 characters"""
         from trcli.cli import Environment
-        
+
         environment = Environment()
         environment.run_refs = "A" * 251  # 251 characters, exceeds limit
-        
+
         assert len(environment.run_refs) > 250
-        
+
         runner = CliRunner()
         long_refs = "A" * 251
-        
-        result = runner.invoke(cmd_add_run.cli, [
-            '--title', 'Test Run',
-            '--run-refs', long_refs
-        ], catch_exceptions=False)
-        
+
+        result = runner.invoke(
+            cmd_add_run.cli, ["--title", "Test Run", "--run-refs", long_refs], catch_exceptions=False
+        )
+
         # Should exit with error code 1 due to missing required parameters or validation
         assert result.exit_code == 1
 
     def test_cli_validation_refs_exactly_250_chars(self):
         """Test that references validation passes with exactly 250 characters"""
         from trcli.cli import Environment
-        
+
         runner = CliRunner()
         refs_250 = "A" * 250  # Exactly 250 characters, should pass validation
-        
-        result = runner.invoke(cmd_add_run.cli, [
-            '--title', 'Test Run',
-            '--run-refs', refs_250
-        ], catch_exceptions=False)
-        
+
+        result = runner.invoke(cmd_add_run.cli, ["--title", "Test Run", "--run-refs", refs_250], catch_exceptions=False)
+
         # Should not fail due to refs validation (will fail due to missing required parameters)
         # But the important thing is that it doesn't fail with the character limit error
         assert "References field cannot exceed 250 characters" not in result.output
@@ -88,18 +86,18 @@ class TestCmdAddRun:
     def test_validation_logic_refs_action_without_run_id(self):
         """Test validation logic for refs action without run_id"""
         from trcli.cli import Environment
-        
+
         # Update action validation
         environment = Environment()
         environment.run_refs_action = "update"
         environment.run_id = None
         environment.run_refs = "JIRA-123"
-        
+
         # This should be invalid
         assert environment.run_refs_action == "update"
         assert environment.run_id is None
-        
-        # Delete action validation  
+
+        # Delete action validation
         environment.run_refs_action = "delete"
         assert environment.run_refs_action == "delete"
         assert environment.run_id is None
@@ -107,37 +105,72 @@ class TestCmdAddRun:
     def test_refs_action_parameter_parsing(self):
         """Test that refs action parameter is parsed correctly"""
         runner = CliRunner()
-        
+
         # Test that the CLI accepts new param without crashing! :) - acuanico
-        result = runner.invoke(cmd_add_run.cli, ['--help'])
+        result = runner.invoke(cmd_add_run.cli, ["--help"])
         assert result.exit_code == 0
         assert "--run-refs-action" in result.output
         assert "Action to perform on references" in result.output
 
+    def test_clear_assigned_to_id_parameter_exists(self):
+        """Test that --clear-run-assigned-to-id parameter is available"""
+        runner = CliRunner()
+
+        result = runner.invoke(cmd_add_run.cli, ["--help"])
+        assert result.exit_code == 0
+        assert "--clear-run-assigned-to-id" in result.output
+        assert "Clear the assignee" in result.output
+
+    @mock.patch("trcli.cli.Environment.check_for_required_parameters")
+    def test_clear_assigned_to_id_requires_run_id(self, mock_check):
+        """Test that --clear-run-assigned-to-id requires --run-id"""
+        runner = CliRunner()
+
+        result = runner.invoke(cmd_add_run.cli, ["--title", "Test Run", "--clear-run-assigned-to-id"])
+
+        assert result.exit_code == 1
+        assert (
+            "--clear-run-assigned-to-id can only be used when updating" in result.output
+            or "--run-id required" in result.output
+        )
+
+    @mock.patch("trcli.cli.Environment.check_for_required_parameters")
+    def test_clear_assigned_to_id_mutually_exclusive_with_assigned_to_id(self, mock_check):
+        """Test that --clear-run-assigned-to-id and --run-assigned-to-id are mutually exclusive"""
+        runner = CliRunner()
+
+        result = runner.invoke(
+            cmd_add_run.cli,
+            ["--title", "Test Run", "--run-id", "123", "--run-assigned-to-id", "42", "--clear-run-assigned-to-id"],
+        )
+
+        assert result.exit_code == 1
+        assert "cannot be used together" in result.output
+
 
 class TestApiRequestHandlerReferences:
     """Test class for reference management functionality"""
-    
+
     def test_manage_references_add(self):
         """Test adding references to existing ones"""
         from trcli.api.api_request_handler import ApiRequestHandler
         from trcli.cli import Environment
         from trcli.api.api_client import APIClient
         from trcli.data_classes.dataclass_testrail import TestRailSuite
-        
+
         environment = Environment()
         api_client = APIClient("https://test.testrail.com")
         suite = TestRailSuite(name="Test Suite")
         handler = ApiRequestHandler(environment, api_client, suite)
-        
+
         # Adding new references
         result = handler._manage_references("JIRA-100,JIRA-200", "JIRA-300,JIRA-400", "add")
         assert result == "JIRA-100,JIRA-200,JIRA-300,JIRA-400"
-        
+
         # Adding duplicate references (should not duplicate)
         result = handler._manage_references("JIRA-100,JIRA-200", "JIRA-200,JIRA-300", "add")
         assert result == "JIRA-100,JIRA-200,JIRA-300"
-        
+
         # Adding to empty existing references
         result = handler._manage_references("", "JIRA-100,JIRA-200", "add")
         assert result == "JIRA-100,JIRA-200"
@@ -148,16 +181,16 @@ class TestApiRequestHandlerReferences:
         from trcli.cli import Environment
         from trcli.api.api_client import APIClient
         from trcli.data_classes.dataclass_testrail import TestRailSuite
-        
+
         environment = Environment()
         api_client = APIClient("https://test.testrail.com")
         suite = TestRailSuite(name="Test Suite")
         handler = ApiRequestHandler(environment, api_client, suite)
-        
+
         # Test replacing all references
         result = handler._manage_references("JIRA-100,JIRA-200", "JIRA-300,JIRA-400", "update")
         assert result == "JIRA-300,JIRA-400"
-        
+
         # Test replacing with empty references
         result = handler._manage_references("JIRA-100,JIRA-200", "", "update")
         assert result == ""
@@ -168,24 +201,24 @@ class TestApiRequestHandlerReferences:
         from trcli.cli import Environment
         from trcli.api.api_client import APIClient
         from trcli.data_classes.dataclass_testrail import TestRailSuite
-        
+
         environment = Environment()
         api_client = APIClient("https://test.testrail.com")
         suite = TestRailSuite(name="Test Suite")
         handler = ApiRequestHandler(environment, api_client, suite)
-        
+
         # Deleting specific references
         result = handler._manage_references("JIRA-100,JIRA-200,JIRA-300", "JIRA-200", "delete")
         assert result == "JIRA-100,JIRA-300"
-        
+
         # Deleting multiple specific references
         result = handler._manage_references("JIRA-100,JIRA-200,JIRA-300,JIRA-400", "JIRA-200,JIRA-400", "delete")
         assert result == "JIRA-100,JIRA-300"
-        
+
         # Deleting all references (empty new_refs)
         result = handler._manage_references("JIRA-100,JIRA-200", "", "delete")
         assert result == ""
-        
+
         # Deleting non-existent references
         result = handler._manage_references("JIRA-100,JIRA-200", "JIRA-999", "delete")
         assert result == "JIRA-100,JIRA-200"