mixlib-shellout 3.1.0 → 3.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30e1e2ac3023606a67aec29e74171247e37518d698d0ca3836c05344207ec310
-  data.tar.gz: bc0f8c45ae8f390242e6abec532e2a4e10300d57d60ad5443e15e7a2832e28d0
+  metadata.gz: 06626b906743fd932b0921f90d24e9aeee3c51fbdecfec571ee9547e1ac701ef
+  data.tar.gz: c2255e8cf8b72ad727fb076e2eafafef51cdf7b0f17fef0d0e526424dc986c25
 SHA512:
-  metadata.gz: 656c0cd5bd821435ac0a79eaef5950d0b7a7fc94251d35a79e2ab53fa2ead1db4fd1aadf65a395224ba81a93b3c6e39fd1e8eb49b09fdfebd4b75406a689e301
-  data.tar.gz: 6bf939d4cb2fc86585b3d1eb6a2c39424cd1b624290b1dc72a5a5efa831804114a1a983ef27424aa17f3a98328b02b595a9945522717b4b32f74d96e5643299b
+  metadata.gz: a8bbe1757af6c210b789decff30f35126ae1348481461a3b05eac662a295ec849fe293ede7d361b0598d04799e10e8aea89e18eea048de03a303b0a077d2b471
+  data.tar.gz: 0f5cce16bfa678c486ee46ee1c84f218507825070ef86a3eb8a6498d3b98277982ea9c457e10a8cde131969e5cdf1251b02fa16f36cecc6afdfcc835b72fd2c2

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"
 
@@ -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

@@ -16,33 +16,23 @@
 # limitations under the License.
 
 require_relative "../shellout"
-require "chef-utils"
-require "chef-utils/dsl/path_sanity"
+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::PathSanity
+      include ChefUtils::DSL::DefaultPaths
 
-      # PREFERRED APIS:
       #
-      # all consumers should now call shell_out!/shell_out.
+      # 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.
       #
-      # the shell_out_compacted/shell_out_compacted! APIs are private but are intended for use
-      # in rspec tests, and should ideally always be used to make code refactoring that do not
-      # change behavior easier:
-      #
-      # allow(provider).to receive(:shell_out_compacted!).with("foo", "bar", "baz")
-      # provider.shell_out!("foo", [ "bar", nil, "baz"])
-      # provider.shell_out!(["foo", nil, "bar" ], ["baz"])
-      #
-      # note that shell_out_compacted also includes adding the magical timeout option to force
-      # people to setup expectations on that value explicitly.  it does not include the default_env
-      # mangling in order to avoid users having to setup an expectation on anything other than
-      # setting `default_env: false` and allow us to make tweak to the default_env without breaking
-      # a thousand unit tests.
+      # 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)
@@ -98,15 +88,28 @@ module Mixlib
             "LC_ALL" => __config[:internal_locale],
             "LANGUAGE" => __config[:internal_locale],
             "LANG" => __config[:internal_locale],
-            __env_path_name => sanitized_path,
+            __env_path_name => default_paths,
           }.update(options[env_key] || {})
         end
         options
       end
 
-      # this SHOULD be used for setting up expectations in rspec, see banner comment at top.
+      # 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.
       #
-      # the private constraint is meant to avoid code calling this directly, rspec expectations are fine.
+      # 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)
@@ -117,10 +120,6 @@ module Mixlib
         end
       end
 
-      # this SHOULD be used for setting up expectations in rspec, see banner comment at top.
-      #
-      # the private constraint is meant to avoid code calling this directly, rspec expectations are fine.
-      #
       def shell_out_compacted!(*args, **options)
         options = __apply_default_env(options)
         cmd = if options.empty?
@@ -132,23 +131,12 @@ module Mixlib
         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).
-      #
-      # Usage:
-      #   shell_out!(*clean_array("useradd", universal_options, useradd_options, new_resource.username))
-      #
-      # universal_options and useradd_options can be nil, empty array, empty string, strings or arrays
-      # and the result makes sense.
-      #
-      # keeping this separate from shell_out!() makes it a bit easier to write expectations against the
-      # shell_out args and be able to omit nils and such in the tests (and to test that the nils are
-      # being rejected correctly).
+      # 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
@@ -169,7 +157,7 @@ module Mixlib
       end
 
       def __io_for_live_stream
-        if STDOUT.tty? && !__config[:daemon] && __log.debug?
+        if !STDOUT.closed? && __log.trace?
           STDOUT
         else
           nil

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.1.0".freeze
+    VERSION = "3.1.7".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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-shellout
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.7
 platform: ruby
 authors:
 - Chef Software Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-utils