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

BuildFailureOnText

open class BuildFailureOnText : FailureCondition

fun FailureConditions.failOnText(init: BuildFailureOnText.() -> Unit): BuildFailureOnText

A build failure condition failing build on specific text in a build log.

Example. Fail build if text "ERROR" appears in the build log.

buildType {
    // Other Build Type settings ...
    failureConditions {
        // Other Failure Conditions ...
        failOnText {
          conditionType = BuildFailureOnText.ConditionType.CONTAINS
          pattern = "ERROR"
          failureMessage = """Found "ERROR" in the log"""
          reverse = false
        }




Content copied to clipboard
    }
}

Example. Fail build if the build log text matches some regexp. Also stops the build as soon as the failure is detected.

buildType {
    // Other Build Type settings ...
    failureConditions {
        // Other Failure Conditions ...
        failOnText {
          conditionType = BuildFailureOnText.ConditionType.REGEXP
          pattern = "#[^#]+EXCEPTION_ACCESS_VIOLATION"
          failureMessage = "JVM crash detected"
          reverse = false
          stopBuildOnFailure = true
        }





Content copied to clipboard
    }
}

Constructors

BuildFailureOnText

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

constructor()

Types

ConditionType

enum ConditionType : Enum<BuildFailureOnText.ConditionType>

Defines how to treat the pattern specified in failure condition

Properties

conditionType

var conditionType: <Error class: unknown class>

A type defining how to treat the specified pattern

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

failureMessage

var failureMessage: <Error class: unknown class>

The message to display in the UI and the build log when build fails

var id: String?

Build feature id, if not specified will be generated

params

val params: List<Parameter>

pattern

var pattern: <Error class: unknown class>

The pattern to search for in the build log. Pattern interpretation depends on the selected conditionType.

reportOnlyFirstMatch

var reportOnlyFirstMatch: <Error class: unknown class>

Create build problem only on the first match

reverse

var reverse: <Error class: unknown class>

Whether the matching should be reversed, ie. the build should fail if build log doesn't contain the specified pattern.

stopBuildOnFailure

var stopBuildOnFailure: <Error class: unknown class>

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

type

var type: String

Build feature type

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, 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

fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

findRawParam