quality-continuous-traceability-monitor

README

Continuous Traceability Monitor (CTM)

Why?

CTM allows you to continuously monitor the health of your product's requirements. Test results often miss a link to the project's requirements so that it's cumbersome to understand which requirement is affected by a broken test.
Adding CTM to e.g. your Continuous Delivery pipeline will give the complete team an always up to date view on the quality status of your project's requirements!
Read also our blog: Don’t monitor the health of your test cases, monitor the health of your product requirements! on the rational of CTM

How?

CTM creates a linkage between your product's requirements, its automated tests and their test results.
The generated reports may help you e.g. provide traceability in respect to the ISO9001 requirement "Identification and traceability".
Further more you may use CTM to store a continuous trace of your automated test results per product requirement in a so called traceability repository. This will grant you a constant insight on your product quality from a requirements point of view.

Requirements

To trace your product's requirements, they have to be maintained in either

• Atlassian JIRA
• GitHub
• Enterprise GitHub

Your automated test results (e.g. provided by your test runner) must be available in

• xunit XML (see XSD Schema)

Installation

Stable release

Please ensure you have a working latest version of go installed.

Get the latest version of CTM via go get

go get github.com/SAP/quality-continuous-traceability-monitor

Getting Started

See our Getting Started Guide, to learn how you can use CTM.

Configuration

Check our CTM Guidebook to learn about the various options you could use CTM to improve your code quality.

How to obtain support

In case of troubles with CTM, please file an issue and we'll try to help you.

Contributing

Read and understand our contribution guidelines before opening a pull request.

Licensing

Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.