poise 2.0.0

data/lib/poise/subcontext/runner.rb

@@ -0,0 +1,50 @@
+#
+# 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.
+#
+
+require 'chef/runner'
+
+
+module Poise
+  module Subcontext
+    # A subclass of the normal Chef Runner that migrates delayed notifications
+    # to the enclosing run_context instead of running them at the end of the
+    # subcontext convergence.
+    #
+    # @api private
+    # @since 1.0.0
+    class Runner < Chef::Runner
+      def initialize(resource, *args)
+        super(*args)
+        @resource = resource
+      end
+
+      def run_delayed_notifications(error=nil)
+        # If there is an error, just do the normal thing. The return shouldn't
+        # ever fire because the superclass re-raises if there is an error.
+        return super if error
+        delayed_actions.each do |notification|
+          notifications = run_context.delayed_notifications(@resource)
+          if run_context.delayed_notifications(@resource).any? { |existing_notification| existing_notification.duplicates?(notification) }
+              Chef::Log.info( "#{@resource} not queuing delayed action #{notification.action} on #{notification.resource}"\
+                              " (delayed), as it's already been queued")
+          else
+            notifications << notification
+          end
+        end
+      end
+    end
+  end
+end

data/lib/poise/utils.rb

@@ -0,0 +1,60 @@
+#
+# 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 'poise/error'
+
+
+module Poise
+  module Utils
+    autoload :ResourceProviderMixin, 'poise/utils/resource_provider_mixin'
+
+    extend self
+
+    # Find the cookbook name for a given filename. The can used to find the
+    # cookbook that corresponds to a caller of a file.
+    #
+    # @param run_context [Chef::RunContext] Context to check.
+    # @param filename [String] Absolute filename to check for.
+    # @return [String]
+    # @example
+    #   def my_thing
+    #     caller_filename = caller.first.split(':').first
+    #     cookbook = Poise::Utils.find_cookbook_name(run_context, caller_filename)
+    #     # ...
+    #   end
+    def find_cookbook_name(run_context, filename)
+      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, ''))
+            return name
+          end
+        else
+          Chef::CookbookVersion::COOKBOOK_SEGMENTS.each do |seg|
+            ver.segment_filenames(seg).each do |file|
+              if file == filename
+                return name
+              end
+            end
+          end
+        end
+      end
+      raise Poise::Error.new("Unable to find cookbook for file #{filename.inspect}")
+    end
+  end
+end

data/lib/poise/utils/resource_provider_mixin.rb

@@ -0,0 +1,53 @@
+#
+# 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.
+#
+
+
+module Poise
+  module Utils
+    # A mixin to dispatch other mixins with resource and provider
+    # implementations. The module this is included in must have Resource and
+    # Provider sub-modules.
+    #
+    # @since 2.0.0
+    # @example
+    #   module MyHelper
+    #     include Poise::Utils::ResourceProviderMixin
+    #     module Resource
+    #       # ...
+    #     end
+    #
+    #     module Provider
+    #       # ...
+    #     end
+    #   end
+    module ResourceProviderMixin
+      # @!classmethods
+      module ClassMethods
+        def included(klass)
+          super
+          klass.extend(ClassMethods)
+          if klass < Chef::Resource
+            klass.class_exec { include self::Resource }
+          elsif klass < Chef::Provider
+            klass.class_exec { include self::Provider }
+          end
+        end
+      end
+
+      extend ClassMethods
+    end
+  end
+end

data/lib/poise/version.rb

@@ -0,0 +1,20 @@
+#
+# 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
+  VERSION = '2.0.0'
+end

data/poise.gemspec

@@ -0,0 +1,38 @@
+#
+# 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.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poise/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'poise'
+  spec.version = Poise::VERSION
+  spec.authors = ['Noah Kantrowitz']
+  spec.email = %w{noah@coderanger.net}
+  spec.description = "Helpers for writing extensible Chef cookbooks."
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/poise/poise'
+  spec.license = 'Apache 2.0'
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w{lib}
+
+  spec.add_dependency 'halite', '~> 1.0'
+  spec.add_development_dependency 'poise-boiler', '~> 1.0'
+end

data/test/cookbooks/poise_test/attributes/default.rb

@@ -0,0 +1,17 @@
+#
+# 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.
+#
+
+default['poise_test']['c']['provider'] = 'two'

data/test/cookbooks/poise_test/libraries/app.rb

@@ -0,0 +1,43 @@
+#
+# 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.
+#
+
+require 'poise'
+
+
+class Chef
+  class Resource::App < Resource
+    include Poise(container: true)
+    default_action(:install)
+
+    attribute(:path, kind_of: String, name_attribute: true)
+    attribute(:user, kind_of: String, default: 'root')
+    attribute(:group, kind_of: String, default: 'root')
+  end
+
+  class Provider::App < Provider
+    include Poise
+
+    def action_install
+      notifying_block do
+        directory new_resource.path do
+          owner new_resource.user
+          group new_resource.group
+          mode '755'
+        end
+      end
+    end
+  end
+end

data/test/cookbooks/poise_test/libraries/app_config.rb

@@ -0,0 +1,46 @@
+#
+# 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.
+#
+
+require_relative 'app'
+
+class Chef
+  class Resource::AppConfig < Resource
+    include Poise(App)
+    default_action(:create)
+
+    attribute('', template: true, required: true)
+    attribute(:config_name, kind_of: String, default: lazy { name.split('::').last })
+
+    def path
+      ::File.join(parent.path, config_name+'.conf')
+    end
+  end
+
+  class Provider::AppConfig < Provider
+    include Poise
+
+    def action_create
+      notifying_block do
+        file new_resource.path do
+          owner new_resource.parent.user
+          group new_resource.parent.group
+          mode '644'
+          content new_resource.content
+        end
+      end
+    end
+  end
+end

data/test/cookbooks/poise_test/libraries/inversion.rb

@@ -0,0 +1,67 @@
+#
+# 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 'poise'
+
+
+module PoiseTest
+  module Inversion
+    class Resource < Chef::Resource
+      include Poise(inversion: true)
+      provides(:poise_test_inversion)
+      actions(:run)
+
+      attribute(:path, name_attribute: true)
+    end
+
+    class ProviderOne < Chef::Provider
+      include Poise(inversion: Resource)
+      provides(:one)
+
+      def self.provides_auto?(node, resource)
+        true
+      end
+
+      def action_run
+        file new_resource.path do
+          content 'one'
+        end
+      end
+    end
+
+    class ProviderTwo < Chef::Provider
+      include Poise(inversion: Resource)
+      provides(:two)
+
+      def action_run
+        file new_resource.path do
+          content 'two'
+        end
+      end
+    end
+
+    class ProviderThree < Chef::Provider
+      include Poise(inversion: Resource)
+      provides(:three)
+
+      def action_run
+        file new_resource.path do
+          content options['msg'] || 'three'
+        end
+      end
+    end
+  end
+end

data/test/cookbooks/poise_test/metadata.rb

@@ -0,0 +1,18 @@
+#
+# 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.
+#
+
+name 'poise_test'
+depends 'poise'

data/test/cookbooks/poise_test/recipes/default.rb

@@ -0,0 +1,25 @@
+#
+# 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.
+#
+
+app '/srv/app' do
+  app_config 'defaults' do
+    content 'some defaults'
+  end
+end
+
+app_config 'user' do
+  content 'user config'
+end