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

{robotframework_events-0.3.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.3.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.3.0 → robotframework_events-0.4.0}/src/robotframework_events/__init__.py

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

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

@@ -82,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.3.0 → robotframework_events-0.4.0}/src/robotframework_events/events-v1.schema.json

@@ -74,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.3.0 → robotframework_events-0.4.0}/src/robotframework_events/events.py

@@ -78,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.3.0 → robotframework_events-0.4.0}/src/robotframework_events/listener.py

@@ -392,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.3.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.3.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.3.0 → robotframework_events-0.4.0}/tests/test_events.py

@@ -22,6 +22,17 @@ 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"]