robotframework-trace 1.0.0__tar.gz

robotframework_trace-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jonathan Simmonds
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

robotframework_trace-1.0.0/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: robotframework-trace
+Version: 1.0.0
+Summary: Alternative CLI for Robot Framework
+Author-email: Jonathan Simmonds <jon@jonsim.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/jonsim/robot-trace
+Project-URL: Repository, https://github.com/jonsim/robot-trace.git
+Project-URL: Issues, https://github.com/jonsim/robot-trace/issues
+Keywords: robotframework,listener,cli,trace
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: robotframework; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# RobotFramework CLI Progress Listener
+
+A lightweight Robot Framework listener that provides real-time progress updates
+directly on the command-line during test execution. The main design intention is
+you don't need to open the HTML files directly to debug failing tests.
+
+## Features
+- Displays test execution progress in the CLI.
+- Provides a clear and concise overview of running tests.
+- Provides a full, intuitive trace of any failing tests.
+
+## Usage
+The listener supports three different usage models:
+
+### 1. As a separate command-line tool
+This is the easiest and recommended usage model.
+
+#### Installation
+```sh
+pip install robotframework-trace
+```
+
+#### Usage
+```sh
+robot-trace path/to/tests
+```
+
+#### Details
+You don't need to remember any extra arguments to pass to Robot - the runner
+automatically passes the correct arguments to Robot and bases its own command
+line from the arguments you pass to Robot. This gives a drop-in replacement
+for any existing `robot` command lines.
+
+The `robot-trace` command is a very thin wrapper on top of `robot` - it passes all
+arguments it receives straight through, while adding additional arguments to
+ensure the listener output works properly.
+
+Robot's standard `--consolewidth` and `--consolecolors` arguments control the
+listener's output; their behavior matches Robot's documentation.
+
+`robot-trace` also introduces its own custom arguments that are consumed (matching
+Robot's argument parsing conventions regarding case insensitivity and
+hyphenation) before passing the command line to Robot:
+- `--verbose`: Sets the listener verbosity to `DEBUG` verbosity. Traces from all
+  tests are printed.
+- `--quiet`: Sets the listener verbosity to `QUIET` verbosity. Only traces from
+  failing tests are printed. Passing tests that raise warnings or errors are
+  not printed.
+- `--consoleprogress <value>`: Controls where the progress box is printed.
+  Valid values are `AUTO`, `STDOUT`, `STDERR`, `NONE` (to suppress it). Defaults
+  to `AUTO`, which will print to `stdout` or `stderr` if they haven't been
+  redirected, or suppress it otherwise.
+
+
+### 2. As a module-based Robot listener
+If you want to keep using `robot` directly, you can use the listener as a
+module.
+
+#### Installation
+```sh
+pip install robotframework-trace
+```
+
+#### Usage
+When calling the listener directly, ensure you call Robot with `--console=none`
+to avoid Robot's default console markers getting interleaved.
+```sh
+robot --listener robot_trace --console=none path/to/tests
+```
+
+#### Details
+The listener supports the following arguments:
+- `verbosity=<value>`: takes a string value to set the listener's verbosity.
+  Valid values are `DEBUG` (print traces from all tests), `NORMAL` (print traces
+  from failing, warning, and erroring tests), `QUIET` (print traces from failing
+  tests). Defaults to `NORMAL`.
+- `colors=<value>`: takes a string value to control whether or not the output is
+  colorized. Valid values are `AUTO`, `ON`, `ANSI`, `OFF`. Values behave the same
+  as Robot's `--consolecolors` argument. Defaults to `AUTO`.
+- `console_progress=<value>`: Controls where the progress box is printed. Valid
+  values are `AUTO`, `STDOUT`, `STDERR`, `NONE` (to suppress it). Defaults to
+  `AUTO`, which will print to `stdout` or `stderr` if they haven't been
+  redirected, or suppress it otherwise.
+- `width=<value>`: Controls the width of the progress box. Defaults to `120`.
+
+
+### 3. As a single-file Robot listener
+If you don't want to install the package, the listener is implemented as a
+single file which you can deploy standalone. This is useful for minimal setups
+or for embedding the listener in your own projects, but you lose the ability to
+update via `pip`.
+
+#### Installation
+Copy `robot_trace/RobotTrace.py` to your project directory.
+
+#### Usage
+Usage is identical to option 2, except using the file not the module:
+```sh
+robot --listener RobotTrace.py --console=none path/to/tests
+```
+
+
+### Related options
+You may also consider calling `robot` or `robot-trace` with:
+- `--maxerrorlines=10000` to avoid truncating all but the longest error
+  messages.
+- `--maxassignlength=10000` to avoid truncating all but the longest variables.
+
+
+## Example Output
+```sh
+$ robot-trace tests/minimal_testcases
+TEST FAILED: Nested Keywords.Nested Failing Test Case
+═════════════════════════════════════════════════════
+▶ Level Two Keyword('should_fail=${True}')
+  ▶ BuiltIn.Log('In the level two keyword')
+    I In the level two keyword
+    ✓ PASS     0s
+  ▶ Level Three Keyword()
+    ▶ BuiltIn.Log('In the level three keyword')
+      I In the level three keyword
+      ✓ PASS     0s
+    ✓ PASS     0s
+  ▶ Failing Keyword()
+    ▶ BuiltIn.Log('In the failing keyword')
+      I In the failing keyword
+      ✓ PASS     0s
+    ▶ BuiltIn.Fail('This keyword failed')
+      F This keyword failed
+      ✗ FAIL     0s
+    ✗ FAIL     0s
+  ✗ FAIL     0s
+
+┌──────────────────────────────────────────────────────────────────────┐
+│ [SUITE  2/ 2] Suite 2                                                │
+│ [TEST 11/16] Test Case 3 - Slow               (elapsed  4s, ETA  3s) │
+│ [Sleep]  '${DELAY_LONG}'                                             │
+└──────────────────────────────────────────────────────────────────────┘
+```
+
+## Requirements
+- Python 3.6+
+- Robot Framework 5.0+
+
+The script has no dependencies beyond the standard library. On Windows to get
+colorized output, you need to install the `colorama` package, however the script
+will work without it.
+
+The script has no direct dependency on `robotframework` itself, but obviously it
+doesn't do much without it installed.
+
+
+## Contributing
+Contributions, bugs, and feature requests are welcome! Please see the
+[Contributing Guide](CONTRIBUTING.md) for details on how to build the project
+locally and submit changes.
+
+
+## License
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
+for details.

robotframework_trace-1.0.0/README.md

@@ -0,0 +1,161 @@
+# RobotFramework CLI Progress Listener
+
+A lightweight Robot Framework listener that provides real-time progress updates
+directly on the command-line during test execution. The main design intention is
+you don't need to open the HTML files directly to debug failing tests.
+
+## Features
+- Displays test execution progress in the CLI.
+- Provides a clear and concise overview of running tests.
+- Provides a full, intuitive trace of any failing tests.
+
+## Usage
+The listener supports three different usage models:
+
+### 1. As a separate command-line tool
+This is the easiest and recommended usage model.
+
+#### Installation
+```sh
+pip install robotframework-trace
+```
+
+#### Usage
+```sh
+robot-trace path/to/tests
+```
+
+#### Details
+You don't need to remember any extra arguments to pass to Robot - the runner
+automatically passes the correct arguments to Robot and bases its own command
+line from the arguments you pass to Robot. This gives a drop-in replacement
+for any existing `robot` command lines.
+
+The `robot-trace` command is a very thin wrapper on top of `robot` - it passes all
+arguments it receives straight through, while adding additional arguments to
+ensure the listener output works properly.
+
+Robot's standard `--consolewidth` and `--consolecolors` arguments control the
+listener's output; their behavior matches Robot's documentation.
+
+`robot-trace` also introduces its own custom arguments that are consumed (matching
+Robot's argument parsing conventions regarding case insensitivity and
+hyphenation) before passing the command line to Robot:
+- `--verbose`: Sets the listener verbosity to `DEBUG` verbosity. Traces from all
+  tests are printed.
+- `--quiet`: Sets the listener verbosity to `QUIET` verbosity. Only traces from
+  failing tests are printed. Passing tests that raise warnings or errors are
+  not printed.
+- `--consoleprogress <value>`: Controls where the progress box is printed.
+  Valid values are `AUTO`, `STDOUT`, `STDERR`, `NONE` (to suppress it). Defaults
+  to `AUTO`, which will print to `stdout` or `stderr` if they haven't been
+  redirected, or suppress it otherwise.
+
+
+### 2. As a module-based Robot listener
+If you want to keep using `robot` directly, you can use the listener as a
+module.
+
+#### Installation
+```sh
+pip install robotframework-trace
+```
+
+#### Usage
+When calling the listener directly, ensure you call Robot with `--console=none`
+to avoid Robot's default console markers getting interleaved.
+```sh
+robot --listener robot_trace --console=none path/to/tests
+```
+
+#### Details
+The listener supports the following arguments:
+- `verbosity=<value>`: takes a string value to set the listener's verbosity.
+  Valid values are `DEBUG` (print traces from all tests), `NORMAL` (print traces
+  from failing, warning, and erroring tests), `QUIET` (print traces from failing
+  tests). Defaults to `NORMAL`.
+- `colors=<value>`: takes a string value to control whether or not the output is
+  colorized. Valid values are `AUTO`, `ON`, `ANSI`, `OFF`. Values behave the same
+  as Robot's `--consolecolors` argument. Defaults to `AUTO`.
+- `console_progress=<value>`: Controls where the progress box is printed. Valid
+  values are `AUTO`, `STDOUT`, `STDERR`, `NONE` (to suppress it). Defaults to
+  `AUTO`, which will print to `stdout` or `stderr` if they haven't been
+  redirected, or suppress it otherwise.
+- `width=<value>`: Controls the width of the progress box. Defaults to `120`.
+
+
+### 3. As a single-file Robot listener
+If you don't want to install the package, the listener is implemented as a
+single file which you can deploy standalone. This is useful for minimal setups
+or for embedding the listener in your own projects, but you lose the ability to
+update via `pip`.
+
+#### Installation
+Copy `robot_trace/RobotTrace.py` to your project directory.
+
+#### Usage
+Usage is identical to option 2, except using the file not the module:
+```sh
+robot --listener RobotTrace.py --console=none path/to/tests
+```
+
+
+### Related options
+You may also consider calling `robot` or `robot-trace` with:
+- `--maxerrorlines=10000` to avoid truncating all but the longest error
+  messages.
+- `--maxassignlength=10000` to avoid truncating all but the longest variables.
+
+
+## Example Output
+```sh
+$ robot-trace tests/minimal_testcases
+TEST FAILED: Nested Keywords.Nested Failing Test Case
+═════════════════════════════════════════════════════
+▶ Level Two Keyword('should_fail=${True}')
+  ▶ BuiltIn.Log('In the level two keyword')
+    I In the level two keyword
+    ✓ PASS     0s
+  ▶ Level Three Keyword()
+    ▶ BuiltIn.Log('In the level three keyword')
+      I In the level three keyword
+      ✓ PASS     0s
+    ✓ PASS     0s
+  ▶ Failing Keyword()
+    ▶ BuiltIn.Log('In the failing keyword')
+      I In the failing keyword
+      ✓ PASS     0s
+    ▶ BuiltIn.Fail('This keyword failed')
+      F This keyword failed
+      ✗ FAIL     0s
+    ✗ FAIL     0s
+  ✗ FAIL     0s
+
+┌──────────────────────────────────────────────────────────────────────┐
+│ [SUITE  2/ 2] Suite 2                                                │
+│ [TEST 11/16] Test Case 3 - Slow               (elapsed  4s, ETA  3s) │
+│ [Sleep]  '${DELAY_LONG}'                                             │
+└──────────────────────────────────────────────────────────────────────┘
+```
+
+## Requirements
+- Python 3.6+
+- Robot Framework 5.0+
+
+The script has no dependencies beyond the standard library. On Windows to get
+colorized output, you need to install the `colorama` package, however the script
+will work without it.
+
+The script has no direct dependency on `robotframework` itself, but obviously it
+doesn't do much without it installed.
+
+
+## Contributing
+Contributions, bugs, and feature requests are welcome! Please see the
+[Contributing Guide](CONTRIBUTING.md) for details on how to build the project
+locally and submit changes.
+
+
+## License
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
+for details.

robotframework_trace-1.0.0/pyproject.toml

@@ -0,0 +1,55 @@
+[project]
+name = "robotframework-trace"
+version = "1.0.0"
+description = "Alternative CLI for Robot Framework"
+readme = "README.md"
+authors = [{ name = "Jonathan Simmonds", email = "jon@jonsim.com" }]
+keywords = ["robotframework", "listener", "cli", "trace"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python"
+]
+license = "MIT"
+license-files = ["LICENSE"]
+dependencies = []
+requires-python = ">=3.6"
+
+[project.urls]
+Homepage = "https://github.com/jonsim/robot-trace"
+Repository = "https://github.com/jonsim/robot-trace.git"
+Issues = "https://github.com/jonsim/robot-trace/issues"
+
+[project.optional-dependencies]
+dev = ["robotframework", "pre-commit", "coverage", "build", "twine"]
+
+[build-system]
+requires = ["setuptools>=64"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["."]
+
+[project.scripts]
+robot-trace = "robot_trace.runner:main"
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.robocop.lint]
+# In order to support older RobotFramework versions we deliberately use
+# deprecated keywords (in this case, VAR).
+ignore = ["VAR05", "DEPR05"]
+
+[tool.robocop.lint.per_file_ignores]
+"tests/minimal_testcases/*" = ["DOC01", "DOC02", "DOC03", "DOC04"]
+"tests/minimal_testcases/invalid_syntax.robot" = ["MISC08"]
+
+[tool.robocop.format]
+select = ["AlignTemplatedTestCases"]

robotframework_trace-1.0.0/robot_trace/PrintVisits.py

@@ -0,0 +1,43 @@
+# Copyright (c) 2026 Jonathan Simmonds
+#
+
+
+class PrintVisits:
+    ROBOT_LISTENER_API_VERSION = 3
+
+    def __init__(self):
+        print("__init__")
+
+    def start_suite(self, suite, result):
+        print(f"start_suite({suite}, {result})")
+
+    def end_suite(self, suite, result):
+        print(f"end_suite({suite}, {result})")
+
+    def start_test(self, test, result):
+        print(f"start_test: {test}, {result}")
+
+    def end_test(self, test, result):
+        print(f"end_test: {test}, {result}")
+
+    def start_keyword(self, keyword, result):
+        print(f"start_keyword({keyword}, {result})")
+
+    def end_keyword(self, keyword, result):
+        print(f"end_keyword({keyword}, {result})")
+
+    def log_message(self, message):
+        print(f"log_message({message})")
+
+    def message(self, message):
+        # print(f"message({message})")
+        pass
+
+    def start_error(self, data, result):
+        print(f"start_error({data}, {result})")
+
+    def end_error(self, data, result):
+        print(f"end_error({data}, {result})")
+
+    def close(self):
+        print("close")

robotframework_trace-1.0.0/robot_trace/PrintVisitsV2.py

@@ -0,0 +1,44 @@
+# Copyright (c) 2026 Jonathan Simmonds
+#
+import pprint
+
+
+class PrintVisitsV2:
+    ROBOT_LISTENER_API_VERSION = 2
+
+    def __init__(self):
+        print("__init__")
+
+    def start_suite(self, suite, result):
+        print(f"start_suite({suite}, {result})")
+
+    def end_suite(self, suite, result):
+        print(f"end_suite({suite}, {result})")
+
+    def start_test(self, test, result):
+        print(f"start_test: {test}, {result}")
+
+    def end_test(self, test, result):
+        print(f"end_test: {test}, {result}")
+
+    def start_keyword(self, keyword, result):
+        print(f"start_keyword({keyword}, {pprint.pformat(result, indent=4)})")
+
+    def end_keyword(self, keyword, result):
+        print(f"end_keyword({keyword}, {pprint.pformat(result, indent=4)})")
+
+    def log_message(self, message):
+        print(f"log_message({message})")
+
+    def message(self, message):
+        # print(f"message({message})")
+        pass
+
+    def start_error(self, data, result):
+        print(f"start_error({data}, {result})")
+
+    def end_error(self, data, result):
+        print(f"end_error({data}, {result})")
+
+    def close(self):
+        print("close")