TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildSteps/DotCoverBuildStep

DotCoverBuildStep

open class DotCoverBuildStep : BuildStep

fun BuildSteps.dotCover(init: DotCoverBuildStep.() -> Unit): DotCoverBuildStep

A dotCover build step to run dotCover – .NET code coverage tool

Example. Runs dotCover cover command for a provided command line and generate report by running dotCover report command

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        dotCover {
            executable = "/path/to/dotnet"
            commandLineArguments = "test MyProjectTests.dll"
        }
Content copied to clipboard
    }
}

Example. Runs dotCover cover command for a provided command line and passes additinal command-line arguments

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        dotCover {
            executable = "/path/to/dotnet"
            commandLineArguments = "test MyProjectTests.dll"
            coverArguments = "--Output=/path/to/MyProjectTests.dcvr"
            generateReport = "false"
        }
Content copied to clipboard
    }
}

Example. Runs dotCover merge command for provided additional snapshots paths and then generate report by running dotCover report command

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        dotCover {
            snapshotPaths = """
                /path/to/MyProject1Tests.dcvr
                /path/to/MyProject2Tests.dcvr
                /path/to/MyProject3Tests.dcvr
            """.trimIndent()
        }
Content copied to clipboard
    }
}

Constructors

DotCoverBuildStep

constructor(init: DotCoverBuildStep.() -> Unit)

constructor()

Types

ImagePlatform

enum ImagePlatform : Enum<DotCoverBuildStep.ImagePlatform>

Docker image platforms

Properties

assemblyFilters

var assemblyFilters: String?

Specify a new-line separated list of filters for code coverage

attributeFilters

var attributeFilters: String?

Specify a new-line separated list of attribute filters for code coverage. Supported only with dotCover 2.0 or later

commandLineArguments

var commandLineArguments: String?

Space or new-line separated command line parameters for covering process

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

coverArguments

var coverArguments: String?

Enter additional new-line separated command line parameters for dotCover cover command

dockerImage

var dockerImage: String?

Specifies which Docker image to use for running this build step. I.e. the build step will be run inside specified docker image, using 'docker run' wrapper.

dockerImagePlatform

var dockerImagePlatform: DotCoverBuildStep.ImagePlatform?

Specifies which Docker image platform will be used to run this build step.

dockerPull

var dockerPull: Boolean?

If enabled, "pull image" command will be run before docker run.

dockerRunParameters

var dockerRunParameters: String?

Additional docker run command arguments

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

executable

var executable: String?

Specify path to an executable file to run the process under dotCover coverage profile and produce a dotCover snapshot file. This parameter is optional

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

generateReport

var generateReport: Boolean?

Generates a TeamCity coverage report that will be displayed on the Code Coverage tab after the build is complete. Default value is true

var id: String?

Optional id of the step. Usually the id is not required, however if a build configuration inherits from a template and wants to override a build step defined there, then both steps should have the same id.

name

var name: String

Build step name

params

val params: List<Parameter>

snapshotPaths

var snapshotPaths: String?

Specify dotCover snapshot (.dcvr) files paths separated by spaces or new lines. Wildcards are supported. Note that you can merge snapshots generated only by the selected or earlier version of dotCover tool

toolPath

var toolPath: String?

Specify the path to dotCover CLT

type

var type: String

Build step type

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

conditions

fun conditions(init: BuildStepConditions.() -> Unit = {})

Configures build step conditions

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildStep

Creates an instance of this build step via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter