feat: add not_append_test_results flag to xray cli (#556)

refactor: move XrayPublisher to XrayInterface with optimized authentication

- Rename XrayPublisher to XrayInterface for better API representation
- Move authentication into XrayInterface constructor
- Make base URL configurable as parameter
- Add methods upload_test_results and get_jira_test_keys_from_test_execution_ticket to class
- Remove standalone functions to eliminate code duplication
- Optimize CLI to create XrayInterface once and reuse for all operations
- Update all imports and tests accordingly

Author: DianeMornas

docs/tools/xray.rst

@@ -36,6 +36,8 @@ Options:
                                       [optional][default value: None] Required when creating a new test execution ticket;
                                       optional when updating an existing one.
   --merge-xml-files                   Merge all the xml files to be send in one xml file
+  --not-append-test-results, -na      Do not append new test keys from the .xml(s) to the updated test execution,
+                                      only overwrite already existing ones
   --help                              Show this message and exit.
 
 
@@ -69,6 +71,23 @@ You can rewrite the test execution description:
     xray --user USER_ID --password MY_API_KEY --url "https://xray.cloud.getxray.app/" upload --path-results path/reports/folder --test-execution-key "ABC-123" --test-execution-description "New test execution description"
 
 
+Update existing test results only (do not append new tests)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default, when uploading test results to an existing test execution ticket, new test results from the XML files are appended to the test execution.
+If you want to only update the results of tests that already exist in the test execution ticket (without adding new tests), use the ``--not-append-test-results`` flag:
+
+.. code:: bash
+
+    xray --user USER_ID --password MY_API_KEY --url "https://xray.cloud.getxray.app/" upload --path-results path/reports/folder --test-execution-key "ABC-123" --not-append-test-results
+
+This is useful when you want to:
+
+- Update only specific test results without changing the test execution scope
+- Maintain a fixed set of tests in your test execution ticket
+- Prevent accidental addition of new tests to an existing test execution
+
+
 Add the Xray decorator to the test functions
 --------------------------------------------
 

docs/whats_new/index.rst

@@ -4,6 +4,12 @@ What's New In Pykiso?
 .. toctree::
 
     version_ongoing
+    version_1_4_0
+    version_1_3_4
+    version_1_3_3
+    version_1_3_2
+    version_1_3_1
+    version_1_3_0
     version_1_2_0
     version_0_29_0
     version_0_28_0

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pykiso"
-version = "1.3.4"
+version = "1.4.0"
 description = "Embedded integration testing framework."
 authors = ["Sebastian Fischer <sebastian.fischer@de.bosch.com>"]
 license = "Eclipse Public License - v 2.0"

src/pykiso/tool/xray/cli.py

@@ -4,7 +4,7 @@
 
 import click
 
-from .xray import extract_test_results, upload_test_results
+from .xray import XrayInterface, extract_test_results
 
 
 @click.group()
@@ -76,6 +76,14 @@ def cli_xray(ctx: dict, user: str, password: str, url: str) -> None:
     is_flag=True,
     required=False,
 )
+@click.option(
+    "-na",
+    "--not-append-test-results",
+    help="Do not append new test keys from the .xml(s) to the updated test execution, only overwrite already existing ones",
+    is_flag=True,
+    default=False,
+    required=False,
+)
 @click.pass_context
 def cli_upload(
     ctx,
@@ -84,6 +92,7 @@ def cli_upload(
     test_execution_description: str,
     test_execution_summary: str,
     merge_xml_files: bool,
+    not_append_test_results: bool,
 ) -> None:
     """Upload the JUnit xml test results on xray.
 
@@ -93,6 +102,7 @@ def cli_upload(
     :param test_execution_description: update the test execution ticket description - otherwise, keep current description
     :param test_execution_summary: update the test execution ticket summary - otherwise, keep current summary
     :param merge_xml_files: if True, merge the xml files, else do nothing
+    :param not_append_test_results: if True, only overwrite the existing ones (update only), else append the new results from the .xml file(s) to the test execution
 
     """
     # If a new test execution ticket is being created (no key), the user should pass a description and a summary.
@@ -101,26 +111,34 @@ def cli_upload(
             "Creating a new test execution ticket requires both a description and a summary in the CLI options"
         )
 
+    # Create XrayInterface once for authentication optimization
+    xray_interface = XrayInterface(
+        base_url=ctx.obj["URL"], client_id=ctx.obj["USER"], client_secret=ctx.obj["PASSWORD"]
+    )
+
+    # If the user chooses not to append new test results to an existing test execution ticket,
+    # retrieve the existing test keys from Jira for the specified test execution ticket.
+    # If appending is allowed, there is no need to fetch the existing test keys.
+    if not_append_test_results and test_execution_key:
+        print("Preparing the ticket for update...")
+        jira_keys = xray_interface.get_jira_test_keys_from_test_execution_ticket(test_execution_key)
+    else:
+        jira_keys = []
+
     # From the JUnit xml files found, create a list of the dictionary per test results marked with an xray decorator.
     path_results = Path(path_results).resolve()
     test_results = extract_test_results(
         path_results=path_results,
         merge_xml_files=merge_xml_files,
+        jira_keys=jira_keys,
         test_execution_key=test_execution_key,
         test_execution_summary=test_execution_summary,
         test_execution_description=test_execution_description,
     )
 
     responses = []
     for result in test_results:
-        # Upload the test results into Xray
-        responses.append(
-            upload_test_results(
-                base_url=ctx.obj["URL"],
-                user=ctx.obj["USER"],
-                password=ctx.obj["PASSWORD"],
-                results=result,
-            )
-        )
+        # Upload the test results into Xray using the same interface instance
+        responses.append(xray_interface.upload_test_results(data=result))
     responses_result_str = json.dumps(responses, indent=2)
     print(f"The test results can be found in JIRA by: {responses_result_str}")