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

RakeStep

fun BuildSteps.rake(init: RakeStep.() -> Unit): RakeStep

A Rake build step.

Example. Adds a simple Rake build step with default Ruby interpreter settings, launching parameters and test reporting.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        rake {
            name = "My Rake step"
            rakefile = file {
                path = "build/Rakefile"
            }
            tasks = "mytask:test mytask:test2"
        }
Content copied to clipboard
    }
}

Example. Adds a Rake build step with Rakefile script content and custom Rake parameters, custom Ruby interpreter settings, custom launching parameters and test reporting.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        rake {
            name = "My Rake step"
            workingDir = "project/"
            rakefile = content {
                content = """
                    // Rakefile content
                    // goes here ...
                """.trimIndent()
            }
            tasks = "mytask:test mytask:test2"
            rakeAdditionalParameters = "--trace"
            rubyInterpreterMode = rvm {
                rvmInterpreter = "jruby-1.4.0"
            }
            execBundle = false
            trackInvokeExecuteStages = true
            interpreterAdditionalParameters = "-J-Xmx512m"
            enableTestUnit = false
            enableTestSpec = true
            enableShoulda = true
            rspecSpecOptions = "user options"
            cucumberOptions = "user options"
        }
Content copied to clipboard
    }
}

Constructors

RakeStep

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

constructor()

Types

Rakefile

sealed class Rakefile : CompoundParam<RakeStep.Rakefile>

RubyInterpreterMode

sealed class RubyInterpreterMode : CompoundParam<RakeStep.RubyInterpreterMode>

Properties

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

cucumberOptions

var cucumberOptions: String?

Rake will be invoked with a "CUCUMBER_OPTS={internal options} {user options}".

enableCucumber

var enableCucumber: Boolean?

Whether to attach Cucumber framework results to Tests tab of the Build Results page.

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

enableRSpec

var enableRSpec: Boolean?

Whether to attach RSpec framework results to Tests tab of the Build Results page.

enableShoulda

var enableShoulda: Boolean?

Whether to attach Shoulda framework results to Tests tab of the Build Results page.

enableTestSpec

var enableTestSpec: Boolean?

Whether to attach Test-Spec framework results to Tests tab of the Build Results page.

enableTestUnit

var enableTestUnit: Boolean?

Whether to attach Test::Unit framework results to Tests tab of the Build Results page.

execBundle

var execBundle: Boolean?

If your project uses the Bundler requirements manager and your Rakefile doesn't load the bundler setup script, this option will allow you to launch rake tasks using the bundle exec command emulation. If you want to execute bundle install command, you need to do it in the Command Line step before the Rake step. Also, remember to set up the Ruby environment configurator build feature to automatically pass Ruby interpreter to the command line runner.

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

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.

interpreterAdditionalParameters

var interpreterAdditionalParameters: String?

Additional parameters for interpreter, useful for JRuby interpreters. E.g. '-J-Xmx512m'

name

var name: String

Build step name

params

val params: List<Parameter>

rakeAdditionalParameters

var rakeAdditionalParameters: String?

Specified parameters will be added to rake command line.

rakefile

var rakefile: RakeStep.Rakefile?

rspecSpecOptions

var rspecSpecOptions: String?

Rake will be invoked with a "SPEC_OPTS={internal options} {user options}".

rubyInterpreterMode

var rubyInterpreterMode: RakeStep.RubyInterpreterMode?

tasks

var tasks: String?

Space-separated tasks names if you don't want to use the default task. For example, test:functionals or mytask:test mytask:test2.

trackInvokeExecuteStages

var trackInvokeExecuteStages: Boolean?

Whether to enable showing Invoke stage data in the build log.

type

var type: String

Build step type

workingDir

var workingDir: String?

Build working directory for ant script, specify it if it is different from the checkout directory.

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

conditions

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

Configures build step conditions

content

fun content(init: RakeStep.Rakefile.Content.() -> Unit = {}): RakeStep.Rakefile.Content

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.

default

fun default(): RakeStep.RubyInterpreterMode.Default

Use Ruby interpreter settings defined in the Ruby environment configurator build feature settings or the interpreter will be searched in the PATH.

doubleParameter