Security
Reporting a vulnerability
Section titled “Reporting a vulnerability”Being a test tool, ReqCover is meant to be a pure development tool. It runs inside your test JVM during the build, and its code is not intended to be shipped as part of an actual production system.
Therefore, coordinated disclosure of security vulnerabilities is not required at present. If you find a security vulnerability, please treat it as a bug and report it in the issue tracker. Include the affected module and version, a description of the problem and, if possible, steps or a small project to reproduce it.
If you believe that in your situation the disclosure should happen in private, please contact one of the authors.
The policy is also in SECURITY.md in the repository.
Supported versions
Section titled “Supported versions”Only the latest release receives fixes. ReqCover is pre-1.0; upgrade to the latest version (see Releases) before reporting.
What ReqCover does at runtime
Section titled “What ReqCover does at runtime”ReqCover is a test-time library. It runs inside your test JVM and is not part of the artifact you ship. While your tests run, it:
- Reads files from the test classpath: the requirements specifications listed in
reqCover.requirementsUris, and configuration files such asjunit-platform.propertiesorcucumber.properties. - Writes report files: the HTML and XML reporters create the directory set by
reqCover.reportsDir(defaultbuild/reports/tests/reqcover) and write their reports into it. - May end the test JVM: the JUnit, TestNG and Cucumber listeners call
System.exit(1)(exitProcess(1)in Kotlin) to fail the build when coverage is belowreqCover.minimumRequiredCoveragePercentandreqCover.failIfBelowMinimumistrue(the default), when a requirements file cannot be loaded, and (JUnit only) when the removedreqCover.requirementsUriis set.
Treat requirements specifications like other build inputs: only put trusted files on the test classpath.