TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.failureConditions/BuildFailureOnMetric

BuildFailureOnMetric

open class BuildFailureOnMetric : FailureCondition

fun FailureConditions.failOnMetricChange(init: BuildFailureOnMetric.() -> Unit): BuildFailureOnMetric

A build failure condition failing build on metric change.

Example. Fail build if the size of its artifacts decreases by 10% comparing to the last successful build.

buildType {
    // Other Build Type settings ...
    failureConditions {
        // Other Failure Conditions ...
        failOnMetricChange {
          metric = BuildFailureOnMetric.MetricType.ARTIFACT_SIZE
          threshold = 10
          units = BuildFailureOnMetric.MetricUnit.PERCENTS
          comparison = BuildFailureOnMetric.MetricComparison.LESS
          compareTo = build {
            buildRule = lastSuccessful()
          }
        }
Content copied to clipboard
    }
}

Example. Fail build if number of ignored tests exceeds 100.

buildType {
    // Other Build Type settings ...
    failureConditions {
        // Other Failure Conditions ...
        failOnMetricChange {
          metric = BuildFailureOnMetric.MetricType.TEST_IGNORED_COUNT
          threshold = 100
          units = BuildFailureOnMetric.MetricUnit.DEFAULT_UNIT
          comparison = BuildFailureOnMetric.MetricComparison.MORE
          compareTo = value()
        }
Content copied to clipboard
    }
}

Constructors

BuildFailureOnMetric

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

constructor()

Types

CompareTo

sealed class CompareTo : CompoundParam<BuildFailureOnMetric.CompareTo>

MetricComparison

enum MetricComparison : Enum<BuildFailureOnMetric.MetricComparison>

A type of metric change

MetricType

enum MetricType : Enum<BuildFailureOnMetric.MetricType>

A type of the metric

MetricUnit

enum MetricUnit : Enum<BuildFailureOnMetric.MetricUnit>

Specifies how to treat the threshold specified in the failure condition

Properties

compareTo

var compareTo: BuildFailureOnMetric.CompareTo?

Specifies which value should be compared to the metric value in the build

comparison

var comparison: BuildFailureOnMetric.MetricComparison?

On which type of metric change a build should fail

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

var id: String?

Build feature id, if not specified will be generated

metric

var metric: BuildFailureOnMetric.MetricType?

Type of the metric

params

val params: List<Parameter>

stopBuildOnFailure

var stopBuildOnFailure: Boolean?

Immediately stop the build if it fails due to this failure condition

threshold

var threshold: Int?

Threshold for build failure. A build will fail when a metric is changed more significantly than the specified threshold. Threshold change is treated according to the selected units. If not specified, the default value 1 is used.

type

var type: String

Build feature type

units

var units: BuildFailureOnMetric.MetricUnit?

Specifies the unit of the given threshold (default metric units or percents)

Functions

booleanParameter

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

build

fun build(init: BuildFailureOnMetric.CompareTo.Build.() -> Unit = {}): BuildFailureOnMetric.CompareTo.Build

The metric value in the build should be compared to the metric value from a build matched by the rule

clear

fun clear()

compoundParameter

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

copyParamsTo

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

Copies parameters of this object to the specified target

create

open fun create(): BuildFeature

Creates an instance of this build feature 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