Cross-platform Ruby library for managing child processes.
Cross-platform Ruby library for managing child processes.
This gem aims at being a simple and reliable solution for controlling external programs running in the background on any Ruby / OS combination.
The code originated in the selenium-webdriver gem, but should prove useful as a standalone library.
The object returned from ChildProcess.build will implement ChildProcess::AbstractProcess.
……Note that if you just want to get the output of a command, the backtick method on Kernel may be a better fit.
process = ChildProcess.build("cat")
out = Tempfile.new("duplex")
out.sync = true
process.io.stdout = process.io.stderr = out
process.duplex = true # sets up pipe so process.io.stdin will be available after .start
process.start
process.io.stdin.puts "hello world"
process.io.stdin.close
process.poll_for_exit(exit_timeout_in_seconds)
out.rewind
out.read #=> "hello world\n"search = ChildProcess.build("grep", '-E', %w(redis memcached).join('|'))
search.duplex = true # sets up pipe so search.io.stdin will be available after .start
search.io.stdout = $stdout
search.start
listing = ChildProcess.build("ps", "aux")
listing.io.stdout = search.io.stdin
listing.start
listing.wait
search.io.stdin.close
search.waitBy default, the child process does not create a new process group. This means there's no guarantee that the entire process tree will die when the child process is killed. To solve this:
process = ChildProcess.build(*args)
process.leader = true
process.startprocess = ChildProcess.build("sleep", "10")
process.detach = true
process.startAs opposed to Kernel#system, Kernel#exec et al., ChildProcess will not automatically execute your command in a shell (like /bin/sh or cmd.exe) depending on the arguments.
This means that if you try to execute e.g. gem executables (like bundle or gem) or Windows executables (with .com or .bat extensions) you may see a ChildProcess::LaunchError.
You can work around this by being explicit about what interpreter to invoke:
ChildProcess.build("cmd.exe", "/c", "bundle")
ChildProcess.build("ruby", "-S", "bundle")Errors and debugging information are logged to $stderr by default but a custom logger can be used instead.
logger = Logger.new('logfile.log')
logger.level = Logger::DEBUG
ChildProcess.logger = loggerENV["PATH"] before using childprocess could lead to 'Command not found' errors, since JRuby is unable to modify the environment used for PATH searches in java.lang.ProcessBuilder. This can be avoided by setting ChildProcess.posix_spawn = true.--add-opens java.base/java.io=org.jruby.dist and --add-opens java.base/sun.nio.ch=org.jruby.dist to the JAVA_OPTS environment variable that is used by JRuby when launching the JVM.ChildProcess 5+ uses Process.spawn from the Ruby core library for maximum portability.
git checkout -b my-new-feature devgit commit -am 'Add some feature'git push origin my-new-featureWhen publishing a new gem release:
dev branchdev branch into master: git checkout master && git merge devmaster branchmaster branch: git checkout master && gem build childprocess.gemspecgem push childprocess-.gemgit tag -a Copyright (c) 2010-2015 Jari Bakken. See LICENSE for details.
No open issues yet, or sync has not completed.