Universal traceability validation and rollup for requirements-to-tests mapping.
Project description
Traceability Tooling
Universal traceability validation and rollup for requirements ↔ tests mapping. Designed to work across monorepos and git submodules.
Install
pip install tracetree
Quick Start
From a repo root with docs/traceability/:
tracetree init
tracetree validate
tracetree link
tracetree aggregate
Expected Structure (Defaults)
docs/traceability/requirements.mddocs/traceability/risk_controls.mddocs/traceability/traceability_matrix.csvdocs/traceability/soup_inventory.mddocs/traceability/iec62304_mapping.csvdocs/traceability/verification_plan.md
If you do not already have these files, run:
tracetree init
Generated reports (default):
docs/traceability/generated/traceability_report.mddocs/traceability/generated/traceability_report.jsondocs/traceability/generated/testid_links.mddocs/traceability/generated/testid_links.jsondocs/traceability/generated/aggregate/traceability_rollup.mddocs/traceability/generated/aggregate/traceability_rollup.jsondocs/traceability/generated/iec62304_traceability_table.md
Test discovery defaults:
- GTest:
tests/,test/ - Pytest:
tests/,test/ - JS/TS (Jest/Mocha/Vitest):
tests/,test/,__tests__/,spec/ - Rust (
#[test]):tests/,test/,src/
TestID matching:
- GTest:
SuiteName.TestName - Pytest:
test_function_name - JS/TS: string in
test("name", ...)orit("name", ...) - Rust: function name following
#[test]
IEC 62304 mapping file format (iec62304_mapping.csv):
RequirementID,SoftwareItem,IntegrationSystemTest,Evidence
REQ-EXAMPLE-1,Example Module,verify_reliability.py,Test logs
Repo Configuration
Create .traceability/config.json to override defaults:
{
"traceability_dir": "docs/traceability",
"traceability_output_dir": "docs/traceability/generated",
"requirements_file": "requirements.md",
"risk_controls_file": "risk_controls.md",
"matrix_file": "traceability_matrix.csv",
"iec62304_mapping_file": "iec62304_mapping.csv",
"gtest_roots": ["tests"],
"pytest_roots": ["bindings/python/tests"],
"js_roots": ["packages/web/tests"],
"rust_roots": ["crates/core/tests", "crates/core/src"]
}
You can also point to a custom config with TRACEABILITY_CONFIG=/path/to/config.json.
Coverage Threshold
Default is 100%. Override with:
TRACEABILITY_REQ_COVERAGE=0.95 tracetree validate
Submodule Rollup
tracetree aggregate reads .gitmodules and validates each submodule that contains
traceability files. Results are written to:
docs/traceability/generated/aggregate/traceability_rollup.md.
Combined source + generated files are copied to:
docs/traceability/generated/aggregate/combined/.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tracetree-0.1.7.tar.gz.
File metadata
- Download URL: tracetree-0.1.7.tar.gz
- Upload date:
- Size: 10.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30b6efdd23a6ba9acb084855482f4b3eb4d4ec8a63a32b02ee5e97a5dc343936
|
|
| MD5 |
344eef7cdb97a7525805f9abff14a1e3
|
|
| BLAKE2b-256 |
e8baf45d3360a8dad18d2cabfcff3cb323f7da5901c8cb11ab67622383de49ea
|
File details
Details for the file tracetree-0.1.7-py3-none-any.whl.
File metadata
- Download URL: tracetree-0.1.7-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f931b2ed32482e8f6236afa78ef478a8b863d66f05e1405c810e550029478f65
|
|
| MD5 |
e762b190ab1b81c5ba39d7cb8365076a
|
|
| BLAKE2b-256 |
bd9f900cd105fbaf06b7cc0f7c017fd05f07c6b666a168220323498ab1e302a2
|