kommando 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21c7dae7504adc6c8d020d36a15040145cb539b2
-  data.tar.gz: 6e13903d3610a520f87759feefbf810b9f60e8ed
+  metadata.gz: 90cd16476bfc79190a5707fa07bd7c6d235f5a04
+  data.tar.gz: 947a4d5c54f2837e2f969bb1ca7ef1de0487a06b
 SHA512:
-  metadata.gz: 20709e235f978d408c0a8b4b0e596a2c3d5b8ebc1dcfe9b3c902737f324450d12423633e4801e12a30b8e29d596bb764a2f6810e0ec80023eb7555b3bb329e70
-  data.tar.gz: 48cb28a22b828a1dd39561b88f9f5bf344453385cbbf4edc304b1e0dba2bbe64279f71a7bcbc19ee8d87d91287474e6f89103e95d1b0065706fa411c8677734b
+  metadata.gz: f1bf07fac67f79fa57574c243cfee2e1da16168d4c9a4ce8b7a8ba65f55f09bf491355af063c64a7a1fbce5dc456b05cce877bbdcc3d4223c2cf6002411bac31
+  data.tar.gz: 069f925a8b7b8c13a2f317a6c9b6ea557b1a21c5aad2b82b3d03d2fe86d0023c33280c78827756a02f8acd102aab2bc6b657346ab93a1d616fa027103fc69168

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 0.0.4
+Writes standard out to file and timeouts.
+
+ - FEAT: Support for command run timeouts with `Kommando.new "ping -c 1 google.com", timeout: 3.5`
+ - FEAT: Write output to file with `Kommando.new "ping -c 1 google.com", output: "path/to/file.txt"`
+ - EXAMPLES: `stdout_to_file` and `timeout` added.
+
 ## 0.0.3
 Outputs to standard out while executing.
 
@@ -14,7 +21,6 @@ Actually useful initial release.
  - EXAMPLES: `ping` and `exit` added.
 
 ## 0.0.1
-
 Initial release.
 
  - FEAT: Runs command without arguments.

data/bin/e2e

@@ -1,17 +1,24 @@
 #!/usr/bin/env ruby
 
 require "./lib/kommando"
+require 'tempfile'
 
 find_examples = Kommando.new "find examples -type f -name *"
 find_examples.run
 
+e2e_output = Tempfile.new
+
 for example in find_examples.out.split("\r\n") do
   print "Running #{example} ".ljust(74, ".")
-  example = Kommando.new "ruby #{example}"
+  example = Kommando.new "ruby #{example}", {
+    output: e2e_output.path
+  }
   example.run
 
-  raise "Example #{example} did not exit cleanly" unless example.code == 0
-
+  unless example.code == 0
+    puts "\n#{File.read(e2e_output.path)}"
+    raise "Example #{example} did not exit cleanly"
+  end
   puts " done"
 end
 

data/bin/stress

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require "./lib/kommando"
+
+def stress iterations
+  iterations.times do |i|
+    k = Kommando.new "rake", {
+      timeout: 10
+    }
+    k.run
+    unless k.code == 0
+      print "!FAILED! waiting for 3 seconds"
+      sleep 3 # wait for sync
+      puts k.out
+      exit 1
+    end
+    print "."
+  end
+end
+
+number_of_threads = if ARGV[0]
+  ARGV[0].to_i
+else
+  3
+end
+
+number_of_iterations = if ARGV[1]
+  ARGV[1].to_i
+else
+  100
+end
+
+puts "starting #{number_of_threads} threads for #{number_of_iterations} iterations"
+
+threads = []
+number_of_threads.times do |i|
+  threads << Thread.new do
+    stress number_of_iterations
+  end
+end
+
+threads.each do |thread|
+  thread.join
+end

data/examples/stdout_to_file.rb

@@ -0,0 +1,20 @@
+require "./lib/kommando"
+require "tempfile"
+
+outfile = Tempfile.new
+
+k = Kommando.new "ping -c 3 127.0.0.1", {
+  output: outfile.path
+}
+
+Thread.abort_on_exception=true
+t = Thread.new do
+  Kommando.new "tail -f #{outfile.path}", {
+    output: true
+  }
+end
+
+k.run
+t.kill
+
+puts File.read outfile.path

data/examples/timeout.rb

@@ -0,0 +1,15 @@
+require "./lib/kommando"
+
+k = Kommando.new "sleep 2", {
+  timeout: 1
+}
+k2 = Kommando.new "sleep 2", {
+  timeout: 1
+}
+
+k.run
+k2.run
+
+if k.code == 1 && k2.code == 1
+  puts "timed out"
+end

data/lib/kommando.rb

@@ -1,4 +1,5 @@
 require "pty"
+require "timeout"
 
 require_relative "kommando/error"
 require_relative "kommando/version"
@@ -10,32 +11,72 @@ class Kommando
     @cmd = cmd
     @stdout = Buffer.new
 
-    @output = opts[:output] == true
+    @output_stdout = opts[:output] == true
+    @output_file = if opts[:output].class == String
+      opts[:output]
+    end
+
+    @timeout = if opts[:timeout].class == Float
+      opts[:timeout]
+    elsif opts[:timeout].class == Fixnum
+      opts[:timeout].to_f
+    end
+
+    @executed = false
   end
 
   def run
+    return false if @executed
+    @executed = true
+
     command, *args = @cmd.split " "
     begin
       PTY.spawn(command, *args) do |stdout, stdin, pid|
-        Thread.abort_on_exception = true
+        stdout_file = File.open @output_file, 'w' if @output_file
 
+        Thread.abort_on_exception = true
         thread_stdout = Thread.new do
           while true do
             break if stdout.eof?
 
             c = stdout.getc
             @stdout.append c if c
-            print c if @output
+            print c if @output_stdout
+            stdout_file.write c if @output_file
           end
         end
-        thread_stdout.join
+
+        thread_did_timeout = nil
+        if @timeout
+          begin
+            Timeout.timeout(@timeout) do
+              thread_stdout.join
+            end
+          rescue Timeout::Error
+            Process.kill('KILL', pid)
+            thread_did_timeout = true
+          end
+        else
+          thread_stdout.join
+        end
+
+        stdout_file.close if @output_file
 
         # http://stackoverflow.com/a/7263243
         Process.wait(pid)
 
-        @code = $?.exitstatus
+        @code = if thread_did_timeout
+          1
+        else
+          $?.exitstatus
+        end
+
+      end
+    rescue RuntimeError => ex
+      if ex.message == "can't get Master/Slave device"
+        #suppress, weird stuff.
       end
-    rescue => ex
+    rescue Errno::ENOENT => ex
       raise Kommando::Error, "Command '#{command}' not found"
     end
 

data/lib/kommando/version.rb

@@ -1,3 +1,3 @@
 class Kommando
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kommando
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Matti Paksula
@@ -101,9 +101,12 @@ files:
 - bin/e2e
 - bin/reinstall
 - bin/setup
+- bin/stress
 - examples/exit.rb
 - examples/live_output.rb
 - examples/ping.rb
+- examples/stdout_to_file.rb
+- examples/timeout.rb
 - examples/uptime.rb
 - kommando.gemspec
 - lib/kommando.rb