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
        }
} }

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
        }
} }

See also

Constructors

Link copied to clipboard
fun BuildFailureOnText(init: BuildFailureOnText.() -> Unit)
Link copied to clipboard
fun BuildFailureOnText()

Types

Link copied to clipboard
enum ConditionType : Enum<BuildFailureOnText.ConditionType>

Defines how to treat the pattern specified in failure condition

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
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.

Link copied to clipboard
fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

Link copied to clipboard
var conditionType: <ERROR CLASS>

A type defining how to treat the specified pattern

Link copied to clipboard
var enabled: Boolean = true

Specifies whether the feature is enabled, true by default

Link copied to clipboard
var failureMessage: <ERROR CLASS>

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

Link copied to clipboard
var id: String? = null

Build feature id, if not specified will be generated

Link copied to clipboard
val params: List<Parameter>
Link copied to clipboard
var pattern: <ERROR CLASS>

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

Link copied to clipboard
var reportOnlyFirstMatch: <ERROR CLASS>

Create build problem only on the first match

Link copied to clipboard
var reverse: <ERROR CLASS>

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

Link copied to clipboard
var stopBuildOnFailure: <ERROR CLASS>

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

Link copied to clipboard
var type: String

Build feature type