v0.3.0

Release created on: 25.02.2024 - 00:04:39

New Features

• Unittesting
  • New Read, Write, Parse, Generate methods on JUnitDocument and OsvvmYamlDocument.
    • A document can be created without immediate parsing.
    • A document can be read/analyzed in two steps:
      1. reading the document by the used file format reader (XML, YAML, ...)
      2. parse the structure of the document into the unified testsuite/testcase data model.
    • A document can be written/generated in two steps:
      1. generate the file format specific representation (XML, YAML, ...)
      2. write the content into a file.
  • New @ operator in TestcaseStatus to merge status values.
  • New iterator methods to iterate testsuites, testcases and both:
    • Iterate
    • IterateTestsuites
    • IterateTestcases
  • New properties for Testcase, Testsuite and TestsuiteSummary:
    • StartTime
    • SetupDuration
    • TeardownDuration
    • TotalDuration
    • WarningCount
    • ErrorCount
    • FatalCount
  • New dictionary access methods for all classes to attach arbitrary key-value pairs.
  • New properties for Testsuite and TestsuiteSummary:
    • TestDuration
    • AssertionCount
    • FailedAssertionCount
    • PassedAssertionCount
    • Excluded
    • Skipped
    • Errored
    • Failed
  • New method to convert to a pyTooling tree:
  • New Document class.
  • Merge unit test summary data models (and data files from XML).
    • New Merged and Combined mixin-classes.
    • New MergedTestcase, MergedTestsuite and MergedTestsuiteSummary classes.

Changes

• Unified generic unit test data model and junit data model into a single data model.
  • Updated OSVVM YAML reader.
• Renamed TestcaseState to TestcaseStatus and all related fields and properties (State → Status).
• New flag members in TestcaseStatus.

Bug Fixes

None

Documentation

None

Unit Tests

• Added tests for DocStr_Coverage to check undocumented, partially documented and fully documented Python code examples.
• Added 32 unit test summary files for unit test merge operations.
• New testcases for unit test merging.

---

Related PRs:

None

v0.2.0

Release created on: 22.02.2024 - 12:35:43

New Features

• Rudimentary data model for documentation coverage.
• Added Python documentation coverage model.

Changes

None

Bug Fixes

None

Documentation

None

Tests

• Added basic tests for documentation coverage.

v0.1.0

Release created on: 22.02.2024 - 00:09:29

New Features

• Implemented new exception hierarchy.
• Generic data model for unittest results.
• Parsing junit test summary files.
• A reader for OSVVM's test report summary files (YML files)
• Added unit tests for the unit test model and the JUnit parser.

Changes

• Updated dependabot settings.
• Updated PR template.
• Updated pipeline description.
• Updated dependencies.
• Updated pyproject.toml.
• Updated setup.py.
• Added example XML and YAML files for unit tests.

Documentation

• Removed duplicate license file.
• Updated documentation:
  • Reworked installation instructions.
  • Added glossary.
  • Added ToDo list.
• Updated documentation template and override CSS.
• Updated autoapi templates.
• Updated prolog file.
• Using sphinx-designs and sphinx-reports extensions.

Other

• Old OSVB code will be provided on a separate branch.
  See https://github.com/edaa-org/pyEDAA.Reports/tree/from-OSVB

Bug Fixes

None

---

Related PRs:

• #6
• #10