v0.14.2

Release created on: 09.11.2024 - 22:17:24

Changes

• Bumped dependencies.

v0.14.1

Release created on: 03.11.2024 - 17:05:30

New Features

None

Changes

• Bumped dependencies.
• Use @InheritDocString from pyTooling.

Bug Fixes

None

Documentation

• Prepared more glossary items.

Unit Tests

• Added application tests for outputs generated by jobs running on GitHub Actions.

v0.14.0

Release created on: 13.10.2024 - 22:36:56

Disabled unit test result merging and publishing in release pipeline due to cyclic dependency and a broken pyEDAA.Reports CLI tool due to a bug in this package.

New Features

• pyedaa-reports: Write other dialects then Ant+JUnit4 (CTest, GoogleTest, pyTest).

Changes

• Reduced duplicate code, which had been introduced due to JUnit dialects.

Bug Fixes

None

Documentation

• Use Sphinx 8.1+

Unit Tests

• Added example files from pyGHDL for merge and split testing.

v0.13.1

Release created on: 13.10.2024 - 13:11:24

Disabled documentation creation in release pipeline due to cyclic dependency and a broken sphinx_reports due to a bug in this package.

Changes

• Bumped dependencies.

Bug Fixes

• Package XSD files in wheel (was missing due to a directory renaming).

Unit Tests

• Prepare for application testing

v0.13.0

Release created on: 12.10.2024 - 17:28:33

New Features

• Added keyValuePairs parameter to initializers of the unified test entity classes.

Changes

• Bumped dependencies.
• Renamed pyEDAA.Reports.Unittesting.JUnit.AntJUnit to pyEDAA.Reports.Unittesting.JUnit.AntJUnit4
• Renamed parameter parse top analyzeAndConvert.
• Renamed Document.Read() to Document.Analyze().
• Renamed Document.Parse() to Document.Convert().
• Using a new decorator @InheritDocumentation().
• Removed duplicated code, which was introduced when JUnit was split into dialects.
• Added more checks and raise exceptions on wrong input parameters to the data models.
• Changed some ValueErrors to AlreadyInHierarchyException.

Bug Fixes

• Raise errors on empty names.
• Added more checks to the parent reference.
• Catch exception on path.open().
• Fixed writing of dialects, previously, each dialect generated the pyTest dialect.

Documentation

• Restructured documentation.
• Removed "work in progress" from landing page.
• Added many many doc-strings and pushed documentation coverage to a higher level.
• Added more documentation pages and content.
  • Documented unified test entity data model.
  • Documented JUnit data model.
  • Documented JUnit dialects.
  • Documented test summary usages (unified and JUnit).
  • Documented dialect conversions.
  • Prepared for OSVVM data model (test summary)
• Added texts to describe code coverage.
• Added texts to describe documentation coverage.
• Prepared for EDA tool outputs.
• Fixed CSS issues and added some improvements.
• Use default color levels for reports.
• Disabled sd_fontawesome_latex.
• Moved old content created by @umarcor, this needs to be checked and maybe redistributed.

Unit Tests

• Improved how junit JAR files are found by Ant. See #71 by @skoehler.
• Added pyTest parameter --tb=native.
• Added roundtrip tests on dialects files: read, write, read, compare.

---

Related Issues and Pull-Requests

• #71

v0.12.1

Release created on: 28.09.2024 - 18:34:42

New Features

• Added (first) CLI documentation.
• pyedaa-reports unittest
  • New CLI option --input to read a JUnit XML file.
  • Option --merge:
    • New dialect Any-JUnit to read JUnit XML files using a generic XML dialect and relaxed XML schema.
  • Option --pytest:
    • New rewrite option split to split a testsuite into multiple testsuites.

Changes

• Bumped dependencies.

Bug Fixes

• Fixed type hints for tuples.

Documentation

• Added more doc-strings.

Test cases

• Updated YAML files from OSVVM to newer (fixed) output formats.

---

Related PRs:

• #64

v0.11.0

Release created on: 23.06.2024 - 22:23:46

New Features

• pytest-junit: Support multiple system-out and system-err tags for the pytest JUnit XML dialect.
• generic-junit: Support properties on root element testsuites.

Changes

• Fetch GoogleTest into the lib directory via CMake.
• Name used XSD schema in case of a validation fault.
• Bumped dependencies.
• Fixed typos.

Bug Fixes

• Fixed Ant/JUnit4 execution and build in Java example project: Upgraded dependency Gradle to v8.8.

---

Related PRs:

• #42 (by @navidcity)

v0.10.0

Release created on: 03.06.2024 - 23:05:37

New Features

• Post-processing for pytest: rewrite __init__ in classnames.
• Safer parsing of YAML contents and improved error messages.

Changes

• Bumped dependencies.
• Code refactoring in _merge.

Bug Fixes

• Fixed assertionCount vs. passedAssertionCount.

Documentation

• Added some first documentation paragraphs for unittesting.

v0.9.0

Release created on: 02.06.2024 - 08:29:02

New Features

• Reworked command line interface:
  • Main command unittest

    pyedaa-reports unittest
      -v
      --merge=PyTest-JUnit:tests/data/JUnit/pytest.pyTooling/*-UnitTestReportSummary*.xml
      --pytest=pytest.tests.unit;pytest.tests.benchmark;pytest.tests.performance
      --render=tree
      --output=Ant-JUnit:tests/output/merge/UnitTestReportSummary-Merged.xml
    

    • Use argument --name to set a name for the merged testsuite summary.
    • Use argument --merge to specify a unittest report source for merging.
      • Specify the format and dialect (e.g. "ant-junit") as prefix with a colon: --merge=ant-junit:data/*.xml
    • Use argument --pytest to specify pytest specific cleanup and restructuring instructions.
    • Use argument --render to output the result as an ASCII art rendering.
    • Use argument --output to specify the output format, dialect and filename.
• Added GitHub Action pipeline jobs to create example projects producing example JUnit-like report files in XML format.
• Added example files for different JUnit-like frameworks with various dialects.
  • Currently implemented dialects: ant-junit, ctest-junit, gtest-junit, pytest-junit.
• Postprocessing for pytest:
  • Rewrite __init__ in class names to proper package names.
  • Reduce depth of testsuite in testsuite structure.
• Rendering:
  • Render testsuites and testcases as a tree (if verbose mode is active).
• Support a dialect and filename for the output after merge operations.
  • Currently implemented dialects: ant-junit (other need a XML writer)
• Allow setting a title to the merged TestsuiteSummary.
• Parse OSVVMs AlertLogs from YAML file.
  • A new data model for AlertLogGroups and Documents.
• Python 3.11+: Added notes to exceptions, especially when a TypeError is raised.

Changes

• Bumped dependencies.
• Split JUnit schema files into multiple dialects.
• Split JUnit classes into multiple dialects.

Bug Fixes

• Raise a ValueError when a parameter is None, but not TypeError.
• Specify the encoding when reading or writing files.

---

Related PRs:

• #33 (@skoehler)
• #34
• #36 (@navidcity)

v0.8.0

Release created on: 06.05.2024 - 20:04:26

New Features

• Added property TestDuration also to Testsuites and TestsuiteSummary.
• Check setup, test and teardown durations.
• Aggregate total durations.

Changes

None

Bug Fixes

None