mixlib-shellout 3.0.4-universal-mingw32 → 3.1.2-universal-mingw32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68567052a253b4c6bba0f3ff4c884402a41dd3175a00a3a4cef1d9fab8ca753a
-  data.tar.gz: ca9b2511628cb6655397abf24ea39a9d49a7c72f5550708e1daa2fe553328e91
+  metadata.gz: ff0d68faea99e58c39edacd851b596bfd5a39d53fb778b9e12da8abb3bab8a46
+  data.tar.gz: b9e6f5efb5f63c8767dda3f47b46fac20829dc7bfd6de35c3317d5f02fe98652
 SHA512:
-  metadata.gz: 215b9612e24919b285530b202cb3e62ab27436f82fb5cb95efc0bccfc4538794800c57c88a66cfab978479c3718d5b9d5fa40de43833fd05c61a8a769831c571
-  data.tar.gz: 40458ab0286b067c4811be58fa4ad4c93568f25c5ca036137023690588c0b65e84f2f8dd034e0b0dc1f7070113305a6a262242207cab0eb8f9c53b38ffa125fe
+  metadata.gz: ba31783f95a5db34698906f43591e649eb1615e1eee536f94e61f27e87622aed9e1b7714c9c00602d64e529ccd8b9d7db2061525d7142ded0580b6760cbbca28
+  data.tar.gz: bdf404d7c0ab0ce145170428388c5a02994cea8088a880fc2a71865896fdc75c9b562bc65eb9131e855dd0bf8190e30a6553c246fb5eb2863723e0f786560ae8

data/lib/mixlib/shellout.rb

@@ -19,7 +19,7 @@
 require "etc"
 require "tmpdir"
 require "fcntl"
-require "mixlib/shellout/exceptions"
+require_relative "shellout/exceptions"
 
 module Mixlib
 
@@ -29,10 +29,10 @@ module Mixlib
     DEFAULT_READ_TIMEOUT = 600
 
     if RUBY_PLATFORM =~ /mswin|mingw32|windows/
-      require "mixlib/shellout/windows"
+      require_relative "shellout/windows"
       include ShellOut::Windows
     else
-      require "mixlib/shellout/unix"
+      require_relative "shellout/unix"
       include ShellOut::Unix
     end
 
@@ -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
@@ -210,15 +210,17 @@ module Mixlib
     # TODO migrate to shellout/unix.rb
     def uid
       return nil unless user
-      user.kind_of?(Integer) ? user : Etc.getpwnam(user.to_s).uid
+
+      user.is_a?(Integer) ? user : Etc.getpwnam(user.to_s).uid
     end
 
     # The gid that the subprocess will switch to. If the group attribute is
     # given as a group name, it is converted to a gid by Etc.getgrnam
     # TODO migrate to shellout/unix.rb
     def gid
-      return group.kind_of?(Integer) ? group : Etc.getgrnam(group.to_s).gid if group
+      return group.is_a?(Integer) ? group : Etc.getgrnam(group.to_s).gid if group
       return Etc.getpwuid(uid).gid if using_login?
+
       nil
     end
 
@@ -231,6 +233,7 @@ module Mixlib
     # results when the command exited with an unexpected status.
     def format_for_exception
       return "Command execution failed. STDOUT/STDERR suppressed for sensitive resource" if sensitive
+
       msg = ""
       msg << "#{@terminate_reason}\n" if @terminate_reason
       msg << "---- Begin output of #{command} ----\n"
@@ -363,6 +366,7 @@ module Mixlib
       if login && !user
         raise InvalidCommandOption, "cannot set login without specifying a user"
       end
+
       super
     end
   end

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"
+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 "dependenecy 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.tty? && !__config[:daemon] && __log.debug?
+          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

@@ -53,14 +53,16 @@ module Mixlib
       # to the user's secondary groups
       def sgids
         return nil unless using_login?
+
         user_name = Etc.getpwuid(uid).name
-        all_seconderies.select { |g| g.mem.include?(user_name) }.map { |g| g.gid }
+        all_seconderies.select { |g| g.mem.include?(user_name) }.map(&:gid)
       end
 
       # The environment variables that are deduced from simulating logon
       # Only valid if login is used
       def logon_environment
         return {} unless using_login?
+
         entry = Etc.getpwuid(uid)
         # According to `man su`, the set fields are:
         #  $HOME, $SHELL, $USER, $LOGNAME, $PATH, and $IFS
@@ -269,6 +271,7 @@ module Mixlib
       # Keep this unbuffered for now
       def write_to_child_stdin
         return unless input
+
         child_stdin << input
         child_stdin.close # Kick things off
       end
@@ -337,7 +340,7 @@ module Mixlib
           set_cwd
 
           begin
-            command.kind_of?(Array) ? exec(*command, close_others: true) : exec(command, close_others: true)
+            command.is_a?(Array) ? exec(*command, close_others: true) : exec(command, close_others: true)
 
             raise "forty-two" # Should never get here
           rescue Exception => e
@@ -365,6 +368,7 @@ module Mixlib
 
       def reap_errant_child
         return if attempt_reap
+
         @terminate_reason = "Command exceeded allowed execution time, process terminated"
         logger.error("Command exceeded allowed execution time, sending TERM") if logger
         Process.kill(:TERM, child_pgid)

data/lib/mixlib/shellout/version.rb

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

data/lib/mixlib/shellout/windows.rb

@@ -19,7 +19,7 @@
 #
 
 require "win32/process"
-require "mixlib/shellout/windows/core_ext"
+require_relative "windows/core_ext"
 
 module Mixlib
   class ShellOut
@@ -88,7 +88,7 @@ module Mixlib
           #
           # Start the process
           #
-          process, profile, token = Process.create(create_process_args)
+          process, profile, token = Process.create3(create_process_args)
           logger.debug(format_process(process, app_name, command_line, timeout)) if logger
           begin
             # Start pushing data into input
@@ -110,6 +110,7 @@ module Mixlib
                 unless GetExitCodeProcess(process.process_handle, exit_code)
                   raise get_last_error
                 end
+
                 @status = ThingThatLooksSortOfLikeAProcessStatus.new
                 @status.exitstatus = exit_code.unpack("l").first
 
@@ -170,8 +171,9 @@ module Mixlib
 
       def consume_output(open_streams, stdout_read, stderr_read)
         return false if open_streams.length == 0
+
         ready = IO.select(open_streams, nil, nil, READ_WAIT_TIME)
-        return true if ! ready
+        return true unless ready
 
         if ready.first.include?(stdout_read)
           begin
@@ -227,6 +229,7 @@ module Mixlib
       # @return String
       def combine_args(*args)
         return args[0] if args.length == 1
+
         args.map do |arg|
           if arg =~ /[ \t\n\v"]/
             arg = arg.gsub(/(\\*)"/, '\1\1\"') # interior quotes with N preceeding backslashes need 2N+1 backslashes
@@ -321,10 +324,12 @@ module Mixlib
             return true unless quote
           when "%"
             return true if env
+
             env = env_first_char = true
             next
           else
             next unless env
+
             if env_first_char
               env_first_char = false
               (env = false) && next if c !~ /[A-Za-z_]/
@@ -370,6 +375,7 @@ module Mixlib
 
       def unsafe_process?(name, logger)
         return false unless system_required_processes.include? name
+
         logger.debug(
           "A request to kill a critical system process - #{name} - was received and skipped."
         )
@@ -383,6 +389,7 @@ module Mixlib
       def kill_process_tree(pid, wmi, logger)
         wmi.query("select * from Win32_Process where ParentProcessID=#{pid}").each do |instance|
           next if unsafe_process?(instance.wmi_ole_object.name, logger)
+
           child_pid = instance.wmi_ole_object.processid
           kill_process_tree(child_pid, wmi, logger)
           kill_process(instance, logger)

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

@@ -73,19 +73,19 @@ module Process::Functions
     [:pointer], :bool
 
   attach_pfunc :LoadUserProfileW,
-    [:handle, :pointer], :bool
+    %i{handle pointer}, :bool
 
   attach_pfunc :UnloadUserProfile,
-    [:handle, :handle], :bool
+    %i{handle handle}, :bool
 
   ffi_lib :advapi32
 
   attach_pfunc :LogonUserW,
-    [:buffer_in, :buffer_in, :buffer_in, :ulong, :ulong, :pointer], :bool
+    %i{buffer_in buffer_in buffer_in ulong ulong pointer}, :bool
 
   attach_pfunc :CreateProcessAsUserW,
-    [:ulong, :buffer_in, :buffer_inout, :pointer, :pointer, :int,
-      :ulong, :buffer_in, :buffer_in, :pointer, :pointer], :bool
+    %i{ulong buffer_in buffer_inout pointer pointer int
+      ulong buffer_in buffer_in pointer pointer}, :bool
 
   ffi_lib :user32
 
@@ -93,7 +93,7 @@ module Process::Functions
     [], :ulong
 
   attach_pfunc :GetUserObjectInformationA,
-    [:ulong, :uint, :buffer_out, :ulong, :pointer], :bool
+    %i{ulong uint buffer_out ulong pointer}, :bool
 end
 
 # Override Process.create to check for running in the Service window station and doing
@@ -109,7 +109,11 @@ module Process
   class << self
 
     def create(args)
-      unless args.kind_of?(Hash)
+      create3(args).first
+    end
+
+    def create3(args)
+      unless args.is_a?(Hash)
         raise TypeError, "hash keyword arguments expected"
       end
 
@@ -137,6 +141,7 @@ module Process
         unless valid_keys.include?(key)
           raise ArgumentError, "invalid key '#{key}'"
         end
+
         hash[key] = val
       end
 
@@ -149,6 +154,7 @@ module Process
           unless valid_si_keys.include?(key)
             raise ArgumentError, "invalid startup_info key '#{key}'"
           end
+
           si_hash[key] = val
         end
       end
@@ -367,6 +373,7 @@ module Process
       unless GetProfileType(ptr)
         raise SystemCallError.new("GetProfileType", FFI.errno)
       end
+
       ptr.read_uint
     end
 
@@ -374,6 +381,7 @@ module Process
       unless LoadUserProfileW(token, profile_ptr)
         raise SystemCallError.new("LoadUserProfileW", FFI.errno)
       end
+
       true
     end
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-shellout
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.2
 platform: universal-mingw32
 authors:
 - Chef Software Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-06 00:00:00.000000000 Z
+date: 2020-07-23 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'
 - !ruby/object:Gem::Dependency
   name: win32-process
   requirement: !ruby/object:Gem::Requirement
@@ -47,6 +61,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
@@ -62,7 +77,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:
   - - ">="