diff --git a/README.md b/README.md new file mode 100644 index 0000000..3b9de53 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +## Gradle Exec Utilities + +A small set of methods to make it easy to execute other things from a gradle +script without needing to create a dedicated tasks for each invocation. + +### API + +`com.jdbernard.gradle.ExecUtil` exposes a set of static methods. The two +primary methods are: + +* `void exec(String[] cmd, File workingDirectory, boolean checkExit)` + + Execute the command specified by `cmd` (each argument as a separate string). + The process' output and error streams are redirected to `System.out` and + `System.err`. This call will block until the sub-process exits. + + `workingDirectory` defines the process' working directory. If `null`, the + process inherits the current working directory. + + If `checkExit` is true, `exec` uses a Groovy assertion to check that the exit + value of the executed process is zero (fails the assertion if it is not). + + Other flavors of this method: + + - `void exec(List cmd, File workingDir, boolean checkExit)`, + - `void exec(String... cmd)` - sets `workingDir` to `null` and `checkExit` to `true`, + - `void exec_(List cmd)` - sets `workingDir` to `null` and `checkExit` to `false`, + - `void exec_(String... cmd)` - sets `workingDir` to `null` and `checkExit` to `false`, + - `void execAll(List> cmds, File workingDir, boolean checkExit)` - + convenience method to kick off multiple processes at once. + +* `void spawn(String[] cmd, File workingdir)` + + Similar to `exec`, except the call returns immediately and does not wait for + the sub-process to complete. Becuase of this it cannot check the sub-process + exit value. + + Other flavors: + + - `spawn(List cmd, File workingDir)` + - `spawn(String... cmd)` - sets `workingDir` to null + +### Example Usage + +```groovy +import static com.jdbernard.gradle.ExecUtil.* + +// Execute: 'ls -al', ignoring the exit value +exec_('ls', '-al') + +// Execute 'scss --update src.scss:dest.css', checking that the return is +exec('scss', '--update', 'src.scss:dest.css') +``` diff --git a/build.gradle b/build.gradle index 43fe5fc..ad690c6 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'maven' group = 'com.jdbernard' -version = '0.1.0' +version = '0.2.0' dependencies { compile localGroovy() diff --git a/src/main/groovy/com/jdbernard/gradle/ExecUtil.groovy b/src/main/groovy/com/jdbernard/gradle/ExecUtil.groovy new file mode 100644 index 0000000..3d60eb3 --- /dev/null +++ b/src/main/groovy/com/jdbernard/gradle/ExecUtil.groovy @@ -0,0 +1,46 @@ +package com.jdbernard.gradle + +// ## Utility methods for working with processes. +public class ExecUtil { + + public static void exec_(List cmd) { exec(cmd, null, false) } + public static void exec_(String... cmd) { exec(cmd, null, false) } + public static void exec(String... cmd) { exec(cmd, null, true) } + + public static void exec(List cmd, File workingDir, boolean checkExit) { + exec(cmd as String[], workingDir, checkExit) } + + public static void exec(String[] cmd, File workingDir, boolean checkExit) { + def pb = new ProcessBuilder(cmd) + if (workingDir) pb.directory(workingDir) + def process = pb.start() + process.waitForProcessOutput(System.out, System.err) + + if (process.exitValue() != 0) + println "Command $cmd exited with non-zero exit value: ${process.exitValue()}." + if (checkExit) assert process.exitValue() == 0 : "Not ignoring failed command." } + + public static void execAll(List> cmds, File workingDir, boolean checkExit) { + + // Kick off all processes + def processes = cmds.map { + ProcessBuilder pb = new ProcessBuilder(it) + if (workingDir) pb.directory(workingDir) + pb.start() } + + // Wait for each process to complete + processes.each { + it.waitForProcessOutput(System.out, System.err) + if (it.exitValue() != 0) + println "Command $cmd exited with non-zero exit value: ${it.exitValue()}." + + if (checkExit) + assert process.exitValue() == 0 : "Not ignoring failed command." } } + + public static void spawn(String... cmd) { spawn(cmd, null) } + public static void spawn(List cmd, File workingDir) { spawn(cmd as String[], workingDir) } + public static void spawn(String[] cmd, File workingDir) { + def pb = new ProcessBuilder(cmd) + if (workingDir) pb.directory(workingDir) + def process = pb.start() } +} diff --git a/src/main/groovy/com/jdbernard/gradle/ShellUtil.groovy b/src/main/groovy/com/jdbernard/gradle/ShellUtil.groovy deleted file mode 100644 index 4a75b9e..0000000 --- a/src/main/groovy/com/jdbernard/gradle/ShellUtil.groovy +++ /dev/null @@ -1,35 +0,0 @@ -package com.jdbernard.gradle - -// ## Utility methods for working with processes. -public class ShellUtil { - - public static void shell_(List cmd) { shell(cmd, null, false) } - public static void shell_(String... cmd) { shell(cmd, null, false) } - public static void shell(String... cmd) { shell(cmd, null, true) } - - public static void shell(List cmd, File workingDir, boolean checkExit) { - shell(cmd as String[], workingDir, checkExit) } - - public static void shell(String[] cmd, File workingDir, boolean checkExit) { - def pb = new ProcessBuilder(cmd) - if (workingDir) pb.directory(workingDir) - def process = pb.start() - process.waitForProcessOutput(System.out, System.err) - - if (process.exitValue() != 0) - println "Command $cmd exited with non-zero result code." - if (checkExit) assert process.exitValue() == 0 : "Not ignoring failed command." } - - public static void shell(List> cmds, File workingDir) { - cmds.each { - ProcessBuilder pb = new ProcessBuilder(it) - pb.directory(workingDir) - pb.start().waitForProcessOutput(System.out, System.err) } } - - public static void spawn(String... cmd) { spawn(cmd, null) } - public static void spawn(List cmd, File workingDir) { spawn(cmd as String[], workingDir) } - public static void spawn(String[] cmd, File workingDir) { - def pb = new ProcessBuilder(cmd) - if (workingDir) pb.directory(workingDir) - def process = pb.start() } -}