Skip to content

Commit

Permalink
v0.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@Paebbels
Paebbels authored May 6, 2024
2 parents 7e776c4 + 423bb4b commit 120296d
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 31 deletions.
121 changes: 91 additions & 30 deletions pyEDAA/Reports/Unittesting/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@ class IterationScheme(Flag):


TestsuiteType = TypeVar("TestsuiteType", bound="Testsuite")
TestcaseAggregateReturnType = Tuple[int, int, int]
TestsuiteAggregateReturnType = Tuple[int, int, int, int, int, int, int, int, int, int, int]
TestcaseAggregateReturnType = Tuple[int, int, int, timedelta]
TestsuiteAggregateReturnType = Tuple[int, int, int, int, int, int, int, int, int, int, int, timedelta]


@export
Expand All @@ -165,6 +165,7 @@ class Base(metaclass=ExtendedType, slots=True):

_startTime: datetime
_setupDuration: Nullable[timedelta]
_testDuration: Nullable[timedelta]
_teardownDuration: Nullable[timedelta]
_totalDuration: Nullable[timedelta]

Expand All @@ -179,6 +180,7 @@ def __init__(
name: str,
startTime: Nullable[datetime] = None,
setupDuration: Nullable[timedelta] = None,
testDuration: Nullable[timedelta] = None,
teardownDuration: Nullable[timedelta] = None,
totalDuration: Nullable[timedelta] = None,
warningCount: int = 0,
Expand All @@ -194,8 +196,45 @@ def __init__(
self._parent = parent
self._name = name

if testDuration is not None:
if setupDuration is not None:
if teardownDuration is not None:
if totalDuration is not None:
if totalDuration < (setupDuration + testDuration + teardownDuration):
raise UnittestException(f"Parameter 'totalDuration' can not be less than the sum of setup, test and teardown durations.")
else: # no total
totalDuration = setupDuration + testDuration + teardownDuration
# no teardown
elif totalDuration is not None:
if totalDuration < (setupDuration + testDuration):
raise UnittestException(f"Parameter 'totalDuration' can not be less than the sum of setup and test durations.")
# no teardown, no total
else:
totalDuration = setupDuration + testDuration
# no setup
elif teardownDuration is not None:
if totalDuration is not None:
if totalDuration < (testDuration + teardownDuration):
raise UnittestException(f"Parameter 'totalDuration' can not be less than the sum of test and teardown durations.")
else: # no setup, no total
totalDuration = testDuration + teardownDuration
# no setup, no teardown
elif totalDuration is not None:
if totalDuration < testDuration:
raise UnittestException(f"Parameter 'totalDuration' can not be less than test durations.")
else: # no setup, no teardown, no total
totalDuration = testDuration
# no test
elif totalDuration is not None:
testDuration = totalDuration
if setupDuration is not None:
testDuration -= setupDuration
if teardownDuration is not None:
testDuration -= teardownDuration

self._startTime = startTime
self._setupDuration = setupDuration
self._testDuration = testDuration
self._teardownDuration = teardownDuration
self._totalDuration = totalDuration

Expand All @@ -205,12 +244,11 @@ def __init__(

self._dict = {}

# QUESTION: allow Parent as setter?
@readonly
def Parent(self) -> Nullable["Testsuite"]:
return self._parent

# QUESTION: allow Parent as setter?

@readonly
def Name(self) -> str:
return self._name
Expand All @@ -223,6 +261,10 @@ def StartTime(self) -> datetime:
def SetupDuration(self) -> timedelta:
return self._setupDuration

@readonly
def TestDuration(self) -> timedelta:
return self._testDuration

@readonly
def TeardownDuration(self) -> timedelta:
return self._teardownDuration
Expand Down Expand Up @@ -269,7 +311,6 @@ def Aggregate(self):
@export
class Testcase(Base):
_status: TestcaseStatus
_testDuration: Nullable[timedelta]
_assertionCount: Nullable[int]
_failedAssertionCount: Nullable[int]
_passedAssertionCount: Nullable[int]
Expand Down Expand Up @@ -297,11 +338,9 @@ def __init__(

parent._testcases[name] = self

super().__init__(name, startTime, setupDuration, teardownDuration, totalDuration, warningCount, errorCount, fatalCount, parent)
super().__init__(name, startTime, setupDuration, testDuration, teardownDuration, totalDuration, warningCount, errorCount, fatalCount, parent)

self._status = status
self._testDuration = testDuration
# if totalDuration is not None:

self._assertionCount = assertionCount
if assertionCount is not None:
Expand Down Expand Up @@ -338,10 +377,6 @@ def __init__(
def Status(self) -> TestcaseStatus:
return self._status

@readonly
def TestDuration(self) -> timedelta:
return self._testDuration

@readonly
def AssertionCount(self) -> int:
if self._assertionCount is None:
Expand Down Expand Up @@ -396,13 +431,16 @@ def Aggregate(self, strict: bool = True) -> TestcaseAggregateReturnType:
# TODO: check for setup errors
# TODO: check for teardown errors

return self._warningCount, self._errorCount, self._fatalCount
totalDuration = timedelta() if self._totalDuration is None else self._totalDuration

return self._warningCount, self._errorCount, self._fatalCount, totalDuration

def __str__(self) -> str:
return (
f"<Testcase {self._name}: {self._status.name} -"
f" assert/pass/fail:{self._assertionCount}/{self._passedAssertionCount}/{self._failedAssertionCount} -"
f" warn/error/fatal:{self._warningCount}/{self._errorCount}/{self._fatalCount}>"
f" warn/error/fatal:{self._warningCount}/{self._errorCount}/{self._fatalCount} -"
f" setup/test/teardown:{self._setupDuration:.3f}/{self._testDuration:.3f}/{self._teardownDuration:.3f}>"
)


Expand All @@ -427,6 +465,7 @@ def __init__(
kind: TestsuiteKind = TestsuiteKind.Logical,
startTime: Nullable[datetime] = None,
setupDuration: Nullable[timedelta] = None,
testDuration: Nullable[timedelta] = None,
teardownDuration: Nullable[timedelta] = None,
totalDuration: Nullable[timedelta] = None,
status: TestsuiteStatus = TestsuiteStatus.Unknown,
Expand All @@ -442,7 +481,7 @@ def __init__(

parent._testsuites[name] = self

super().__init__(name, startTime, setupDuration, teardownDuration, totalDuration, warningCount, errorCount, fatalCount, parent)
super().__init__(name, startTime, setupDuration, testDuration, teardownDuration, totalDuration, warningCount, errorCount, fatalCount, parent)

self._kind = kind
self._status = status
Expand Down Expand Up @@ -559,12 +598,15 @@ def Aggregate(self) -> TestsuiteAggregateReturnType:
weak = 0
failed = 0
passed = 0

warningCount = 0
errorCount = 0
fatalCount = 0

totalDuration = timedelta()

for testsuite in self._testsuites.values():
t, i, ex, s, e, w, f, p, wc, ec, fc = testsuite.Aggregate()
t, i, ex, s, e, w, f, p, wc, ec, fc, td = testsuite.Aggregate()
tests += t
inconsistent += i
excluded += ex
Expand All @@ -573,11 +615,14 @@ def Aggregate(self) -> TestsuiteAggregateReturnType:
weak += w
failed += f
passed += p

warningCount += wc
errorCount += ec
fatalCount += fc

return tests, inconsistent, excluded, skipped, errored, weak, failed, passed, warningCount, errorCount, fatalCount
totalDuration += td

return tests, inconsistent, excluded, skipped, errored, weak, failed, passed, warningCount, errorCount, fatalCount, totalDuration

def AddTestsuite(self, testsuite: TestsuiteType) -> None:
if testsuite._parent is not None:
Expand Down Expand Up @@ -648,6 +693,7 @@ def __init__(
kind: TestsuiteKind = TestsuiteKind.Logical,
startTime: Nullable[datetime] = None,
setupDuration: Nullable[timedelta] = None,
testDuration: Nullable[timedelta] = None,
teardownDuration: Nullable[timedelta] = None,
totalDuration: Nullable[timedelta] = None,
status: TestsuiteStatus = TestsuiteStatus.Unknown,
Expand All @@ -658,7 +704,7 @@ def __init__(
testcases: Nullable[Iterable["Testcase"]] = None,
parent: Nullable[TestsuiteType] = None
):
super().__init__(name, kind, startTime, setupDuration, teardownDuration, totalDuration, status, warningCount, errorCount, fatalCount, testsuites, parent)
super().__init__(name, kind, startTime, setupDuration, testDuration, teardownDuration, totalDuration, status, warningCount, errorCount, fatalCount, testsuites, parent)

# self._testDuration = testDuration

Expand Down Expand Up @@ -700,16 +746,19 @@ def Copy(self) -> "Testsuite":
)

def Aggregate(self, strict: bool = True) -> TestsuiteAggregateReturnType:
tests, inconsistent, excluded, skipped, errored, weak, failed, passed, warningCount, errorCount, fatalCount = super().Aggregate()
tests, inconsistent, excluded, skipped, errored, weak, failed, passed, warningCount, errorCount, fatalCount, totalDuration = super().Aggregate()

for testcase in self._testcases.values():
wc, ec, fc = testcase.Aggregate(strict)
wc, ec, fc, td = testcase.Aggregate(strict)

tests += 1

warningCount += wc
errorCount += ec
fatalCount += fc

totalDuration += td

status = testcase._status
if status is TestcaseStatus.Unknown:
raise UnittestException(f"Found testcase '{testcase._name}' with state 'Unknown'.")
Expand Down Expand Up @@ -740,10 +789,14 @@ def Aggregate(self, strict: bool = True) -> TestsuiteAggregateReturnType:
self._weak = weak
self._failed = failed
self._passed = passed

self._warningCount = warningCount
self._errorCount = errorCount
self._fatalCount = fatalCount

if self._totalDuration is None:
self._totalDuration = totalDuration

if errored > 0:
self._status = TestsuiteStatus.Errored
elif failed > 0:
Expand All @@ -757,7 +810,7 @@ def Aggregate(self, strict: bool = True) -> TestsuiteAggregateReturnType:
else:
self._status = TestsuiteStatus.Unknown

return tests, inconsistent, excluded, skipped, errored, weak, failed, passed, warningCount, errorCount, fatalCount
return tests, inconsistent, excluded, skipped, errored, weak, failed, passed, warningCount, errorCount, fatalCount, totalDuration

def Iterate(self, scheme: IterationScheme = IterationScheme.Default) -> Generator[Union[TestsuiteType, Testcase], None, None]:
assert IterationScheme.PreOrder | IterationScheme.PostOrder not in scheme
Expand Down Expand Up @@ -796,6 +849,7 @@ def __init__(
name: str,
startTime: Nullable[datetime] = None,
setupDuration: Nullable[timedelta] = None,
testDuration: Nullable[timedelta] = None,
teardownDuration: Nullable[timedelta] = None,
totalDuration: Nullable[timedelta] = None,
status: TestsuiteStatus = TestsuiteStatus.Unknown,
Expand All @@ -805,10 +859,10 @@ def __init__(
testsuites: Nullable[Iterable[TestsuiteType]] = None,
parent: Nullable[TestsuiteType] = None
):
super().__init__(name, TestsuiteKind.Root, startTime, setupDuration, teardownDuration, totalDuration, status, warningCount, errorCount, fatalCount, testsuites, parent)
super().__init__(name, TestsuiteKind.Root, startTime, setupDuration, testDuration, teardownDuration, totalDuration, status, warningCount, errorCount, fatalCount, testsuites, parent)

def Aggregate(self) -> TestsuiteAggregateReturnType:
tests, inconsistent, excluded, skipped, errored, weak, failed, passed, warningCount, errorCount, fatalCount = super().Aggregate()
tests, inconsistent, excluded, skipped, errored, weak, failed, passed, warningCount, errorCount, fatalCount, totalDuration = super().Aggregate()

self._tests = tests
self._inconsistent = inconsistent
Expand All @@ -818,10 +872,14 @@ def Aggregate(self) -> TestsuiteAggregateReturnType:
self._weak = weak
self._failed = failed
self._passed = passed

self._warningCount = warningCount
self._errorCount = errorCount
self._fatalCount = fatalCount

if self._totalDuration is None:
self._totalDuration = totalDuration

if errored > 0:
self._status = TestsuiteStatus.Errored
elif failed > 0:
Expand All @@ -837,7 +895,7 @@ def Aggregate(self) -> TestsuiteAggregateReturnType:
else:
self._status = TestsuiteStatus.Unknown

return tests, inconsistent, excluded, skipped, errored, weak, failed, passed, warningCount, errorCount, fatalCount
return tests, inconsistent, excluded, skipped, errored, weak, failed, passed, warningCount, errorCount, fatalCount, totalDuration

def Iterate(self, scheme: IterationScheme = IterationScheme.Default) -> Generator[Union[TestsuiteType, Testcase], None, None]:
if IterationScheme.IncludeSelf | IterationScheme.IncludeTestsuites | IterationScheme.PreOrder in scheme:
Expand Down Expand Up @@ -970,10 +1028,11 @@ def SummedFailedAssertionCount(self) -> int:
def Aggregate(self, strict: bool = True) -> TestcaseAggregateReturnType:
firstMTC = self._mergedTestcases[0]

status = firstMTC._status
warningCount = firstMTC._warningCount
errorCount = firstMTC._errorCount
fatalCount = firstMTC._fatalCount
status = firstMTC._status
warningCount = firstMTC._warningCount
errorCount = firstMTC._errorCount
fatalCount = firstMTC._fatalCount
totalDuration = firstMTC._totalDuration

for mtc in self._mergedTestcases[1:]:
status @= mtc._status
Expand All @@ -983,7 +1042,7 @@ def Aggregate(self, strict: bool = True) -> TestcaseAggregateReturnType:

self._status = status

return warningCount, errorCount, fatalCount
return warningCount, errorCount, fatalCount, totalDuration

def Merge(self, tc: Testcase) -> None:
self._mergedCount += 1
Expand Down Expand Up @@ -1028,7 +1087,7 @@ def __init__(
testsuite._name,
testsuite._kind,
testsuite._startTime,
testsuite._setupDuration, testsuite._teardownDuration, testsuite._totalDuration,
testsuite._setupDuration, testsuite._testDuration, testsuite._teardownDuration, testsuite._totalDuration,
TestsuiteStatus.Unknown,
testsuite._warningCount, testsuite._errorCount, testsuite._fatalCount,
parent
Expand Down Expand Up @@ -1068,6 +1127,7 @@ def ToTestsuite(self) -> Testsuite:
self._kind,
self._startTime,
self._setupDuration,
self._testDuration,
self._teardownDuration,
self._totalDuration,
self._status,
Expand Down Expand Up @@ -1120,6 +1180,7 @@ def ToTestsuiteSummary(self) -> TestsuiteSummary:
self._name,
self._startTime,
self._setupDuration,
self._testDuration,
self._teardownDuration,
self._totalDuration,
self._status,
Expand Down
2 changes: 1 addition & 1 deletion pyEDAA/Reports/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
__email__ = "[email protected]"
__copyright__ = "2021-2024, Electronic Design Automation Abstraction (EDA²)"
__license__ = "Apache License, Version 2.0"
__version__ = "0.7.2"
__version__ = "0.8.0"
__keywords__ = ["Reports", "Abstract Model", "Data Model", "Unit Testing", "Testcase", "Testsuite", "OSVVM", "YAML", "XML"]

from enum import Enum
Expand Down

0 comments on commit 120296d

Please sign in to comment.