Git Product home page Git Product logo

koproc's Introduction

koproc

jdk11 kotlin gradle GitHub maven central

Small lib to execute process and run commands in Kotlin style.

Based on Java ProcessBuilder API

Get Started

Add dependencies

Gradle Groovy Dsl:

dependencies {
    /** KoProc */
    implementation "ru.iopump.koproc:koproc:1.1.1"
}

Gradle Kotlin Dsl:

dependencies {
    /** KoProc */
    implementation("ru.iopump.koproc:koproc:1.1.1")
}

Run process and get the result

Start process with long duration, do something with Process Java API via KoprocCall and get the result as KoprocResult

import ru.iopump.koproc.startProcess

fun run() {
    val koprocCall: KoprocCall = "java -jar koproc-sample.jar".startProcess()

    // Get available 'out' and 'err' and close
    koprocCall.use { koprocCall: KoprocCall ->
        val out: String = koprocCall.readAvailableOut
        val err: String = koprocCall.readAvailableErrOut
    }

    // Get immutable object with results
    val koprocResult: KoprocResult = koprocCall.result
    // Throw exception on exit code != 0 or any Throwable during execution.
    koprocResult.throwOnAnyFailure().also { koprocResult ->
        println("There are no exception thrown. The result is ${koprocResult.out}")
    }
}

Run command and get the result

Execute short command and wait the result as KoprocResult

import ru.iopump.koproc.startCommand

fun run() {
    // Adjust KoprocConfig in startCommand function argument
    val koprocResult: KoprocResult = "java -jar koproc-sample.jar".startCommand { timeoutSec = 5 }

    if (koprocResult.hasSuccessCode) println("Exit code == 0")
    if (koprocResult.hasNotError) println("No Throwable during execution")
    if (koprocResult.isSuccess) println("Exit code == 0 and no Throwable during execution")
}

Adjust default timeouts

init {
    ru.iopump.koproc.koprocDefaultStartCommandTimeoutSec = 5L
    ru.iopump.koproc.koprocDefaultStartProcessTimeoutSec = 3600L
}

Examples

There is a sample project link using koproc

koproc's People

Contributors

kochetkov-ma avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.