testbench2robotframework 0.9.2a2__tar.gz → 0.9.2b4__tar.gz

{testbench2robotframework-0.9.2a2 → testbench2robotframework-0.9.2b4}/.gitignore

@@ -165,4 +165,5 @@ cli-export-config.json
 cli-import-config.json
 robot_tests/
 reports/
-.github/
+.github/
+openapi.yml

testbench2robotframework-0.9.2b4/DEVELOPMENT.md

@@ -0,0 +1,35 @@
+# Contributing
+
+## Setting up project for the first time
+
+1. Create venv and activate it:
+    ```bash
+    python -m venv .venv
+    source .venv/bin/activate  # Linux/macOS
+    .venv\scripts\activate     # Windows
+    ```
+2. Install project with dev dependencies:
+    ```bash
+    pip install -e .[dev]
+    ```
+
+## Building and publishing
+
+```bash
+check-manifest --update
+python -m build
+twine check dist/*
+twine upload dist/*
+```
+
+## Updating the data model
+
+`testbench2robotframework/model.py` is generated from the TestBench OpenAPI spec using [datamodel-code-generator](https://github.com/koxudaxi/datamodel-code-generator).
+
+1. Download the OpenAPI YAML from the TestBench Swagger documentation (e.g. `openapi.yml`).
+2. Generate the model (settings are in `pyproject.toml` under `[tool.datamodel-codegen]`):
+    ```bash
+    invoke generate-model --input openapi.yml
+    ```
+   This runs `datamodel-codegen` and injects `__VERSION__` from the spec's `info.version` field into `model.py`.
+3. Review the generated file

{testbench2robotframework-0.9.2a2 → testbench2robotframework-0.9.2b4}/ExampleConfiguration/json_config.json

@@ -10,8 +10,14 @@
   "output-directory": "{root}/Generated",
   "log-suite-numbering": true,
   "resource-directory": "{root}/Resources",
+  "resource-directory-regex": ".*\\[Robot-Resources\\].*",
   "clean": true,
   "compound-keyword-logging": "GROUP",
+  "reference-behaviour": "ATTACHMENT",
+  "attachment-conflict-behaviour": "USE_EXISTING",
+  "testcase-splitting-regex": "^StopWithRestart\\..*",
+  "phase-pattern": "{testcase} : Phase {index}/{length}",
+  "metadata": {},
   "library-mapping": {
       "SeleniumLibrary": "SeleniumLibrary    timeout=10    implicit_wait=1    run_on_failure=Capture Page Screenshot",
       "SuperRemoteLibrary": "Remote    http://127.0.0.1:8270       WITH NAME    SuperRemoteLibrary"
@@ -20,20 +26,15 @@
     "MyKeywords": "{root}/../MyKeywords.resource",
     "MyOtherKeywords": "{resourceDirectory}/subdir/MyOtherKeywords.resource"
   },
-  "forcedImport": {
-    "libraries": [
-    ],
-    "resources":
-    [
-    ],
-    "variables": [
-    ]
+  "forced-import": {
+    "libraries": [],
+    "resources": [],
+    "variables": []
   },
-  "testCaseSplitPathRegEx": "^StopWithRestart\\..*",
   "console-logging": {
     "logLevel": "debug"
   },
   "file-logging": {
       "logLevel": "info"
-    }
+  }
 }

{testbench2robotframework-0.9.2a2 → testbench2robotframework-0.9.2b4}/ExampleConfiguration/pyproject_example.toml

@@ -7,9 +7,10 @@ fully-qualified = false
 output-directory = "{root}/Generated"
 log-suite-numbering = false
 clean = true
-compound-keyword-logging = true
+compound-keyword-logging = "GROUP"
 resource-directory = "{root}/Resources"
-testcase-split-regex = ".*StopWithRestart.*"
+resource-directory-regex = ".*\\[Robot-Resources\\].*"
+testcase-splitting-regex = ".*StopWithRestart.*"
 phase-pattern = "{testcase} : Phase {index}/{length}"
 reference-behaviour = "ATTACHMENT"
 attachment-conflict-behaviour = "USE_EXISTING"

{testbench2robotframework-0.9.2a2 → testbench2robotframework-0.9.2b4}/ExampleConfiguration/toml_config.toml

@@ -7,9 +7,10 @@ fully-qualified = false
 output-directory = "{root}/Generated"
 log-suite-numbering = false
 clean = true
-compound-keyword-logging = true
+compound-keyword-logging = "GROUP"
 resource-directory = "{root}/Resources"
-testcase-split-regex = ".*StopWithRestart.*"
+resource-directory-regex = ".*\\[Robot-Resources\\].*"
+testcase-splitting-regex = ".*StopWithRestart.*"
 phase-pattern = "{testcase} : Phase {index}/{length}"
 reference-behaviour = "ATTACHMENT"
 attachment-conflict-behaviour = "USE_EXISTING"

testbench2robotframework-0.9.2b4/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: testbench2robotframework
+Version: 0.9.2b4
+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
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click >= 8.0
+Requires-Dist: robotframework >= 5.0
+Requires-Dist: tomli; python_version < '3.11'
+Requires-Dist: build ; extra == "dev"
+Requires-Dist: check-manifest ; extra == "dev"
+Requires-Dist: flit ; extra == "dev"
+Requires-Dist: invoke ; extra == "dev"
+Requires-Dist: mypy ; extra == "dev"
+Requires-Dist: pylint ; extra == "dev"
+Requires-Dist: pytest ; extra == "dev"
+Requires-Dist: pytest-cov ; extra == "dev"
+Requires-Dist: pytest-spec ; extra == "dev"
+Requires-Dist: robotframework-tidy ; extra == "dev"
+Requires-Dist: datamodel-code-generator ; extra == "dev"
+Requires-Dist: ruff ; extra == "dev"
+Requires-Dist: twine ; extra == "dev"
+Project-URL: Repository, https://github.com/imbus/testbench2robotframework
+Provides-Extra: dev
+
+# TestBench2RobotFramework
+
+testbench2robotframework is a CLI tool to convert a TestBench JSON report into Robot Framework test suites and to write the execution results provided by Robot Framework back to the TestBench report.
+
+This can be used for automated test execution with Robot Framework, triggered by a CI/CD pipeline.
+
+## Documentation
+
+The documentation is available in the [docs](./docs) folder of this repository.
+
+## Releases
+
+Releases are published on GitHub and available via [PyPI](https://pypi.org/project/testbench2robotframework/).
+
+## Requirements
+
+- Python 3.10 or higher
+- TestBench version >= 4
+

testbench2robotframework-0.9.2b4/README.md

@@ -0,0 +1,18 @@
+# TestBench2RobotFramework
+
+testbench2robotframework is a CLI tool to convert a TestBench JSON report into Robot Framework test suites and to write the execution results provided by Robot Framework back to the TestBench report.
+
+This can be used for automated test execution with Robot Framework, triggered by a CI/CD pipeline.
+
+## Documentation
+
+The documentation is available in the [docs](./docs) folder of this repository.
+
+## Releases
+
+Releases are published on GitHub and available via [PyPI](https://pypi.org/project/testbench2robotframework/).
+
+## Requirements
+
+- Python 3.10 or higher
+- TestBench version >= 4

{testbench2robotframework-0.9.2a2 → testbench2robotframework-0.9.2b4}/atest/robot/libs/json_config.py

@@ -43,4 +43,3 @@ data = {
 def create_json_configuration_file(path: Path):
     with path.open("w") as json_file:
         json.dump(data, json_file, indent=2)
-

testbench2robotframework-0.9.2b4/atest/robot/libs/pyproject_config.py

@@ -0,0 +1,8 @@
+import tomli_w
+
+data = {"tool": {"testbench2robotframework": {"generationDirectory": "{root}/toml_config_tests"}}}
+
+
+def create_toml_configuration_file():
+    with open("pyproject.toml", "w") as toml_file:
+        toml_file.write(tomli_w.dumps(data))

{testbench2robotframework-0.9.2a2 → testbench2robotframework-0.9.2b4}/create_json_schema.py

@@ -1,20 +1,24 @@
 import json
 import re
 
-
-with open("testbench2robotframework/model.py", "r", encoding="utf8") as model_py:
+with open("testbench2robotframework/model.py", encoding="utf8") as model_py:
     model_str = model_py.read()
 
 pydantic_model = re.sub(r"(@dataclass\n)(class .*?)(:)", r"\2(BaseModel)\3", model_str)
 pydantic_model = re.sub(r"( {4}@classmethod.*?)(\nclass|$)", r"\2", pydantic_model, flags=re.DOTALL)
-pydantic_model = re.sub(r"from dataclasses import dataclass", r"from pydantic import BaseModel", pydantic_model, flags=re.DOTALL)
+pydantic_model = re.sub(
+    r"from dataclasses import dataclass",
+    r"from pydantic import BaseModel",
+    pydantic_model,
+    flags=re.DOTALL,
+)
 
 
 with open("pydantic_model.py", "w", encoding="utf8") as pydantic_model_py:
     pydantic_model_py.write(pydantic_model)
 
 from pydantic_model import *
-from yaml import dump, Dumper
+from yaml import Dumper, dump
 
 with open("model.json", "w") as schema:
     schema.write(json.dumps(AllModels.model_json_schema(), indent=2))

testbench2robotframework-0.9.2b4/docs/configuration/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Configuration",
+  "position": 4
+}

testbench2robotframework-0.9.2b4/docs/configuration/cli_options.md

@@ -0,0 +1,112 @@
+---
+sidebar_position: 2
+---
+
+# CLI Options Reference
+
+Complete reference for all command-line options available in TestBench2RobotFramework.
+
+## Global Options
+
+These options are available for all commands:
+
+| Option | Description |
+|--------|-------------|
+| `--help` | Displays the help message and exits. |
+| `--version` | Writes the TestBench2RobotFramework, Robot Framework and Python version to console. |
+| `-c`, `--config PATH` | Path to a configuration file for TestBench2RobotFramework. |
+
+## generate-tests Options
+
+Options specific to the `generate-tests` subcommand:
+
+### Output Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `-d`, `--output-directory PATH` | Path | Directory or ZIP archive containing the generated test suites. |
+| `--clean` | Flag | Deletes all files present in the output-directory before new test suites are created. |
+
+### Keyword & Logging Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `--compound-keyword-logging` | Choice | Mode for logging compound keywords. Options: `GROUP`, `COMMENT`, or `NONE`. |
+| `--fully-qualified` | Flag | Calls Robot Framework keywords by their fully qualified names in the generated test suites. |
+| `--log-suite-numbering` | Flag | Enables logging of the test suite numbering. |
+| `--metadata TEXT` | Text | Add extra metadata to the settings of the generated Robot Framework test suite. Provide entries as `key:value` pairs. |
+
+### Resource & Library Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `--resource-directory PATH` | Path | Directory containing the Robot Framework resource files. |
+| `--resource-directory-regex TEXT` | Regex | Regex that can be used to identify the TestBench Subdivision that corresponds to the resource-directory. Resources will be imported relative to this subdivision based on the test elements structure in TestBench. |
+| `--library-regex TEXT` | Regex | Regular expression used to identify TestBench subdivisions corresponding to Robot Framework libraries. |
+| `--library-root TEXT` | Text | TestBench root subdivision whose direct children correspond to Robot Framework libraries. |
+| `--resource-regex TEXT` | Regex | Regular expression used to identify TestBench subdivisions corresponding to Robot Framework resources. |
+| `--resource-root TEXT` | Text | TestBench root subdivision whose direct children correspond to Robot Framework resources. |
+| `--library-mapping TEXT` | Text | Library import statement to use when a keyword from the specified TestBench subdivision is encountered. |
+| `--resource-mapping TEXT` | Text | Resource import statement to use when a keyword from the specified TestBench subdivision is encountered. |
+
+## fetch-results Options
+
+Options specific to the `fetch-results` subcommand:
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `-d`, `--output-directory PATH` | Path | Path to the directory or ZIP file where the updated TestBench JSON report (with results) should be saved. |
+
+## Usage Examples
+
+### Display Help
+
+```powershell
+testbench2robotframework --help
+testbench2robotframework generate-tests --help
+testbench2robotframework fetch-results --help
+```
+
+### Check Version
+
+```powershell
+testbench2robotframework --version
+```
+
+### Generate Tests with Multiple Options
+
+```powershell
+testbench2robotframework generate-tests \
+  --clean \
+  -d ./Generated \
+  --compound-keyword-logging GROUP \
+  --fully-qualified \
+  --log-suite-numbering \
+  my_report.json
+```
+
+### Fetch Results with Custom Output
+
+```powershell
+testbench2robotframework fetch-results \
+  -d ./updated_reports \
+  output.xml \
+  testbench_report.json
+```
+
+### Using Configuration File
+
+```powershell
+testbench2robotframework generate-tests -c config.toml my_report.json
+```
+
+## Option Priority
+
+When the same option is specified in multiple places, the priority order is:
+
+1. **Command-line options** (highest priority)
+2. **Workspace-local `.robot.toml`**
+3. **Project `robot.toml` or `pyproject.toml`**
+4. **Default values** (lowest priority)
+
+

testbench2robotframework-0.9.2b4/docs/configuration/overview.md

@@ -0,0 +1,93 @@
+---
+sidebar_position: 1
+---
+
+# Configuration Overview
+
+TestBench2RobotFramework offers flexible configuration options to customize the behavior of test generation and result fetching.
+
+## Configuration Methods
+
+You can configure TestBench2RobotFramework using three different methods:
+
+### 1. Command-Line Options
+
+Pass options directly when running commands:
+
+```powershell
+testbench2robotframework generate-tests --clean -d ./Generated my_report.json
+```
+
+✅ **Best for:** Quick, one-time runs and overriding specific settings
+
+### 2. Configuration Files
+
+Store settings in configuration files for reusable configurations:
+
+- `pyproject.toml` - Python project configuration
+- `robot.toml` - Robot Framework specific configuration
+- `.robot.toml` - Workspace-local configuration
+
+✅ **Best for:** Team projects, consistent settings, complex configurations
+
+TestBench2RobotFramework will automatically detect and apply settings from these files when present.
+
+### 3. Mixed Approach
+
+Combine both methods - command-line options override configuration file settings:
+
+```powershell
+testbench2robotframework generate-tests -c config.toml --clean my_report.json
+```
+
+## Configuration Hierarchy
+
+When multiple configuration methods are used, settings are applied in the following order (later overrides earlier):
+
+1. Default values
+2. `pyproject.toml` or `robot.toml`
+3. `.robot.toml` (workspace-local)
+4. Command-line options
+
+## Common Configuration Options
+
+### Output Settings
+
+- `output-directory` - Where to save generated files or results
+- `clean` - Delete existing files before generating new ones
+- `fully-qualified` - Enable/disable fully qualified keyword names in generated test suites
+- `compound-keyword-logging` - Control compound TestBench keyword logging (`GROUP`, `COMMENT`, `NONE`)
+- `log-suite-numbering` - Enable/disable suite numbering in generated file names
+- `testcase-splitting-regex` - Regular expression to split test cases at matching interactions
+- `phase-pattern` - Pattern for naming test case phases when splitting
+
+### Library & Resource Mapping
+
+- `library-regex` - Pattern to identify TestBench subdivisions as libraries
+- `resource-regex` - Pattern to identify TestBench subdivisions as resources
+- `library-root` - Root subdivision for libraries
+- `resource-root` - Root subdivision for resources
+- `library-mapping` - Custom library import statements
+- `resource-mapping` - Custom resource import statements
+- `resource-directory` - Directory containing Robot Framework resource files
+- `resource-directory-regex` - Regex to identify the TestBench subdivision corresponding to the resource directory
+
+### Metadata
+
+- `metadata` - Extra metadata key-value pairs added to generated test suite settings
+
+### Forced Imports
+
+- `forced-import` - Force import of specific libraries, resources, or variables in every generated suite
+
+### Attachment & Reference Handling
+
+- `reference-behaviour` - How to handle references (`ATTACHMENT`, `REFERENCE`, `NONE`)
+- `attachment-conflict-behaviour` - How to handle attachment conflicts (`ERROR`, `USE_NEW`, `USE_EXISTING`, `RENAME_NEW`)
+
+### Logging
+
+- `console-logging` - Console output log level and format
+- `file-logging` - File-based log level, format, and file name
+
+

testbench2robotframework-0.9.2b4/docs/configuration/pyproject_config.md

@@ -0,0 +1,171 @@
+---
+sidebar_position: 3
+---
+
+# pyproject.toml Configuration
+
+All CLI options available for `testbench2robotframework` can be defined in your `pyproject.toml` file, `robot.toml`, or a workspace-local `.robot.toml`. This offers a convenient way to store and reuse configuration settings, particularly in larger projects or automated environments.
+
+## Basic Structure
+
+Add a `[tool.testbench2robotframework]` section to your `pyproject.toml`:
+
+```toml
+[tool.testbench2robotframework]
+# Your configuration options here
+```
+
+## Complete Configuration Example
+
+Here's a comprehensive example with all available options:
+
+```toml
+[tool.testbench2robotframework]
+library-regex = ['(?:.*\.)?(?P<resourceName>[^.]+?)\s*\[Robot-Library\].*']
+resource-regex = ['(?:.*\.)?(?P<resourceName>[^.]+?)\s*\[Robot-Resource\].*']
+library-root = ["RF", "RF-Library"]
+resource-root = ["RF-Resource"]
+fully-qualified = false
+output-directory = "{root}/Generated"
+log-suite-numbering = false
+clean = true
+compound-keyword-logging = "GROUP"
+resource-directory = "{root}/Resources"
+resource-directory-regex = ".*\\[Robot-Resources\\].*"
+reference-behaviour = "ATTACHMENT"
+attachment-conflict-behaviour = "USE_EXISTING"
+testcase-splitting-regex = ".*StopWithRestart.*"
+phase-pattern = "{testcase} : Phase {index}/{length}"
+
+[tool.testbench2robotframework.metadata]
+# Example: MyKey = "my value"
+
+[tool.testbench2robotframework.library-mapping]
+SeleniumLibrary = "SeleniumLibrary    timeout=10    implicit_wait=1    run_on_failure=Capture Page Screenshot"
+SuperRemoteLibrary = "Remote    http://127.0.0.1:8270       WITH NAME    SuperRemoteLibrary"
+
+[tool.testbench2robotframework.resource-mapping]
+MyKeywords = "{root}/../MyKeywords.resource"
+MyOtherKeywords = "{resourceDirectory}/subdir/MyOtherKeywords.resource"
+
+[tool.testbench2robotframework.forced-import]
+libraries = ["test.py"]
+resources = []
+variables = []
+
+[tool.testbench2robotframework.console-logging]
+logLevel = "INFO"
+logFormat = "%(levelname)s: %(message)s"
+
+[tool.testbench2robotframework.file-logging]
+logLevel = "DEBUG"
+logFormat = "%(asctime)s - %(filename)s:%(lineno)d - %(levelname)8s - %(message)s"
+fileName = "testbench2robotframework.log"
+```
+
+## Configuration Sections
+
+### Main Configuration
+
+The main `[tool.testbench2robotframework]` section contains general settings:
+
+```toml
+[tool.testbench2robotframework]
+output-directory = "{root}/Generated"
+clean = true
+fully-qualified = false
+log-suite-numbering = false
+compound-keyword-logging = "GROUP"
+testcase-splitting-regex = ".*StopWithRestart.*"
+phase-pattern = "{testcase} : Phase {index}/{length}"
+```
+
+### Metadata
+
+Add custom metadata to the settings of generated Robot Framework test suites:
+
+```toml
+[tool.testbench2robotframework.metadata]
+MyMetadata = "some value"
+```
+
+### Library Mapping
+
+Define custom import statements for libraries:
+
+```toml
+[tool.testbench2robotframework.library-mapping]
+SeleniumLibrary = "SeleniumLibrary    timeout=10    implicit_wait=1"
+MyLibrary = "MyLibrary    arg1=value1    arg2=value2"
+```
+
+### Resource Mapping
+
+Define custom import statements for resources:
+
+```toml
+[tool.testbench2robotframework.resource-mapping]
+MyKeywords = "{root}/../MyKeywords.resource"
+CommonKeywords = "{resourceDirectory}/common/keywords.resource"
+```
+
+### Forced Imports
+
+Force specific libraries, resources, or variables to be imported:
+
+```toml
+[tool.testbench2robotframework.forced-import]
+libraries = ["BuiltIn", "Collections"]
+resources = ["common.resource"]
+variables = ["variables.py"]
+```
+
+### Console Logging
+
+Configure console output:
+
+```toml
+[tool.testbench2robotframework.console-logging]
+logLevel = "INFO"
+logFormat = "%(levelname)s: %(message)s"
+```
+
+### File Logging
+
+Configure file-based logging:
+
+```toml
+[tool.testbench2robotframework.file-logging]
+logLevel = "DEBUG"
+logFormat = "%(asctime)s - %(filename)s:%(lineno)d - %(levelname)8s - %(message)s"
+fileName = "testbench2robotframework.log"
+```
+
+## Variable Placeholders
+
+You can use the following placeholders in configuration values:
+
+- `{root}` - Project root directory
+- `{resourceDirectory}` - Configured resource directory path
+
+**Example:**
+```toml
+output-directory = "{root}/Generated"
+resource-directory = "{root}/Resources"
+```
+
+## Using robot.toml
+
+Instead of `pyproject.toml`, you can use `robot.toml` with the same structure:
+
+```toml
+[tool.testbench2robotframework]
+output-directory = "./Generated"
+clean = true
+```
+
+## Workspace-Local Configuration
+
+Create a `.robot.toml` file in your workspace for project-specific settings that override the global configuration.
+
+

testbench2robotframework-0.9.2b4/docs/getting_started/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Getting started",
+  "position": 2
+}

testbench2robotframework-0.9.2b4/docs/getting_started/installation.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 1
+---
+
+# Installation
+
+## Prerequisites
+
+Before installing TestBench2RobotFramework, ensure you have:
+
+- **Python 3.10 or higher** installed on your system
+- **pip** package manager (usually comes with Python)
+
+## Install via pip
+
+You can install TestBench2RobotFramework via pip using the following command:
+
+```powershell
+pip install testbench2robotframework
+```
+
+## Verify Installation
+
+After installation, verify that the tool is correctly installed by checking the version:
+
+```powershell
+testbench2robotframework --version
+```
+
+This command will display the TestBench2RobotFramework, Robot Framework, and Python versions.
+