poise 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a493c9d1d4c7f307cfa38c39d5e9de3d7242c3b6
-  data.tar.gz: 6b700222a7634a9e301b55dc3be8a41d61a15e04
+  metadata.gz: 805b189d8f29b6d7fcdcd5e189a24e525a755f96
+  data.tar.gz: ae33e8ec60d4d947811f35211ce3eecc69712dd8
 SHA512:
-  metadata.gz: 3d90977a6a46d00298dddf93479023d27364aa73049e89ef97c4671af27847b695de39ac5af04e962d449818f5fd556ec4cbf168ac5f275c88d35e91c711f722
-  data.tar.gz: 81c4de3bb755d2d8c5c2f7e6837eea4f16fab1c942b6d60d6ac611fb8f0867c3ec07153c58156402f00331b4b38e0e3671d9fce3207ec408f737b6a5efa25ff6
+  metadata.gz: eb2351eab975e312a23c039dd12c3b18dd4fc76307cb08c92d10702e317d935fa515d7928e0733188b03be2157779d1be8adf74c62f7f13f766927e96db726c8
+  data.tar.gz: dedd4fe5fdb0f15f0eb50402309ad51513b9663fd38c13dddbdb4891cbb62396d0d04c25201571769531aa638dc87ab7527dbd7a13e05bc2acc6f68f1601dd48

data/Berksfile.lock

@@ -5,6 +5,6 @@ DEPENDENCIES
     path: test/cookbooks/poise_test
 
 GRAPH
-  poise (2.0.2)
+  poise (2.2.0)
   poise_test (0.0.0)
     poise (>= 0.0.0)

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v2.2.0
+
+* Compatibility with Chef 12.4.1 and Chefspec 4.3.0.
+* New helper `ResourceCloning`: Disables resource cloning between Poise-based
+  resources. This is enabled by default.
+* Subresource parent references can be set to nil.
+
 ## v2.1.0
 
 * Compatibility with Chef 12.4.

data/Gemfile

@@ -18,12 +18,16 @@ source 'https://rubygems.org/'
 
 gemspec path: File.expand_path('..', __FILE__)
 
-def dev_gem(name, path: File.join('..', name))
+def dev_gem(name, path: File.join('..', name), github: nil)
   path = File.expand_path(File.join('..', path), __FILE__)
   if File.exist?(path)
     gem name, path: path
+  elsif github
+    gem name, github: github
   end
 end
 
 dev_gem 'halite'
 dev_gem 'poise-boiler'
+
+gem 'kitchen-docker', github: 'portertech/kitchen-docker'

data/lib/poise/helpers.rb

@@ -26,6 +26,7 @@ module Poise
     autoload :LWRPPolyfill, 'poise/helpers/lwrp_polyfill'
     autoload :NotifyingBlock, 'poise/helpers/notifying_block'
     autoload :OptionCollector, 'poise/helpers/option_collector'
+    autoload :ResourceCloning, 'poise/helpers/resource_cloning'
     autoload :ResourceName, 'poise/helpers/resource_name'
     autoload :Subresources, 'poise/helpers/subresources'
     autoload :TemplateContent, 'poise/helpers/template_content'

data/lib/poise/helpers/chefspec_matchers.rb

@@ -60,9 +60,9 @@ module Poise
         # Create a resource-level matcher for this resource.
         #
         # @see Resource::ResourceName.provides
-        def provides(name)
+        def provides(name, *args, &block)
           ChefSpec.define_matcher(name) if defined?(ChefSpec)
-          super
+          super(name, *args, &block)
         end
 
         # Create matchers for all declared actions.

data/lib/poise/helpers/inversion.rb

@@ -134,9 +134,9 @@ module Poise
           #
           # @param name [Symbol] Resource name
           # return [void]
-          def provides(name)
+          def provides(name, *args, &block)
             create_inversion_options_resource!(name) if inversion_options_resource
-            super if defined?(super)
+            super(name, *args, &block) if defined?(super)
           end
 
           def included(klass)

data/lib/poise/helpers/lwrp_polyfill.rb

@@ -32,8 +32,9 @@ module Poise
       module Resource
         def initialize(*args)
           super
-          # Try to not stomp on stuff if already set in a parent.
-          @action = self.class.default_action if @action == :nothing
+          # Try to not stomp on stuff if already set in a parent. Coerce @action
+          # to an array because this behavior may change in the future in Chef.
+          @action = self.class.default_action if Array(@action) == [:nothing]
           (@allowed_actions << self.class.actions).flatten!.uniq!
         end
 
@@ -42,14 +43,14 @@ module Poise
           #   Get the default action for this resource class. If no explicit
           #   default is set, the first action in the list will be used.
           #   @see #actions
-          #   @return [Symbol]
+          #   @return [Array<Symbol>]
           # @overload default_action(name)
           #   Set the default action for this resource class. If this action is
           #   not already allowed, it will be added.
           #   @note It is idiomatic to use {#actions} instead, with the first
           #     action specified being the default.
-          #   @param name [Symbol] Name of the action.
-          #   @return [Symbol]
+          #   @param name [Symbol, Array<Symbol>] Name of the action(s).
+          #   @return [Array<Symbol>]
           #   @example
           #     class MyApp < Chef::Resource
           #       include Poise
@@ -57,10 +58,11 @@ module Poise
           #     end
           def default_action(name=nil)
             if name
+              name = Array(name).flatten.map(&:to_sym)
               @default_action = name
-              actions(name)
+              actions(*name)
             end
-            @default_action || ( respond_to?(:superclass) && superclass != Chef::Resource && superclass.respond_to?(:default_action) && superclass.default_action ) || actions.first || :nothing
+            @default_action || ( respond_to?(:superclass) && superclass != Chef::Resource && superclass.respond_to?(:default_action) && superclass.default_action ) || (actions.first && [actions.first]) || [:nothing]
           end
 
           # @overload actions()
@@ -79,8 +81,7 @@ module Poise
           #     end
           def actions(*names)
             @actions ||= ( respond_to?(:superclass) && superclass.respond_to?(:actions) && superclass.actions.dup ) || ( respond_to?(:superclass) && superclass != Chef::Resource && superclass.respond_to?(:allowed_actions) && superclass.allowed_actions.dup ) || []
-            (@actions << names).flatten!.uniq!
-            @actions
+            (@actions << names).tap {|actions| actions.flatten!; actions.uniq! }
           end
 
           # Create a resource property (née attribute) on this resource class.
@@ -130,6 +131,12 @@ module Poise
             if klass.is_a?(Class) && klass.superclass == Chef::Provider
               klass.class_exec do
                 def load_current_resource
+                  @current_resource = if new_resource
+                    new_resource.class.new(new_resource.name, run_context)
+                  else
+                    # Better than nothing, subclass can overwrite anyway.
+                    Chef::Resource.new(nil, run_context)
+                  end
                 end
               end
             end

data/lib/poise/helpers/resource_cloning.rb

@@ -0,0 +1,72 @@
+#
+# Copyright 2013-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.
+#
+
+
+module Poise
+  module Helpers
+    # A resource mixin to disable resource cloning.
+    #
+    # @since 2.2.0
+    # @example
+    #   class MyResource < Chef::Resource
+    #     include Poise::Helpers::ResourceCloning
+    #   end
+    module ResourceCloning
+      # Override to disable resource cloning on Chef 12.0.
+      #
+      # @api private
+      def load_prior_resource(*args)
+        # Do nothing.
+      end
+
+      # Override to disable resource cloning on Chef 12.1+.
+      #
+      # @api private
+      def load_from(*args)
+        # Do nothing.
+      end
+
+      # Monkeypatch for Chef::ResourceBuilder to silence the warning if needed.
+      #
+      # @api private
+      module ResourceBuilderPatch
+        # @api private
+        def self.install!
+          begin
+            require 'chef/resource_builder'
+            Chef::ResourceBuilder.send(:prepend, ResourceBuilderPatch)
+          rescue LoadError
+            # For 12.0, this is already taken care of.
+          end
+        end
+
+        # @api private
+        def emit_cloned_resource_warning
+          super unless resource.is_a?(ResourceCloning)
+        end
+
+        # @api private
+        def emit_harmless_cloning_debug
+          super unless resource.is_a?(ResourceCloning)
+        end
+      end
+
+      # Install the patch.
+      ResourceBuilderPatch.install!
+
+    end
+  end
+end

data/lib/poise/helpers/resource_name.rb

@@ -51,7 +51,7 @@ module Poise
         #     include Poise::Resource::ResourceName
         #     provides(:my_resource)
         #   end
-        def provides(name)
+        def provides(name, *args, &block)
           # Patch self.constantize so this can cope with anonymous classes.
           # This does require that the anonymous class define self.name though.
           if self.name && respond_to?(:constantize)
@@ -63,7 +63,7 @@ module Poise
           # Store the name for later.
           @provides_name = name
           # Call the original if present. The defined? is for old Chef.
-          super if defined?(super)
+          super(name, *args, &block) if defined?(super)
         end
 
         # Retreive the DSL name for the resource class. If not set explicitly
@@ -75,10 +75,16 @@ module Poise
           # In 12.4+ we need to proxy through the super class for setting.
           return super(auto) if defined?(super) && (auto.is_a?(Symbol) || auto.is_a?(String))
           return @provides_name unless auto
-          @provides_name || if name && name.start_with?('Chef::Resource')
-            Chef::Mixin::ConvertToClassName.convert_to_snake_case(name, 'Chef::Resource').to_sym
-          elsif name
-            Chef::Mixin::ConvertToClassName.convert_to_snake_case(name.split('::').last).to_sym
+          @provides_name || if name
+            mode = if name.start_with?('Chef::Resource')
+              [name, 'Chef::Resource']
+            else
+              [name.split('::').last]
+            end
+            Chef::Mixin::ConvertToClassName.convert_to_snake_case(*mode).to_sym
+          elsif defined?(super)
+            # No name on 12.4+ probably means this is an LWRP, use super().
+            super()
           end
         end
 

data/lib/poise/helpers/subcontext_block.rb

@@ -27,9 +27,21 @@ module Poise
       private
 
       def subcontext_block(parent_context=nil, &block)
-        # Setup a sub-run-context.
+        # Setup a subcontext.
         parent_context ||= @run_context
         sub_run_context = parent_context.dup
+        # Reset state for the subcontext. In 12.4+ this uses the built-in
+        # support, otherwise do it manually.
+        if defined?(sub_run_context.initialize_child_state)
+          sub_run_context.initialize_child_state
+        else
+          # Audits was added in 12.1 I thin.
+          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
+          sub_run_context.delayed_notification_collection = parent_context.delayed_notification_collection.dup.clear
+        end
+        # Create the subcollection.
         sub_run_context.resource_collection = Poise::Subcontext::ResourceCollection.new(parent_context.resource_collection)
 
         # Declare sub-resources within the sub-run-context. Since they

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

@@ -56,8 +56,8 @@ module Poise
         #   string), or a type:name hash.
         #   @param val [String, Hash, Chef::Resource] Parent resource to set.
         #   @return [Chef::Resource, nil]
-        def parent(val=nil)
-          _parent(:parent, self.class.parent_type, self.class.parent_optional, self.class.parent_auto, val)
+        def parent(*args)
+          _parent(:parent, self.class.parent_type, self.class.parent_optional, self.class.parent_auto, *args)
         end
 
         # Register ourself with parents in case this is not a nested resource.
@@ -77,28 +77,34 @@ module Poise
         #
         # @since 2.0.0
         # @see #parent
-        def _parent(name, parent_type, parent_optional, parent_auto, val=nil)
+        def _parent(name, parent_type, parent_optional, parent_auto, *args)
           # Allow using a DSL symbol as the parent type.
           if parent_type.is_a?(Symbol)
             parent_type = Chef::Resource.resource_for_node(parent_type, node)
           end
           # Grab the ivar for local use.
           parent_ref = instance_variable_get(:"@#{name}")
-          if val
-            if val.is_a?(String) && !val.include?('[')
-              raise Poise::Error.new('Cannot use a string parent without defining a parent type') if parent_type == Chef::Resource
-              val = "#{parent_type.resource_name}[#{val}]"
-            end
-            if val.is_a?(String) || val.is_a?(Hash)
-              parent = @run_context.resource_collection.find(val)
+          if !args.empty?
+            val = args.first
+            if val.nil?
+              # Unsetting the parent.
+              parent = nil
             else
-              parent = val
-            end
-            if !parent.is_a?(parent_type)
-              raise Poise::Error.new("Parent resource is not an instance of #{parent_type.name}: #{val.inspect}")
+              if val.is_a?(String) && !val.include?('[')
+                raise Poise::Error.new('Cannot use a string parent without defining a parent type') if parent_type == Chef::Resource
+                val = "#{parent_type.resource_name}[#{val}]"
+              end
+              if val.is_a?(String) || val.is_a?(Hash)
+                parent = @run_context.resource_collection.find(val)
+              else
+                parent = val
+              end
+              if !parent.is_a?(parent_type)
+                raise Poise::Error.new("Parent resource is not an instance of #{parent_type.name}: #{val.inspect}")
+              end
             end
             parent_ref = ParentRef.new(parent)
-          elsif !parent_ref
+          elsif !parent_ref || !parent_ref.resource
             if parent_auto
               # Automatic sibling lookup for sequential composition.
               # Find the last instance of the parent class as the default parent.
@@ -181,8 +187,8 @@ module Poise
           def parent_attribute(name, type: Chef::Resource, optional: false, auto: true)
             name = :"parent_#{name}"
             (@parent_attributes ||= {})[name] = type
-            define_method(name) do |val=nil|
-              _parent(name, type, optional, auto, val)
+            define_method(name) do |*args|
+              _parent(name, type, optional, auto, *args)
             end
           end
 

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

@@ -56,7 +56,9 @@ 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'
             order_fixer.block do
+              Chef::Log.debug("[#{self_}] Running order fixer")
               collection = self_.run_context.resource_collection
               # Delete the current container resource from its current position.
               collection.all_resources.delete(self_)

data/lib/poise/resource.rb

@@ -37,6 +37,7 @@ module Poise
     include Poise::Helpers::LazyDefault if Poise::Helpers::LazyDefault.needs_polyfill?
     include Poise::Helpers::LWRPPolyfill
     include Poise::Helpers::OptionCollector
+    include Poise::Helpers::ResourceCloning
     include Poise::Helpers::ResourceName
     include Poise::Helpers::TemplateContent
 

data/lib/poise/version.rb

@@ -16,5 +16,5 @@
 
 
 module Poise
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/test/spec/helpers/lazy_default_spec.rb

@@ -48,7 +48,7 @@ describe Poise::Helpers::LazyDefault do
       poise_sub 'test'
     end
 
-    it { is_expected.to run_poise_test('test').with(value: 'test_lazy') }
+    it { is_expected.to run_poise_sub('test').with(value: 'test_lazy') }
   end # /context in a subclass
 
   context 'with an external global' do

data/test/spec/helpers/lwrp_polyfill_spec.rb

@@ -107,25 +107,29 @@ describe Poise::Helpers::LWRPPolyfill do
       end
 
       it { is_expected.to one_poise_test('test') }
+      it { expect(resource(:poise_test).default_action).to eq [:one] }
     end # /describe #default_action
   end # /describe Poise::Helpers::LWRPPolyfill::Resource
 
   describe Poise::Helpers::LWRPPolyfill::Provider do
     describe 'load_current_resource override' do
-      subject { provider(:poise_test).new(nil, nil).load_current_resource }
+      resource(:poise_test)
+      let(:test_resource) { resource(:poise_test).new('test', nil) }
+      subject { provider(:poise_test).new(test_resource, nil).load_current_resource }
 
       context 'with a direct Provider subclass' do
         provider(:poise_test, auto: false) do
           include described_class
         end
 
-        it { is_expected.to be_nil }
+        it { is_expected.to be_a resource(:poise_test) }
+        its(:name) { is_expected.to eq 'test' }
       end # /context with a direct Provider subclass
 
       context 'with an intermediary class' do
         provider(:poise_parent, auto: false) do
           def load_current_resource
-            'helper'
+            @current_resource = 'helper'
           end
         end
         provider(:poise_test, auto: false, parent: :poise_parent) do

data/test/spec/helpers/notifying_block_spec.rb

@@ -84,4 +84,43 @@ describe Poise::Helpers::NotifyingBlock do
 
     it { expect { subject }.to raise_error(RuntimeError) }
   end # /context with an exception raised inside the block
+
+  describe 'regression test for picking up sibling notifications outside the subcontext for resources with matching name' do
+    resource(:poise_inner) do
+      include Poise::Helpers::ResourceCloning
+      attr_accessor :mark_updated
+    end
+    provider(:poise_inner) do
+      def action_run
+        new_resource.updated_by_last_action(new_resource.mark_updated)
+      end
+    end
+    provider(:poise_test) do
+      include Poise::Helpers::LWRPPolyfill
+      include described_class
+
+      def action_run
+        notifying_block do
+          poise_inner 'test' do
+            self.mark_updated = true
+          end
+        end
+      end
+    end
+    recipe do
+      ruby_block 'test' do
+        block { }
+        action :nothing
+      end
+
+      poise_inner 'test' do
+        self.mark_updated = false
+        notifies :run, 'ruby_block[test]', :immediately
+      end
+
+      poise_test 'test'
+    end
+
+    it { is_expected.to_not run_ruby_block('test') }
+  end # /describe regression test for picking up sibling notifications outside the subcontext for resources with matching name
 end

data/test/spec/helpers/resource_cloning_spec.rb

@@ -0,0 +1,56 @@
+#
+# 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'
+
+describe Poise::Helpers::ResourceCloning do
+  resource(:poise_test) do
+    def value(*args)
+      set_or_return(:value, *args, {})
+    end
+  end
+  provider(:poise_test)
+  recipe do
+    poise_test 'test' do
+      value 1
+    end
+
+    poise_test 'test' do
+      value 2
+    end
+  end
+
+  context 'with a resource that should be cloned' do
+    # Baseline to make sure my test harness works.
+    it do
+      expect(Chef::Log).to receive(:warn).exactly(3).times
+      run_chef
+    end
+  end # /context with a resource that should be cloned
+
+  context 'a resource using the helper' do
+    resource(:poise_test) do
+      include described_class
+      def value(*args)
+        set_or_return(:value, *args, {})
+      end
+    end
+    it do
+      expect(Chef::Log).to_not receive(:warn)
+      run_chef
+    end
+  end # /context a resource using the helper
+end

data/test/spec/helpers/subresources/child_spec.rb

@@ -169,6 +169,37 @@ describe Poise::Helpers::Subresources::Child do
 
       it { is_expected.to run_poise_test('test').with(parent: be_nil) }
     end # /context with no automatic parent but optional
+
+    context 'with a parent but then unset' do
+      recipe do
+        poise_container 'test2'
+        poise_container 'test'
+        poise_test 'test' do
+          parent 'test2'
+          parent nil
+        end
+      end
+
+      it { is_expected.to run_poise_test('test').with(parent: container) }
+    end # context with a parent but then unset
+
+    context 'with an optional parent but then unset' do
+      resource(:poise_test) do
+        include described_class
+        parent_type :poise_container
+        parent_optional true
+        parent_auto false
+      end
+      recipe do
+        poise_container 'test'
+        poise_test 'test' do
+          parent 'test'
+          parent nil
+        end
+      end
+
+      it { is_expected.to run_poise_test('test').with(parent: nil) }
+    end # context with an optional parent but then unset
   end # /describe #parent
 
   describe '.parent_type' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poise
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: halite
@@ -72,6 +72,7 @@ files:
 - lib/poise/helpers/lwrp_polyfill.rb
 - lib/poise/helpers/notifying_block.rb
 - lib/poise/helpers/option_collector.rb
+- lib/poise/helpers/resource_cloning.rb
 - lib/poise/helpers/resource_name.rb
 - lib/poise/helpers/subcontext_block.rb
 - lib/poise/helpers/subresources.rb
@@ -115,11 +116,12 @@ files:
 - test/spec/helpers/lwrp_polyfill_spec.rb
 - test/spec/helpers/notifying_block_spec.rb
 - test/spec/helpers/option_collector_spec.rb
+- test/spec/helpers/resource_cloning_spec.rb
 - test/spec/helpers/resource_name_spec.rb
 - test/spec/helpers/subcontext_block_spec.rb
 - test/spec/helpers/subresources/child_spec.rb
 - test/spec/helpers/subresources/container_spec.rb
-- test/spec/helpers/template_context_spec.rb
+- test/spec/helpers/template_content_spec.rb
 - test/spec/poise_spec.rb
 - test/spec/provider_spec.rb
 - test/spec/resource_spec.rb
@@ -178,11 +180,12 @@ test_files:
 - test/spec/helpers/lwrp_polyfill_spec.rb
 - test/spec/helpers/notifying_block_spec.rb
 - test/spec/helpers/option_collector_spec.rb
+- test/spec/helpers/resource_cloning_spec.rb
 - test/spec/helpers/resource_name_spec.rb
 - test/spec/helpers/subcontext_block_spec.rb
 - test/spec/helpers/subresources/child_spec.rb
 - test/spec/helpers/subresources/container_spec.rb
-- test/spec/helpers/template_context_spec.rb
+- test/spec/helpers/template_content_spec.rb
 - test/spec/poise_spec.rb
 - test/spec/provider_spec.rb
 - test/spec/resource_spec.rb