cheetah 0.5.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ffad6048946bc9340bf92edbc08b4955a2444da86ed5c029bcf3a2f5b799f78
-  data.tar.gz: d3fc65ea30218372099bf81ab8ab86d4c5a2eb5314faac7c972c5518f910331c
+  metadata.gz: bd4cbe464be1d5ee56434c1a380d958cf0cbcb40095d8f21fcfb3cf7b2320db2
+  data.tar.gz: 3572805d086b24911c1feb6169b5911723a918fcf1ca0547d2f28984e0827ade
 SHA512:
-  metadata.gz: ff33b7ccf7423baf8c8158287be0efd1ad184069a6542f0d945fa493ea04c2a43c98b84e4e6e50f54d119ddb09575cddd0780fdaa7676fff3f9e839539db591c
-  data.tar.gz: f930f40f3eac5de9c611061ea0c3844d47e4c3475a392f4cfb74a3fe4350519eaca35e57eda0a9ef9fead81157d90b2967c14943b599e9d456220ee68a42b72c
+  metadata.gz: 032f86dbf253379e1663e01d03f8a5a013a13829e4bb5b9c3f880d73611a2c92176e51086402b604cfd20a30d28dfa1571766b9fa2e4eb5377e4c12a6bda1b39
+  data.tar.gz: 1ecf8c2ff66d2eef73b658f925bbb5a7c6292861ce4fd52a9f2ed6fab91e49f3ba25fe5cd84f8da294b6340887872c9ef5100f2799fa8f8c319afbcead8ced3e

data/CHANGELOG

@@ -1,3 +1,9 @@
+1.0.0 (2021-11-30)
+------------------
+
+* Add support for ruby 3.0
+  As side effect now Recorder#record_status receive additional parameter
+
 0.5.2 (2020-01-06)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-0.5.2
+1.0.0

data/lib/cheetah/version.rb

@@ -3,5 +3,5 @@
 # Cheetah namespace
 module Cheetah
   # Cheetah version (uses [semantic versioning](http://semver.org/)).
-  VERSION = File.read(File.dirname(__FILE__) + "/../../VERSION").strip
+  VERSION = File.read("#{File.dirname(__FILE__)}/../../VERSION").strip
 end

data/lib/cheetah.rb

@@ -5,7 +5,7 @@ require "logger"
 require "shellwords"
 require "stringio"
 
-require File.expand_path(File.dirname(__FILE__) + "/cheetah/version")
+require File.expand_path("#{File.dirname(__FILE__)}/cheetah/version")
 
 # Your swiss army knife for executing external commands in Ruby safely and
 # conveniently.
@@ -121,6 +121,7 @@ module Cheetah
     #
     #   @abstract
     #   @param [Process::Status] status the executed command exit status
+    #   @param [Boolean] allowed_status whether the exit code is in the list of allowed exit codes
     abstract_method :record_status
   end
 
@@ -135,7 +136,7 @@ module Cheetah
 
     def record_stderr(_stderr);     end
 
-    def record_status(_status);     end
+    def record_status(_status, _allowed_status); end
   end
 
   # A default recorder. It uses the `Logger::INFO` level for normal messages and
@@ -150,6 +151,8 @@ module Cheetah
     }.freeze
 
     def initialize(logger)
+      super()
+
       @logger = logger
 
       @stream_used   = { stdin: false, stdout: false, stderr: false }
@@ -172,19 +175,19 @@ module Cheetah
       log_stream_increment(:stderr, stderr)
     end
 
-    def record_status(status)
+    def record_status(status, allowed_status)
       log_stream_remainder(:stdin)
       log_stream_remainder(:stdout)
       log_stream_remainder(:stderr)
 
-      @logger.send status.success? ? :info : :error,
+      @logger.send allowed_status ? :info : :error,
                    "Status: #{status.exitstatus}"
     end
 
     protected
 
     def format_commands(commands)
-      '"' + commands.map { |c| Shellwords.join(c) }.join(" | ") + '"'
+      "\"#{commands.map { |c| Shellwords.join(c) }.join(' | ')}\""
     end
 
     def log_stream_increment(stream, data)
@@ -402,14 +405,19 @@ module Cheetah
       select_loop(streams, pipes, recorder)
       _pid, status = Process.wait2(pid)
 
-      # when more exit status are allowed, then redefine success as command
-      # not failed (bsc#1153749)
-      adapt_status(status, options)
+      # when more exit status are allowed, then pass it below that it did
+      # not fail (bsc#1153749)
+      success = allowed_status?(status, options)
 
       begin
-        check_errors(commands, status, streams, streamed)
+        report_errors(commands, status, streams, streamed) if !success
       ensure
-        recorder.record_status(status)
+        # backward compatibility for recorders with just single parameter
+        if recorder.method(:record_status).arity == 1
+          recorder.record_status(status)
+        else
+          recorder.record_status(status, success)
+        end
       end
 
       build_result(streams, status, options)
@@ -417,12 +425,11 @@ module Cheetah
 
     private
 
-    def adapt_status(status, options)
-      return unless allowed_exitstatus?(options)
+    def allowed_status?(status, options)
+      exit_status = status.exitstatus
+      return exit_status.zero? unless allowed_exitstatus?(options)
 
-      status.define_singleton_method(:success?) do
-        options[:allowed_exitstatus].include?(exitstatus)
-      end
+      options[:allowed_exitstatus].include?(exit_status)
     end
 
     # Parts of Cheetah.run
@@ -519,51 +526,49 @@ module Cheetah
 
     def fork_commands_recursive(commands, pipes, options)
       fork do
-        begin
-          # support chrooting
-          options = chroot_step(options)
-
-          if commands.size == 1
-            from_pipe(STDIN, pipes[:stdin])
-          else
-            pipe_to_child = IO.pipe
-
-            fork_commands_recursive(commands[0..-2],
-                                    {
-                                      stdin: pipes[:stdin],
-                                      stdout: pipe_to_child,
-                                      stderr: pipes[:stderr]
-                                    },
-                                    options)
-
-            pipes[:stdin][READ].close
-            pipes[:stdin][WRITE].close
-
-            from_pipe(STDIN, pipe_to_child)
-          end
+        # support chrooting
+        options = chroot_step(options)
 
-          into_pipe(STDOUT, pipes[:stdout])
-          into_pipe(STDERR, pipes[:stderr])
+        if commands.size == 1
+          from_pipe($stdin, pipes[:stdin])
+        else
+          pipe_to_child = IO.pipe
 
-          close_fds
+          fork_commands_recursive(commands[0..-2],
+                                  {
+                                    stdin: pipes[:stdin],
+                                    stdout: pipe_to_child,
+                                    stderr: pipes[:stderr]
+                                  },
+                                  options)
 
-          command, *args = commands.last
-          with_env(options[:env]) do
-            exec([command, command], *args)
-          end
-        rescue SystemCallError => e
-          # depends when failed, if pipe is already redirected or not, so lets find it
-          output = pipes[:stderr][WRITE].closed? ? STDERR : pipes[:stderr][WRITE]
-          output.puts e.message
+          pipes[:stdin][READ].close
+          pipes[:stdin][WRITE].close
+
+          from_pipe($stdin, pipe_to_child)
+        end
 
-          exit!(127)
+        into_pipe($stdout, pipes[:stdout])
+        into_pipe($stderr, pipes[:stderr])
+
+        close_fds
+
+        command, *args = commands.last
+        with_env(options[:env]) do
+          exec([command, command], *args)
         end
+      rescue SystemCallError => e
+        # depends when failed, if pipe is already redirected or not, so lets find it
+        output = pipes[:stderr][WRITE].closed? ? $stderr : pipes[:stderr][WRITE]
+        output.puts e.message
+
+        exit!(127)
       end
     end
 
     # closes all open fds starting with 3 and above
     def close_fds
-      # note: this will work only if unix has /proc filesystem. If it does not
+      # NOTE: this will work only if unix has /proc filesystem. If it does not
       # have it, it won't close other fds.
       Dir.glob("/proc/self/fd/*").each do |path|
         fd = File.basename(path).to_i
@@ -655,7 +660,7 @@ module Cheetah
       end
     end
 
-    def check_errors(commands, status, streams, streamed)
+    def report_errors(commands, status, streams, streamed)
       return if status.success?
 
       stderr_part = if streamed[:stderr]
@@ -664,7 +669,7 @@ module Cheetah
                       " (no error output)"
                     else
                       lines = streams[:stderr].string.split("\n")
-                      ": " + lines.first + (lines.size > 1 ? " (...)" : "")
+                      ": #{lines.first}#{lines.size > 1 ? ' (...)' : ''}"
                     end
 
       raise ExecutionFailed.new(
@@ -707,7 +712,7 @@ module Cheetah
     end
 
     def format_commands(commands)
-      '"' + commands.map { |c| Shellwords.join(c) }.join(" | ") + '"'
+      "\"#{commands.map { |c| Shellwords.join(c) }.join(' | ')}\""
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheetah
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0
 platform: ruby
 authors:
 - David Majda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract_method
@@ -77,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
 summary: Your swiss army knife for executing external commands in Ruby safely and