A gradle plugin for getting test coverage using OpenCover
A base plugin 'com.ullink.opencover' is provided. It will sets up a task named 'opencover' that when called will execute the OpenCover.exe file of the associated OpenCover version. That task may be configured:
opencover {
// optional - defaults to '4.7.1189'
openCoverVersion
// optional - defaults to OPENCOVER_HOME env variable if set or to a downloaded opencover home corresponding to
// the specified openCoverVersion
openCoverHome
// mandatory - specifies the test runner executable path (ie 'nunit-console.exe')
targetExec
// mandatory - specifies the test runner arguments (associated 'nunit-console.exe' parameters)
targetExecArgs
// mandatory - assemblies to obtain test coverage for
targetAssemblies
// optional - defaults to TRUE. OpenCover will return the return code of the test runner executable.
returnTargetCode
// optional - defaults to FALSE. Determines the behavior of the task if OpenCover's return code is abnormal
ignoreFailures
// optional - defaults to user. Specifies opencover's profile register mode (user, path32, path64, null). More details in https://github.com/OpenCover/opencover/wiki/Usage
registerMode
// optional - Exclude a class (or methods) by filter(s) that match the filenames
// More details in https://github.com/OpenCover/opencover/wiki/Usage
excludeByFile
// optional - Exclude a class or method by filter(s) that match attributes that have been applied.
// More details in https://github.com/OpenCover/opencover/wiki/Usage
excludeByAttribute
// optional - defaults to FALSE. Neither track nor record auto-implemented properties.
skipAutoProps
// optional - Remove information from output file that relates to classes/modules that have been skipped.
// Possible values: File;Filter;Attribute;MissingPdb;All
hideSkipped
}
#opencover-nunit plugin
An NUnit ready plugin is also provided: 'com.ullink.opencover-nunit'. It relies on the gradle-nunit-plugin 'nunit' task to configure the 'opencover' task. Using it, provided the default values suit you, the only setup you'll need is
opencover {
targetAssemblies = ...
}
All these plugins are licensed under the Apache License, Version 2.0 with no warranty (expressed or implied) for any purpose.