gradle2-processes's Introduction

gradle-processes

Gradle Processes Plugin - Create and manage forked processes.

This Gradle plugin provides the capability to create forked processes from a Gradle build. It's primary goal is to bolster the built in capabilities of Gradle which allow for processing forking only in a synchronous manner.

Compatibility Notes

This plugin is tested against Gradle versions 1.8 - 1.11 (final versions only).

How To Use

First, add the BinTray JCenter repository and the plugin library to your build's buildscript.

buildscript {
    respositories {
       jcenter()
    }
    dependencies {
       classpath 'com.github.jengelman.gradle.plugins:gradle-processes:0.3.0'
    }
}

Second, apply the plugin to your Gradle build:

apply plugin: 'com.github.johnrengelman.processes'

Capabilities

Process Forking

ProcessHandle handle = project.procs.fork {
    <process configuration> See [Exec](http://www.gradle.org/docs/current/dsl/org.gradle.api.tasks.Exec.html)
}

ProcessHandle handle = project.procs.javafork {
    <process configuration> See [JavaExec](http://www.gradle.org/docs/current/dsl/org.gradle.api.tasks.JavaExec.html)
}

Process Joining

project.procs.waitForFinish(handle)

Handling Multiple Processes

ProcessHandle handle = project.procs.javafork { ... }
ProcessHandle handle2 = project.procs.javafork { ... }
project.procs.waitForFinish([handle, handle2])

Forking Tasks

task fork(type: Fork) {
  // Configure the same as the Exec task
}

task javafork(type: JavaFork) {
  // Configure the same as the JavaExec task
}

Accessing a Forked Tasks Process

task fork(type: Fork) {
  // Configure task
}

task waitForFork() << {
  fork.processHandle.waitForFinish()
}

Using the forked tasks can allow for starting/stopping processes for things like test infrastructure.

task startServer(type: Fork) {
  // Start some external service
}

task stopServer << {
  startServer.processHandle.abort()
}

test.dependsOn startServer
test.finalizedBy stopServer

Recommend Projects