Environment Configuration

The environment where Cover is run can be configured in several ways:

  • Setting Environment variables

  • Setting properties in Java Properties files

Predominantly, environment variables are used, but some of these properties can also be set in a Java Properties file called cover.properties.

cover.properties

To use cover.properties a new file called cover.properties must be created in the .diffblue folder in the user home directory.

Properties are added as a name/value pair separated with an =

For example:

cover.reports.upload.url=http://example.com

Properties will be read when Cover starts its JVM and cached for future use. When using Cover Plugin, the JVM is the same as Intellij. Therefore, when changing properties, Intellij must be restarted to reflect the change.

Setting environment variables

All the properties that can be set in cover.properties can also be set as environment variables. The name of the environment variable is the same as the property name except:

  • All the letters are capitalised

  • The . separators are replaced with underscores

  • A prefix of DIFFBLUE_ is added to disambiguate Diffblue variables on host systems with many variables

For example:

cover.reports.upload.url can be set in an environment variable as DIFFBLUE_COVER_REPORTS_UPLOAD_URL

Environment variables have a higher precedence that properties set in cover.properties. Therefore, if the same variable is set in both places, the value from the environment variable will be used.

Available properties

The properties that can be set in cover.properties are:

NameEnvironment variable namePurposeExample use

cover.reports.username

DIFFBLUE_COVER_REPORTS_USERNAME

name of user that can upload to an installed Cover Reports, e.g. when using dcover upload

cover.reports.username=reportsuser

cover.reports.password

DIFFBLUE_COVER_REPORTS_PASSWORD

password of user that can upload to an installed Cover Reports, e.g. when using dcover upload

cover.reports.password=some-password

cover.reports.upload.url

DIFFBLUE_COVER_REPORTS_UPLOAD_URL

URL of an installed Cover Reports to upload coverage reports into, e.g. when using dcover upload

cover.reports.upload.url=http://example.com

Last updated