File size: 35,817 Bytes
cb65407 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 | # Copyright (c) 2013, 2018 Potential Ventures Ltd
# Copyright (c) 2013 SolarFlare Communications Inc
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of Potential Ventures Ltd,
# SolarFlare Communications Inc nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""All things relating to regression capabilities."""
import functools
import hashlib
import inspect
import math
import os
import pdb
import random
import re
import sys
import time
import warnings
from itertools import product
from typing import (
Any,
Callable,
Coroutine,
Dict,
Generic,
Iterable,
List,
Optional,
Sequence,
Tuple,
Type,
TypeVar,
Union,
cast,
overload,
)
import cocotb
from cocotb import ANSI, simulator
from cocotb._outcomes import Error, Outcome, capture
from cocotb._xunit_reporter import XUnitReporter
from cocotb.log import SimLog
from cocotb.result import SimFailure, TestSuccess
from cocotb.task import Task, _RunningTest
from cocotb.utils import (
get_sim_time,
remove_traceback_frames,
want_color_output,
)
_pdb_on_exception = "COCOTB_PDB_ON_EXCEPTION" in os.environ
_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 False, "pytest.raises doesn't raise an exception when it fails"
class _Test:
_id_count = 0 # used by the RegressionManager to sort tests in definition order
def __init__(
self,
func: Callable[..., Coroutine[Any, Any, None]],
name: Optional[str],
module: Optional[str],
timeout_time: Optional[float],
timeout_unit: str,
expect_fail: bool,
expect_error: Union[Type[Exception], Sequence[Type[Exception]]],
skip: bool,
stage: int,
):
self._id = self._id_count
type(self)._id_count += 1
if timeout_time is not None:
co = func # must save ref because we overwrite variable "func"
@functools.wraps(func)
async def func(*args, **kwargs):
running_co = Task(co(*args, **kwargs))
try:
res = await cocotb.triggers.with_timeout(
running_co, self.timeout_time, self.timeout_unit
)
except cocotb.result.SimTimeoutError:
running_co.kill()
raise
else:
return res
self.func = func
self.timeout_time = timeout_time
self.timeout_unit = timeout_unit
self.expect_fail = expect_fail
self.expect_error = expect_error
self.skip = skip
self.stage = stage
self.name = self.func.__qualname__ if name is None else name
self.module = self.func.__module__ if module is None else module
self.fullname = f"{self.module}.{self.name}"
self.included: Optional[bool] = None
class RegressionManager:
"""Encapsulates all regression capability into a single place"""
def __init__(self) -> None:
self._test = None
self._test_task = None
self._test_start_time = None
self._test_start_sim_time = None
self.log = _logger
self._regression_start_time: float
self.test_results = []
self.ntests = 0
self.count = 0
self.passed = 0
self.skipped = 0
self.failures = 0
self._tearing_down = False
self._queue: List[_Test] = []
# Setup XUnit
###################
results_filename = os.getenv("COCOTB_RESULTS_FILE", "results.xml")
suite_name = os.getenv("RESULT_TESTSUITE", "all")
package_name = os.getenv("RESULT_TESTPACKAGE", "all")
self.xunit = XUnitReporter(filename=results_filename)
self.xunit.add_testsuite(name=suite_name, package=package_name)
self.xunit.add_property(name="random_seed", value=str(cocotb.RANDOM_SEED))
def discover_tests(
self, modules: Iterable[str], filters: Optional[Sequence[str]] = None
) -> None:
"""Discover tests in files automatically.
Should be called before :meth:`start_regression` is called.
If no filters are given, all tests are included.
If one or more filters are given, only those tests which match a filter are included; the rest are excluded.
Args:
modules: a list of module names to execute to find tests.
filters: regex patterns for test names.
A match *includes* the test.
"""
for module_name in modules:
self.log.debug("Searching for tests in module %s", module_name)
self.log.debug("Python Path: %s", ",".join(sys.path))
self.log.debug("PWD: %s", os.getcwd())
__import__(module_name)
self.ntests = len(self._queue)
# error if no tests were discovered
if self.ntests == 0:
modules_str = ", ".join(repr(m) for m in modules)
raise RuntimeError(f"No tests were discovered in modules: {modules_str}")
# if no filters, accept all tests
if not filters:
return
# else mark all tests as excluded
self.ntests = 0
for test in self._queue:
test.included = False
# include tests that match filter
for test in self._queue:
for filter in filters:
if re.search(filter, test.fullname):
self.ntests += 1
test.included = True
break
else:
self.log.debug("Filtered out test %s", test.fullname)
if self.ntests == 0:
self.log.warning(
"No tests left after filtering with: %s",
", ".join(repr(f) for f in filters),
)
self._queue.sort(key=lambda test: (test.stage, test._id))
def register_test(
self,
func: Callable[..., Coroutine[Any, Any, None]],
name: Optional[str] = None,
module: Optional[str] = None,
timeout_time: Optional[float] = None,
timeout_unit: str = "step",
expect_fail: bool = False,
expect_error: Union[Type[Exception], Sequence[Type[Exception]]] = (),
skip: bool = False,
stage: int = 0,
) -> None:
"""Register a test with the RegressionManager.
Should be called before :meth:`start_regression` is called.
Args:
func:
The test function to register.
name:
The name of the test function.
Defaults to ``func.__qualname__`` if not given.
module:
The name of the module containing the test function.
Defaults to ``func.__module__`` if not given.
timeout_time:
Simulation time duration before timeout occurs.
timeout_unit:
Units of ``timeout_time``, accepts any units that :class:`~cocotb.triggers.Timer` does.
expect_fail:
If ``True`` and the test fails a functional check via an ``assert`` statement, :class:`pytest.raises`,
:class:`pytest.warns`, or :class:`pytest.deprecated_call`, the test is considered to have passed.
If ``True`` and the test passes successfully, the test is considered to have failed.
expect_error:
Mark the result as a pass only if one of the exception types is raised in the test.
This is primarily for cocotb internal regression use for when a simulator error is expected.
skip:
Don't execute this test as part of the regression.
The test can still be run manually by setting :make:var:`TESTCASE`.
stage:
Order tests logically into stages, where multiple tests can share a stage.
"""
test = _Test(
func=func,
name=name,
module=module,
timeout_time=timeout_time,
timeout_unit=timeout_unit,
expect_fail=expect_fail,
expect_error=expect_error,
skip=skip,
stage=stage,
)
self.log.debug("Registered test %r", test.fullname)
self._queue.append(test)
@classmethod
def setup_pytest_assertion_rewriting(cls, test_modules: Iterable[str]) -> None:
try:
import pytest
except ImportError:
_logger.info(
"pytest not found, install it to enable better AssertionError messages"
)
return
try:
# Install the assertion rewriting hook, which must be done before we
# import the test modules.
from _pytest.assertion import install_importhook
from _pytest.config import Config
pytest_conf = Config.fromdictargs(
{}, ["--capture=no", "-o", "python_files=*.py"]
)
install_importhook(pytest_conf)
except Exception:
_logger.exception(
"Configuring the assertion rewrite hook using pytest {} failed. "
"Please file a bug report!".format(pytest.__version__)
)
def start_regression(self) -> None:
"""Start the regression.
Should be called only once after :meth:`discover_tests` is called.
"""
self.count = 1
self._regression_start_time = time.time()
self._execute()
def _tear_down(self) -> None:
# prevent re-entering the tear down procedure
if not self._tearing_down:
self._tearing_down = True
else:
return
# fail remaining tests
while True:
test = self._next_test()
if test is None:
break
self._record_result(
test=test, outcome=Error(SimFailure), wall_time_s=0, sim_time_ns=0
)
# Write out final log messages
self._log_test_summary()
# Generate output reports
self.xunit.write()
# Setup simulator finalization
simulator.stop_simulator()
cocotb._stop_user_coverage()
cocotb._stop_library_coverage()
def _next_test(self) -> Optional[_Test]:
"""Get the next test to run"""
if not self._queue:
return None
return self._queue.pop(0)
def _handle_result(self, test: Task) -> None:
"""Handle a test completing.
Dump result to XML and schedule the next test (if any). Entered by the scheduler.
Args:
test: The test that completed
"""
assert test is self._test_task
real_time = time.time() - self._test_start_time
sim_time_ns = get_sim_time("ns") - self._test_start_sim_time
self._record_result(
test=self._test,
outcome=self._test_task._outcome,
wall_time_s=real_time,
sim_time_ns=sim_time_ns,
)
self._execute()
def _init_test(self, test: _Test) -> Optional[Task]:
"""Initialize a test.
Record outcome if the initialization fails.
Record skip if the test is skipped.
Save the initialized test if it successfully initializes.
"""
if test.included is None and test.skip:
self._record_test_skipped(test)
return None
if test.included is False:
self._record_test_excluded(test)
return None
test_init_outcome = capture(test.func, cocotb.top)
if isinstance(test_init_outcome, Error):
self.log.error(
"Failed to initialize test %s",
test.name,
exc_info=test_init_outcome.error,
)
self._record_result(test, test_init_outcome, 0, 0)
return None
# seed random number generator based on test module, name, and RANDOM_SEED
hasher = hashlib.sha1()
hasher.update(test.fullname.encode())
seed = cocotb.RANDOM_SEED + int(hasher.hexdigest(), 16)
random.seed(seed)
return _RunningTest(test_init_outcome.get(), test.name)
def _score_test(self, test: _Test, outcome: Outcome) -> Tuple[bool, bool]:
"""
Given a test and the test's outcome, determine if the test met expectations and log pertinent information
"""
# scoring outcomes
result_pass = True
sim_failed = False
try:
outcome.get()
except (KeyboardInterrupt, SystemExit):
raise
except BaseException as e:
result = remove_traceback_frames(e, ["_score_test", "get"])
else:
result = TestSuccess()
if (
isinstance(result, TestSuccess)
and not test.expect_fail
and not test.expect_error
):
self._log_test_passed(test, None, None)
elif isinstance(result, TestSuccess) and test.expect_error:
self._log_test_failed(test, None, "passed but we expected an error")
result_pass = False
elif isinstance(result, TestSuccess):
self._log_test_failed(test, None, "passed but we expected a failure")
result_pass = False
elif isinstance(result, SimFailure):
if isinstance(result, test.expect_error):
self._log_test_passed(test, result, "errored as expected")
else:
self.log.error("Test error has lead to simulator shutting us down")
result_pass = False
# 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")
else:
self._log_test_failed(test, result, "errored with unexpected type ")
result_pass = False
else:
self._log_test_failed(test, result, None)
result_pass = False
if _pdb_on_exception:
pdb.post_mortem(result.__traceback__)
return result_pass, sim_failed
def _get_lineno(self, test: _Test) -> None:
try:
return inspect.getsourcelines(test.func)[1]
except OSError:
return 1
def _log_test_passed(
self, test: _Test, result: Optional[Exception] = None, msg: Optional[str] = None
) -> None:
start_hilight = ANSI.COLOR_PASSED if want_color_output() else ""
stop_hilight = ANSI.COLOR_DEFAULT if want_color_output() else ""
if msg is None:
rest = ""
else:
rest = f": {msg}"
if result is None:
result_was = ""
else:
result_was = f" (result was {type(result).__qualname__})"
self.log.info(
f"{test.name} {start_hilight}passed{stop_hilight}{rest}{result_was}"
)
def _log_test_failed(
self, test: _Test, result: Optional[Exception] = None, msg: Optional[str] = None
) -> None:
start_hilight = ANSI.COLOR_FAILED if want_color_output() else ""
stop_hilight = ANSI.COLOR_DEFAULT if want_color_output() else ""
if msg is None:
rest = ""
else:
rest = f": {msg}"
self.log.info(
f"{test.name} {start_hilight}failed{stop_hilight}{rest}",
exc_info=result,
)
def _record_test_excluded(self, test: _Test) -> None:
lineno = self._get_lineno(test)
self.xunit.add_testcase(
name=test.name,
classname=test.module,
file=inspect.getfile(test.func),
lineno=repr(lineno),
time=repr(0),
sim_time_ns=repr(0),
ratio_time=repr(0),
)
self.xunit.add_skipped()
def _record_test_skipped(self, test: _Test) -> None:
hilight_start = ANSI.COLOR_SKIPPED if want_color_output() else ""
hilight_end = ANSI.COLOR_DEFAULT if want_color_output() else ""
# Want this to stand out a little bit
self.log.info(
"{start}skipping{end} {name} ({i}/{total})".format(
start=hilight_start,
i=self.count,
total=self.ntests,
end=hilight_end,
name=test.name,
)
)
lineno = self._get_lineno(test)
self.xunit.add_testcase(
name=test.name,
classname=test.module,
file=inspect.getfile(test.func),
lineno=repr(lineno),
time=repr(0),
sim_time_ns=repr(0),
ratio_time=repr(0),
)
self.xunit.add_skipped()
self.skipped += 1
self.count += 1
def _record_result(
self,
test: _Test,
outcome: Outcome,
wall_time_s: float,
sim_time_ns: float,
) -> None:
ratio_time = self._safe_divide(sim_time_ns, wall_time_s)
lineno = self._get_lineno(test)
self.xunit.add_testcase(
name=test.name,
classname=test.module,
file=inspect.getfile(test.func),
lineno=repr(lineno),
time=repr(wall_time_s),
sim_time_ns=repr(sim_time_ns),
ratio_time=repr(ratio_time),
)
test_pass, sim_failed = self._score_test(test, outcome)
if not test_pass:
self.xunit.add_failure(
message=f"Test failed with RANDOM_SEED={cocotb.RANDOM_SEED}"
)
self.failures += 1
else:
self.passed += 1
self.count += 1
self.test_results.append(
{
"test": test.fullname,
"pass": test_pass,
"sim": sim_time_ns,
"real": wall_time_s,
"ratio": ratio_time,
}
)
if sim_failed:
self._tear_down()
return
def _execute(self) -> None:
while True:
self._test = self._next_test()
if self._test is None:
return self._tear_down()
self._test_task = self._init_test(self._test)
if self._test_task is not None:
return self._start_test()
def _start_test(self) -> None:
# Want this to stand out a little bit
start = ""
end = ""
if want_color_output():
start = ANSI.COLOR_TEST
end = ANSI.COLOR_DEFAULT
self.log.info(
"{start}running{end} {name} ({i}/{total}){description}".format(
start=start,
i=self.count,
total=self.ntests,
end=end,
name=self._test.name,
description=_trim(self._test.__doc__),
)
)
self._test_start_time = time.time()
self._test_start_sim_time = get_sim_time("ns")
cocotb.scheduler._add_test(self._test_task)
def _log_test_summary(self) -> None:
real_time = time.time() - self._regression_start_time
sim_time_ns = get_sim_time("ns")
ratio_time = self._safe_divide(sim_time_ns, real_time)
if len(self.test_results) == 0:
return
TEST_FIELD = "TEST"
RESULT_FIELD = "STATUS"
SIM_FIELD = "SIM TIME (ns)"
REAL_FIELD = "REAL TIME (s)"
RATIO_FIELD = "RATIO (ns/s)"
TOTAL_NAME = f"TESTS={self.ntests} PASS={self.passed} FAIL={self.failures} SKIP={self.skipped}"
TEST_FIELD_LEN = max(
len(TEST_FIELD),
len(TOTAL_NAME),
len(max([x["test"] for x in self.test_results], key=len)),
)
RESULT_FIELD_LEN = len(RESULT_FIELD)
SIM_FIELD_LEN = len(SIM_FIELD)
REAL_FIELD_LEN = len(REAL_FIELD)
RATIO_FIELD_LEN = len(RATIO_FIELD)
header_dict = dict(
a=TEST_FIELD,
b=RESULT_FIELD,
c=SIM_FIELD,
d=REAL_FIELD,
e=RATIO_FIELD,
a_len=TEST_FIELD_LEN,
b_len=RESULT_FIELD_LEN,
c_len=SIM_FIELD_LEN,
d_len=REAL_FIELD_LEN,
e_len=RATIO_FIELD_LEN,
)
LINE_LEN = (
3
+ TEST_FIELD_LEN
+ 2
+ RESULT_FIELD_LEN
+ 2
+ SIM_FIELD_LEN
+ 2
+ REAL_FIELD_LEN
+ 2
+ RATIO_FIELD_LEN
+ 3
)
LINE_SEP = "*" * LINE_LEN + "\n"
summary = ""
summary += LINE_SEP
summary += "** {a:<{a_len}} {b:^{b_len}} {c:>{c_len}} {d:>{d_len}} {e:>{e_len}} **\n".format(
**header_dict
)
summary += LINE_SEP
test_line = "** {a:<{a_len}} {start}{b:^{b_len}}{end} {c:>{c_len}.2f} {d:>{d_len}.2f} {e:>{e_len}} **\n"
for result in self.test_results:
hilite = ""
lolite = ""
if result["pass"] is None:
ratio = "-.--"
pass_fail_str = "SKIP"
if want_color_output():
hilite = ANSI.COLOR_SKIPPED
lolite = ANSI.COLOR_DEFAULT
elif result["pass"]:
ratio = format(result["ratio"], "0.2f")
pass_fail_str = "PASS"
if want_color_output():
hilite = ANSI.COLOR_PASSED
lolite = ANSI.COLOR_DEFAULT
else:
ratio = format(result["ratio"], "0.2f")
pass_fail_str = "FAIL"
if want_color_output():
hilite = ANSI.COLOR_FAILED
lolite = ANSI.COLOR_DEFAULT
test_dict = dict(
a=result["test"],
b=pass_fail_str,
c=result["sim"],
d=result["real"],
e=ratio,
a_len=TEST_FIELD_LEN,
b_len=RESULT_FIELD_LEN,
c_len=SIM_FIELD_LEN - 1,
d_len=REAL_FIELD_LEN - 1,
e_len=RATIO_FIELD_LEN - 1,
start=hilite,
end=lolite,
)
summary += test_line.format(**test_dict)
summary += LINE_SEP
summary += test_line.format(
a=TOTAL_NAME,
b="",
c=sim_time_ns,
d=real_time,
e=format(ratio_time, "0.2f"),
a_len=TEST_FIELD_LEN,
b_len=RESULT_FIELD_LEN,
c_len=SIM_FIELD_LEN - 1,
d_len=REAL_FIELD_LEN - 1,
e_len=RATIO_FIELD_LEN - 1,
start="",
end="",
)
summary += LINE_SEP
self.log.info(summary)
@staticmethod
def _safe_divide(a: float, b: float) -> float:
try:
return a / b
except ZeroDivisionError:
if a == 0:
return float("nan")
else:
return float("inf")
F = TypeVar("F", bound=Callable[..., Coroutine[Any, Any, None]])
class TestFactory(Generic[F]):
"""Factory to automatically generate tests.
Args:
test_function: A Callable that returns the test Coroutine.
Must take *dut* as the first argument.
*args: Remaining arguments are passed directly to the test function.
Note that these arguments are not varied. An argument that
varies with each test must be a keyword argument to the
test function.
**kwargs: Remaining keyword arguments are passed directly to the test function.
Note that these arguments are not varied. An argument that
varies with each test must be a keyword argument to the
test function.
Assuming we have a common test function that will run a test. This test
function will take keyword arguments (for example generators for each of
the input interfaces) and generate tests that call the supplied function.
This Factory allows us to generate sets of tests based on the different
permutations of the possible arguments to the test function.
For example, if we have a module that takes backpressure, has two configurable
features where enabling ``feature_b`` requires ``feature_a`` to be active, and
need to test against data generation routines ``gen_a`` and ``gen_b``:
>>> tf = TestFactory(test_function=run_test)
>>> tf.add_option(name='data_in', optionlist=[gen_a, gen_b])
>>> tf.add_option('backpressure', [None, random_backpressure])
>>> tf.add_option(('feature_a', 'feature_b'), [(False, False), (True, False), (True, True)])
>>> tf.generate_tests()
We would get the following tests:
* ``gen_a`` with no backpressure and both features disabled
* ``gen_a`` with no backpressure and only ``feature_a`` enabled
* ``gen_a`` with no backpressure and both features enabled
* ``gen_a`` with ``random_backpressure`` and both features disabled
* ``gen_a`` with ``random_backpressure`` and only ``feature_a`` enabled
* ``gen_a`` with ``random_backpressure`` and both features enabled
* ``gen_b`` with no backpressure and both features disabled
* ``gen_b`` with no backpressure and only ``feature_a`` enabled
* ``gen_b`` with no backpressure and both features enabled
* ``gen_b`` with ``random_backpressure`` and both features disabled
* ``gen_b`` with ``random_backpressure`` and only ``feature_a`` enabled
* ``gen_b`` with ``random_backpressure`` and both features enabled
The tests are appended to the calling module for auto-discovery.
Tests are simply named ``test_function_N``. The docstring for the test (hence
the test description) includes the name and description of each generator.
.. versionchanged:: 1.5
Groups of options are now supported
.. versionchanged:: 2.0
You can now pass :func:`cocotb.test` decorator arguments when generating tests.
"""
def __init__(self, test_function: F, *args: Any, **kwargs: Any) -> None:
self.test_function = test_function
self.args = args
self.kwargs_constant = kwargs
self.kwargs: Dict[
Union[str, Sequence[str]], Union[Sequence[Any], Sequence[Sequence[Any]]]
] = {}
@overload
def add_option(self, name: str, optionlist: Sequence[Any]) -> None:
...
@overload
def add_option(
self, name: Sequence[str], optionlist: Sequence[Sequence[Any]]
) -> None:
...
def add_option(
self,
name: Union[str, Sequence[str]],
optionlist: Union[Sequence[str], Sequence[Sequence[str]]],
) -> None:
"""Add a named option to the test.
Args:
name:
An option name, or an iterable of several option names. Passed to test as keyword arguments.
optionlist:
A list of possible options for this test knob.
If N names were specified, this must be a list of N-tuples or
lists, where each element specifies a value for its respective
option.
.. versionchanged:: 1.5
Groups of options are now supported
"""
if not isinstance(name, str):
for opt in optionlist:
if len(name) != len(opt):
raise ValueError(
"Mismatch between number of options and number of option values in group"
)
self.kwargs[name] = optionlist
def generate_tests(
self,
*,
prefix: Optional[str] = None,
postfix: Optional[str] = None,
name: Optional[str] = None,
timeout_time: Optional[float] = None,
timeout_unit: str = "steps",
expect_fail: bool = False,
expect_error: Union[Type[Exception], Sequence[Type[Exception]]] = (),
skip: bool = False,
stage: int = 0,
):
"""
Generate an exhaustive set of tests using the cartesian product of the
possible keyword arguments.
The generated tests are appended to the namespace of the calling
module.
Args:
prefix:
Text string to append to start of ``test_function`` name when naming generated test cases.
This allows reuse of a single ``test_function`` with multiple :class:`TestFactories <.TestFactory>` without name clashes.
.. deprecated:: 2.0
Use the more flexible ``name`` field instead.
postfix:
Text string to append to end of ``test_function`` name when naming generated test cases.
This allows reuse of a single ``test_function`` with multiple :class:`TestFactories <.TestFactory>` without name clashes.
.. deprecated:: 2.0
Use the more flexible ``name`` field instead.
name:
Passed as ``name`` argument to :func:`cocotb.test`.
.. versionadded:: 2.0
timeout_time:
Passed as ``timeout_time`` argument to :func:`cocotb.test`.
.. versionadded:: 2.0
timeout_unit:
Passed as ``timeout_unit`` argument to :func:`cocotb.test`.
.. versionadded:: 2.0
expect_fail:
Passed as ``expect_fail`` argument to :func:`cocotb.test`.
.. versionadded:: 2.0
expect_error:
Passed as ``expect_error`` argument to :func:`cocotb.test`.
.. versionadded:: 2.0
skip:
Passed as ``skip`` argument to :func:`cocotb.test`.
.. versionadded:: 2.0
stage:
Passed as ``stage`` argument to :func:`cocotb.test`.
.. versionadded:: 2.0
"""
if prefix is not None:
warnings.warn(
"``prefix`` argument is deprecated. Use the more flexible ``name`` field instead.",
DeprecationWarning,
)
else:
prefix = ""
if postfix is not None:
warnings.warn(
"``postfix`` argument is deprecated. Use the more flexible ``name`` field instead.",
DeprecationWarning,
)
else:
postfix = ""
d = self.kwargs
test_func_name = self.test_function.__qualname__ if name is None else name
for index, testoptions in enumerate(
dict(zip(d, v)) for v in product(*d.values())
):
name = "%s%s%s_%03d" % (
prefix,
test_func_name,
postfix,
index + 1,
)
doc: str = "Automatically generated test\n\n"
# preprocess testoptions to split tuples
testoptions_split: Dict[str, Sequence[Any]] = {}
for optname, optvalue in testoptions.items():
if isinstance(optname, str):
optvalue = cast(Sequence[Any], optvalue)
testoptions_split[optname] = optvalue
else:
# previously checked in add_option; ensure nothing has changed
optvalue = cast(Sequence[Sequence[Any]], optvalue)
assert len(optname) == len(optvalue)
for n, v in zip(optname, optvalue):
testoptions_split[n] = v
for optname, optvalue in testoptions_split.items():
if callable(optvalue):
if not optvalue.__doc__:
desc = "No docstring supplied"
else:
desc = optvalue.__doc__.split("\n")[0]
doc += f"\t{optname}: {optvalue.__qualname__} ({desc})\n"
else:
doc += f"\t{optname}: {repr(optvalue)}\n"
kwargs: Dict[str, Any] = {}
kwargs.update(self.kwargs_constant)
kwargs.update(testoptions_split)
@functools.wraps(self.test_function)
async def _my_test(dut, kwargs: Dict[str, Any] = kwargs):
await self.test_function(dut, *self.args, **kwargs)
_my_test.__doc__ = doc
_my_test.__name__ = name
_my_test.__qualname__ = name
cocotb.regression_manager.register_test(
func=_my_test,
name=name,
timeout_time=timeout_time,
timeout_unit=timeout_unit,
expect_fail=expect_fail,
expect_error=expect_error,
skip=skip,
stage=stage,
)
def _trim(docstring: Optional[str]) -> str:
"""Normalizes test docstrings
Based on https://www.python.org/dev/peps/pep-0257/#handling-docstring-indentation.
"""
if docstring is None or docstring == "":
return ""
# Convert tabs to spaces (following the normal Python rules)
# and split into a list of lines:
lines = docstring.expandtabs().splitlines()
# Determine minimum indentation (first line doesn't count):
indent = math.inf
for line in lines[1:]:
stripped = line.lstrip()
if stripped:
indent = min(indent, len(line) - len(stripped))
# Remove indentation (first line is special):
trimmed = [lines[0].strip()]
if indent < math.inf:
for line in lines[1:]:
trimmed.append(line[indent:].rstrip())
# Strip off trailing and leading blank lines:
while trimmed and not trimmed[-1]:
trimmed.pop()
while trimmed and not trimmed[0]:
trimmed.pop(0)
# Add one newline back
trimmed.insert(0, "")
# Return a single string:
return "\n ".join(trimmed)
|