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

AntBuildStep

fun BuildSteps.ant(init: AntBuildStep.() -> Unit): AntBuildStep

A build step running ant script

Example. Adds a simpe Ant build step with specified build file and targets. Default JDK is used.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        ant {
            name = "My Ant step"
            mode = antFile {
                path = "my-build.xml"
            }
            targets = "target1 target2"
        }
Content copied to clipboard
    }
}

Example. Adds an Ant build step with build file content specified directly in the step settings. Custom working directory is set. Custom Ant setup is provided, as well as custom JDK home and JVM parameters are set. IDEA-based code coverage is configured.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        ant {
            name = "My Ant step"
            mode = antScript {
                content = """
                    // Example Build file
                    // content goes here ...
                """.trimIndent()
            }
            workingDir = "ant-project/"
            targets = "target1 target2"

            antHome = "my-ant/home"
            antArguments = "-quiet"

            jdkHome = "%env.JDK_11_0%"
            jvmArgs = "-Xmx512m"

            coverageEngine = idea {
                includeClasses = "org.sample.*"
                excludeClasses = "org.sample.test.*"
            }
        }
Content copied to clipboard
    }
}

Example. Adds an Ant build step with build file content specified directly in the step settings to be run inside a Docker container. Custom test parameter is set. This build step will run even if some previous build steps are failed.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        ant {
            name = "My Ant step"
            executionMode = BuildStep.ExecutionMode.RUN_ON_FAILURE
            mode = antScript {
                content = """
                    // Example Build file
                    // content goes here ...
                """.trimIndent()
            }
            targets = "target1 target2"
            reduceTestFeedback = AntBuildStep.TestPolicy.RECENTLY_FAILED_AND_MODIFIED

            dockerImage = "myImage:2.4"
            dockerImagePlatform = AntBuildStep.ImagePlatform.Linux
            dockerPull = true
        }
Content copied to clipboard
    }
}

Constructors

AntBuildStep

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

AntBuildStep

fun AntBuildStep()

Types

CoverageEngine

sealed class CoverageEngine : CompoundParam<AntBuildStep.CoverageEngine>

ImagePlatform

enum ImagePlatform : Enum<AntBuildStep.ImagePlatform>

Docker image platforms

Mode

sealed class Mode : CompoundParam<AntBuildStep.Mode>

TestPolicy

enum TestPolicy : Enum<AntBuildStep.TestPolicy>

Tests reordering policy

Functions

antFile

fun antFile(init: AntBuildStep.Mode.AntFile.() -> Unit = {}): AntBuildStep.Mode.AntFile

Executes the ant script at the given path

antScript

fun antScript(init: AntBuildStep.Mode.AntScript.() -> Unit = {}): AntBuildStep.Mode.AntScript

Executes the ant script with the given content

booleanParameter

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

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, 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.

doubleParameter

fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

emma

fun emma(init: AntBuildStep.CoverageEngine.Emma.() -> Unit = {}): AntBuildStep.CoverageEngine.Emma

Emma coverage engine Emma is out of date and it does not support Java 8. Consider using IntelliJ IDEA or JaCoCo coverage runners. Add a 'clean' target to your Ant build for this coverage runner to work.

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

idea

fun idea(init: AntBuildStep.CoverageEngine.Idea.() -> Unit = {}): AntBuildStep.CoverageEngine.Idea

intParameter

fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

jacoco

fun jacoco(init: AntBuildStep.CoverageEngine.Jacoco.() -> Unit = {}): AntBuildStep.CoverageEngine.Jacoco

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

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

antArguments

var antArguments: <ERROR CLASS>

Space-separated list of additional arguments for ant

antHome

var antHome: <ERROR CLASS>

Path to ant distribution on the agent, specify it when you want to use custom ant instead of the bundled ant 1.9.7

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

coverageEngine

var coverageEngine: <ERROR CLASS>

Specifies coverage engine to use

dockerImage

var dockerImage: <ERROR CLASS>

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: <ERROR CLASS>

Specifies which Docker image platform will be used to run this build step.

dockerPull

var dockerPull: <ERROR CLASS>

If enabled, "pull image" command will be run before docker run.

dockerRunParameters

var dockerRunParameters: <ERROR CLASS>

Additional docker run command arguments

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

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.

jdkHome

var jdkHome: <ERROR CLASS>

Custom JDK to use. The default is JAVA_HOME environment variable or the agent's own Java.

jvmArgs

var jvmArgs: <ERROR CLASS>

Space-separated list of additional arguments for JVM

mode

var mode: <ERROR CLASS>

Specifies what ant script will be executed

name

var name: String

Build step name