JavaRequirementsTracer

THE tool for monitoring traceability between requirements and Java code.

Intro

Ever needed to quantify the amount of requirements you implemented for an application? Or to quantify the amount of requirements covered in your tests? Or needed to produce a traceability matrix from requirements to the code and vice versa? Doing all that manually can be quite cumbersome. With JavaRequirementsTracer (JRT) it is a piece of cake. Simply annotate your code with requirements labels and all of the above is taken care of by JavaRequirementsTracer.

JavaRequirementsTracer easily generates a report on your project using the annotations showing all of the info required. It can be run through a Maven plugin (recommended), as a standalone Java program, or through a Unit Test (which is probably the simplest way of running it). For more details see the JavaDoc of the Requirements annotation.

See also:

• JavaRequirementsTracer project page.
• Example reports: Main code, System Test code.
• Example property files: Requirements Labels, Main code parameters, System Test code parameters.
  NB. Main and System Test code must have separate parameters files but should have a shared labels file.
• In case your project decomposes into multiple subprojects (aka. modules, subsystems) you must have separate labels and parameters files per (group of) subproject(s) in order to be able to achieve 100% code coverage and 100% requirements coverage. You can then use ReportAggregator to create an overview report of all your main code subreports. Idem for all your system test code subreports. It is configured through yet another parameters property file.
  Example overview reports: Main code, System Test code.
  Example overview property files: Main code parameters, System Test code parameters.
• README.txt: How to use JavaRequirementsTracer Quick Start (also included in the sources.zip distro file).
• Maven repo at Maven Central, Maven repo at SourceForge (see README.txt referenced above).
• JRT Maven Plugin documentation (see README.txt referenced above).
• Tutorial: In the Java Magazine of May 2010 a Dutch language article was published on JavaRequirementsTracer. It can be used as a tutorial.
• Download JavaRequirementsTracer (for non-Maven users).
• Release Notes.

History

JavaRequirementsTracer was developed by Ronald Koster while working at several software development projects by Logica from 2006 to 2009. Logica donated JavaRequirementsTracer to the open source community in September 2009. Part of the idea of tracing requirements in this way came from Wen Hu and Frank Reerink.