feat: add abort function (#270)

src/pykiso/__init__.py

@@ -56,6 +56,7 @@
     define_test_parameters,
     retry_test_case,
 )
+from .test_coordinator.test_execution import abort
 from .test_coordinator.test_suite import (
     BasicTestSuiteSetup,
     BasicTestSuiteTeardown,

src/pykiso/test_coordinator/test_execution.py

@@ -25,6 +25,7 @@
 """
 from __future__ import annotations
 
+import os
 from typing import TYPE_CHECKING
 from unittest.loader import VALID_MODULE_NAME
 
@@ -323,6 +324,20 @@ def collect_test_suites(
     return list_of_test_suites
 
 
+def abort(reason: str = None) -> None:
+    """Quit ITF test and log an error if a reason is indicated and
+    if any errors occurred it logs them.
+
+    :param reason: reason to abort, defaults to None
+    """
+    if reason:
+        log.critical(reason)
+    log.critical(
+        "Non recoverable error occurred during test execution, aborting test session."
+    )
+    os.kill(os.getpid(), ExitCode.ONE_OR_MORE_TESTS_RAISED_UNEXPECTED_EXCEPTION)
+
+
 def execute(
     config: Dict[str, Any],
     report_type: str = "text",

tests/test_config_registry_and_test_execution.py

@@ -10,6 +10,7 @@
 import copy
 import logging
 import pathlib
+import signal
 from contextlib import nullcontext as does_not_raise
 from pathlib import Path
 from typing import Any
@@ -771,3 +772,17 @@ def test_config_registry_config_no_patching(mocker: MockerFixture, sample_config
     assert mock_linker.provide_connector.call_count == 1
     assert mock_linker.provide_auxiliary.call_count == 2
     mock_linker._aux_cache.get_instance.assert_not_called()
+
+
+def test_abort(mocker: MockerFixture, caplog):
+    reason = "reason"
+    os_kill_mock = mocker.patch("os.kill")
+
+    test_execution.abort(reason)
+
+    assert reason in caplog.text
+    assert (
+        "Non recoverable error occurred during test execution, aborting test session."
+        in caplog.text
+    )
+    os_kill_mock.assert_called_once()