eclipse-score / eclipse-score/docs-as-code

Add generic module verification and inspection needs to metamodel

Open
#611 2 comments 0 reactions 1 assignee Claimed by @FScholPer View on GitHub
Dominant language
Python
Stars
10
Forks
32
Avg merge
23h 52m
Merged PRs (30d)
52

Description

## Summary
Add metamodel support for module-level verification reporting and formal inspection evidence in a way that is generic, scalable, and aligned with S-CORE verification/review concepts.

## Background
Current metamodel support is strong for requirement/test traceability (`testcase -> fully_verifies/partially_verifies`), but module-level verification reporting and checklist-based inspection evidence are not modeled as first-class, flexible needs.

The process expects Module Verification Reports to aggregate heterogeneous evidence (tests, analyses, inspections, coverage, logs/results, qualification evidence), and inspections may use different checklist families (requirements, architecture, implementation, etc.).

## Scope
Introduce and integrate:
- `mod_ver_report` as a module-level verification aggregation need.
- `mod_insp` as a formal inspection evidence need.
- Extra link types to support broad evidence linkage (`evidence`) and inspection scope (`inspects`).
- Generic linking behavior so reports/inspections can reference many relevant need types (not only a narrow fixed subset).

## Requirements
- Keep existing direct testcase-to-requirement verification links unchanged.
- Allow `mod_ver_report` to aggregate evidence for:
- requirement coverage
- architecture/detailed design verification
- DFA/safety/security analysis evidence
- test results and retained logs
- static analysis and structural coverage evidence
- component qualification verification evidence
- Allow `mod_insp` to reference multiple checklist/evidence artifact flavors (req/arc/impl/custom).
- Keep compatibility with existing status patterns and avoid global schema churn.

## Acceptance Criteria
- Metamodel contains `mod_ver_report` and `mod_insp` definitions with required metadata and links.
- `mod_ver_report` can link to heterogeneous evidence using generic relations (e.g. `contains`, `evidence`, `covers`).
- `mod_insp` can link to arbitrary inspected artifacts and checklist evidence.
- `needs_extra_links` includes required link types for evidence and inspection.
- No metamodel parsing/lint errors.

## Follow-ups (optional but recommended)
- Add graph checks for ASIL-specific verification evidence completeness.
- Add doc examples showing how to populate `mod_ver_report` and `mod_insp` with real module artifacts.
- Align templates/how-to pages with the new needs.

** Co-created by github copilot

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.