mixlib-shellout 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e6f0d990000b229cfa3d812040828440973f528374790b2eb261c28db29bc13
-  data.tar.gz: 23ff6a2702bcb423b56daa92a23938299f541f1724dfb5599059dd65aa4e957c
+  metadata.gz: f11a7758041e86b3243966f06c35f8c5e104286cd9658465442a1f15fb1483ec
+  data.tar.gz: 6ccd66f875c30ecab220f933bb35019a43f30b463ca9febf05a9d176133ebe46
 SHA512:
-  metadata.gz: 6c76cc403ee32e7dae114f34e7684b3aa530eacfde72eb160ab0c007de6dbf3d8497f651d2894c873b6f3e734918de922ad57632965ada3fb1ef67418efb6d31
-  data.tar.gz: cad33035223cdd99827846282a9e9a201e63a6f99611f25430caaa6ddf72fd3da21f18e97840d77c70d1af9abd2da65bfeb732a20aa41b1f039ae494c8968b44
+  metadata.gz: 528a473db4dba8fe3d67add2d7c618d23b0926b02640a09d64b98c520180e0ea9259b790d65523ddc43d57b6d19f577838f59c89c99d3caf1cb380a5a23921ec
+  data.tar.gz: 73b5d26d33f68670128e4c4debb265d2f9bb3c7f73a5b04c88fda71ea7de1d6d5e6fdedea3b1be836921a5ec2ff0d9122cc29b70f5021c742a24fb3485c7d7b3

data/lib/mixlib/shellout/helper.rb

@@ -17,32 +17,22 @@
 
 require_relative "../shellout"
 require "chef-utils"
-require "chef-utils/dsl/path_sanity"
+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 "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)
@@ -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

data/lib/mixlib/shellout/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-shellout
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Chef Software Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-utils