Skip to content
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 110 additions & 0 deletions requirements.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,113 @@ sections:
range of .NET projects, including those targeting .NET Framework and older .NET Core versions.
tests:
- "net481@DemoMethod_ReturnsGreeting_WithDefaultPrefix"

- title: OTS Software
requirements:
- id: Template-OTS-MSTest
title: MSTest shall execute unit tests and report results.
justification: |
MSTest (MSTest.TestFramework and MSTest.TestAdapter) is the unit-testing framework used
by the project. It discovers and runs all test methods and writes TRX result files that
feed into coverage reporting and requirements traceability. Passing tests confirm the
framework is functioning correctly.
tags: [ots]
tests:
- DemoMethod_ReturnsGreeting_WithDefaultPrefix
- DemoMethod_ReturnsGreeting_WithCustomPrefix
- DemoMethod_ThrowsArgumentNullException_ForNullInput
- DemoMethod_ThrowsArgumentException_ForEmptyInput
- Constructor_ThrowsArgumentNullException_ForNullPrefix
- Constructor_ThrowsArgumentException_ForEmptyPrefix
- DemoClass_DefaultPrefix_IsHello
- DemoClass_Prefix_ReturnsCustomPrefix
- DemoClass_DefaultConstructor_SetsDefaultPrefix

- id: Template-OTS-Coverlet
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated
title: Coverlet shall collect code-coverage data during unit-test execution.
justification: |
coverlet.collector integrates with the .NET test host to measure how much of the library
source code is exercised by the test suite. Coverage data is published to SonarCloud and
used to detect untested code paths. Any passing test confirms that coverlet collected
coverage successfully.
tags: [ots]
tests:
- DemoMethod_ReturnsGreeting_WithDefaultPrefix

- id: Template-OTS-ReqStream
title: ReqStream shall enforce that every requirement is linked to passing test evidence.
justification: |
demaconsulting.reqstream processes requirements.yaml and the TRX test-result files to
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated
produce a requirements report, justifications document, and traceability matrix. When
run with --enforce, it exits with a non-zero code if any requirement lacks test evidence,
making unproven requirements a build-breaking condition. A successful pipeline run with
--enforce proves all requirements are covered and that ReqStream is functioning.
tags: [ots]
tests:
- DemoMethod_ReturnsGreeting_WithDefaultPrefix
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated

- id: Template-OTS-BuildMark
title: BuildMark shall generate build-notes documentation from GitHub Actions metadata.
justification: |
demaconsulting.buildmark queries the GitHub API to capture workflow run details and
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated
renders them as a markdown build-notes document included in the release artifacts.
It runs as part of the same CI pipeline that produces the TRX test results, so a
successful pipeline run is evidence that BuildMark executed without error.
tags: [ots]
tests:
- DemoMethod_ReturnsGreeting_WithDefaultPrefix
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated

- id: Template-OTS-VersionMark
title: VersionMark shall capture and publish tool-version information.
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated
justification: |
demaconsulting.versionmark reads version metadata for each dotnet tool used in the
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated
pipeline and writes a versions markdown document included in the release artifacts.
It runs in the same CI pipeline that produces the TRX test results, so a successful
pipeline run is evidence that VersionMark executed without error.
tags: [ots]
tests:
- DemoMethod_ReturnsGreeting_WithDefaultPrefix
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated

- id: Template-OTS-SarifMark
title: SarifMark shall convert CodeQL SARIF results into a markdown report.
justification: |
demaconsulting.sarifmark reads the SARIF output produced by CodeQL code scanning and
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated
renders it as a human-readable markdown document included in the release artifacts.
It runs in the same CI pipeline that produces the TRX test results, so a successful
pipeline run is evidence that SarifMark executed without error.
tags: [ots]
tests:
- DemoMethod_ReturnsGreeting_WithDefaultPrefix
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated

- id: Template-OTS-SonarMark
title: SonarMark shall generate a SonarCloud quality report.
justification: |
demaconsulting.sonarmark retrieves quality-gate and metrics data from SonarCloud and
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated
renders it as a markdown document included in the release artifacts. It runs in the
same CI pipeline that produces the TRX test results, so a successful pipeline run is
evidence that SonarMark executed without error.
tags: [ots]
tests:
- DemoMethod_ReturnsGreeting_WithDefaultPrefix
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated

- id: Template-OTS-PandocTool
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated
title: PandocTool shall convert markdown documentation to HTML.
justification: |
demaconsulting.pandoctool wraps the pandoc document converter and is used to transform
the markdown release documents (requirements report, traceability matrix, etc.) into
styled HTML pages. It runs in the same CI pipeline that produces the TRX test results,
so a successful pipeline run is evidence that PandocTool executed without error.
tags: [ots]
tests:
- DemoMethod_ReturnsGreeting_WithDefaultPrefix

- id: Template-OTS-WeasyPrintTool
title: WeasyPrintTool shall convert HTML documentation to PDF.
justification: |
demaconsulting.weasyprinttool wraps the WeasyPrint renderer and is used to convert the
HTML release documents into PDF artifacts for distribution. It runs in the same CI
pipeline that produces the TRX test results, so a successful pipeline run is evidence
that WeasyPrintTool executed without error.
tags: [ots]
tests:
- DemoMethod_ReturnsGreeting_WithDefaultPrefix