poise 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2670b11e79bcee699172c7eaa7a842df9432324e
-  data.tar.gz: 56e5b571574d41de09f7af34da94034557fa741a
+  metadata.gz: 59e1a4b84effd92c53b370ae6e5ad4330ac48672
+  data.tar.gz: 8ed9df5c50afd344e838bf637c875cae8c1765f0
 SHA512:
-  metadata.gz: 58b803a269f764c6a061077d27f608d14e14f572c2e016f3986eeee22adc39bf408683cac41c6714b32bc4ad56dba6d03e87095e1c228d6edebc6d744a685209
-  data.tar.gz: 047b174a37deae87fb3658b6e465be97fe86826028d4575c2f46298d573115eb1c83794289df262b66f6771f9d538ea14f07851aeb139d779cd9f22a38b69874
+  metadata.gz: 2f924807105ed9ba4b41616df467768d4a5fc2f0259c8f83d8b6fba5b64d744e4cff6fa38ff66e1ab781f94dd6ed3c4f196aadae0733727cbe384569fc367a7b
+  data.tar.gz: ad8775e6a9e0c924e7633f390ca82f7982a4eddb32ca058e3b0e0e988da4766fd074c40022977899012571bacee33c882146f27bff3ae940483cb0f6057c8515

data/.travis.yml

@@ -23,4 +23,6 @@ gemfile:
 - test/gemfiles/chef-12.1.gemfile
 - test/gemfiles/chef-12.2.gemfile
 - test/gemfiles/chef-12.3.gemfile
+- test/gemfiles/chef-12.4.gemfile
+- test/gemfiles/chef-12.5.gemfile
 - test/gemfiles/master.gemfile

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v2.5.0
+
+* New property for inversion resources: `provider_no_auto`. Set one or more
+  provider names that will be ignored for automatic resolution for that instance.
+* Support `variables` as an alias for `options` in template content properties
+  to match the `template` resource.
+* Template content properties are no longer validated after creation for
+  non-default actions.
+* Formalize the extra-verbose logging mode for Poise and expose it via helpers.
+* Extra-verbose logging mode can now be enabled by creating a `/poise_debug` file.
+* New helper: `poise_shell_out`. Like normal `shell_out` but sets group and
+  environment variables automatically to better defaults.
+
 ## v2.4.0
 
 * Added return value to `Container#register_subresource` to track if the resource

data/README.md

@@ -193,6 +193,15 @@ end
 
 This will be converted to `{key1: 'value1', key2: 'value2'}`. You can also pass a Hash to an option collector attribute just as you would with a normal attribute.
 
+## Debugging Poise
+
+Poise has its own extra-verbose level of debug logging that can be enabled in
+three different ways. You can either set the environment variable `$POISE_DEBUG`,
+set a node attribute `node['POISE_DEBUG']`, or touch the file `/POISE_DEBUG`.
+You will see a log message `Extra verbose logging enabled` at the start of the
+run to confirm Poise debugging has been enabled. Make sure you also set Chef's
+log level to `debug`, usually via `-l debug` on the command line.
+
 ## Upgrading from Poise 1.x
 
 The biggest change when upgrading from Poise 1.0 is that the mixin is no longer

data/lib/poise.rb

@@ -30,6 +30,36 @@ module Poise
   autoload :Subcontext, 'poise/subcontext'
   autoload :Utils, 'poise/utils'
   autoload :VERSION, 'poise/version'
+
+  # Check if Poise's extra debugging output is enabled. This produces a *lot*
+  # of logging.
+  #
+  # @param node [Chef::Node, Chef::RunContext] Optional node to check for
+  #   attributes. If not given, Chef.node is used instead.
+  # @return [Boolean]
+  def self.debug?(node=nil)
+    node = node.node if node.is_a?(Chef::RunContext)
+    node ||= Chef.node if defined?(Chef.node)
+    @debug_file_upper = ::File.exist?('/POISE_DEBUG') unless defined?(@debug_file_upper)
+    @debug_file_lower = ::File.exist?('/poise_debug') unless defined?(@debug_file_lower)
+    !!(
+      (ENV['POISE_DEBUG'] && ENV['POISE_DEBUG'] != 'false') ||
+      (ENV['poise_debug'] && ENV['poise_debug'] != 'false') ||
+      (node && node['POISE_DEBUG']) ||
+      (node && node['poise_debug']) ||
+      @debug_file_upper ||
+      @debug_file_lower
+    )
+  end
+
+  # Log a message only if Poise's extra debugging output is enabled.
+  #
+  # @see #debug?
+  # @param msg [String] Log message.
+  # @return [void]
+  def self.debug(msg)
+    Chef::Log.debug(msg) if debug?
+  end
 end
 
 # Callable form to allow passing in options:
@@ -71,3 +101,7 @@ def Poise(options={})
 
   mod
 end
+
+# Display a message if poise_debug is enabled. Off in ChefSpec so I don't get
+# extra logging stuff that I don't care about.
+Poise.debug('[Poise] Extra verbose logging enabled') unless defined?(ChefSpec)

data/lib/poise/helpers/chefspec_matchers.rb

@@ -61,12 +61,12 @@ module Poise
         #
         # @see Resource::ResourceName.provides
         def provides(name, *args, &block)
+          super(name, *args, &block)
           ChefSpec.define_matcher(name) if defined?(ChefSpec)
           # Call #actions here to grab any actions from a parent class.
           actions.each do |action|
             ChefspecMatchers.create_matcher(name, action)
           end
-          super(name, *args, &block)
         end
 
         # Create matchers for all declared actions.
@@ -76,7 +76,7 @@ module Poise
           super.tap do |actions|
             actions.each do |action|
               ChefspecMatchers.create_matcher(resource_name, action)
-            end if resource_name
+            end if resource_name && resource_name != :resource && !names.empty?
           end
         end
 

data/lib/poise/helpers/defined_in.rb

@@ -65,9 +65,9 @@ module Poise
         # @return [String]
         def poise_defined_in_cookbook(run_context, file=nil)
           file ||= poise_defined_in
-          Chef::Log.debug("[#{self.name}] Checking cookbook name for #{file}")
+          Poise.debug("[#{self.name}] Checking cookbook name for #{file}")
           Poise::Utils.find_cookbook_name(run_context, file).tap do |cookbook|
-            Chef::Log.debug("[#{self.name}] found cookbook #{cookbook.inspect}")
+            Poise.debug("[#{self.name}] found cookbook #{cookbook.inspect}")
           end
         end
 

data/lib/poise/helpers/inversion.rb

@@ -83,12 +83,23 @@ module Poise
             resource_names.concat(self.class.subclass_resource_equivalents) if self.class.respond_to?(:subclass_resource_equivalents)
             # Silly ruby tricks to find the first provider that exists and no more.
             provider_class = resource_names.lazy.map {|name| Poise::Helpers::Inversion.provider_for(name, node, val) }.select {|x| x }.first
-            Chef::Log.debug("[#{self}] Checking for an inversion provider for #{val}: #{provider_class && provider_class.name}")
+            Poise.debug("[#{self}] Checking for an inversion provider for #{val}: #{provider_class && provider_class.name}")
             val = provider_class if provider_class
           end
           super
         end
 
+        # Set or return the array of provider names to be blocked from
+        # auto-resolution.
+        #
+        # @param val [String, Array<String>] Value to set.
+        # @return [Array<String>]
+        def provider_no_auto(val=nil)
+          # Coerce to an array.
+          val = Array(val).map(&:to_s) if val
+          set_or_return(:provider_no_auto, val, kind_of: Array, default: [])
+        end
+
         # @!classmethods
         module ClassMethods
           # Options resource class.
@@ -290,6 +301,8 @@ module Poise
               opts.update(run_state['*']) if run_state['*']
               # Options resource options for this provider.
               opts.update(run_state[provides]) if run_state[provides]
+              # Vomitdebug output for tracking down weirdness.
+              Poise.debug("[#{resource}] Resolved inversion options: #{opts.inspect}")
             end
           end
 
@@ -352,8 +365,8 @@ module Poise
             end
             return false unless resource_name_equivalents[inversion_resource]
             provider_name = resolve_inversion_provider(node, resource)
-            Chef::Log.debug("[#{resource}] Checking provides? on #{self.name}. Got provider_name #{provider_name.inspect}")
-            provider_name == provides.to_s || ( provider_name == 'auto' && provides_auto?(node, resource) )
+            Poise.debug("[#{resource}] Checking provides? on #{self.name}. Got provider_name #{provider_name.inspect}")
+            provider_name == provides.to_s || ( provider_name == 'auto' && !resource.provider_no_auto.include?(provides.to_s) && provides_auto?(node, resource) )
           end
 
           # Subclass hook to provide auto-detection for providers.

data/lib/poise/helpers/subcontext_block.rb

@@ -35,7 +35,7 @@ module Poise
         if defined?(sub_run_context.initialize_child_state)
           sub_run_context.initialize_child_state
         else
-          # Audits was added in 12.1 I thin.
+          # Audits was added in 12.1 I think.
           sub_run_context.audits = {} if defined?(sub_run_context.audits)
           # Dup and clear to preserve the default behavior without copy-pasta.
           sub_run_context.immediate_notification_collection = parent_context.immediate_notification_collection.dup.clear

data/lib/poise/helpers/subresources/container.rb

@@ -63,7 +63,8 @@ module Poise
             # we need to jump through some hoops to get it swapped into place.
             self_ = self
             order_fixer = Chef::Resource::RubyBlock.new('subresource_order_fixer', @run_context)
-            order_fixer.declared_type = 'ruby_block'
+            # respond_to? is for <= 12.0.2, remove some day when I stop caring.
+            order_fixer.declared_type = 'ruby_block' if order_fixer.respond_to?(:declared_type=)
             order_fixer.block do
               Chef::Log.debug("[#{self_}] Running order fixer")
               collection = self_.run_context.resource_collection

data/lib/poise/helpers/template_content.rb

@@ -68,6 +68,9 @@ module Poise
             # Template variables if using a template
             attribute("#{name_prefix}options", option_collector: true)
 
+            # Make an alias for #variables to match the template resource.
+            alias_method("#{name_prefix}variables", "#{name_prefix}options")
+
             # The big one, get/set content, but if you are getting and no
             # explicit content was given, try to render the template
             define_method("#{name_prefix}content") do |arg=nil, no_compute=false|
@@ -97,7 +100,7 @@ module Poise
               old_after_created = instance_method(:after_created)
               define_method(:after_created) do
                 old_after_created.bind(self).call
-                send("_#{name_prefix}validate")
+                send("_#{name_prefix}validate") if Array(action) == Array(self.class.default_action)
               end
             end
 

data/lib/poise/provider.rb

@@ -15,6 +15,7 @@
 #
 
 require 'poise/helpers'
+require 'poise/utils'
 
 
 module Poise
@@ -35,6 +36,7 @@ module Poise
     include Poise::Helpers::IncludeRecipe
     include Poise::Helpers::LWRPPolyfill
     include Poise::Helpers::NotifyingBlock
+    include Poise::Utils::ShellOut
 
     # @!classmethods
     module ClassMethods

data/lib/poise/resource.rb

@@ -15,6 +15,7 @@
 #
 
 require 'poise/helpers'
+require 'poise/utils'
 
 
 module Poise
@@ -41,6 +42,7 @@ module Poise
     include Poise::Helpers::ResourceName
     include Poise::Helpers::ResourceSubclass
     include Poise::Helpers::TemplateContent
+    include Poise::Utils::ShellOut
 
     # @!classmethods
     module ClassMethods

data/lib/poise/utils.rb

@@ -20,6 +20,7 @@ require 'poise/error'
 module Poise
   module Utils
     autoload :ResourceProviderMixin, 'poise/utils/resource_provider_mixin'
+    autoload :ShellOut, 'poise/utils/shell_out'
 
     extend self
 
@@ -37,14 +38,14 @@ module Poise
     #   end
     def find_cookbook_name(run_context, filename)
       possibles = {}
-      Chef::Log.debug("[Poise] Checking cookbook for #{filename.inspect}")
+      Poise.debug("[Poise] Checking cookbook for #{filename.inspect}")
       run_context.cookbook_collection.each do |name, ver|
         # This special method is added by Halite::Gem#as_cookbook_version.
         if ver.respond_to?(:halite_root)
           # The join is there because ../poise-ruby/lib starts with ../poise so
           # we want a trailing /.
           if filename.start_with?(File.join(ver.halite_root, ''))
-            Chef::Log.debug("[Poise] Found matching halite_root in #{name}: #{ver.halite_root.inspect}")
+            Poise.debug("[Poise] Found matching halite_root in #{name}: #{ver.halite_root.inspect}")
             possibles[ver.halite_root] = name
           end
         else
@@ -52,9 +53,9 @@ module Poise
             ver.segment_filenames(seg).each do |file|
               # Put this behind an environment variable because it is verbose
               # even for normal debugging-level output.
-              Chef::Log.debug("[Poise] Checking #{seg} in #{name}: #{file.inspect}") if ENV['POISE_DEBUG'] || run_context.node['POISE_DEBUG']
+              Poise.debug("[Poise] Checking #{seg} in #{name}: #{file.inspect}")
               if file == filename
-                Chef::Log.debug("[Poise] Found matching #{seg} in #{name}: #{file.inspect}")
+                Poise.debug("[Poise] Found matching #{seg} in #{name}: #{file.inspect}")
                 possibles[file] = name
               end
             end

data/lib/poise/utils/shell_out.rb

@@ -0,0 +1,85 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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 'etc'
+
+require 'chef/mixin/shell_out'
+
+
+module Poise
+  module Utils
+    # A mixin to provider a better shell_out.
+    #
+    # @since 2.5.0
+    # @example
+    #   Poise::Utils::ShellOut.poise_shell_out('ruby myapp.rb', user: 'myuser')
+    module ShellOut
+      extend self
+      include Chef::Mixin::ShellOut
+
+      # An enhanced version of Chef's `shell_out` which sets some default
+      # parameters. If possible it will set $HOME, $USER, $LOGNAME, and the
+      # group to run as.
+      #
+      # @param command_args [Array] Command arguments to be passed to `shell_out`.
+      # @param options [Hash<Symbol, Object>] Options to be passed to `shell_out`,
+      #   with modifications.
+      # @return [Mixlib::ShellOut]
+      def poise_shell_out(*command_args, **options)
+        # Allow the env option shorthand.
+        options[:environment] ||= {}
+        if options[:env]
+          options[:environment].update(options[:env])
+          options.delete(:env)
+        end
+        # Convert environment keys to strings to be safe.
+        options[:environment] = options[:environment].inject({}) do |memo, (key, value)|
+          memo[key.to_s] = value.to_s
+          memo
+        end
+        # Populate some standard environment variables.
+        ent = begin
+          if options[:user].is_a?(Integer)
+            Etc.getpwuid(options[:user])
+          elsif options[:user]
+            Etc.getpwnam(options[:user])
+          end
+        rescue ArgumentError
+          nil
+        end
+        username = ent ? ent.name : options[:name]
+        if username
+          options[:environment]['HOME'] ||= Dir.home(username)
+          options[:environment]['USER'] ||= username
+          # On the off chance they set one manually but not the other.
+          options[:environment]['LOGNAME'] ||= options[:environment]['USER']
+        end
+        # Set the default group on Unix.
+        options[:group] ||= ent.gid if ent
+        # Call Chef's shell_out wrapper.
+        shell_out(*command_args, **options)
+      end
+
+      # The `error!` version of {#poise_shell_out}.
+      #
+      # @see #poise_shell_out
+      # @return [Mixlib::ShellOut]
+      def poise_shell_out!(*command_args)
+        poise_shell_out(*command_args).tap(&:error!)
+      end
+    end
+  end
+end

data/lib/poise/version.rb

@@ -16,5 +16,5 @@
 
 
 module Poise
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

data/test/gemfiles/chef-12.0.gemfile

@@ -16,4 +16,4 @@
 
 eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
 
-gem 'chef', '~> 12.0.0'
+gem 'chef', '~> 12.0.3'

data/test/gemfiles/chef-12.1.gemfile

@@ -16,4 +16,4 @@
 
 eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
 
-gem 'chef', '~> 12.1.0'
+gem 'chef', '~> 12.1.2'

data/test/gemfiles/chef-12.2.gemfile

@@ -16,4 +16,4 @@
 
 eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
 
-gem 'chef', '~> 12.2.0'
+gem 'chef', '~> 12.2.1'

data/test/gemfiles/chef-12.4.gemfile

@@ -0,0 +1,19 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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.
+#
+
+eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
+
+gem 'chef', '~> 12.4.3'

data/test/gemfiles/chef-12.5.gemfile

@@ -0,0 +1,19 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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.
+#
+
+eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
+
+gem 'chef', '~> 12.5.1'

data/test/spec/helpers/inversion_spec.rb

@@ -279,6 +279,7 @@ describe Poise::Helpers::Inversion do
       resource(:poise_test_inversion, step_into: false) do
         include Poise
         provides(:poise_test_inversion)
+        attribute(:provider_no_auto, default: [])
       end
       provider(:poise_test_inversion) do
         include described_class
@@ -341,6 +342,17 @@ describe Poise::Helpers::Inversion do
         its(:enabled_handlers) { is_expected.to eq [provider(:poise_test_inversion), provider(:poise_test_inversion_other)] }
         its(:resolve) { is_expected.to eq provider(:poise_test_inversion) }
       end # /context with a subclassed resource using subclass_providers!
+
+      context 'with provider_no_auto' do
+        recipe(subject: false) do
+          poise_test_inversion 'test' do
+            provider_no_auto %w{inverted}
+          end
+        end
+        let(:test_resource) { chef_run.poise_test_inversion('test') }
+
+        its(:resolve) { is_expected.to eq provider(:poise_test_inversion_other) }
+      end # /context with provider_no_auto
     end # /describe provider resolution
   end # /describe Poise::Helpers::Inversion::Provider
 end

data/test/spec/helpers/template_content_spec.rb

@@ -68,7 +68,7 @@ describe Poise::Helpers::TemplateContent do
     end
   end # /context with a template
 
-  context 'with some template variables' do
+  context 'with some template options' do
     recipe do
       poise_test 'test' do
         source 'test.erb'
@@ -81,6 +81,21 @@ describe Poise::Helpers::TemplateContent do
     let(:required_template_options) { {'one' => '1', 'two' => 2} }
 
     it { is_expected.to run_poise_test('test').with(source: 'test.erb', options: required_template_options, content: 'rendered template') }
+  end # /context with some template options
+
+  context 'with some template variables' do
+    recipe do
+      poise_test 'test' do
+        source 'test.erb'
+        variables do
+          one '1'
+          two 2
+        end
+      end
+    end
+    let(:required_template_options) { {'one' => '1', 'two' => 2} }
+
+    it { is_expected.to run_poise_test('test').with(source: 'test.erb', variables: required_template_options, content: 'rendered template') }
   end # /context with some template variables
 
   context 'with explicit content' do
@@ -131,7 +146,7 @@ describe Poise::Helpers::TemplateContent do
       attribute(:config, template: true, required: true)
     end
 
-    it { expect{chef_run}.to raise_error(Chef::Exceptions::ValidationFailed) }
+    it { expect{chef_run}.to raise_error Chef::Exceptions::ValidationFailed }
   end # /context with required content
 
   context 'with both source and content' do
@@ -142,6 +157,26 @@ describe Poise::Helpers::TemplateContent do
       end
     end
 
-    it { expect{chef_run}.to raise_error(Chef::Exceptions::ValidationFailed) }
+    it { expect{chef_run}.to raise_error Chef::Exceptions::ValidationFailed }
   end # /context with both source and content
+
+  context 'with required content and a non-default action' do
+    resource(:poise_test) do
+      include Poise
+      attribute(:config, template: true, required: true)
+      actions(:one, :two)
+    end
+    provider(:poise_test) do
+      def action_one; end
+      def action_two; end
+    end
+    recipe do
+      poise_test 'test' do
+        action :two
+      end
+    end
+
+    it { run_chef }
+    it { expect { chef_run.poise_test('test').config_content }.to raise_error Chef::Exceptions::ValidationFailed }
+  end # /context with required content and a non-default action
 end

data/test/spec/poise_spec.rb

@@ -182,4 +182,137 @@ describe Poise do
   it 'has a fake name when used a function' do
     expect(Poise().name).to eq 'Poise'
   end # /it has a fake name when used a function
+
+  describe '.debug?' do
+    let(:debug_files) { [] }
+    before do
+      allow(File).to receive(:exist?).and_call_original
+      expect(File).to receive(:exist?).with(/\/poise_debug/i).twice {|path| debug_files.include?(path) }
+    end
+    around do |ex|
+      # Reset the stat checks both before and after.
+      begin
+        Poise.remove_instance_variable(:@debug_file_upper) if Poise.instance_variable_defined?(:@debug_file_upper)
+        Poise.remove_instance_variable(:@debug_file_lower) if Poise.instance_variable_defined?(:@debug_file_lower)
+        ex.run
+      ensure
+        Poise.remove_instance_variable(:@debug_file_upper) if Poise.instance_variable_defined?(:@debug_file_upper)
+        Poise.remove_instance_variable(:@debug_file_lower) if Poise.instance_variable_defined?(:@debug_file_lower)
+      end
+    end
+    subject { described_class.debug?(chef_runner.node) }
+
+    context 'with no flags' do
+      it { is_expected.to be false }
+    end # /context with no flags
+
+    context 'with $POISE_DEBUG' do
+      around do |ex|
+        begin
+          old = ENV['POISE_DEBUG']
+          ENV['POISE_DEBUG'] = '1'
+          ex.run
+        ensure
+          ENV['POISE_DEBUG'] = old
+        end
+      end
+
+      it { is_expected.to be true }
+    end # /context with $POISE_DEBUG
+
+    context 'with $POISE_DEBUG = false' do
+      around do |ex|
+        begin
+          old = ENV['POISE_DEBUG']
+          ENV['POISE_DEBUG'] = 'false'
+          ex.run
+        ensure
+          ENV['POISE_DEBUG'] = old
+        end
+      end
+
+      it { is_expected.to be false }
+    end # /context with $POISE_DEBUG = false
+
+    context 'with $poise_debug' do
+      around do |ex|
+        begin
+          old = ENV['poise_debug']
+          ENV['poise_debug'] = '1'
+          ex.run
+        ensure
+          ENV['poise_debug'] = old
+        end
+      end
+
+      it { is_expected.to be true }
+    end # /context with $poise_debug
+
+    context 'with $poise_debug = false' do
+      around do |ex|
+        begin
+          old = ENV['poise_debug']
+          ENV['poise_debug'] = 'false'
+          ex.run
+        ensure
+          ENV['poise_debug'] = old
+        end
+      end
+
+      it { is_expected.to be false }
+    end # /context with $poise_debug = false
+
+    context 'with node["POISE_DEBUG"]' do
+      before { default_attributes['POISE_DEBUG'] = true }
+      it { is_expected.to be true }
+    end # /context with node["POISE_DEBUG"]
+
+    context 'with node["poise_debug"]' do
+      before { default_attributes['poise_debug'] = true }
+      it { is_expected.to be true }
+    end # /context with node["poise_debug"]
+
+    context 'with /POISE_DEBUG' do
+      let(:debug_files) { %w{/POISE_DEBUG} }
+      it { is_expected.to be true }
+    end # /context with /POISE_DEBUG
+
+    context 'with /poise_debug' do
+      let(:debug_files) { %w{/poise_debug} }
+      it { is_expected.to be true }
+    end # /context with /poise_debug
+
+    context 'with a global node' do
+      before do
+        default_attributes['POISE_DEBUG'] = true
+        allow(Chef).to receive(:node).and_return(chef_runner.node)
+      end
+      subject { described_class.debug? }
+      it { is_expected.to be true }
+    end # /context with a global node
+
+    context 'with a run_context' do
+      before { default_attributes['poise_debug'] = true }
+      subject { described_class.debug?(chef_run.run_context) }
+      it { is_expected.to be true }
+    end # /context with a run_context
+  end # /describe .debug?
+
+  describe '.debug' do
+    context 'with debugging disabled' do
+      before { allow(described_class).to receive(:debug?).and_return(false) }
+      it do
+        expect(Chef::Log).to_not receive(:debug)
+        Poise.debug('msg')
+      end
+    end # /context with debugging disabled
+
+    context 'with debugging enabled' do
+      before { allow(described_class).to receive(:debug?).and_return(true) }
+      it do
+        expect(Chef::Log).to receive(:debug).with('msg')
+        Poise.debug('msg')
+      end
+    end # /context with debugging enabled
+  end # /describe .debug
 end

data/test/spec/utils/shell_out_spec.rb

@@ -0,0 +1,104 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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 'spec_helper'
+require 'etc'
+
+describe Poise::Utils::ShellOut do
+  let(:arg) { double('command argument') }
+  let(:cmd) { double('Mixlib::ShellOut') }
+
+  describe '.poise_shell_out' do
+    let(:user_ent) { double('Passwd', name: 'testuser', uid: 500, gid: 501) }
+    let(:command_args) { [arg] }
+    let(:expect_args) { [arg, {environment: {}}] }
+    before do
+      allow(Etc).to receive(:getpwuid).with(500).and_return(user_ent)
+      allow(Etc).to receive(:getpwnam).with('testuser').and_return(user_ent)
+      allow(Dir).to receive(:home).with('testuser').and_return('/home/testuser')
+      expect(described_class).to receive(:shell_out).with(*expect_args).and_return(cmd)
+    end
+    subject { described_class.poise_shell_out(*command_args) }
+
+    context 'with no user' do
+      it { is_expected.to be cmd }
+    end # /context with no user
+
+    context 'with a user' do
+      let(:command_args) { [arg, {user: 'testuser'}] }
+      let(:expect_args) { [arg, {user: 'testuser', group: 501, environment: {'HOME' => '/home/testuser', 'USER' => 'testuser', 'LOGNAME' => 'testuser'}}] }
+      it { is_expected.to be cmd }
+    end # /context with a user
+
+    context 'with a uid' do
+      let(:command_args) { [arg, {user: 500}] }
+      let(:expect_args) { [arg, {user: 500, group: 501, environment: {'HOME' => '/home/testuser', 'USER' => 'testuser', 'LOGNAME' => 'testuser'}}] }
+      it { is_expected.to be cmd }
+    end # /context with a uid
+
+    context 'with a group' do
+      let(:command_args) { [arg, {user: 'testuser', group: 'othergroup'}] }
+      let(:expect_args) { [arg, {user: 'testuser', group: 'othergroup', environment: {'HOME' => '/home/testuser', 'USER' => 'testuser', 'LOGNAME' => 'testuser'}}] }
+      it { is_expected.to be cmd }
+    end # /context with a group
+
+    context 'with a $HOME' do
+      let(:command_args) { [arg, {user: 'testuser', environment: {'HOME' => '/other'}}] }
+      let(:expect_args) { [arg, {user: 'testuser', group: 501, environment: {'HOME' => '/other', 'USER' => 'testuser', 'LOGNAME' => 'testuser'}}] }
+      it { is_expected.to be cmd }
+    end # /context with a $HOME
+
+    context 'with a $USER' do
+      let(:command_args) { [arg, {user: 'testuser', environment: {'USER' => 'other'}}] }
+      let(:expect_args) { [arg, {user: 'testuser', group: 501, environment: {'HOME' => '/home/testuser', 'USER' => 'other', 'LOGNAME' => 'other'}}] }
+      it { is_expected.to be cmd }
+    end # /context with a $USER
+
+    context 'with a bad user' do
+      let(:command_args) { [arg, {user: 'testuser'}] }
+      let(:expect_args) { [arg, {user: 'testuser', environment: {}}] }
+      before do
+        allow(Etc).to receive(:getpwnam).with('testuser').and_raise(ArgumentError)
+      end
+      it { is_expected.to be cmd }
+    end # /context with a bad user
+
+    context 'with an env option' do
+      let(:command_args) { [arg, {user: 'testuser', env: {FOO: 'BAR'}}] }
+      let(:expect_args) { [arg, {user: 'testuser', group: 501, environment: {'HOME' => '/home/testuser', 'USER' => 'testuser', 'LOGNAME' => 'testuser', 'FOO' => 'BAR'}}] }
+      it { is_expected.to be cmd }
+    end # /context with an env option
+
+    context 'on Windows' do
+      let(:command_args) { [arg, {user: 'testuser'}] }
+      let(:expect_args) { [arg, {user: 'testuser', environment: {}}] }
+      before do
+        allow(Etc).to receive(:getpwnam).with('testuser').and_return(nil)
+      end
+      it { is_expected.to be cmd }
+    end # /context on Windows
+  end # /describe .poise_shell_out
+
+  describe '.poise_shell_out!' do
+    subject { described_class.poise_shell_out!(arg) }
+
+    it do
+      expect(described_class).to receive(:poise_shell_out).with(arg).and_return(cmd)
+      expect(cmd).to receive(:error!)
+      is_expected.to be cmd
+    end
+  end # /describe .poise_shell_out!
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poise
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: halite
@@ -89,6 +89,7 @@ files:
 - lib/poise/subcontext/runner.rb
 - lib/poise/utils.rb
 - lib/poise/utils/resource_provider_mixin.rb
+- lib/poise/utils/shell_out.rb
 - lib/poise/version.rb
 - poise.gemspec
 - test/cookbooks/poise_test/attributes/default.rb
@@ -104,6 +105,8 @@ files:
 - test/gemfiles/chef-12.1.gemfile
 - test/gemfiles/chef-12.2.gemfile
 - test/gemfiles/chef-12.3.gemfile
+- test/gemfiles/chef-12.4.gemfile
+- test/gemfiles/chef-12.5.gemfile
 - test/gemfiles/chef-12.gemfile
 - test/gemfiles/master.gemfile
 - test/integration/default/serverspec/default_spec.rb
@@ -132,6 +135,7 @@ files:
 - test/spec/spec_helper.rb
 - test/spec/subcontext/resource_collection_spec.rb
 - test/spec/utils/resource_provider_mixin_spec.rb
+- test/spec/utils/shell_out_spec.rb
 - test/spec/utils_spec.rb
 homepage: https://github.com/poise/poise
 licenses:
@@ -171,6 +175,8 @@ test_files:
 - test/gemfiles/chef-12.1.gemfile
 - test/gemfiles/chef-12.2.gemfile
 - test/gemfiles/chef-12.3.gemfile
+- test/gemfiles/chef-12.4.gemfile
+- test/gemfiles/chef-12.5.gemfile
 - test/gemfiles/chef-12.gemfile
 - test/gemfiles/master.gemfile
 - test/integration/default/serverspec/default_spec.rb
@@ -199,5 +205,6 @@ test_files:
 - test/spec/spec_helper.rb
 - test/spec/subcontext/resource_collection_spec.rb
 - test/spec/utils/resource_provider_mixin_spec.rb
+- test/spec/utils/shell_out_spec.rb
 - test/spec/utils_spec.rb
 has_rdoc: