chore: Add EventStream.finish method

schemathesis · Jun 7, 2021 · a9fbccd · a9fbccd
1 parent 3d5d093
commit a9fbccd
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -7,7 +7,7 @@ Changelog
 **Added**
 
 - GraphQL support in CLI. `#746`_
-- A way to stop the Schemathesis runner's event stream manually via ``events.stop()``. `#1202`_
+- A way to stop the Schemathesis runner's event stream manually via ``events.stop()`` / ``events.finish()`` methods. `#1202`_
 
 **Changed**
 

diff --git a/src/schemathesis/runner/impl/core.py b/src/schemathesis/runner/impl/core.py
@@ -161,6 +161,11 @@ def stop(self) -> None:
         """
         self.stop_event.set()
 
+    def finish(self) -> events.ExecutionEvent:
+        """Stop the event stream & return the last event."""
+        self.stop()
+        return next(self)
+
 
 def handle_schema_error(
     error: InvalidSchema, results: TestResultSet, data_generation_method: DataGenerationMethod, recursion_level: int

diff --git a/test/runner/test_runner.py b/test/runner/test_runner.py
@@ -869,3 +869,9 @@ def test_stop_event_stream_after_second_event(event_stream):
     assert isinstance(next(event_stream), events.BeforeExecution)
     event_stream.stop()
     assert isinstance(next(event_stream), events.Finished)
+
+
+def test_finish(event_stream):
+    assert isinstance(next(event_stream), events.Initialized)
+    event = event_stream.finish()
+    assert isinstance(event, events.Finished)