Features

Create test entities

The hierarchy of test entities (test cases, test suites and test summaries) can be constructed top-down or bottom-up.

Test Case

from pyEDAA.Reports.Unittesting import Testsuite, Testcase

# Top-down
ts1 = Testsuite("ts1")

tc = Testcase("tc", parent=ts)

# Bottom-up
tc1 = Testcase("tc1")
tc2 = Testcase("tc2")

ts2 = Testsuite("ts2", testcases=(tc1, tc2))

# ts.AddTestcase(...)
tc3 = Testcase("tc3")
tc4 = Testcase("tc4")

ts3 = Testsuite("ts3")
ts3.AddTestcase(tc3)
ts3.AddTestcase(tc4)

# ts.AddTestcases(...)
tc3 = Testcase("tc3")
tc4 = Testcase("tc4")

ts3 = Testsuite("ts3")
ts3.AddTestcases((tc3, tc4))

Test Suite

from pyEDAA.Reports.Unittesting import Testsuite, TestsuiteSummary

# Top-down
ts = Testsuite("ts")

ts1 = Testsuite("ts1", parent=tss)

# Bottom-up
ts2 = Testsuite("ts2")
ts3 = Testsuite("ts3")

ts4 = Testsuite("ts4", testsuites=(ts2, ts3))

# ts.AddTestsuite(...)
ts5 = Testcase("ts5")
ts6 = Testcase("ts6")

ts7 = Testsuite("ts7")
ts7.AddTestsuite(ts5)
ts7.AddTestsuite(ts6)

# ts.AddTestsuites(...)
ts8 = Testcase("ts8")
ts9 = Testcase("ts9")

ts10 = Testsuite("ts10")
ts10.AddTestsuites((ts8, ts9))

Test Suite Summary

from pyEDAA.Reports.Unittesting import Testsuite, TestsuiteSummary

# Top-down

# Bottom-up

Reading unittest reports

A JUnit XML test report summary file can be read by creating an instance of the Document class. Because JUnit has so many dialects, a derived subclass for the dialect might be required. By choosing the right Document class, also the XML schema for XML schema validation gets pre-selected.

Any JUnit

from pyEDAA.Reports.Unittesting.JUnit import Document

xmlReport = Path("AnyJUnit-Report.xml")
try:
  doc = Document(xmlReport, parse=True)
except UnittestException as ex:
  ...

Ant + JUnit4

from pyEDAA.Reports.Unittesting.JUnit.AntJUnit import Document

xmlReport = Path("AntJUnit4-Report.xml")
try:
  doc = Document(xmlReport, parse=True)
except UnittestException as ex:
  ...

CTest JUnit

from pyEDAA.Reports.Unittesting.JUnit.CTestJUnit import Document

xmlReport = Path("CTest-JUnit-Report.xml")
try:
  doc = Document(xmlReport, parse=True)
except UnittestException as ex:
  ...

GoogleTest JUnit

from pyEDAA.Reports.Unittesting.JUnit.GoogleTestJUnit import Document

xmlReport = Path("GoogleTest-JUnit-Report.xml")
try:
  doc = Document(xmlReport, parse=True)
except UnittestException as ex:
  ...

pyTest JUnit

from pyEDAA.Reports.Unittesting.JUnit.PyTestJUnit import Document

xmlReport = Path("pyTest-JUnit-Report.xml")
try:
  doc = Document(xmlReport, parse=True)
except UnittestException as ex:
  ...

Converting unittest reports

Any JUnit dialect specific data model can be converted to the generic hierarchy of test entities.

Note

This conversion is identical for all derived dialects.

Document

from pyEDAA.Reports.Unittesting.JUnit import Document

# Read from XML file
xmlReport = Path("JUnit-Report.xml")
try:
  doc = Document(xmlReport, parse=True)
except UnittestException as ex:
  ...

# Convert to unified test data model
summary = doc.ToTestsuiteSummary()

# Convert to a tree
rootNode = doc.ToTree()

# Convert back to a document
newXmlReport = Path("New JUnit-Report.xml")
newDoc = Document.FromTestsuiteSummary(newXmlReport, summary)

# Write to XML file
newDoc.Write()

Annotations

Every test entity can be annotated with arbitrary key-value pairs.

Testcase

# Add annotate a key-value pair
testcase["key"] = value

# Update existing annotation with new value
testcase["key"] = newValue

# Check if key exists
if "key" in testcase:
  pass

# Access annoation by key
value = testcase["key"]

# Get number of annotations
annotationCount = len(testcase)

# Delete annotation
del testcase["key"]

# Iterate annotations
for key, value in testcases:
   pass

Testsuite

# Add annotate a key-value pair
testsuite["key"] = value

# Update existing annotation with new value
testsuite["key"] = newValue

# Check if key exists
if "key" in testsuite:
  pass

# Access annoation by key
value = testsuite["key"]

# Get number of annotations
annotationCount = len(testsuite)

# Delete annotation
del testsuite["key"]

# Iterate annotations
for key, value in testsuite:
   pass

TestsuiteSummary

# Add annotate a key-value pair
testsuiteSummary["key"] = value

# Update existing annotation with new value
testsuiteSummary["key"] = newValue

# Check if key exists
if "key" in testsuiteSummary:
  pass

# Access annoation by key
value = testsuiteSummary["key"]

# Get number of annotations
annotationCount = len(testsuiteSummary)

# Delete annotation
del testsuiteSummary["key"]

# Iterate annotations
for key, value in testsuiteSummary:
   pass

Merging unittest reports

add description here

Testcase

# add code here

Concatenate unittest reports

Todo

Planned feature.

Transforming the reports’ hierarchy

pytest specific transformations

add description here

Testcase

# add code here

Writing unittest reports

A test suite summary can be converted to a document of any JUnit dialect. Internally a deep-copy is created to convert from a hierarchy of the unified test entities to a hierarchy of specific test entities (e.g. JUnit entities).

When the document was created, it can be written to disk.

Any JUnit

from pyEDAA.Reports.Unittesting.JUnit import Document

# Convert a TestsuiteSummary back to a Document
newXmlReport = Path("JUnit-Report.xml")
newDoc = Document.FromTestsuiteSummary(newXmlReport, summary)

# Write to XML file
try:
   newDoc.Write()
except UnittestException as ex:
  ...

Ant + JUnit4

from pyEDAA.Reports.Unittesting.JUnit.AntJUnit import Document

# Convert a TestsuiteSummary back to a Document
newXmlReport = Path("JUnit-Report.xml")
newDoc = Document.FromTestsuiteSummary(newXmlReport, summary)

# Write to XML file
try:
   newDoc.Write()
except UnittestException as ex:
  ...

CTest JUnit

from pyEDAA.Reports.Unittesting.JUnit.CTestJUnit import Document

# Convert a TestsuiteSummary back to a Document
newXmlReport = Path("JUnit-Report.xml")
newDoc = Document.FromTestsuiteSummary(newXmlReport, summary)

# Write to XML file
try:
   newDoc.Write()
except UnittestException as ex:
  ...

GoogleTest JUnit

from pyEDAA.Reports.Unittesting.JUnit.GoogleTestJUnit import Document

# Convert a TestsuiteSummary back to a Document
newXmlReport = Path("JUnit-Report.xml")
newDoc = Document.FromTestsuiteSummary(newXmlReport, summary)

# Write to XML file
try:
   newDoc.Write()
except UnittestException as ex:
  ...

pyTest JUnit

from pyEDAA.Reports.Unittesting.JUnit.PyTestJUnit import Document

# Convert a TestsuiteSummary back to a Document
newXmlReport = Path("JUnit-Report.xml")
newDoc = Document.FromTestsuiteSummary(newXmlReport, summary)

# Write to XML file
try:
   newDoc.Write()
except UnittestException as ex:
  ...