gre / playcli Goto Github PK

View Code? Open in Web Editor NEW

69.0 13.0 5.0 1.47 MB

Play Framework Iteratees + UNIX pipe library

Scala 100.00%

playcli's Introduction

Play CLI

Play CLI defines helpers to deal with UNIX command with Play Framework iteratees.

Getting Started

Add this SBT dependency:

"fr.greweb" %% "playcli" % "0.12"

Play CLI depends only on play-iteratee.

Some random examples:

import playcli._
val logs = CLI.enumerate("tail -f aLogFile")
/* Ok.stream(logs) */

val colorQuantize = CLI.pipe("convert - -colors 14 png:-")
/* Ok.stream(anImageEnum &> colorQuantize) */

val scaleVideoHalf = CLI.pipe("ffmpeg -i pipe:0 -vf scale=iw/2:-1 -f avi pipe:1")
/* Ok.stream(streamEnum &> scaleVideoHalf) */

// Don't concatenate CMD string, but use the Seq syntax:
val logs = CLI.enumerate(Seq("tail", "-f", myFilePath))
/* Ok.stream(logs) */

// A consume example
val events : Enumerator[String] = …
events &> 
  Enumerator.map(e => (e+"\n").map(_.toByte).toArray) |>>> 
  CLI.consume("externalLoggerCmd")

//

… continue to the scala API

playcli's People

Contributors

Stargazers

Watchers

Forkers

sledorze nsullins malax kompot yzernik

playcli's Issues

Handle CLI errors (command not found kind)

I've started to implement it like this:

(pipe example)

  runProcess(command) map { case (process, stdin, stdout, stderr) =>
     ...
  } getOrElse(Future.successful(Error("CLI failed", Input.Empty)))

But it's maybe not the good way.

CLI.pipe not working with Enumerator.generateM

  import collection.immutable.StringOps
  import play.api.libs.concurrent.Promise.timeout
  import concurrent.{Await}
  import concurrent.duration.Duration
  val maxDuration = Duration.Inf
  val stringToBytes = (str: StringOps) => str.map(_.toByte).toArray
  val bytesJoinConsumer = Iteratee.fold[Array[Byte], Array[Byte]](Array[Byte]())((a, b) => a++b)
  val nbOfLines = 3
  val line = stringToBytes("hello\n")
  val enum = Enumerator.generateM[Array[Byte]] {
    timeout(Some(line), 5)
  }
  val pipe = CLI.pipe(Seq("head", "-n", nbOfLines.toString), 10)

  val result: Array[Byte] = Await.result(enum &> pipe |>>> bytesJoinConsumer, maxDuration)
  println(result.map(_.toChar).mkString)

[feature] get the exitCode

It could be a callback:

CLI.pipe("myCommand", (exitCode) => { doSomethingWith(exitCode) } )

Find a non blocking Process IO library

Today we are blocking thread when reading InputStream,
it would be great if we could find a non blocking Process IO lib

It is not possible to grep tail command

Tail as an enumerator keeps waiting and does not go through grep. Below is a sample code to reproduce the issue.

val file = args(0)
val pattern = args(1)

val tail = CLI.enumerate(Seq("tail", "-f", file))
val grep = CLI.pipe(Seq("grep", pattern))
val printlnIteratee = Iteratee.foreach[Array[Byte]](s => print(new String(s)))

tail &> grep |>>> printlnIteratee

unmaintained. giveaway if anyone want the project.

CLI.pipe issues

CLI.pipe current implementation seems to lock in some case (command are not closed and nothing is streamed anymore).

when chaining multiple CLI.pipe.
when triggering a lot of pipe (with the ffmpeg example and opening multiple connections).
during some time (~ 2min in the webradio example)

Example for (1):

import concurrent.ExecutionContext.Implicits.global
import concurrent.{Future, Await}
import concurrent.duration.Duration
import play.api.libs.iteratee._
import cli.CLI

val enum = Enumerator("test".map(_.toByte).toArray)
val cat = CLI.pipe("cat")
val all = enum &> cat &> cat &> cat |>>> Iteratee.consume[Array[Byte]]()
concurrent.Await.result(all, Duration("2 s")).map(_.toChar).mkString

playCLI doesn't work with playframework master: mapDone is deprecated!

I've just fixed the tests with 9b4c3cf

/cc @ybr: do you want to provide a PR?
Thanks

CLI.pipe lock issue with `convert`

Example: CLI.pipe("convert - png:-")

Bug: the command is never terminated. stdin is written, but nothing is read from the command which is not responding.

[feature] set a timeout to limit a command maximum time

Please release 0.12 to maven central

because README says

"fr.greweb" %% "playcli" % "0.12"

Make broadcast working

Exemple:

val addEchoToOgg = CLI.pipe("sox -t ogg - -t ogg - echo 0.5 0.7 60 1")
val radioStream = proxyBroadcast("http://radio.hbr1.com:19800/ambient.ogg")
val (radioStreamWithEcho, _) = Concurrent.broadcast(radioStream &> addEchoToOgg)

def radio = Action(Ok.stream(radioStreamWithEcho).withHeaders(CONTENT_TYPE -> "audio/ogg"))