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

MSpecStep

fun BuildSteps.mspec(init: MSpecStep.() -> Unit): MSpecStep

Example. Runs MSpec tests with help of the MSpec executable located on the agent at the specified path. 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 ...
        mspec {
          mspecPath = "<path to MSpec executable on the agent>"
          includeTests = """tests\*.dll"""
          coverage = dotcover {
            assemblyFilters = "+:*"
          }
        }
Content copied to clipboard
    }
}

Constructors

MSpecStep

fun MSpecStep(init: MSpecStep.() -> Unit)

MSpecStep

fun MSpecStep()

Types

Coverage

sealed class Coverage : CompoundParam<MSpecStep.Coverage>

Platform

enum Platform : Enum<MSpecStep.Platform>

Execution mode on a x64 machine

PlatformBitness

enum PlatformBitness : Enum<MSpecStep.PlatformBitness>

PlatformVersion

enum PlatformVersion : Enum<MSpecStep.PlatformVersion>

Registration

enum Registration : Enum<MSpecStep.Registration>

ReportOrder

enum ReportOrder : Enum<MSpecStep.ReportOrder>

ReportType

enum ReportType : Enum<MSpecStep.ReportType>

RuntimeVersion

enum RuntimeVersion : Enum<MSpecStep.RuntimeVersion>

.NET Framework version

Functions

booleanParameter

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

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<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

fun dotcover(init: MSpecStep.Coverage.Dotcover.() -> Unit = {}): MSpecStep.Coverage.Dotcover

doubleParameter

fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): SingleDelegateProvider<Int>

ncover

fun ncover(init: MSpecStep.Coverage.Ncover.() -> Unit = {}): MSpecStep.Coverage.Ncover

ncover3

fun ncover3(init: MSpecStep.Coverage.Ncover3.() -> Unit = {}): MSpecStep.Coverage.Ncover3

param

fun param(name: String, value: String)

Adds parameter with specified name and value

partcover

fun partcover(init: MSpecStep.Coverage.Partcover.() -> Unit = {}): MSpecStep.Coverage.Partcover

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

fun stringParameter(customName: String? = null): SingleDelegateProvider<String>

toString

open override fun toString(): String

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

args

var args: String?

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

coverage

var coverage: MSpecStep.Coverage?

Specifies coverage tool to use

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

excludeSpecs

var excludeSpecs: String?

Comma- or newline-separated list of specifications to be excluded.

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? = null

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.

includeSpecs

var includeSpecs: String?

Comma- or newline-separated list of specifications to be executed.

includeTests

var includeTests: String?

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

mspecPath

var mspecPath: String?

A path to mspec.exe

name

var name: String

Build step name