Upgrading
This page lists what to change in your build when you upgrade ReqCover; for the full change list see Releases.
From 0.0.11 to 0.0.12
Section titled “From 0.0.11 to 0.0.12”Update the version of all ReqCover dependencies to 0.0.12. Then check:
- Coverage settings:
reqCover.minimumRequiredCoveragePercentmust be a number from 0 to 100 andreqCover.failIfBelowMinimummust betrueorfalse. A value such as100%oryesused to be accepted silently; it now fails the build with anInvalid valueerror. Fix the value. - JUnit 5: works again; you can stay on JUnit 5.
- XML report readers: the
coverageattribute always uses a dot now (50.0), also on machines with a German or similar locale.
From 0.0.10 to 0.0.11
Section titled “From 0.0.10 to 0.0.11”No breaking changes. Update the version of all ReqCover dependencies to 0.0.11.
Optional:
-
Maven users: set
reqCover.reportsDirso the reports go totarget/instead ofbuild/:<systemPropertyVariables><reqCover.reportsDir>${project.build.directory}/reqcover</reqCover.reportsDir></systemPropertyVariables> -
Cucumber users: add
reqcover-engine-cucumber(Maven:reqcover-engine-cucumber-jvm) and register the plugin. See the Cucumber guide. -
Reporter authors: override
report(tracker, reportsDirectory)to honourreqCover.reportsDir. Existing reporters keep working unchanged.
From 0.0.9 to 0.0.10
Section titled “From 0.0.9 to 0.0.10”1. Rename the JUnit module
Section titled “1. Rename the JUnit module”| 0.0.9 | 0.0.10 |
|---|---|
dev.reqcover:reqcover-junit-jupiter |
dev.reqcover:reqcover-engine-junit-jupiter |
Maven: reqcover-junit-jupiter-jvm |
Maven: reqcover-engine-junit-jupiter-jvm |
dependencies { testImplementation("dev.reqcover:reqcover-engine-junit-jupiter:0.0.10")}<dependency> <groupId>dev.reqcover</groupId> <artifactId>reqcover-engine-junit-jupiter-jvm</artifactId> <version>0.0.10</version> <scope>test</scope></dependency>2. Replace reqCover.requirementsUri
Section titled “2. Replace reqCover.requirementsUri”The singular setting is removed. Rename it to reqCover.requirementsUris (plural); the value can stay as it is.
reqCover.requirementsUris=requirements.yamlIf the old key is still set, a JUnit build fails with The reqCover.requirementsUri configuration parameter has been removed. Use reqCover.requirementsUris instead. TestNG and Cucumber ignore the old key, so it no longer has any effect there.
3. Check system properties
Section titled “3. Check system properties”JVM system properties now also win over JUnit configuration parameters passed to the launcher, for example Gradle configurationParameter(...) or Surefire configurationParameters (they already won over junit-platform.properties). If you set a reqCover.* key in both places, the system property is used. See Precedence.
4. Fix broken requirements files
Section titled “4. Fix broken requirements files”A requirements file that is missing, malformed or not in a supported format now fails the build. In 0.0.9 such a run could pass with 100% coverage. If the build fails after the upgrade, check the paths in reqCover.requirementsUris; see Troubleshooting.
5. On JUnit 5, go straight to 0.0.12
Section titled “5. On JUnit 5, go straight to 0.0.12”ReqCover 0.0.10 and 0.0.11 forced JUnit Platform 6 on projects, so on JUnit 5 test discovery failed with DiscoveryIssueException. From 0.0.12 on, your project’s own JUnit 5 or 6 is used; upgrade to 0.0.12 or later instead of 0.0.10 or 0.0.11.
6. Expect lower, correct coverage
Section titled “6. Expect lower, correct coverage”Parameterized, repeated and @TestFactory tests now cover their requirement only if at least one run passes, and parallel runs no longer lose requirements. Coverage can drop where it was overstated before.