Comment on page
Specs & Reqs
Environment prerequisites, plus system specifications and requirements
Diffblue Cover requires that the system environment (hardware, operating system, network connectivity, Java installation) as well as the project environment (build tooling, dependencies, presence of artifacts, existing unit tests) meet the minimum requirements as outlined below. Diffblue Cover will perform an environment check before analysis begins to ensure that the requirements are met.
Cover CLI provides a
--preflight option (see Preflight checks) which can be used to check the status of the prerequisites without performing the project analysis. This option can also be run without a license key.- 16 GB RAM, 5 GB minimum available disk space, 4 CPU cores
- 8GB Java heap allocated
- TCP connection *
- Windows 11 Pro, Windows 10 Enterprise, Ubuntu 18.04, RHEL 7.7, macOS 10.15
- The latest or n-1 64-bit sub-version of Java 8 (8u361 & 8u351), Java 11 (11.0.18 & 11.0.17), Java 17 (17.0.6 & 17.0.5), or Java 21 (21.0.1)
- For Maven projects: Maven version 3.2.5+
- For Ant projects: access to the complete Ant classpath
- JUnit 4.7 - 4.13, JUnit 5.0 - 5.10.0, or TestNG 6.0.1 - 7.8.
- For Java 8 projects: Mockito 1.9.5 - 4.11.0
- For Java 11 projects: Mockito 2.22.0 - 5.4.0
- For Java 17 projects: Mockito 4.1.0 - 5.4.0
- For Java 21 projects: Mockito 4.1.0 - 5.7.0
- All necessary tooling to build the project
- The project must compile and run with no failing unit tests
- Access to a dependency repository to download transient dependencies
- Access to the Diffblue licensing server for remote license check
* Cover requires the use of an analysis service that communicates with Cover Plugin and Cover CLI via TCP connections on localhost. In particular, Cover must be able to start up the analysis service and open a bi-directional TCP connection between the frontend and the service.
- IntelliJ Community or Ultimate version 2023.2 and 2023.1
- One instance of the Diffblue Cover Plugin for IntelliJ, per project
- A minimum of 4GB memory allocated to IntelliJ
Server hosting Cover Reports - Cover Reports Administrator:
- Docker Install - Docker Engine 20.10.17, Docker Compose v2.10.2, and if you're using Docker Hub you'll also need an internet connection.
- Zip Install & Windows Installer - Java JDK 11+ (and available in your PATH system environment variable). For production use, you'll also need to provide a vanilla PostgreSQL 14 database (see Cover Reports > Configuration options).
- Windows Install - Windows Server 2019 and above, Windows 10 and above.
- All - Network connectivity between the server and client workstations.
Client workstation - Cover Reports Contributor:
- Diffblue Cover CLI
- JaCoCo 0.8.3+
- Network connectivity between the user's workstation and the Cover Reports server.
Client workstation - Cover Reports User:
- The latest version of Chrome, Edge, Safari, or Firefox with a screen resolution of 1920 x 1080 or higher.
- Network connectivity between the user's workstation and the Cover Reports server.
Spring and Spring Boot versions are required to be compatible with your version of Java, as well as each other. Diffblue Cover supports the following:
- Java 8 Projects: Spring Boot 1.3.3 to 2.7.x, Spring Core 4.1.1 to 5.3.x
- Java 11 Projects: Spring Boot 2.1.0 to 2.7.x, Spring Core 5.1.0 to 5.3.x
- Java 17 Projects: Spring Boot 2.4.0 to 3.1.x, Spring Core 5.3.1 to 6.0.x
- Java 21 Projects: Spring Boot 2.4.0 to 3.1.x, Spring Core 5.3.1 to 6.0.x
Dependencies required for running tests should be in the project configuration. Additional libraries may also be necessary depending on the project under test.
Dependency | When | Version |
|---|---|---|
Surefire Plugin ( org.apache.maven.plugins:maven-surefire-plugin) | When using Maven and junit-jupiter-engine | 3.0.0-M7 |
JUnit ( junit:junit or org.junit.jupiter:junit-jupiter-engine) | Unless using TestNG, Spring, or Spring Boot | 4.7+ |
JUnit Launcher ( org.junit.platform:junit-platform-launcher) | When using junit-jupiter-engine, unless using Maven, Spring or Spring Boot | 1+ |
TestNG ( org.testng:testng) | Unless using JUnit, Spring, or Spring Boot | 6 or 7 |
Spring Boot Test ( org.springframework:spring-boot-test) | When using Spring Boot ( org.springframework:spring-boot) | 2+, matching version |
Spring Test ( org.springframework:spring-test) | When using Spring ( org.springframework:spring-core) unless using Spring Boot | 4.1.1+, matching version |
Mockito ( org.mockito:mockito-core) | | 4.1.0+ for Java 21 4.1.0+ for Java 17 2.22.0+ for Java 11 1.9.5+ for Java 8 |
Other dependencies listed below may be needed, if they are transitive dependencies of your project. If one of these dependencies is required but missing, tests will be generated for some classes but not others. A message will appear in the console output indicating a missing dependency.
Dependency | Version |
|---|---|
Java Servlet API ( javax.servlet:javax.servlet-api or jakarta.servlet:jakarta.servlet-api) | 4+, matching version |
JSR107 API and SPI ( javax.cache:cache-api) | 0.2+, matching version |
Spring Boot Starter Test ( org.springframework.boot:spring-boot-starter-test) | 2+, matching version |
Spring Security Config ( org.springframework.security:spring-security-config) | 4.2.1+, matching version |
Spring Web MVC ( org.springframework:spring-webmvc) | 5+, matching version |
Either:
- Use the
spring-boot-starter-testdependency to add Hamcrest. - Add
org.hamcrest:hamcrest. The version of Hamcrest needs to match the relevant version ofspring-boot-test. For example, if the user hasspring-boot-test:2.4.6, they should look at the dependency list: Maven Repository: org.springframework.boot spring-boot-starter-test 2.4.6. This shows that the matching version is Hamcrest 2.2 (you may have to scroll).
OS | Cover CLI | Cover Plugin |
|---|---|---|
Windows 11 Pro | ✅ | ✅ |
Windows 10 Enterprise | ✅ | ✅ |
Ubuntu 18.04 | ✅ | ✅ |
RHEL 7.7 | ✅ | ✅ |
macOS 10.15 | ✅ | ✅ |
Cover Plugin for IntelliJ supports the latest and the previous versions of IntelliJ.
IntelliJ | Cover Plugin |
|---|---|
IntelliJ Community 2023.2 | ✅ |
IntelliJ Ultimate 2023.2 | ✅ |
IntelliJ Community 2023.1 | ✅ |
IntelliJ Ultimate 2023.1 | ✅ |
Java Version | Cover CLI | Cover Plugin |
|---|---|---|
Open JDK | ✅ | ✅ |
Oracle JDK 8 (version 161+) | ✅ | ✅ |
Java 8 (8u361 & 8u351) | ✅ | ✅ |
Java 11 (11.0.18 & 11.0.17 - note that Java 11.0.7 is NOT supported) | ✅ | ✅ |
Java 17 (17.0.6 & 17.0.5) | ✅ | ✅ |
Java 21 (21.0.1) | ✅ | ✅ |
Note that only 64 bit versions of Java are supported.
Jakarta | Cover CLI | Cover Plugin |
|---|---|---|
Java EE 8/Jakarta EE 8 Dependency Injection * | ✅ | ✅ |
Jakarta EE 9 Dependency Injection * | ✅ | ✅ |
* Note that Diffblue Cover does not use Jakarta EE application context for tests, all injected dependencies will be mocked.
Spring * | Cover CLI | Cover Plugin |
|---|---|---|
Java 8 Projects: Spring Boot 1.3.3 to 2.7.x, Spring Core 4.1.1 to 5.3.x | ✅ | ✅ |
Java 11 Projects: Spring Boot 2.1.0 to 2.7.x, Spring Core 5.1.0 to 5.3.x | ✅ | ✅ |
Java 17 Projects: Spring Boot 2.4.0 to 3.1.x, Spring Core 5.3.1 to 6.0.x | ✅ | ✅ |
Java 21 Projects: Spring Boot 2.4.0 to 3.1.x, Spring Core 5.3.1 to 6.0.x | ✅ | ✅ |
Spring and Spring Boot versions are required to be compatible with your version of Java, as well as each other.
Text | Cover CLI | Cover Plugin |
|---|---|---|
✅ | ✅ | |
Maven 3.2.5+ | ✅ | ✅ |
Framework | Cover CLI | Cover Plugin |
|---|---|---|
JUnit 4 - 4.7 to 4.13 | ✅ | ✅ |
JUnit Jupiter 5 - 5.0 to 5.10.0 | ✅ | ✅ |
TestNG 6.0.1 to 7.8.0 | ✅ | ✅ |
Diffblue Cover supports JUnit 4, from JUnit 4.7 to JUnit 4.13. In the CLI, you can force the usage of JUnit 4 by passing the
--testing-framework=junit-4 option. In the plugin, you can select JUnit 4 as a testing framework in the settings dialog.Diffblue Cover supports JUnit Jupiter, from JUnit Jupiter 5.0 to JUnit Jupiter 5.10.0. In the CLI, you can force the usage of JUnit 5 by passing the
--testing-framework=junit-5 option. In the plugin, you can select JUnit 5 as a testing framework in the settings dialog.You may need some specific set-up for your build system to work properly with JUnit 5, in particular if you wish to use Diffblue Cover's built-in test validation. See Building a Gradle project or Building a Maven project for details.
Diffblue Cover supports TestNG versions 6 and 7. In the CLI, you can force the usage of TestNG by passing the
--testing-framework=testng option. In the plugin, you can select TestNG as a testing framework in the settings dialog.Framework | Cover CLI | Cover Plugin |
|---|---|---|
Mockito 1.9.5 - 4.11.0 for Java 8 | ✅ | ✅ |
Mockito 2.22.0 - 5.4.0 for Java 11 | ✅ | ✅ |
Mockito 4.1.0 - 5.4.0 for Java 17 | ✅ | ✅ |
Mockito 4.1.0 - 5.7.0 for Java 21 | ✅ | ✅ |
JaCoCo | Cover CLI | Cover Plugin |
|---|---|---|
JaCoCo 0.8.2 + | ✅ | ✅ |
Tool | Cover CLI | Cover Plugin |
|---|---|---|
Externally via JaCoCo, SonarQube etc. | ✅ | ✅ |
Level | Cover CLI | Cover Plugin |
|---|---|---|
Per method | ✅ | ✅ |
Per class | ✅ | ✅ |
Per package * | ✅ | ☑ |
Per module ** | ✅ | ☑ |
Exclude methods from analysis | ✅ | |
* For Cover Plugin, this feature is not available in the Community Edition.
** For Cover Plugin, this feature is only available in the Enterprise Edition.
Database | Docker | Zip |
|---|---|---|
Postgres 14* | Included | Optional |
H2 | | Included |
* For Cover Reports, when using our Docker distribution Postgres 14 is included. When using Zip distribution, H2 is included. However you can provide a self hosted Postgres 14 database for production purposes. We support vanilla Postgres 14. Postgres 15+ versions and alternative distributions can be used at your own risk.
Last modified 8d ago