long-command-runner 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f6d2038cb89e937c4338cb47e4e3cbbd63e6df288ce146c56cdedaf9cd4e669
-  data.tar.gz: 12dae9fedb930a911813dd69aa06efc30d6beda0f70c3a5ed902afd657818923
+  metadata.gz: 732ddcf74afb4d4a3f7e5990e4761e4fabbea37824890c98e8cc236c3339a317
+  data.tar.gz: 3209440517bcfcb93e020e01a3484e029487af1e61b95e86d932db6c27b30c7e
 SHA512:
-  metadata.gz: 66a47ff6f6de3d987b5192aad839b2dccf44c5f132c6066e9430e0b0ea8ef8598bb84644936bf7b7c61c166367493a6b06d8a17ae020104a8c2d85168df24a1c
-  data.tar.gz: 230c0b1ad2803be4f3b267f6724482715bf4bc8403dbe45d3731aa156289c26dff61e73df93c62913e6aa38a106150c45bf9723773c0ef467c53c2ba1b417294
+  metadata.gz: ac8cc65bf6dfc634469ca90d9312183aa17c7ec3d7d6649bddfc505879babbf0adadc503124a384d6fe3d78aa335d2d90e230bdfb7cf1d8670bfae04496efd6e
+  data.tar.gz: 004ca4095874c144356593c7ceedef1c8a3983b2f6a5fbf18cfd0da5ca154fac670bc64cc81acf22644a5e5603e47a026fb1231c96b69c0cfdf1bf4644e86f19

data/README.md

@@ -12,8 +12,7 @@ the CPU usage and the progression of the program.
 ## Currently (what we have)
 - monitoring of the progression of the application through the output of the app
     (I don't think that we can do better)
-- get the real/user/sys time usage of the application by using the output of the `time` `bash` function.
-    (This make it incompatible with system that doesn't support ouput redirections and bash itself)
+- get the real/user/sys time usage of the application by using the lib Benchmark of ruby.
 
 ## v1 goal
 

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

@@ -5,6 +5,9 @@ require 'open3'
 module LCR
   # This class aims to contain the runing script.
   class Container
+    # The expected Language environment:
+    ENVIRONMENT = 'LANGUAGE=en'
+
     # Get the standard input IO of the process.
     #
     # @note Be aware that it may be closed by the process (on  exit), or by you.
@@ -34,7 +37,8 @@ module LCR
     # @param [String] command The command to execute.
     # @param [Hash] opts The option to pass to Open3.popen3.
     def initialize(command, opts = {})
-      @stdin, @stdout, @stderr, @wait_thr = Open3.popen3(command, opts)
+      safe_command = quote_sanitize(command)
+      @stdin, @stdout, @stderr, @wait_thr = Open3.popen3("#{ENVIRONMENT} bash -c \"#{safe_command}\"", opts)
     end
 
     # Is the last launched command is still running.
@@ -64,5 +68,11 @@ module LCR
     def pid
       @wait_thr.pid
     end
+
+    private
+
+    def quote_sanitize(cmd)
+      cmd.gsub(/(["])/, '\\"')
+    end
   end
 end

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

@@ -1,6 +1,7 @@
 #  frozen_string_literal: true
 
 require 'open3'
+require 'benchmark'
 
 module LCR
   # This class aims to manage an external process through a parallele excecution thread.
@@ -14,15 +15,11 @@ module LCR
   class Runner
     # The constant used to get the percetange of completion of the command.
     PERCENT_INDICATOR = /(.*\s|^)((\d+)([,.]\d*)?)%.*/.freeze
-    # The constant to match a `time -p` output:
-    TIMES_INDICATORS = /\A(real|user|sys)\s+(\d+[\.,]\d\d)\z/.freeze
-    # The expected Language environment:
-    ENVIRONMENT = 'LC_ALL=C.UTF-8 LANGUAGE=en'
 
     # 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
+    attr_reader :progress, :tms
 
     # Initializer takes the command as a plain string.
     # You can optionaly pass a block that will be called when the command generate
@@ -39,7 +36,7 @@ module LCR
       @launch_lock = Mutex.new
       @on_input = on_input
       @progress = 0.0
-      @times = { real: nil, user: nil, sys: nil }
+      @tms = nil
     end
 
     # Is the last launched command is still running.
@@ -56,13 +53,17 @@ module LCR
 
     # Actually launch the process.
     def launch
-      stderr, stderr_in = IO.pipe
-      @container = Container.new("#{ENVIRONMENT} bash -c 'time -p #{@command} 2>&3'", 3 => stderr_in)
-      @line_reader = LineReader.new([@container.stdout, stderr, @container.stderr]) do |*new_lines|
+      @bench_thread = Thread.new do
+        @tms = Benchmark.measure do
+          @container = Container.new(@command)
+          @container.wait
+        end
+      end
+      Thread.pass while @container.nil?
+      @line_reader = LineReader.new([@container.stdout, @container.stderr]) do |*new_lines|
         on_newline(*new_lines)
       end
       @reader_thr = Thread.new { @line_reader.read }
-      stderr_in.close
       Thread.pass
     end
 
@@ -98,9 +99,10 @@ module LCR
     #
     # @return [Process::Status]
     def wait
-      p = @container.wait
+      @bench_thread.join
+      @reader_thr.join
       sleep 0.01 until @line_reader.streams.all?(&:eof?)
-      p
+      @container.status
     end
 
     # Get the status of the process without blocking.
@@ -125,35 +127,37 @@ module LCR
       nil
     end
 
-    # Get the time really spend ('real' part of `time` command)
-    #
-    # @return [Float | nil] The elapsed seconds (using POSIX.2 standard see `time -p` for more information)
-    #   if the Process isn't finished it return nil.
+    # Old get the time really spend ('real' part of `time` command)
+    # DEPRECATED: use tms access now.
     def time_real
-      @times[:real]
+      warn '[DEPRECATION] use :tms instead of :time_real'
+      return nil if @tms.nil?
+
+      @tms.real
     end
 
-    # Get the time in user space spend ('user' part of `time` command)
-    #
-    # @return [Float | nil] The elapsed seconds (using POSIX.2 standard see `time -p` for more information)
-    #   if the Process isn't finished it return nil.
+    # Old get the time in user space spend ('user' part of `time` command)
+    # DEPRECATED: use tms access now.
     def time_user
-      @times[:user]
+      warn '[DEPRECATION] use :tms instead of :time_user'
+      return nil if @tms.nil?
+
+      @tms.cutime + @tms.utime
     end
 
-    # Get the time system space spend ('sys' part of `time` command)
-    #
-    # @return [Float | nil] The elapsed seconds (using POSIX.2 standard see `time -p` for more information)
-    #   if the Process isn't finished it return nil.
+    # old get the time system space spend ('sys' part of `time` command)
+    # DEPRECATED: use tms access now.
     def time_sys
-      @times[:sys]
+      warn '[DEPRECATION] use :tms instead of :time_user'
+      return nil if @tms.nil?
+
+      @tms.cstime + @tms.stime
     end
 
     private
 
-    def on_newline(nl_stdout, nl_stderr, nl_time)
+    def on_newline(nl_stdout, nl_stderr)
       manage_progress(nl_stdout) unless nl_stdout.nil?
-      manage_time(nl_time) unless nl_time.nil?
       @on_input&.call(nl_stdout, nl_stderr)
     end
 
@@ -163,12 +167,5 @@ module LCR
 
       @progress = match[2].to_f
     end
-
-    def manage_time(new_line)
-      match = new_line.match TIMES_INDICATORS
-      return unless match
-
-      @times[match[1].to_sym] = match[2].to_f
-    end
   end
 end

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

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

metadata

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