Installing and Updating Cover Reports
How to install, start, stop, and update Diffblue Cover Reports
Please ensure that the server on which Diffblue Cover Reports is deployed can be accessed via the Diffblue Cover CLI on port 8080. This default port can be adjusted by following the instructions below.
1. Using the link provided by Diffblue, download the Cover Reports
.tar.gz bundle e.g. diffblue-cover-reports-2023.02.01.tar.gz2. From the directory containing the Cover Reports
.tar.gz bundle, load the Docker bundle using the command:docker load -i /path/diffblue-cover-reports-<version>.tar.gz
3. In your shell, navigate to the directory where the installation is to be made; referred to throughout this guide as
$COVER_REPORTS_HOME. This will be the home directory of Cover Reports e.g.:cd $COVER_REPORTS_HOME
4. Using the link provided by Diffblue, download the Cover Reports Docker Compose file
docker-compose.yml into $COVER_REPORTS_HOME5. From the
$COVER_REPORTS_HOME directory, start Cover Reports using:docker compose up -d
Cover Reports is also available via the authenticated Diffblue Docker Hub repository.
1. To access the repository please sign up to Docker Hub and provide Diffblue Support with your username. Diffblue Support will grant access according to your subscription terms.
2. In your shell, log in to Docker Hub using the
docker login command with either your username and password or username and Docker Hub Access Token e.g.:docker login -u <username>
Then either type your password or paste your access token
3. In your shell, navigate to the directory where the installation is to be made; referred to throughout this guide as
$COVER_REPORTS_HOME. This will be the home directory of Cover Reports e.g.:cd $COVER_REPORTS_HOME
4. Using the link provided by Diffblue, download the Cover Reports Docker Compose file
docker-compose.yml into $COVER_REPORTS_HOME5. From the
$COVER_REPORTS_HOME directory, start Cover Reports using:docker compose up -d
Cover Reports is now deployed and running; once the application has completed loading, you can open Cover Reports using a locally accessible URL e.g.
http://localhost:8080/
An example project is included with Cover Reports as part of the installation, to help users get started quickly. Click on the Open Demo Project button.
1. In your shell on the Cover Reports server, navigate to the directory
$COVER_REPORTS_HOME where the existing installation is made:cd $COVER_REPORTS_HOME
2. From the
$COVER_REPORTS_HOME directory, stop Cover Reports using:docker compose down
Cover Reports can collect usage telemetry from Cover CLI and Cover Plugin installations to give you vital information on usage across your organization. To configure telemetry:
- 1.Telemetry endpoints are configured using the
telemetry.propertiesfile in your Cover CLI and Cover Plugin installations. Edit/add the following section:
#Named section 'reports'
name[reports]=Cover Reports
backend[reports]=cover-reports
api_url[reports]=http://cover-reports.mycompany.com:8080/telemetry/event
Field | Description |
|---|---|
name | Useful name. |
backend | Data endpoint type, set to cover-reports |
api_url | Endpoint URL to send data to. Set to the /telemetry/event path using the IP address or URL of your Cover Reports instance. For example, http://cover-reports.mycompany:8080/telemetry/event |
- 2.Navigate to your Cover Reports telemetry home page, e.g.
http://cover-reports.company.com:8080/dashboards - 3.From the list shown, select either the Telemetry CLI dashboard for CLI events, or the Telemetry Intellij Plugin dashboard for plugin events:
Updating Cover Reports may take some time to complete. During this time you won't be able to upload new reports bundles and the Reports URL won't be accessible.
On your Cover Reports server:
- 1.Stop Cover Reports by running:
docker compose down - 2.In your shell, navigate to the
$COVER_REPORTS_HOMEdirectory where the existing installation is located and make a copy (backup) of the directory. - 3.Rename the
docker-compose.ymlfile in the$COVER_REPORTS_HOMEdirectory - e.g.docker-compose-2023.08.13.yml - 4.Using the link provided by Diffblue, download Cover Reports: - For Cover Reports Docker Compose, download the
docker-compose.ymlfile to the$COVER_REPORTS_HOMEdirectory. - For Cover Reports.tar.gz, download the latest Cover Reports bundle (e.g.diffblue-cover-reports-2023.08.01.tar.gz) and load the Docker bundle:docker load -i /path/diffblue-cover-reports-<version>.tar.gz - 5.Start the new version of Cover Reports using the command:
docker compose up -d
The port used by both Cover CLI and the user's browser to communicate with Cover Reports can be adjusted in
docker-compose.yml. To change the port:1. In your shell, navigate to the directory
$COVER_REPORTS_HOME where the existing installation is made:cd $COVER_REPORTS_HOME
2. From the
$COVER_REPORTS_HOME directory, stop Cover Reports using:docker compose down
3. Using a text editor, change
port key. Note the value specified is in the format <external-port>:<internal-port>; the internal port must not be changed e.g. changing the port from default 8080 to 9090 would involve changing:```shell
ports:
- "8080:8080"
```
to
```shell
ports:
- "9090:8080"
```
5. From the
$COVER_REPORTS_HOME directory, start Cover Reports using:docker compose up -d
Last modified 12d ago