libis-tools 0.9.60 → 0.9.62

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 849924a2ded64d5bdf008c008bfef08c7147ed86
-  data.tar.gz: de30bd5fdb3957bfb2065859be5dfbe21acf211a
+  metadata.gz: a2464bf3e02e56791cd56ff6c266ab875fec58b5
+  data.tar.gz: cbef32af7fde215e0b7cf2b3e8f1ca4d0c5609b9
 SHA512:
-  metadata.gz: c38376b193fa67a9258bb1ee42e3635627a10e1b271946f134b2a425eb86bd154e29603de52f15e1c22126042afd104f220a4f5ff65606a702a8b040b90aac99
-  data.tar.gz: 77a2529dc92b94c6cc8395363cd3ea133a9ccdc1c8061f6164f28917aed932a84f600675f5b229ed989ac109ea684e2a5cbdfecef73fa884bd36b900669f48f4
+  metadata.gz: 94c9e9154bfdb7b56ef646dded3b31031f8011c01a1cfd9e6f15e23349a680bcecb984734da1a383663993e0ae69c36b066f9b71364d4b39842645cd33e65e47
+  data.tar.gz: d67f4c5487a564cf9d24a55fd500017706d669caa3b7d7667ddf2767e3f4430d99051993073531cbad57a053f52be0860097cd94b2ed66947f90d58d18f8c1ea

data/lib/libis/tools/command.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require 'open3'
+require 'timeout'
 
 module Libis
   module Tools
@@ -10,6 +10,17 @@ module Libis
     # * :out => an array with lines that were printed on the external program's standard out.
     # * :err => an array with lines that were printed on the external program's standard error.
     # * :status => exit code returned by the external program.
+    # * :timeout => true if the command was terminated due to a timeout.
+    # * :pid => pid of the command (in case <pid>.log files need to be cleaned up)
+    #
+    # Optionally an option hash can be appended to the list of arguments with:
+    # * :stdin_data => values sent to the command's standard input (optional, nothing sent if not present)
+    # * :binmode => if present and true, will set the IO communication to binary data
+    # * :timeout => if specified, SIGTERM signal is sent to the command after the number of seconds
+    # * :signal => Signal sent to the command instead of the default SIGTERM
+    # * :kill_after => if specified, SIGKILL signal is sent aftern the number of seconds if command is still running
+    #             after initial signal was sent
+    # * any other options will be handed over to the spawn command (e.g. pgroup)
     #
     # Examples:
     #
@@ -30,32 +41,92 @@ module Libis
       # Run an external program and return status, stdout and stderr.
       #
       #
-      # @param [String] cmd program name
-      # @param [Array<String>] opts optional list of command line arguments
+      # @param [Array<String>] cmd command name optionally prepended with env and appended with command-line arguments
       # @return [Hash] a Hash with:
       #         * :status (Integer) - the exit status of the command
       #         * :out (Array<String>) - the stdout output of the command
       #         * :err (Array<String>)- the stderr output of the command
-      def self.run(cmd, *opts)
+      #         * :timeout(Boolean) - if true, the command did not return in time
+      #         * :pid(Integer) - the command's processID
+      def self.run(*cmd)
+
+        spawn_opts = Hash === cmd.last ? cmd.pop.dup : {}
+        opts = {
+            :stdin_data => spawn_opts.delete(:stdin_data) || '',
+            :binmode => spawn_opts.delete(:binmode) || false,
+            :timeout => spawn_opts.delete(:timeout),
+            :signal => spawn_opts.delete(:signal) || :TERM,
+            :kill_after => spawn_opts.delete(:kill_after),
+        }
+        in_r, in_w = IO.pipe
+        out_r, out_w = IO.pipe
+        err_r, err_w = IO.pipe
+        in_w.sync = true
+
+        if opts[:binmode]
+          in_w.binmode
+          out_r.binmode
+          err_r.binmode
+        end
+
+        spawn_opts[:in] = in_r
+        spawn_opts[:out] = out_w
+        spawn_opts[:err] = err_w
+
         result = {
-            status: 999,
-            out: [],
-            err: []
+            :pid => nil,
+            :status => nil,
+            :out => [],
+            :err => [],
+            :timeout => false,
         }
+
+        out_reader = nil
+        err_reader = nil
+        wait_thr = nil
+
         begin
-          output, error, status = Open3.capture3(cmd, *opts)
-          result[:out] = output.split("\n").map(&:chomp)
-          result[:err] = error.split("\n").map(&:chomp)
-          result[:status] = status.exitstatus
+          Timeout.timeout(opts[:timeout]) do
+            result[:pid] = spawn(*cmd, spawn_opts)
+            wait_thr = Process.detach(result[:pid])
+            in_r.close
+            out_w.close
+            err_w.close
+
+            out_reader = Thread.new {out_r.read}
+            err_reader = Thread.new {err_r.read}
+
+            in_w.write opts[:stdin_data]
+            in_w.close
+
+            result[:status] = wait_thr.value
+          end
+
+        rescue Timeout::Error
+          result[:timeout] = true
+          pid = spawn_opts[:pgroup] ? -result[:pid] : result[:pid]
+          Process.kill(opts[:signal], pid)
+          if opts[:kill_after]
+            unless wait_thr.join(opts[:kill_after])
+              Process.kill(:KILL, pid)
+            end
+          end
 
         rescue StandardError => e
           result[:err] = [e.class.name, e.message]
 
+        ensure
+          result[:status] = wait_thr.value.exitstatus if wait_thr
+          result[:out] += out_reader.value.split("\n").map(&:chomp) if out_reader
+          result[:err] += err_reader.value.split("\n").map(&:chomp) if err_reader
+          out_r.close unless out_r.closed?
+          err_r.close unless err_r.closed?
         end
 
         result
 
       end
+
     end
 
   end

data/lib/libis/tools/mets_file.rb

@@ -240,11 +240,7 @@ module Libis
 
       def get_id(klass)
         self.mutex.synchronize do
-          if @id_map[klass]
-            @id_map[klass] += 1
-          else
-            @id_map[klass] = 1
-          end
+          @id_map[klass] = (@id_map[klass] ? @id_map[klass] + 1 : 1)
           return @id_map[klass]
         end
       end

data/lib/libis/tools/mets_objects.rb

@@ -1,4 +1,5 @@
 require 'libis/tools/thread_safe'
+require 'uri'
 
 module Libis
   module Tools
@@ -280,9 +281,9 @@ module Libis
               compositionLevel: composition_level,
               # fileLocationType: 'FILE',
               # fileLocation: '',
-              fileOriginalName: orig_name,
-              fileOriginalPath: orig_path,
-              fileOriginalID: location,
+              fileOriginalName: URI.encode(orig_name),
+              fileOriginalPath: URI.encode(orig_path),
+              fileOriginalID: URI.encode(location),
               fileExtension: ::File.extname(orig_name),
               fileMIMEType: mimetype,
               fileSizeBytes: size,

data/lib/libis/tools/version.rb

@@ -1,5 +1,5 @@
 module Libis
   module Tools
-    VERSION = '0.9.60'
+    VERSION = '0.9.62'
   end
 end

data/spec/command_spec.rb

@@ -61,4 +61,27 @@ describe 'Command' do
 
   end
 
+  it 'should allow to supply input data' do
+
+    result = Libis::Tools::Command.run('cat', stdin_data: "FooBar", timeout: 1)
+    expect(result[:out]).to eq ['FooBar']
+    expect(result[:err].size).to eq 0
+    expect(result[:status]).to eq 0
+
+  end
+
+  it 'should not timeout if command finishes' do
+
+    result = Libis::Tools::Command.run('cat', stdin_data: "FooBar", timeout: 1)
+    expect(result[:timeout]).to be_falsey
+
+  end
+
+  it 'should timeout if command hangs' do
+
+    result = Libis::Tools::Command.run('ls', '-aRlp', '/', timeout: 1)
+    expect(result[:timeout]).to be_truthy
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libis-tools
 version: !ruby/object:Gem::Version
-  version: 0.9.60
+  version: 0.9.62
 platform: ruby
 authors:
 - Kris Dekeyser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler