testbench2robotframework 0.9.2b6__tar.gz → 1.0.0__tar.gz

{testbench2robotframework-0.9.2b6 → testbench2robotframework-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testbench2robotframework
-Version: 0.9.2b6
+Version: 1.0.0
 Summary: Robot Framework Code Generator from Keyword-Driven Tests in imbus TestBench 3.0 and newer
 Author-email: imbus AG <support@imbus.de>
 Requires-Python: >= 3.10

{testbench2robotframework-0.9.2b6 → testbench2robotframework-1.0.0}/testbench2robotframework/__init__.py

@@ -17,4 +17,4 @@ suites and enhancing the TestBench report with execution results from Robot Fram
 
 from .testbench2robotframework import testbench2robotframework  # noqa: F401
 
-__version__ = "0.9.2b6"
+__version__ = "1.0.0"

{testbench2robotframework-0.9.2b6 → testbench2robotframework-1.0.0}/testbench2robotframework/cli.py

@@ -21,10 +21,17 @@ from .config import (
 )
 from .json_reader import read_json
 from .testbench2robotframework import testbench2robotframework
+from .utils import ALLOWED_SERVER_VERSIONS
 
-TESTBENCH2ROBOTFRAMEWORK_DESCRIPTION = """TestBench2RobotFramework converts a TestBench JSON-report
+TESTBENCH2ROBOTFRAMEWORK_DESCRIPTION = (
+    """TestBench2RobotFramework converts a TestBench JSON-report
     to Robot Framework test suites and enhances the TestBench Report
-     with the execution results provided by Robot Framework."""
+    with the execution results provided by Robot Framework. The version your TestBench report
+    was generated with must be compatible with the version of testbench2robotframework you are using.
+    Supported versions for this version of testbench2robotframework are: """
+    + ", ".join(ALLOWED_SERVER_VERSIONS)
+    + "."
+)
 GENERATE_HELP = """Command to convert a TestBench JSON-report to Robot Framework test suites."""
 FETCH_HELP = """Command to fetch execution results from a Robot Framework result XML and
 to write the results to a TestBench JSON-report."""
@@ -56,7 +63,8 @@ def parse_subdivision_mapping(
     help="Writes the TestBench2RobotFramework, Robot Framework and Python version to console.",
     message=(
         f"TestBench2RobotFramework {__version__} with "
-        f"Robot Framework {robot.version.get_full_version()}"
+        f"Robot Framework {robot.version.get_full_version()}. "
+        f"Compatible with TestBench server versions: {', '.join(ALLOWED_SERVER_VERSIONS)}."
     ),
 )
 @click.help_option("-h", "--help")

{testbench2robotframework-0.9.2b6 → testbench2robotframework-1.0.0}/testbench2robotframework/model_utils.py

@@ -104,4 +104,4 @@ def convert_value(value: Any, type_hint: Any) -> Any:
         return convert_value_without_origin(value, type_hint)
     if origin is Origin.UNION:
         return convert_value_with_union_type(value, type_hint)
-    return convert_value_with_list_type(value, type_hint)
+    return convert_value_with_list_type(value, type_hint)

{testbench2robotframework-0.9.2b6 → testbench2robotframework-1.0.0}/testbench2robotframework/result_writer.py

@@ -41,6 +41,7 @@ try:
 except ImportError:
     Group = None
 
+
 def _empty_keyword_call_execution() -> KeywordCallExecution:
     return KeywordCallExecution(
         verdict=KeywordVerdict.Undefined,

{testbench2robotframework-0.9.2b6 → testbench2robotframework-1.0.0}/testbench2robotframework/robotframework2testbench.py

@@ -3,6 +3,8 @@ from pathlib import Path
 
 from robot.api import ExecutionResult
 
+from testbench2robotframework.utils import perform_version_check
+
 from .config import Configuration
 from .log import logger, setup_logger
 from .result_writer import ResultWriter
@@ -18,6 +20,8 @@ def robot2testbench(
         sys.exit("Could not find json directory or zip file at the given path.")
     if not Path(robot_result_xml).exists():
         sys.exit("Robot result xml does not exist at the given path.")
+    perform_version_check(Path(json_input_report))
+
     configuration = Configuration.from_dict(config)
     setup_logger(configuration)
     logger.debug("Configuration loaded.")

{testbench2robotframework-0.9.2b6 → testbench2robotframework-1.0.0}/testbench2robotframework/testbench2robotframework.py

@@ -7,10 +7,16 @@ from .json_reader import TestBenchJsonReader
 from .log import logger, setup_logger
 from .testbench2rf import create_test_suites
 from .testsuite_write import write_test_suites
-from .utils import PathResolver, extract_to_working_directory, is_zip_file
+from .utils import (
+    PathResolver,
+    extract_to_working_directory,
+    is_zip_file,
+    perform_version_check,
+)
 
 
 def testbench2robotframework(testbench_report: str, config: dict | Configuration):
+    perform_version_check(Path(testbench_report))
     configuration = Configuration.from_dict(config) if isinstance(config, dict) else config
     setup_logger(configuration)
     logger.debug("Configuration loaded.")

{testbench2robotframework-0.9.2b6 → testbench2robotframework-1.0.0}/testbench2robotframework/utils.py

@@ -1,3 +1,4 @@
+import json
 import re
 import shutil
 import sys
@@ -17,6 +18,54 @@ from testbench2robotframework.model import (
 
 from .log import logger
 
+ALLOWED_SERVER_VERSIONS = ["4.0"]
+ERROR_COULD_NOT_READ_VERSION = (
+    "Could not read TestBench report version. The report must be generated with one of the supported versions: "
+    + ", ".join(ALLOWED_SERVER_VERSIONS)
+)
+ERROR_INCOMPATIBLE_VERSION = (
+    "The version of testbench2robotframework is not compatible with the TestBench report version '{server_version}'. "
+    f"Supported versions are: {', '.join(ALLOWED_SERVER_VERSIONS)}. "
+)
+
+
+def perform_version_check(testbench_report: Path):
+    try:
+        manifest = read_manifest_json_from_testbench_report(testbench_report)
+    except Exception as e:
+        sys.exit(ERROR_COULD_NOT_READ_VERSION)
+    server_version = manifest.get("serverVersions", {}).get("version", None)
+    if not server_version:
+        sys.exit(ERROR_COULD_NOT_READ_VERSION)
+
+    if server_version not in ALLOWED_SERVER_VERSIONS:
+        sys.exit(ERROR_INCOMPATIBLE_VERSION.format(server_version=server_version))
+
+
+def read_manifest_json_from_testbench_report(testbench_report: Path) -> dict:
+    if testbench_report.is_dir():
+        manifest = testbench_report / "manifest.json"
+        if not manifest.exists():
+            raise FileNotFoundError("manifest.json not found")
+        with open(manifest, "r", encoding="utf-8") as f:
+            return json.load(f)
+
+    # ZIP archive
+    elif testbench_report.suffix == ".zip":
+        with ZipFile(testbench_report) as zf:
+            try:
+                with zf.open("manifest.json") as f:
+                    return json.load(f)
+            except KeyError:
+                raise FileNotFoundError("manifest.json not found in zip")
+
+    # Direct file
+    elif testbench_report.is_file() and testbench_report.name == "manifest.json":
+        with open(testbench_report, "r", encoding="utf-8") as f:
+            return json.load(f)
+    else:
+        raise FileNotFoundError(testbench_report)
+
 
 def robot_tag_from_udf(udf: UserDefinedField) -> str | None:
     if (udf.udfType == UDFType.Enumeration and udf.value) or (