pyEDAA.OSVVM 0.5.0

Parser and converters for OSVVM-specific data models and report formats.

Main Goals

This package provides OSVVM-specific data models and parsers. The data models can be used as-is or converted to generic data models of the pyEDAA data model family. This includes parsing OSVVM's *.pro-files and translating them to a pyEDAA.ProjectModel instance as well as reading OSVVM's reports in YAML format like test results, alerts or functional coverage.

Frameworks consuming these data models can build higher level features and services on top of these models, while using one parser that's aligned with OSVVM's data formats.

Data Models

Project Description via *.pro-Files

Features:

• Parse OSVVM's *.pro files including complex TCL code structures like nested if-statements.
• Emulate tool specific TCL variables: ::osvvm::ToolVendor, ::osvvm::ToolName ::osvvm::ToolNameVersion, ...
• Convert the project description stored in one or more *.pro files to a pyEDAA.ProjectModel instance.

Basic Data Model:

• VHDL source files are accumulated in VHDL libraries.
• The order of source files is preserved in a library.
• Test cases are accumulated in test suites.
• Configuration changes are collected in a context.
  • When a new item is added to the model, certain default values or collected configuration values are used to create this new item.

Quick Example

from pathlib import Path
from pyEDAA.OSVVM.Project.TCL import OsvvmProFileProcessor

processor = OsvvmProFileProcessor()
processor.LoadBuildFile(Path("OSVVM/OSVVMLibraries/OsvvmLibraries.pro"))
processor.LoadBuildFile(Path("OSVVM/OSVVMLibraries/RunAllTests.pro"))

project = processor.Context.ToProject("OsvvmLibraries")
for buildName, build in project.Builds.items():
  for libraryName, lib in build.Libraries.items():
    for file in lib.Files:
      ...

  for testsuiteName, ts in build.Testsuites.items():
    for tc in ts.Testcases.values():
      ...

Testsuite Summary Reports

[!NOTE]
TBD

YAML Report (more details)

from pathlib import Path
from pyEDAA.OSVVM.TestsuiteSummary import BuildSummaryDocument

yamlPath = Path("OSVVMLibraries_RunAllTests.yml")
doc = BuildSummaryDocument(yamlPath, analyzeAndConvert=True)

XML Report (Ant+JUnit format - less details)

from pathlib import Path
from pyEDAA.Reports.Unittesting.JUnit import Document as JUnitDocument

junitExampleFile = Path("OSVVMLibraries_RunAllTests.xml")
doc = JUnitDocument(junitExampleFile, analyzeAndConvert=True)

Testcase Summary Reports

[!NOTE]
TBD

Alert and Log Reports

[!NOTE]
TBD

from pathlib import Path
from pyEDAA.OSVVM.AlertLog import Document as AlertLogDocument

path = Path("TbAxi4_BasicReadWrite_alerts.yml")
doc = AlertLogDocument(path, analyzeAndConvert=True)

print(f"{doc.Name}: {doc.AlertCountWarnings}/{doc.AlertCountErrors}/{doc.AlertCountFailures}")
for item in doc:
	print(f"  {item.Name:<19}: {item.AlertCountWarnings}/{item.AlertCountErrors}/{item.AlertCountFailures}")
print(f"Total errors: {doc.TotalErrors}")

Scoreboard Reports

[!NOTE]
TBD

Functional Coverage Reports

[!NOTE]
TBD

Requirement Reports

[!NOTE]
TBD

Use Cases

• Reading OSVVM's project description from *.pro files.
  • Convert to other data or file format.
• Reading OSVVM's reports from *.yaml files.
  • Convert to other data or file format.
  • Investigate reports.
  • Merge reports.

Examples

from pathlib import Path
from pyEDAA.OSVVM.Project.TCL import OsvvmProFileProcessor

def main() -> None:
  processor = OsvvmProFileProcessor()

  processor.LoadProFile(Path("OSVVM/OSVVMLibraries/OsvvmLibraries.pro"))
  processor.LoadProFile(Path("OSVVM/OSVVMLibraries/RunAllTests.pro"))

  for libraryName, lib in processor.Context.Libraries.items():
    print(f"Library: {libraryName} ({len(lib.Files)})")
    for file in lib.Files:
      print(f"  {file.Path}")

  print()
  for testsuiteName, ts in processor.Context.Testsuites.items():
    print(f"Testsuite: {testsuiteName} ({len(ts.Testcases)})")
    for tc in ts.Testcases.values():
      print(f"  {tc.Name}")

Consumers

References

• OSVVM/OSVVM-Scripts

Contributors

• Patrick Lehmann (Maintainer)
• and more...

License

This Python package (source code) licensed under Apache License 2.0.
The accompanying documentation is licensed under Creative Commons - Attribution 4.0 (CC-BY 4.0).

---

SPDX-License-Identifier: Apache-2.0