erik/kobalt-exec
erik/kobalt-exec
1
0
Fork 0
Code Issues Pull requests Releases Activity

Added predefined operating systems value.

Browse source 
Started documentation.
This commit is contained in:
Erik C. Thauvin 2016-07-13 00:26:17 -07:00
parent f2ff209389
commit 84f64f5437
6 changed files with 163 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

96
README.md
View file

@ -6,6 +6,8 @@
var pl = plugins("net.thauvin.erik:kobalt-exc:")
var p = project {
name = "example"
exec {
commandLine(listOf("echo", "Hello, World!"))
}
@ -14,4 +16,96 @@ var p = project {
```sh
./kobaltw assemble exec
```
```
## CommandLine Directive
```kotlin
exec {
commandLine(listOf("cmd", "/c", "stop.bat"), dir = "../tomcat/bin", os = setOf(Os.WINDOWS))
commandLine(listOf("./stop.sh"), dir = "../tomcat/bin", os = setOf(Os.MAC, Os.LINUX))
commandLine(listOf("/bin/sh", "-c", "ps aux | grep tomcat"), fail = setOf(Fail.EXIT))
}
```
### Parameters
#### args
The full command line including the executable and its parameters.
```kotlin
exec {
commandLine(listOf("ls", "-l"))
comamndLine(args = listOf("touch", "README.md"))
}
```
#### dir
The working directory for the process. Defaults to the project directory.
```kotlin
exec {
commandLine(listOf("cmd", "/c", "stop.bat"), dir = "../tomcat/bin")
}
```
#### os
The operating system(s) to execute the command on. If the current operating system does not match, the command will not be executed.
The following predefined values are available:
Name | Operating System
------------|--------------------------------------------------------------------
Os.FREEBSD | FreeBSD
Os.LINUX | Linux
Os.MAC | Apple Macintosh / OS X
Os.OPENVMS | OpenVMS
Os.OS400 | OS/400
Os.SOLARIS | Solaris / SunOS
Os.TANDEM | Tandem's Non-Stop
Os.WINDOWS | Microsoft Windows
Os.ZOS | z/OS / OS/390
```kotlin
exec {
commandLine(listOf("cmd", "/c", "stop.cmd"), os = setOf(Os.WINDOWS))
commandLine(listOf("./stop.sh"), os = setOf(Os.LINUX, Os.MAC))
}
```
#### fail
Specifies whether output to the stderr, stdout and/or an abnormal exit value constitutes a failure.
The following predefined values are available:
Name | Failure When
------------|--------------------------------------------------------------------
Fail.EXIT | Exit value > 0
Fail.NORMAL | Exit value > 0 or any output to the standard error stream (stderr).
Fail.OUTPUT | Any output to the standard output stream (stdout) or stderr.
Fail.STDERR | Any output to stderr.
Fail.STDOUT | Any output to stdout.
Fail.ALL | Any of the conditions above.
`Fail.NORMAL` is the default value.
```kotlin
exec {
commandLine(listOf("cmd", "/c", "stop.bat"), fail = setOf(Fail.EXIT))
commandLine(listOf("./stop.sh"), fail = setOf(Fail.EXIT, Fail.STDOUT))
}
```
### Logging / Debugging
```sh
./kobaltw exec --log 2
```