Skip to content

Commit

Permalink
Expose more properties for docker and command steps
Browse files Browse the repository at this point in the history
  • Loading branch information
@sagebind
sagebind committed Mar 21, 2019
1 parent 8f729e1 commit 7e7b732
Showing 1 changed file with 211 additions and 44 deletions.
255 changes: 211 additions & 44 deletions buildSrc/src/main/groovy/com/widen/plugins/UploadPipeline.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction

import java.nio.file.Files
import java.time.Duration

/**
* A Gradle task that allows you to define a Buildkite pipeline dynamically and then upload it during a build.
Expand Down Expand Up @@ -59,10 +60,6 @@ class UploadPipeline extends DefaultTask {

/**
* Helper method to return the correct Widen Kubernetes cluster endpoint for a given environment and region.
*
* @param environment
* @param region
* @return
*/
String k8s(String environment, String region) {
if (environment == 'stage' && region == 'us-east-1') {
Expand Down Expand Up @@ -119,17 +116,13 @@ class UploadPipeline extends DefaultTask {

/**
* Sets the label that will be displayed in the pipeline visualisation in Buildkite.
*
* @param label
*/
void label(String label) {
model.label = label
}

/**
* The branch pattern defining which branches will include this step in their builds.
*
* @param branches The branches to match.
* The branch patterns defining which branches will include this step in their builds.
*/
void branches(String... branches) {
model.branches = branches.join(' ')
Expand All @@ -140,44 +133,89 @@ class UploadPipeline extends DefaultTask {
* Configuration for a Buildkite command step.
*/
class CommandStep extends Step {
/**
* The shell command to run during this step.
*/
void command(String command) {
model.command = command
}

/**
* The shell commands to run during this step.
*/
void commands(String[] commands) {
model.command = commands
}

void artifactPath(String path) {
model.get('artifact_paths', []) << path
}

/**
* The agent queue that should run this step.
*
* @param name The agent queue name.
*/
void agentQueue(String name) {
model.get('agents', [:]).queue = name
}

/**
* The agent queue that should run this step.
*
* @param name The agent queue base name.
* @param region A specific AWS region to run in.
*/
void agentQueue(String name, String region) {
agentQueue(region == 'us-east-1' ? name : "$name-$region")
}

/**
* Add a glob path of artifacts to upload from this step.
*/
void artifactPath(String path) {
model.get('artifact_paths', []) << path
}

/**
* The maximum number of jobs created from this step that are allowed to run at the same time. If you use this attribute, you must also
* define a label for it with the concurrency_group attribute.
*
* @param group A unique name for this concurrency group.
* @param concurrency The number of max concurrent jobs.
*/
void concurrency(String group, Integer concurrency) {
model.concurrency = concurrency
model.concurrency_group = group
}

/**
* Add an environment variable to this step.
*
* @param name The variable name.
* @param value The variable value.
*/
void environment(String name, String value) {
model.get('env', [:]).put(name, value)
}

/**
* Add environment variables to this step.
*
* @param variables A map of variable names to values.
*/
void environment(Map<String, String> variables) {
variables.each { name, value ->
environment(name, value)
}
}

void skip() {
model.skip = true
}

void skip(String reason) {
model.skip = reason
/**
* The number of parallel jobs that will be created based on this step.
*/
void parallelism(Integer parallelism) {
model.parallelism = parallelism
}

/**
* Retry this step automatically on failure.
*/
void automaticRetry(@DelegatesTo(AutomaticRetry) Closure closure) {
def config = new AutomaticRetry()
closure = closure.rehydrate(config, this, this)
Expand All @@ -186,16 +224,81 @@ class UploadPipeline extends DefaultTask {
model.get('retry', [:]).automatic = config.model
}

/**
* Configuration for automatic retries.
*/
class AutomaticRetry {
protected Object model = true

/**
* The exit status number that will cause this job to retry.
*/
void exitStatus(Integer exitStatus) {
if (!(model instanceof Map)) {
model = [:]
}
model['exit_status'] = exitStatus
}

/**
* The number of times this job can be retried. The maximum value this can be set to is 10.
*/
void limit(Integer limit) {
if (!(model instanceof Map)) {
model = [:]
}
model['limit'] = limit
}
}

/**
* Skip this step.
*/
void skip() {
model.skip = true
}

/**
* Skip this step with a given reason string.
*/
void skip(String reason) {
model.skip = reason
}

/**
* The amount of time a job created from this step is allowed to run. If the job does not finish within this limit, it will be automatically cancelled
* and the build will fail.
*/
void timeout(Duration timeout) {
model.timeout_in_minutes = Math.max(timeout.toMinutes(), 1)
}

/**
* Add a Buildkite plugin to this step.
*
* @param name The plugin name.
* @param config An object that should be passed to the plugin as configuration.
*/
void plugin(String name, Object config) {
model.get('plugins', []) << [
(name): config
]
}

/**
* Add a Buildkite plugin to this step.
*
* @param name The plugin name.
* @param name The plugin version.
* @param config An object that should be passed to the plugin as configuration.
*/
void plugin(String name, String version, Object config) {
plugin("$name#$version", config)
}

/**
* Add the <a href="https://github.com/buildkite-plugins/docker-buildkite-plugin">Docker plugin</a> to this step.
*/
void docker(@DelegatesTo(Docker) Closure closure) {
def config = new Docker()
closure = closure.rehydrate(config, this, this)
Expand All @@ -204,6 +307,9 @@ class UploadPipeline extends DefaultTask {
plugin('docker', DOCKER_PLUGIN_VERSION, config.model)
}

/**
* Add the <a href="https://github.com/buildkite-plugins/docker-compose-buildkite-plugin">Docker Compose plugin</a> to this step.
*/
void dockerCompose(@DelegatesTo(DockerCompose) Closure closure) {
def config = new DockerCompose()

Expand All @@ -220,81 +326,142 @@ class UploadPipeline extends DefaultTask {

plugin('docker-compose', DOCKER_COMPOSE_PLUGIN_VERSION, config.model)
}

class AutomaticRetry {
protected Object model = true

void exitStatus(Integer exitStatus) {
if (!(model instanceof Map)) {
model = [:]
}
model['exit_status'] = exitStatus
}

void limit(Integer limit) {
if (!(model instanceof Map)) {
model = [:]
}
model['limit'] = limit
}
}
}

/**
* Configuration for the Docker plugin.
*/
class Docker {
protected final Map model = [:]

/**
* The name of the Docker image to use.
*/
void image(String image) {
model.image = image
}

/**
* Always pull the latest image before running the command.
*/
void alwaysPull() {
alwaysPull(true)
}

void alwaysPull(boolean pull) {
model['always-pull'] = pull
model['always-pull'] = true
}

/**
* Set an environment variable to pass into the Docker container.
*
* @param name The variable name.
*/
void environment(String name) {
model.get('environment', []) << name
}

/**
* Set an environment variable to pass into the Docker container.
*
* @param name The variable name.
* @param value The value to set.
*/
void environment(String name, String value) {
model.get('environment', []) << "$name=$value"
}

/**
* Set a map of environment variables to pass into the Docker container.
*
* @param variables A map of variable names to values.
*/
void environment(Map<String, String> variables) {
variables.each { name, value ->
environment(name, value)
}
}

/**
* Automatically propagate all pipeline environment variables into the container.
*/
void propagateEnvironment() {
model['propagate-environment'] = true
}

/**
* Add a volume mount to pass to the container.
*/
void volume(String source, String target) {
model.get('volumes', []) << "$source:$target"
}

/**
* Add extra volume mounts to pass to the container.
*/
void volumes(Map<String, String> volumes) {
volumes.each { source, target ->
volume(source, target)
}
}
}

/**
* Configuration for the Docker Compose plugin.
*/
class DockerCompose {
protected final Map model = [:]

/**
* The names of services to build.
*/
void build(String... services) {
model.get('build', []) << services
}

/**
* The name of the service the command should be run within.
*/
void run(String service) {
model.run = service
}

void build(String... services) {
model.build = services
/**
* The repository for pushing and pulling pre-built images.
*/
void imageRepository(String repository) {
model['image-repository'] = repository
}

/**
* The name to use when tagging pre-built images.
*/
void imageName(String name) {
model['image-name'] = name
}

/**
* Set an environment variable to pass into the container.
*/
void environment(String name) {
model.get('env', []) << name
}

/**
* Set an environment variable to pass into the container.
*/
void environment(String name, String value) {
model.get('env', []) << "$name=$value"
}

/**
* Set a map of environment variables to pass into the container.
*/
void environment(Map<String, String> variables) {
variables.each { name, value ->
environment(name, value)
}
}

/**
* Add a Docker Compose configuration file to use.
*/
void composeFile(String composeFile) {
model.get('config', []) << composeFile
}
Expand Down

0 comments on commit 7e7b732

Please sign in to comment.