IdeaRunner

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"
}
}
}
*/

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

Constructors

Link copied to clipboard
constructor(init: IdeaRunner.() -> Unit = {})

Types

Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard
var artifactsToBuild: <Error class: unknown class>

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

Link copied to clipboard

Optional collection of build step execution conditions

Link copied to clipboard
var coverageEngine: <Error class: unknown class>

Specifies coverage engine to use

Link copied to clipboard

Specifies whether the step is enabled, true by default

Link copied to clipboard
Link copied to clipboard
var id: String?

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.

Link copied to clipboard
var incrementalMake: <Error class: unknown class>

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.

Link copied to clipboard
var jvmArgs: <Error class: unknown class>

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

Link copied to clipboard
var makeRequiredModulesOnly: <Error class: unknown class>

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.

Link copied to clipboard

Build step name

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
var reduceTestFeedback: <Error class: unknown class>

Reduce test failure feedback time

Link copied to clipboard
var runConfigurations: <Error class: unknown class>

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

Link copied to clipboard
var targetJdkHome: <Error class: unknown class>

The path to your custom JDK used to run the build

Link copied to clipboard

Build step type

Link copied to clipboard
var workingDir: <Error class: unknown class>

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

Functions

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

Deletes all configured build step conditions

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

Link copied to clipboard
fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown 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 idea(init: IdeaRunner.CoverageEngine.Idea.() -> Unit = {}): <Error class: unknown class>

IntelliJ IDEA coverage runner

Link copied to clipboard
Link copied to clipboard
fun intParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun jacoco(init: IdeaRunner.CoverageEngine.Jacoco.() -> Unit = {}): <Error class: unknown class>

JaCoCo coverage runner

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
Link copied to clipboard
open fun stringParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown 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