long-command-runner 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 732ddcf74afb4d4a3f7e5990e4761e4fabbea37824890c98e8cc236c3339a317
-  data.tar.gz: 3209440517bcfcb93e020e01a3484e029487af1e61b95e86d932db6c27b30c7e
+  metadata.gz: 52ed0ae54876241ebf67b4fad432492782745247b45f69ac2815eb3f1a24ed3c
+  data.tar.gz: 5394c9c043976a7842aa1201a3e76d09dbd849212641181a8220b320efc2b604
 SHA512:
-  metadata.gz: ac8cc65bf6dfc634469ca90d9312183aa17c7ec3d7d6649bddfc505879babbf0adadc503124a384d6fe3d78aa335d2d90e230bdfb7cf1d8670bfae04496efd6e
-  data.tar.gz: 004ca4095874c144356593c7ceedef1c8a3983b2f6a5fbf18cfd0da5ca154fac670bc64cc81acf22644a5e5603e47a026fb1231c96b69c0cfdf1bf4644e86f19
+  metadata.gz: dde08e22ddb8396d3d3dd97dc115fad4b8034cf89c5d1042de489fd52fe4e392a72d00bfdb453039db70f247dd4bc008f58863bfa38e87239a3c756ce3ed063a
+  data.tar.gz: f89f3c02c3e055cb69714e2a267628dc9773d8d00eb061f774e9015527f631b0e479e8b737fac5471fc63b1368207b1f52c82a733ccd18ba890aa235948ac456

data/lib/long-command-runner/container.rb

@@ -6,7 +6,7 @@ module LCR
   # This class aims to contain the runing script.
   class Container
     # The expected Language environment:
-    ENVIRONMENT = 'LANGUAGE=en'
+    ENVIRONMENT = { 'LANGUAGE' => 'en' }.freeze
 
     # Get the standard input IO of the process.
     #
@@ -38,7 +38,7 @@ module LCR
     # @param [Hash] opts The option to pass to Open3.popen3.
     def initialize(command, opts = {})
       safe_command = quote_sanitize(command)
-      @stdin, @stdout, @stderr, @wait_thr = Open3.popen3("#{ENVIRONMENT} bash -c \"#{safe_command}\"", opts)
+      @stdin, @stdout, @stderr, @wait_thr = Open3.popen3(ENVIRONMENT, "bash -c \"#{safe_command}\"", opts)
     end
 
     # Is the last launched command is still running.
@@ -69,6 +69,13 @@ module LCR
       @wait_thr.pid
     end
 
+    def children
+      get_children = lambda do |pid|
+        `pgrep -P #{pid}`.split("\n").map { |c_pid| [c_pid.to_i, get_children.call(c_pid)] }.to_h
+      end
+      get_children.call(pid)
+    end
+
     private
 
     def quote_sanitize(cmd)

data/lib/long-command-runner/line_reader.rb

@@ -29,11 +29,9 @@ module LCR
     end
 
     # access to the array of streams.
-    # The intance variable is duplicated to prevent modification of the array.
+    # Be carefull accessing these, because you may prevent line_reader to run correctly.
     # @return [Array<IO>]
-    def streams
-      @streams.dup
-    end
+    attr_reader :streams
 
     # Blocking method to read on the streams (you may call it in a dedicated thread).
     #
@@ -103,7 +101,7 @@ module LCR
       # puts "read_on(buffers:#{buffers}, streams_lines:#{stream_newlines}, io:#{io}, line:#{line})"
       if io.eof?
         stream_newlines[line] = [buffers[line]] unless buffers[line].nil?
-        # buffers[line] = ''
+        buffers[line] = nil
         return false
       end
       r = io.read_nonblock(MAX_READ_CHAR)

data/lib/long-command-runner/runner.rb

@@ -16,12 +16,18 @@ module LCR
     # The constant used to get the percetange of completion of the command.
     PERCENT_INDICATOR = /(.*\s|^)((\d+)([,.]\d*)?)%.*/.freeze
 
-    # Get the mesured progress in percentage.
+    # [Float] Get the mesured progress in percentage.
     # This is just the result of parsing stdout lines with {PERCENT_INDICATOR}.
     # So this percentage is comming from the thread not this library.
-    attr_reader :progress, :tms
+    attr_reader :progress
+    # [Benchmark::Tms] The time mesured of execution in the runner thread.
+    attr_reader :tms
 
     # Initializer takes the command as a plain string.
+    # @param [String] command The command to run (can be a one-line shell script)
+    # @option opts [Boolean] :do_progress_on Set to `'stderr'`, if you want to use
+    #   stderr to get the progression percentage instead of the default: `'stdout'`.
+    #   Any other value will deactivate the feature.
     # You can optionaly pass a block that will be called when the command generate
     # outputs:
     # @yield [nl_stdout, nl_stderr] call when at least a line comes on stdout or stderr.
@@ -30,13 +36,14 @@ module LCR
     # @yieldparam [String | nil] nl_stderr The new line without the return line character.
     #   This may be nil if only a new line has been found on stdout.
     # @yieldreturn [void] It is ignored.
-    def initialize(command, &on_input)
+    def initialize(command, opts = {}, &on_input)
       @command = command
       @container = nil
       @launch_lock = Mutex.new
       @on_input = on_input
       @progress = 0.0
       @tms = nil
+      @do_progress_on = opts[:do_progress_on] || 'stdout'
     end
 
     # Is the last launched command is still running.
@@ -122,13 +129,14 @@ module LCR
     def kill(signal)
       return nil if @container.nil?
 
-      Process.kill(signal, @container.pid)
+      children = @container.children
+      Runner.kill_children(signal, @container.pid, children)
     rescue Errno::ESRCH
       nil
     end
 
     # Old get the time really spend ('real' part of `time` command)
-    # DEPRECATED: use tms access now.
+    # DEPRECATED: use tms.real access now.
     def time_real
       warn '[DEPRECATION] use :tms instead of :time_real'
       return nil if @tms.nil?
@@ -136,28 +144,46 @@ module LCR
       @tms.real
     end
 
-    # Old get the time in user space spend ('user' part of `time` command)
-    # DEPRECATED: use tms access now.
+    # Get the total time spent in user space (sum of tms.cutime + tms.utime)
     def time_user
-      warn '[DEPRECATION] use :tms instead of :time_user'
       return nil if @tms.nil?
 
       @tms.cutime + @tms.utime
     end
 
-    # old get the time system space spend ('sys' part of `time` command)
-    # DEPRECATED: use tms access now.
+    # Get the total time spent in system space (sum of tms.cstime + tms.stime)
     def time_sys
-      warn '[DEPRECATION] use :tms instead of :time_user'
       return nil if @tms.nil?
 
       @tms.cstime + @tms.stime
     end
 
+    def self.dead?(pid)
+      Process.kill(0, pid)
+      false
+    rescue Errno::ESRCH
+      true
+    end
+
+    def self.kill_children(signal, pid, children)
+      n = Process.kill(signal, pid)
+      sleep 0.1
+      children.keys.reject { |c_pid| dead? c_pid }.each do |c_pid|
+        # the not dead
+        n += kill_children(signal, c_pid, children[c_pid])
+      end
+      n
+    end
+
     private
 
     def on_newline(nl_stdout, nl_stderr)
-      manage_progress(nl_stdout) unless nl_stdout.nil?
+      nl_progress = if @do_progress_on == 'stdout'
+                      nl_stdout
+                    elsif @do_progress_on == 'stderr'
+                      nl_stderr
+                    end
+      manage_progress(nl_progress) unless nl_progress.nil?
       @on_input&.call(nl_stdout, nl_stderr)
     end
 

data/lib/long-command-runner/version.rb

@@ -2,5 +2,5 @@
 
 module LCR
   # Version of the library.
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: long-command-runner
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Roland Laurès
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry