mixlib-shellout 3.0.9 → 3.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f397fa01d53b269d311c32ad263372d115735935d637385ac9fc735b504216bd
-  data.tar.gz: c871d5ef88067456dc0b11d2fc3eae6cacaf3a2ccffd90a1b14e15555389301e
+  metadata.gz: 26f12f230e23d828bfaaa639a1655b0ba9bac5e8189f62477d921c872bf6238a
+  data.tar.gz: 0b86d014984d7f34ed2eb87db3d7baddbb9d06f6e4d9168052e30023523bb290
 SHA512:
-  metadata.gz: 00e5a3bd7d562a937d9719f61a8043181a5ab4e6b40ce698dffd1f1fc7ce5cc4376739cadeb259749cce448d84ba559134caf5474e9cede4f4f120fa96b3701f
-  data.tar.gz: 76f80cba51a657c26a978668ecc04d9d96c2b8f6242968b55b022b97642963d7d5f1c2c482357508e46aae1b68dc43317d86ba3e38566b232c29c2d25b635046
+  metadata.gz: 2b13c61d4b9a2a054773159a895d3a9948dfc45a2b8b1e55f471069111129ad0dc45ffd6c93fffe0dbb56bd6559db1adb8206e0919645cd5c864ddb80fb177fe
+  data.tar.gz: 8e3e7eb05d3d9cd875019f049b6482645edc4e19d50bbdb11659ca946b7048278884aa9517d254bcaac273fcfbf7a857e1675e8d77a043a029e3f5ce2a772066

data/lib/mixlib/shellout.rb

@@ -16,8 +16,8 @@
 # limitations under the License.
 #
 
-require "etc"
-require "tmpdir"
+require "etc" unless defined?(Etc)
+require "tmpdir" unless defined?(Dir.mktmpdir)
 require "fcntl"
 require_relative "shellout/exceptions"
 
@@ -65,7 +65,7 @@ module Mixlib
     # as the subprocess is running.
     attr_accessor :live_stderr
 
-    # ShellOut will push data from :input down the stdin of the subprocss.
+    # ShellOut will push data from :input down the stdin of the subprocess.
     # Normally set via options passed to new.
     # Default: nil
     attr_accessor :input
@@ -122,7 +122,7 @@ module Mixlib
     # === Options:
     # If the last argument is a Hash, it is removed from the list of args passed
     # to exec and used as an options hash. The following options are available:
-    # * +user+: the user the commmand should run as. if an integer is given, it is
+    # * +user+: the user the command should run as. if an integer is given, it is
     #   used as a uid. A string is treated as a username and resolved to a uid
     #   with Etc.getpwnam
     # * +group+: the group the command should run as. works similarly to +user+
@@ -248,7 +248,7 @@ module Mixlib
     # running or died without setting an exit status (e.g., terminated by
     # `kill -9`).
     def exitstatus
-      @status && @status.exitstatus
+      @status&.exitstatus
     end
 
     # Run the command, writing the command's standard out and standard error

data/lib/mixlib/shellout/helper.rb

@@ -0,0 +1,197 @@
+#--
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative "../shellout"
+require "chef-utils" unless defined?(ChefUtils)
+require "chef-utils/dsl/default_paths"
+require "chef-utils/internal"
+
+module Mixlib
+  class ShellOut
+    module Helper
+      include ChefUtils::Internal
+      include ChefUtils::DSL::DefaultPaths
+
+      #
+      # These APIs are considered public for use in ohai and chef (by cookbooks and plugins, etc)
+      # but are considered private/experimental for now for the direct users of mixlib-shellout.
+      #
+      # You can see an example of how to handle the "dependency injection" in the rspec unit test.
+      # That backend API is left deliberately undocumented for now and may not follow SemVer and may
+      # break at any time (at least for the rest of 2020).
+      #
+
+      def shell_out(*args, **options)
+        options = options.dup
+        options = __maybe_add_timeout(self, options)
+        if options.empty?
+          shell_out_compacted(*__clean_array(*args))
+        else
+          shell_out_compacted(*__clean_array(*args), **options)
+        end
+      end
+
+      def shell_out!(*args, **options)
+        options = options.dup
+        options = __maybe_add_timeout(self, options)
+        if options.empty?
+          shell_out_compacted!(*__clean_array(*args))
+        else
+          shell_out_compacted!(*__clean_array(*args), **options)
+        end
+      end
+
+      private
+
+      # helper sugar for resources that support passing timeouts to shell_out
+      #
+      # module method to not pollute namespaces, but that means we need self injected as an arg
+      # @api private
+      def __maybe_add_timeout(obj, options)
+        options = options.dup
+        # historically resources have not properly declared defaults on their timeouts, so a default default of 900s was enforced here
+        default_val = 900
+        return options if options.key?(:timeout)
+
+        # FIXME: need to nuke descendent tracker out of Chef::Provider so we can just define that class here without requiring the
+        # world, and then just use symbol lookup
+        if obj.class.ancestors.map(&:name).include?("Chef::Provider") && obj.respond_to?(:new_resource) && obj.new_resource.respond_to?(:timeout) && !options.key?(:timeout)
+          options[:timeout] = obj.new_resource.timeout ? obj.new_resource.timeout.to_f : default_val
+        end
+        options
+      end
+
+      # helper function to mangle options when `default_env` is true
+      #
+      # @api private
+      def __apply_default_env(options)
+        options = options.dup
+        default_env = options.delete(:default_env)
+        default_env = true if default_env.nil?
+        if default_env
+          env_key = options.key?(:env) ? :env : :environment
+          options[env_key] = {
+            "LC_ALL" => __config[:internal_locale],
+            "LANGUAGE" => __config[:internal_locale],
+            "LANG" => __config[:internal_locale],
+            __env_path_name => default_paths,
+          }.update(options[env_key] || {})
+        end
+        options
+      end
+
+      # The shell_out_compacted/shell_out_compacted! APIs are private but are intended for use
+      # in rspec tests.  They should always be used in rspec tests instead of shell_out to allow
+      # for less brittle rspec tests.
+      #
+      # This expectation:
+      #
+      # allow(provider).to receive(:shell_out_compacted!).with("foo", "bar", "baz")
+      #
+      # Is met by many different possible calling conventions that mean the same thing:
+      #
+      # provider.shell_out!("foo", [ "bar", nil, "baz"])
+      # provider.shell_out!(["foo", nil, "bar" ], ["baz"])
+      #
+      # Note that when setting `default_env: false` that you should just setup an expectation on
+      # :shell_out_compacted for `default_env: false`, rather than the expanded env settings so
+      # that the default_env implementation can change without breaking unit tests.
+      #
+      def shell_out_compacted(*args, **options)
+        options = __apply_default_env(options)
+        if options.empty?
+          __shell_out_command(*args)
+        else
+          __shell_out_command(*args, **options)
+        end
+      end
+
+      def shell_out_compacted!(*args, **options)
+        options = __apply_default_env(options)
+        cmd = if options.empty?
+                __shell_out_command(*args)
+              else
+                __shell_out_command(*args, **options)
+              end
+        cmd.error!
+        cmd
+      end
+
+      # Helper for subclasses to reject nil out of an array.  It allows using the array form of
+      # shell_out (which avoids the need to surround arguments with quote marks to deal with shells).
+      #
+      # @param args [String] variable number of string arguments
+      # @return [Array] array of strings with nil and null string rejection
+      #
+      def __clean_array(*args)
+        args.flatten.compact.map(&:to_s)
+      end
+
+      def __shell_out_command(*args, **options)
+        if __transport_connection
+          FakeShellOut.new(args, options, __transport_connection.run_command(args.join(" "))) # FIXME: train should accept run_command(*args)
+        else
+          cmd = if options.empty?
+                  Mixlib::ShellOut.new(*args)
+                else
+                  Mixlib::ShellOut.new(*args, **options)
+                end
+          cmd.live_stream ||= __io_for_live_stream
+          cmd.run_command
+          cmd
+        end
+      end
+
+      def __io_for_live_stream
+        if !STDOUT.closed? && __log.trace?
+          STDOUT
+        else
+          nil
+        end
+      end
+
+      def __env_path_name
+        if ChefUtils.windows?
+          "Path"
+        else
+          "PATH"
+        end
+      end
+
+      class FakeShellOut
+        attr_reader :stdout, :stderr, :exitstatus, :status
+
+        def initialize(args, options, result)
+          @args = args
+          @options = options
+          @stdout = result.stdout
+          @stderr = result.stderr
+          @exitstatus = result.exit_status
+          @status = OpenStruct.new(success?: ( exitstatus == 0 ))
+        end
+
+        def error?
+          exitstatus != 0
+        end
+
+        def error!
+          raise Mixlib::ShellOut::ShellCommandFailed, "Unexpected exit status of #{exitstatus} running #{@args}" if error?
+        end
+      end
+    end
+  end
+end

data/lib/mixlib/shellout/unix.rb

@@ -370,11 +370,11 @@ module Mixlib
         return if attempt_reap
 
         @terminate_reason = "Command exceeded allowed execution time, process terminated"
-        logger.error("Command exceeded allowed execution time, sending TERM") if logger
+        logger&.error("Command exceeded allowed execution time, sending TERM")
         Process.kill(:TERM, child_pgid)
         sleep 3
         attempt_reap
-        logger.error("Command exceeded allowed execution time, sending KILL") if logger
+        logger&.error("Command exceeded allowed execution time, sending KILL")
         Process.kill(:KILL, child_pgid)
         reap
 

data/lib/mixlib/shellout/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   class ShellOut
-    VERSION = "3.0.9".freeze
+    VERSION = "3.1.6".freeze
   end
 end

data/lib/mixlib/shellout/windows.rb

@@ -89,7 +89,7 @@ module Mixlib
           # Start the process
           #
           process, profile, token = Process.create3(create_process_args)
-          logger.debug(format_process(process, app_name, command_line, timeout)) if logger
+          logger&.debug(format_process(process, app_name, command_line, timeout))
           begin
             # Start pushing data into input
             stdin_write << input if input
@@ -124,7 +124,7 @@ module Mixlib
                     kill_process_tree(process.process_id, wmi, logger)
                     Process.kill(:KILL, process.process_id)
                   rescue SystemCallError
-                    logger.warn("Failed to kill timed out process #{process.process_id}") if logger
+                    logger&.warn("Failed to kill timed out process #{process.process_id}")
                   end
 
                   raise Mixlib::ShellOut::CommandTimeout, [
@@ -208,7 +208,7 @@ module Mixlib
       # 4.  if the argument must be quoted by #1 and terminates in a sequence of backslashes then all the backlashes must themselves
       #     be backslash excaped (double the backslashes).
       # 5.  if an interior quote that must be escaped by #2 has a sequence of backslashes before it then all the backslashes must
-      #     themselves be backslash excaped along with the backslash ecape of the interior quote (double plus one backslashes).
+      #     themselves be backslash excaped along with the backslash escape of the interior quote (double plus one backslashes).
       #
       # And to restate.  We are constructing a string which will be parsed by the windows parser into arguments, and we want those
       # arguments to match the *args array we are passed here.  So call the windows parser operation A then we need to apply A^-1 to
@@ -398,20 +398,16 @@ module Mixlib
 
       def kill_process(instance, logger)
         child_pid = instance.wmi_ole_object.processid
-        if logger
-          logger.debug([
+        logger&.debug([
             "killing child process #{child_pid}::",
             "#{instance.wmi_ole_object.Name} of parent #{pid}",
           ].join)
-        end
         Process.kill(:KILL, instance.wmi_ole_object.processid)
       rescue SystemCallError
-        if logger
-          logger.debug([
+        logger&.debug([
             "Failed to kill child process #{child_pid}::",
             "#{instance.wmi_ole_object.Name} of parent #{pid}",
           ].join)
-        end
       end
 
       def format_process(process, app_name, command_line, timeout)

data/lib/mixlib/shellout/windows/core_ext.rb

@@ -21,7 +21,6 @@ require "win32/process"
 
 # Add new constants for Logon
 module Process::Constants
-  private
 
   LOGON32_LOGON_INTERACTIVE = 0x00000002
   LOGON32_LOGON_BATCH = 0x00000004
@@ -148,15 +147,13 @@ module Process
       si_hash = {}
 
       # If the startup_info key is present, validate its subkeys
-      if hash["startup_info"]
-        hash["startup_info"].each do |key, val|
-          key = key.to_s.downcase
-          unless valid_si_keys.include?(key)
-            raise ArgumentError, "invalid startup_info key '#{key}'"
-          end
-
-          si_hash[key] = val
+      hash["startup_info"]&.each do |key, val|
+        key = key.to_s.downcase
+        unless valid_si_keys.include?(key)
+          raise ArgumentError, "invalid startup_info key '#{key}'"
         end
+
+        si_hash[key] = val
       end
 
       # The +command_line+ key is mandatory unless the +app_name+ key

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-shellout
 version: !ruby/object:Gem::Version
-  version: 3.0.9
+  version: 3.1.6
 platform: ruby
 authors:
 - Chef Software Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-30 00:00:00.000000000 Z
-dependencies: []
+date: 2020-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Run external commands on Unix or Windows
 email: info@chef.io
 executables: []
@@ -19,6 +33,7 @@ files:
 - LICENSE
 - lib/mixlib/shellout.rb
 - lib/mixlib/shellout/exceptions.rb
+- lib/mixlib/shellout/helper.rb
 - lib/mixlib/shellout/unix.rb
 - lib/mixlib/shellout/version.rb
 - lib/mixlib/shellout/windows.rb
@@ -34,7 +49,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="