Quick Start - General
Overview
This guide explains how to use Diffblue Cover to write tests for your project as part of a CI pipeline. It outlines the basic commands that you will need to add to your CI scripts. We also have dedicated quick start guides for the most common CI tools, such as GitHub Actions or Jenkins.
This guide assumes that you have:
A Maven or Gradle project that:
Compiles
Does not have non-compiling or failing tests
Is stored in a Git repository with any CI tool enabled
A basic understanding of your chosen CI tool
The ability to store secrets variables for your CI tool.
Diffblue Cover stored in the cloud for download along with the license key. See Installation.
To integrate Diffblue Cover into your CI pipeline, we will guide you through creating a CI script that:
Builds your project
Downloads and activates Diffblue Cover CLI
Runs Diffblue Cover to create tests
Commits the created tests to a branch
The following sections provide more details for each of the above steps.
1. Building the project
To run Diffblue Cover CLI your project must be built. Running the project’s tests is not required, and you will save time by skipping them, but they do need to compile and pass.
For example, you can use the following command to build a Maven project while skipping the tests:
2. Downloading and activating Diffblue Cover CLI
You need to give the CI run access to the Diffblue Cover files and activate the dcover
license in order to write tests.
This guide assumes that you have a URL with the Diffblue Cover CLI release zip and the license key for online activation during the CI run. See Installation. If your license allows it you may wish to install Diffblue Cover with offline activation. See Licensing.
You will need to add two secret variables which, here, will be represented as environment variables: the first secret variable with the name DIFFBLUE_COVER_URL
and the value set to the URL of the Diffblue Cover CLI release zip file; the second with the name DIFFBLUE_COVER_LICENSE_KEY
, and the value set to your Diffblue Cover license key.
Append the code for getting, unzipping and activating dcover
to your script.
This will put the Diffblue Cover files into the dcover
directory in the root of the workspace. The files contain a script called dcover
which has the relative path dcover/dcover
(or dcover\dcover.bat
in Windows environments). The script is added to your PATH
variable so that you can invoke Diffblue Cover CLI as dcover
(or dcover.bat
).
Push the changes so that your CI is triggered - ensure that you can see the successful activation of dcover
in your CI output before moving on. You will see a line starting with "Successfully activated key" if this was successful. If your Diffblue Cover did not successfully activate, please see Licensing or contact Diffblue Support.
3. Running Diffblue Cover CLI to create tests
Now that Diffblue Cover is running in CI, you can use it to write tests. Append the following to your workflow file. Note that the --batch
option makes the output more suitable for CI, as it ensures the CI logs are not cluttered with progress bar output.
Push the changes so that CI runs. Once successfully complete, you should expect to see output that looks like this:
If you don't see this output, the call may need small modification for your project or dependencies adding until it works. The output gives you warnings along the way to guide you. See CLI Commands for more information.
Depending on the size of your module/project, creating tests could take a while. You may wish to restrict test creation to a single class by specifying its fully qualified name:
4. Committing the created tests to a branch
To see the new tests created in the previous step in your project you need to commit them and push back to the repository. Depending on your CI tool you may also need to configure a git user to create the commit. We recommend creating a service account for this.
To commit the tests append the following to your script. This will check for any changes to Diffblue tests, add them to a commit and push to your branch.
Please note - be careful not to create an infinite CI loop here. We recommend checking the author of each commit to ensure you are not creating tests for a commit authored by your Diffblue service account.
Last updated