compat_resource 12.10.1 → 12.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c7c3400d3a6270d353403967a7285c17b4c0e01
-  data.tar.gz: 058a4752161e3c8e1610e80f5ff9497d3802a6b2
+  metadata.gz: e5ed711ca2e962b498a3d0f57d83e968f22c3413
+  data.tar.gz: 09a6bf93b34094e41df052900426c11fa1863bab
 SHA512:
-  metadata.gz: 3e1d3dc00dbe9e97c67a6cc14baa7700ae7462e977130bc2bbe8f6ed75c3f35c45505de9d8082506ac68db68532afbd6443e6b9eb3c356a04d4ac216ffac8ba2
-  data.tar.gz: f87ce089823b777aa404cf36ab66f1222a50b9554c0bf0c1c948a6687aa85bcc2b9ca33ea4c836d7a54a3d80431cf401d4cd24156d9101e915df7ac26ecc567b
+  metadata.gz: e1444ac99b53e4a3af0c7d9121f78bc49942ad4c5c55cf006dde1e5830b5b7758d61fdc16a8ae1f38937a1d742d4dcb6e9a3a718560a00e860db4af0989fcedc
+  data.tar.gz: 1d39e68480d28af7e4506e4115475dd0cac935ef25fd9c6ad17ba7ff56c96e9dff4b4214bb352f4ab717de5098f3f7232ef14bbb545ec093d60848585867a9d5

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 gemspec
-gem 'stove', '3.2.5'
+gem 'stove'
 if ENV['GEMFILE_MOD']
   instance_eval(ENV['GEMFILE_MOD'])
 end

data/files/lib/chef_compat/monkeypatches.rb

@@ -6,6 +6,7 @@ require 'chef_compat/monkeypatches/chef/property'
 require 'chef_compat/monkeypatches/chef/provider'
 require 'chef_compat/monkeypatches/chef/recipe'
 require 'chef_compat/monkeypatches/chef/resource'
+require 'chef_compat/monkeypatches/chef/resource_builder'
 require 'chef_compat/monkeypatches/chef/resource/lwrp_base'
 require 'chef_compat/monkeypatches/chef/resource_collection'
 require 'chef_compat/monkeypatches/chef/resource_collection/resource_list'

data/files/lib/chef_compat/monkeypatches/chef/resource_builder.rb

@@ -0,0 +1,159 @@
+#
+# Author:: Lamont Granquist (<lamont@chef.io>)
+# Copyright:: Copyright 2015-2016, 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.
+#
+
+# NOTE: this was extracted from the Recipe DSL mixin, relevant specs are in spec/unit/recipe_spec.rb
+
+if Gem::Requirement.new("< 12.10.24").satisfied_by?(Gem::Version.new(Chef::VERSION))
+  begin
+    require 'chef/resource_builder'
+    # we use the LoadError this creates on early 12.x to not monkeypatch chef client versions that don't have Chef::ResourceBuilder
+    # (it is lazily included and doesn't appear until compile time so we can't resolve the symbol during library loading)
+
+    class Chef
+      class ResourceBuilder
+        attr_reader :type
+        attr_reader :name
+        attr_reader :created_at
+        attr_reader :params
+        attr_reader :run_context
+        attr_reader :cookbook_name
+        attr_reader :recipe_name
+        attr_reader :enclosing_provider
+        attr_reader :resource
+
+        # FIXME (ruby-2.1 syntax): most of these are mandatory
+        def initialize(type:nil, name:nil, created_at: nil, params: nil, run_context: nil, cookbook_name: nil, recipe_name: nil, enclosing_provider: nil)
+          @type               = type
+          @name               = name
+          @created_at         = created_at
+          @params             = params
+          @run_context        = run_context
+          @cookbook_name      = cookbook_name
+          @recipe_name        = recipe_name
+          @enclosing_provider = enclosing_provider
+        end
+
+        def build(&block)
+          raise ArgumentError, "You must supply a name when declaring a #{type} resource" if name.nil?
+
+          @resource = resource_class.new(name, run_context)
+          if resource.resource_name.nil?
+            raise Chef::Exceptions::InvalidResourceSpecification, "#{resource}.resource_name is `nil`!  Did you forget to put `provides :blah` or `resource_name :blah` in your resource class?"
+          end
+          resource.source_line = created_at
+          resource.declared_type = type
+
+          # If we have a resource like this one, we want to steal its state
+          # This behavior is very counter-intuitive and should be removed.
+          # See CHEF-3694, https://tickets.opscode.com/browse/CHEF-3694
+          # Moved to this location to resolve CHEF-5052, https://tickets.opscode.com/browse/CHEF-5052
+          if prior_resource
+            resource.load_from(prior_resource)
+          end
+
+          resource.cookbook_name = cookbook_name
+          resource.recipe_name = recipe_name
+          # Determine whether this resource is being created in the context of an enclosing Provider
+          resource.enclosing_provider = enclosing_provider
+
+          # XXX: this is required for definition params inside of the scope of a
+          # subresource to work correctly.
+          resource.params = params
+
+          # Evaluate resource attribute DSL
+          if block_given?
+            resource.resource_initializing = true
+            begin
+              resource.instance_eval(&block)
+            ensure
+              resource.resource_initializing = false
+            end
+          end
+
+          # emit a cloned resource warning if it is warranted
+          if prior_resource
+            if is_trivial_resource?(prior_resource) && identicalish_resources?(prior_resource, resource)
+              emit_harmless_cloning_debug
+            else
+              emit_cloned_resource_warning
+            end
+          end
+
+          # Run optional resource hook
+          resource.after_created
+
+          resource
+        end
+
+        private
+
+        def resource_class
+          # Checks the new platform => short_name => resource mapping initially
+          # then fall back to the older approach (Chef::Resource.const_get) for
+          # backward compatibility
+          @resource_class ||= Chef::Resource.resource_for_node(type, run_context.node)
+        end
+
+        def is_trivial_resource?(resource)
+          identicalish_resources?(resource_class.new(name, run_context), resource)
+        end
+
+        # this is an equality test specific to checking for 3694 cloning warnings
+        def identicalish_resources?(first, second)
+          skipped_ivars = [ :@source_line, :@cookbook_name, :@recipe_name, :@params, :@elapsed_time, :@declared_type ]
+          checked_ivars = ( first.instance_variables | second.instance_variables ) - skipped_ivars
+          non_matching_ivars = checked_ivars.reject do |iv|
+            if iv == :@action && ( [first.instance_variable_get(iv)].flatten == [:nothing] || [second.instance_variable_get(iv)].flatten == [:nothing] )
+              # :nothing action on either side of the comparison always matches
+              true
+            else
+              first.instance_variable_get(iv) == second.instance_variable_get(iv)
+            end
+          end
+          Chef::Log.debug("ivars which did not match with the prior resource: #{non_matching_ivars}")
+          non_matching_ivars.empty?
+        end
+
+        def emit_cloned_resource_warning
+          Chef::Log.warn("Cloning resource attributes for #{resource} from prior resource (CHEF-3694)")
+          Chef::Log.warn("Previous #{prior_resource}: #{prior_resource.source_line}") if prior_resource.source_line
+          Chef::Log.warn("Current  #{resource}: #{resource.source_line}") if resource.source_line
+        end
+
+        def emit_harmless_cloning_debug
+          Chef::Log.debug("Harmless resource cloning from #{prior_resource}:#{prior_resource.source_line} to #{resource}:#{resource.source_line}")
+        end
+
+        def prior_resource
+          @prior_resource ||=
+            begin
+              key = "#{type}[#{name}]"
+              run_context.resource_collection.lookup_local(key)
+            rescue Chef::Exceptions::ResourceNotFound
+              nil
+            end
+        end
+
+      end
+    end
+  rescue LoadError
+    # cool we're just on early chef 12.x, nothing to do -- we don't have to worry because there's also not parent_run_context pointer, so we don't have to
+    # use lookup_local to avoid resource cloning shit out of the parent run_context.  the resource collection's lookup() method will always use lookup_local
+    # over lookup_recursive.
+  end
+end

data/files/lib/compat_resource/gemspec.rb

@@ -21,7 +21,6 @@ module CompatResource
     s.add_development_dependency 'rake'
     s.add_development_dependency 'rspec'
     s.add_development_dependency 'cheffish'
-    s.add_development_dependency 'stove'
     s.add_development_dependency 'chef'
 
     s.bindir       = "files/bin"

data/files/lib/compat_resource/version.rb

@@ -1,3 +1,3 @@
 module CompatResource
-  VERSION = '12.10.1'
+  VERSION = '12.10.2'
 end

data/files/spec/cookbook_spec.rb

@@ -19,6 +19,8 @@ describe "compat_resource cookbook" do
                  File.join(cookbooks_path, 'hybrid'))
     File.symlink(File.expand_path('../data/cookbooks/notifications', __FILE__),
                  File.join(cookbooks_path, 'notifications'))
+    File.symlink(File.expand_path('../data/cookbooks/cloning', __FILE__),
+                 File.join(cookbooks_path, 'cloning'))
   end
 
   require 'chef/mixin/shell_out'
@@ -43,6 +45,11 @@ describe "compat_resource cookbook" do
     puts result.stderr
   end
 
+  it "should not clone resources from the outer run context" do
+    result = run_chef("-o future::declare_resource,cloning::default")
+    expect(result.stdout).not_to match(/3694/)
+  end
+
   it "when chef-client runs the test recipe, it succeeds" do
     result = run_chef("-o test::test,test")
     puts result.stdout

data/files/spec/data/cookbooks/cloning/metadata.rb

@@ -0,0 +1,3 @@
+name "cloning"
+description "cookbook that DOES NOT depend on compat_resource"
+version "1.0.0"

data/files/spec/data/cookbooks/cloning/providers/resource.rb

@@ -0,0 +1,9 @@
+provides :resource
+
+use_inline_resources
+
+action :create do
+  log "stuff" do
+    only_if { true }
+  end
+end

data/files/spec/data/cookbooks/cloning/recipes/default.rb

@@ -0,0 +1,3 @@
+log "stuff"
+
+resource "doit"

data/files/spec/data/cookbooks/cloning/resources/resource.rb

@@ -0,0 +1,2 @@
+provides :resource
+resource_name :resource

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compat_resource
 version: !ruby/object:Gem::Version
-  version: 12.10.1
+  version: 12.10.2
 platform: ruby
 authors:
 - John Keiser
 autorequire: 
 bindir: files/bin
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: stove
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +104,7 @@ files:
 - files/lib/chef_compat/monkeypatches/chef/recipe.rb
 - files/lib/chef_compat/monkeypatches/chef/resource.rb
 - files/lib/chef_compat/monkeypatches/chef/resource/lwrp_base.rb
+- files/lib/chef_compat/monkeypatches/chef/resource_builder.rb
 - files/lib/chef_compat/monkeypatches/chef/resource_collection.rb
 - files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_list.rb
 - files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_set.rb
@@ -131,10 +118,12 @@ files:
 - files/lib/compat_resource/gemspec.rb
 - files/lib/compat_resource/version.rb
 - files/spec/cookbook_spec.rb
-- files/spec/data/.bundle/config
 - files/spec/data/Gemfile
-- files/spec/data/Gemfile.lock
 - files/spec/data/config.rb
+- files/spec/data/cookbooks/cloning/metadata.rb
+- files/spec/data/cookbooks/cloning/providers/resource.rb
+- files/spec/data/cookbooks/cloning/recipes/default.rb
+- files/spec/data/cookbooks/cloning/resources/resource.rb
 - files/spec/data/cookbooks/future/libraries/future_custom_resource.rb
 - files/spec/data/cookbooks/future/libraries/super_properties.rb
 - files/spec/data/cookbooks/future/metadata.rb

data/files/spec/data/.bundle/config

@@ -1 +0,0 @@
---- {}

data/files/spec/data/Gemfile.lock

@@ -1,94 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    chef (12.0.3)
-      chef-zero (~> 3.2)
-      diff-lcs (~> 1.2, >= 1.2.4)
-      erubis (~> 2.7)
-      ffi-yajl (~> 1.2)
-      highline (~> 1.6, >= 1.6.9)
-      mixlib-authentication (~> 1.3)
-      mixlib-cli (~> 1.4)
-      mixlib-config (~> 2.0)
-      mixlib-log (~> 1.3)
-      mixlib-shellout (>= 2.0.0.rc.0, < 3.0)
-      net-ssh (~> 2.6)
-      net-ssh-multi (~> 1.1)
-      ohai (~> 8.0)
-      plist (~> 3.1.0)
-      pry (~> 0.9)
-    chef-zero (3.2.1)
-      ffi-yajl (~> 1.1)
-      hashie (~> 2.0)
-      mixlib-log (~> 1.3)
-      rack
-      uuidtools (~> 2.1)
-    coderay (1.1.1)
-    diff-lcs (1.2.5)
-    erubis (2.7.0)
-    ffi (1.9.10)
-    ffi-yajl (1.4.0)
-      ffi (~> 1.5)
-      libyajl2 (~> 1.2)
-    hashie (2.1.2)
-    highline (1.7.8)
-    ipaddress (0.8.3)
-    libyajl2 (1.2.0)
-    method_source (0.8.2)
-    mime-types (2.99.1)
-    mixlib-authentication (1.4.0)
-      mixlib-log
-      rspec-core (~> 3.2)
-      rspec-expectations (~> 3.2)
-      rspec-mocks (~> 3.2)
-    mixlib-cli (1.6.0)
-    mixlib-config (2.2.1)
-    mixlib-log (1.6.0)
-    mixlib-shellout (2.2.6)
-    net-ssh (2.9.4)
-    net-ssh-gateway (1.2.0)
-      net-ssh (>= 2.6.5)
-    net-ssh-multi (1.2.1)
-      net-ssh (>= 2.6.5)
-      net-ssh-gateway (>= 1.2.0)
-    ohai (8.4.0)
-      ffi (~> 1.9)
-      ffi-yajl (>= 1.1, < 3.0)
-      ipaddress
-      mime-types (~> 2.0)
-      mixlib-cli
-      mixlib-config (~> 2.0)
-      mixlib-log
-      mixlib-shellout (~> 2.0)
-      rake (~> 10.1)
-      systemu (~> 2.6.4)
-      wmi-lite (~> 1.0)
-    plist (3.1.0)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rack (1.6.4)
-    rake (10.5.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    slop (3.6.0)
-    systemu (2.6.5)
-    uuidtools (2.1.5)
-    wmi-lite (1.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  chef (~> 12.0.0)
-
-BUNDLED WITH
-   1.12.1