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

NUnitConsoleStep

fun BuildSteps.nunitConsole(init: NUnitConsoleStep.() -> Unit): NUnitConsoleStep

A build step running NUnit tests

Example. Runs NUnit tests with help of the default NUnit console tool installed on the TeamCity server. Collects сode coverage with help of JetBrains DotCover and reports it to the TeamCity server together with the test results.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        nunitConsole {
          nunitPath = "%teamcity.tool.NUnit.Console.DEFAULT%"
          includeTests = """tests\*.dll"""
          coverage = dotcover {
            assemblyFilters = "+:*"
          }
        }
Content copied to clipboard
    }
}

Constructors

NUnitConsoleStep

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

constructor()

Types

Coverage

sealed class Coverage : CompoundParam<NUnitConsoleStep.Coverage>

ImagePlatform

enum ImagePlatform : Enum<NUnitConsoleStep.ImagePlatform>

Docker image platforms

Properties

args

var args: String?

Enter additional command line parameters for nunit console.

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

configFile

var configFile: String?

Path to nunit configuration file.

coverage

var coverage: NUnitConsoleStep.Coverage?

Specifies coverage tool to use

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: NUnitConsoleStep.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

excludeCategories

var excludeCategories: String?

Comma- or newline-separated list of NUnit categories which should be excluded. Category expressions are supported as well.

excludeTests

var excludeTests: String?

Comma- or newline-separated list of .NET assemblies which should be excluded from the list of found assemblies to test.

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

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.

includeCategories

var includeCategories: String?

Comma- or newline-separated list of NUnit categories. Category expressions are supported as well.

includeTests

var includeTests: String?

Comma- or newline-separated list of .NET assemblies where the NUnit tests are specified relative to the checkout directory. Wildcards are supported.

name

var name: String

Build step name

nunitPath

var nunitPath: String?

A path to NUnit console tool including the file name

params

val params: List<Parameter>

reduceTestFeedback

var reduceTestFeedback: Boolean?

Whether TeamCity should run recently failed tests first to reduce test feedback

type

var type: String

Build step type

useProjectFile

var useProjectFile: Boolean?

Whether TeamCity should create *.nunit test project files for each test assemblies location

workingDir

var workingDir: String?

Build working directory for script, specify it if it is different from the checkout * directory.

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.

dotcover