TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin/IdeaRunner

IdeaRunner

open class IdeaRunner : IdeaSettingsBasedRunner

fun BuildSteps.ideaRunner(init: IdeaRunner.() -> Unit = {})

IntelliJ IDEA Project build runner allows you to build a project created in IntelliJ IDEA

Example. Adds a simple IDEA Project build step with project JDK setup and aftifact build.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        ideaRunner {
            name = "My IDEA Step"
            pathToProject = ""
            jdk {
                name = "13"
                path = "%env.JDK_13_0%"
                patterns("jre/lib/*.jar", "jre/lib/ext/jfxrt.jar")
                extAnnotationPatterns("%teamcity.tool.idea%/lib/jdkAnnotations.jar")
            }
            artifactsToBuild = "aftifact1"
        }
Content copied to clipboard
    }
}

*/

Example. Adds an IDEA Project build step in the checkount directory root with specified project JDK settings, custom JVM settings, run configurations, artifacts build, and IDEA-base coverage.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        ideaRunner {
            name = "My IDEA Step"
            pathToProject = ""
            jdk {
                name = "13"
                path = "%env.JDK_13_0%"
                patterns("jre/lib/*.jar", "jre/lib/ext/jfxrt.jar")
                extAnnotationPatterns("%teamcity.tool.idea%/lib/jdkAnnotations.jar")
            }
            jvmArgs = "-Xmx256m"
            targetJdkHome = "%env.JDK_11_0%"
            runConfigurations = """
                run_configuration1
                run_configuration2
            """.trimIndent()
            incrementalMake = true
            makeRequiredModulesOnly = true
            artifactsToBuild = """
                aftifact1
                aftifact2
            """.trimIndent()
            coverageEngine = idea {
                includeClasses = "org.sample.*"
                excludeClasses = "org.sample.test.*"
            }
            reduceTestFeedback = IdeaRunner.TestPolicy.RECENTLY_FAILED_AND_MODIFIED
        }
Content copied to clipboard
    }
}

*/

Constructors

IdeaRunner

fun IdeaRunner(init: IdeaRunner.() -> Unit = {})

Types

CoverageEngine

sealed class CoverageEngine : CompoundParam<IdeaRunner.CoverageEngine>

TestPolicy

enum TestPolicy : Enum<IdeaRunner.TestPolicy>

Functions

androidsdk

fun androidsdk(init: IdeaSettingsBasedRunner.IdeaSettings.AndroidSdk.() -> Unit)

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.

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

idea

fun idea(init: IdeaRunner.CoverageEngine.Idea.() -> Unit = {}): <ERROR CLASS>

IntelliJ IDEA coverage runner

ideajdk

fun ideajdk(init: IdeaSettingsBasedRunner.IdeaSettings.IdeaJdk.() -> Unit)

intParameter

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

jacoco

fun jacoco(init: IdeaRunner.CoverageEngine.Jacoco.() -> Unit = {}): <ERROR CLASS>

JaCoCo coverage runner

jdk

fun jdk(init: IdeaSettingsBasedRunner.IdeaSettings.Jdk.() -> Unit)

library

fun library(init: IdeaSettingsBasedRunner.IdeaSettings.Library.() -> Unit)

param

fun param(name: String, value: String)

Adds parameter with specified name and value

pathvars

fun pathvars(init: IdeaSettingsBasedRunner.IdeaSettings.PathVariables.() -> Unit)

removeRawParam

fun removeRawParam(paramName: String)

sdk

fun sdk(init: IdeaSettingsBasedRunner.IdeaSettings.Sdk.() -> Unit)

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

artifactsToBuild

var artifactsToBuild: String?

Names of the artifacts to be built that are configured in the IntelliJ IDEA project

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

coverageEngine

var coverageEngine: IdeaRunner.CoverageEngine?

Specifies coverage engine to use

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.

incrementalMake

var incrementalMake: Boolean?

Compile classes and build artifacts incrementally when possible. Incremental make will work if there are caches on the agent left by the previous build of this build configuration.

jvmArgs

var jvmArgs: String?

JVM command line parameters which are passed by the JVM used to run your build

makeRequiredModulesOnly

var makeRequiredModulesOnly: Boolean?

Only compile classes required to build artifacts and execute run configurations. Whether to compile all classes in the project or only classes that are required by run configurations or for building artifacts.

name

var name: String

Build step name

params

val params: List<Parameter>

pathToProject

var pathToProject: String

The path to the project file (.ipr) or path to the project directory (root directory of the project that contains .idea directory). The path should be relative to the checkout directory.

reduceTestFeedback

var reduceTestFeedback: IdeaRunner.TestPolicy?

Reduce test failure feedback time

runConfigurations

var runConfigurations: String?

Names of IntelliJ IDEA run configurations configured in the project to execute inside TeamCity build. Supported configuration types are: JUnit, TestNG, and Application.

targetJdkHome

var targetJdkHome: String?

The path to your custom JDK used to run the build

type

var type: String

Build step type

workingDir

var workingDir: String?

A path to a Build Working Directory, if it differs from the Build Checkout Directory