robotframework-events 0.2.0__tar.gz → 0.4.0__tar.gz

{robotframework_events-0.2.0/src/robotframework_events.egg-info → robotframework_events-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-events
-Version: 0.2.0
+Version: 0.4.0
 Summary: Robot Framework listener that writes execution events as JSON Lines
 Author: Tim de Groot
 License-Expression: MIT

{robotframework_events-0.2.0 → robotframework_events-0.4.0}/src/robotframework_events/__init__.py

@@ -27,4 +27,4 @@ __all__ = [
     "remove_callback",
     "schema",
 ]
-__version__ = "0.2.0"
+__version__ = "0.4.0"

{robotframework_events-0.2.0 → robotframework_events-0.4.0}/src/robotframework_events/convert.py

@@ -64,6 +64,7 @@ class _Converter:
             "run.started",
             self.t,
             run=run,
+            outputdir=os.path.dirname(os.path.abspath(path)),
             rf=match.group(1) if match else "unknown",
             python=match.group(2) if match else None,
         )
@@ -81,6 +82,7 @@ class _Converter:
             longname=suite.full_name,
             source=str(suite.source) if suite.source else None,
             tests=suite.test_count,
+            planned=[test.full_name for test in suite.all_tests] if parent is None else None,
         )
         counter = _Counter(id)
         if suite.has_setup:

{robotframework_events-0.2.0 → robotframework_events-0.4.0}/src/robotframework_events/events-v1.schema.json

@@ -51,7 +51,11 @@
         "rf": { "description": "Robot Framework version.", "type": "string" },
         "python": { "description": "Python version.", "type": "string" },
         "pid": { "type": "integer" },
-        "cwd": { "type": "string" }
+        "cwd": { "type": "string" },
+        "outputdir": {
+          "description": "The run's output directory; log.html links screenshots and other files relative to it.",
+          "type": "string"
+        }
       }
     },
     "run.ended": {
@@ -70,7 +74,11 @@
         "name": { "type": "string" },
         "longname": { "type": "string" },
         "source": { "type": "string" },
-        "tests": { "description": "Number of tests in the suite and its child suites.", "type": "integer", "minimum": 0 }
+        "tests": { "description": "Number of tests in the suite and its child suites.", "type": "integer", "minimum": 0 },
+        "planned": {
+          "description": "Top-level suite only: the full names of every test the run will execute, in run order.",
+          "$ref": "#/$defs/strings"
+        }
       }
     },
     "suite.ended": {

{robotframework_events-0.2.0 → robotframework_events-0.4.0}/src/robotframework_events/events.py

@@ -57,6 +57,7 @@ class RunStarted(Event):
     python: str | None = None
     pid: int | None = None
     cwd: str | None = None
+    outputdir: str | None = None
 
 
 @dataclass(slots=True, kw_only=True)
@@ -77,6 +78,7 @@ class SuiteStarted(Event):
     longname: str
     source: str | None = None
     tests: int
+    planned: list[str] | None = None
 
 
 @dataclass(slots=True, kw_only=True)

{robotframework_events-0.2.0 → robotframework_events-0.4.0}/src/robotframework_events/listener.py

@@ -329,20 +329,21 @@ class Listener:
             with contextlib.suppress(OSError):
                 self._out.flush()
 
-    def _open_file(self) -> None:
+    def _output_locations(self) -> tuple[str, str | None]:
+        """${OUTPUT DIR} and ${OUTPUT FILE} of the run (cwd and None when they cannot be read)."""
+        from robot.libraries.BuiltIn import BuiltIn
+
+        try:
+            outdir = BuiltIn().get_variable_value("${OUTPUT DIR}") or os.getcwd()
+            output = BuiltIn().get_variable_value("${OUTPUT FILE}")
+        except Exception:
+            return os.getcwd(), None
+        return str(outdir), output
+
+    def _open_file(self, outdir: str, output: str | None) -> None:
         if self._file_option and self._file_option.upper() == "NONE":
             return
-        if self._file_option:
-            path = Path(self._file_option)
-        else:
-            from robot.libraries.BuiltIn import BuiltIn
-
-            try:
-                outdir = BuiltIn().get_variable_value("${OUTPUT DIR}") or os.getcwd()
-                output = BuiltIn().get_variable_value("${OUTPUT FILE}")
-            except Exception:
-                outdir, output = os.getcwd(), None
-            path = default_events_file(outdir, output)
+        path = Path(self._file_option) if self._file_option else default_events_file(outdir, output)
         try:
             path.parent.mkdir(parents=True, exist_ok=True)
             # buffered; flushed after every test and at close so tailing readers see progress
@@ -370,7 +371,8 @@ class Listener:
         if not self._started:
             self._started = True
             self._root = result
-            self._open_file()
+            outdir, output = self._output_locations()
+            self._open_file(outdir, output)
             self._emit(
                 "run.started",
                 run=self._run_id,
@@ -378,6 +380,8 @@ class Listener:
                 python=platform.python_version(),
                 pid=os.getpid(),
                 cwd=os.getcwd(),
+                # log.html links screenshots and other files relative to it
+                outputdir=outdir,
             )
         source = str(data.source) if data.source else None
         self._emit(
@@ -388,6 +392,8 @@ class Listener:
             longname=result.full_name,
             source=source,
             tests=data.test_count,
+            # the top-level suite lists every test the run will execute, for time estimates
+            planned=[test.full_name for test in data.all_tests] if not self._stack else None,
         )
         self._stack.append(_Frame(data.id, source, self._stack[-1] if self._stack else None))
 

{robotframework_events-0.2.0 → robotframework_events-0.4.0/src/robotframework_events.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-events
-Version: 0.2.0
+Version: 0.4.0
 Summary: Robot Framework listener that writes execution events as JSON Lines
 Author: Tim de Groot
 License-Expression: MIT

{robotframework_events-0.2.0 → robotframework_events-0.4.0}/tests/test_events.py

@@ -22,9 +22,21 @@ def test_every_event_has_envelope_fields_and_gapless_seq(sample_events):
     assert all(e["v"] == 1 for e in sample_events)
 
 
+def test_top_level_suite_lists_the_planned_tests(sample_events):
+    suites = by_type(sample_events, "suite.started")
+    assert suites[0]["planned"] == ["Sample.Passing With Structures", "Sample.Failing Test", "Sample.Skipped Test"]
+    assert all("planned" not in s for s in suites[1:])
+
+
+def test_planned_tests_follow_the_selection(tmp_path: Path):
+    events, _ = run_with_listener(tmp_path, [DATA / "sample.robot"], test=["Failing Test"])
+    assert by_type(events, "suite.started")[0]["planned"] == ["Sample.Failing Test"]
+
+
 def test_run_events_frame_the_stream(sample_events):
     assert sample_events[0]["type"] == "run.started"
     assert sample_events[0]["run"]
+    assert sample_events[0]["outputdir"]
     assert sample_events[-1]["type"] == "run.ended"
     assert sample_events[-1]["stats"] == {"total": 3, "passed": 1, "failed": 1, "skipped": 1}