cocotb 1.7.2__cp38-cp38-win_amd64.whl → 1.8.0rc1__cp38-cp38-win_amd64.whl

cocotb/regression.py

@@ -37,18 +37,18 @@ import sys
 import time
 import traceback
 from itertools import product
-from typing import Any, Iterable, Optional, Tuple
+from typing import Any, Iterable, Optional, Tuple, Type
 
 import cocotb
 import cocotb.ANSI as ANSI
 from cocotb import simulator
 from cocotb._deprecation import deprecated
-from cocotb.decorators import Task
 from cocotb.decorators import test as Test
 from cocotb.handle import SimHandle
 from cocotb.log import SimLog
 from cocotb.outcomes import Error, Outcome
 from cocotb.result import SimFailure, TestSuccess
+from cocotb.task import Task
 from cocotb.utils import get_sim_time, remove_traceback_frames, want_color_output
 from cocotb.xunit_reporter import XUnitReporter
 
@@ -78,6 +78,20 @@ def _my_import(name: str) -> Any:
 
 _logger = SimLog(__name__)
 
+_Failed: Type[BaseException]
+try:
+    import pytest
+except ModuleNotFoundError:
+    _Failed = AssertionError
+else:
+    try:
+        with pytest.raises(Exception):
+            pass
+    except BaseException as _raises_e:
+        _Failed = type(_raises_e)
+    else:
+        assert "pytest.raises doesn't raise an exception when it fails"
+
 
 class RegressionManager:
     """Encapsulates all regression capability into a single place"""
@@ -250,11 +264,8 @@ class RegressionManager:
             from _pytest.assertion import install_importhook
             from _pytest.config import Config
 
-            # Pass python_files to Config to support assertion rewriting only on test modules.
-            # See https://github.com/pytest-dev/pytest/discussions/10052.
-            test_modules_str = " ".join(f"{name}.py" for name in test_modules)
             pytest_conf = Config.fromdictargs(
-                {}, ["--capture=no", "-o", f"python_files={test_modules_str}"]
+                {}, ["--capture=no", "-o", "python_files=*.py"]
             )
             install_importhook(pytest_conf)
         except Exception:
@@ -394,7 +405,9 @@ class RegressionManager:
 
         try:
             outcome.get()
-        except Exception as e:
+        except (KeyboardInterrupt, SystemExit):
+            raise
+        except BaseException as e:
             result = remove_traceback_frames(e, ["_score_test", "get"])
         else:
             result = TestSuccess()
@@ -406,9 +419,6 @@ class RegressionManager:
         ):
             self._log_test_passed(test, None, None)
 
-        elif isinstance(result, AssertionError) and test.expect_fail:
-            self._log_test_passed(test, result, "failed as expected")
-
         elif isinstance(result, TestSuccess) and test.expect_error:
             self._log_test_failed(test, None, "passed but we expected an error")
             result_pass = False
@@ -426,6 +436,9 @@ class RegressionManager:
             # whether we expected it or not, the simulation has failed unrecoverably
             sim_failed = True
 
+        elif isinstance(result, (AssertionError, _Failed)) and test.expect_fail:
+            self._log_test_passed(test, result, "failed as expected")
+
         elif test.expect_error:
             if isinstance(result, test.expect_error):
                 self._log_test_passed(test, result, "errored as expected")
@@ -455,7 +468,9 @@ class RegressionManager:
             result_was = ""
         else:
             result_was = f" (result was {type(result).__qualname__})"
-        self.log.info(f"{test} {start_hilight}passed{stop_hilight}{rest}{result_was}")
+        self.log.info(
+            f"{test.__qualname__} {start_hilight}passed{stop_hilight}{rest}{result_was}"
+        )
 
     def _log_test_failed(
         self, test: Test, result: Optional[Exception] = None, msg: Optional[str] = None
@@ -467,7 +482,8 @@ class RegressionManager:
         else:
             rest = f": {msg}"
         self.log.info(
-            f"{test} {start_hilight}failed{stop_hilight}{rest}", exc_info=result
+            f"{test.__qualname__} {start_hilight}failed{stop_hilight}{rest}",
+            exc_info=result,
         )
 
     def _record_result(
@@ -502,7 +518,9 @@ class RegressionManager:
         else:
             test_pass, sim_failed = self._score_test(test, outcome)
             if not test_pass:
-                self.xunit.add_failure()
+                self.xunit.add_failure(
+                    message=f"Test failed with RANDOM_SEED={cocotb.RANDOM_SEED}"
+                )
                 self.failures += 1
             else:
                 self.passed += 1
@@ -892,7 +910,7 @@ def _trim(docstring: Optional[str]) -> str:
 
     Based on https://www.python.org/dev/peps/pep-0257/#handling-docstring-indentation.
     """
-    if docstring is None:
+    if docstring is None or docstring == "":
         return ""
     # Convert tabs to spaces (following the normal Python rules)
     # and split into a list of lines: