chef-sugar-sre 5.1.13

data/lib/chef/sugar/constraints_dsl.rb

@@ -0,0 +1,83 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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 'constraints'
+
+class Chef
+  module Sugar
+    #
+    # The Constraints DSL methods were broken out into this separate
+    # file to allow projects (such as Omnibus) to consume the
+    # Chef::Sugar::Constraints classes without the DSL methods
+    # stepping on existing methods of the same name.
+    #
+    module Constraints
+      extend self
+
+      #
+      # Shortcut method for creating a new {Version} object.
+      #
+      # @param [String] version
+      #   the version (as a string) to create
+      #
+      # @return [Chef::Sugar::Constraints::Version]
+      #   the new version object
+      #
+      def version(version)
+        Chef::Sugar::Constraints::Version.new(version)
+      end
+
+      #
+      # Shortcut method for creating a new {Constraint} object.
+      #
+      # @param [String, Array<String>] constraints
+      #   the list of constraints to use
+      #
+      # @return [Chef::Sugar::Constraints::Constraint]
+      #   the new constraint object
+      #
+      def constraint(*constraints)
+        Chef::Sugar::Constraints::Constraint.new(*constraints)
+      end
+    end
+
+    module DSL
+      # @see Chef::Sugar::Constraints#version
+      def version(version)
+        Chef::Sugar::Constraints::Version.new(version)
+      end
+
+      # @see Chef::Sugar::Constraints#constraint
+      def constraint(*constraints)
+        Chef::Sugar::Constraints.constraint(*constraints)
+      end
+
+      #
+      # This wrapper/convenience method is only available in the recipe DSL. It
+      # creates a new version object from the {Chef::VERSION}.
+      #
+      # @example Check if Chef 11+
+      #   chef_version.satisfies?('>= 11.0.0')
+      #
+      # @return [Chef::Sugar::Constraints::Version]
+      #   a version object, wrapping the current {Chef::VERSION}
+      #
+      def chef_version
+        version(Chef::VERSION)
+      end
+    end
+  end
+end

data/lib/chef/sugar/core_extensions/array.rb

@@ -0,0 +1,34 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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 '../constraints'
+
+class Array
+  #
+  # Treat an array of objects as version constraints.
+  #
+  # @see Chef::Sugar::Constraints::Constraint
+  #
+  # @example Using pure Array<String> objects like constraints
+  #   ['> 2.0.0', '< 3.0.0'].satisfied_by?('2.1.0')
+  #
+  # @param [String] version
+  #   the version to check if it is satisfied
+  #
+  def satisfied_by?(version)
+    Chef::Sugar::Constraints::Constraint.new(*dup).satisfied_by?(version)
+  end unless method_defined?(:satisfied_by?)
+end

data/lib/chef/sugar/core_extensions/object.rb

@@ -0,0 +1,27 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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.
+#
+
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # This is implemented in rails.
+  #
+  # @example foo.nil? || foo.empty? can be replaced by foo.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end unless method_defined?(:blank?)
+end

data/lib/chef/sugar/core_extensions/string.rb

@@ -0,0 +1,66 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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 '../constraints'
+
+class String
+  #
+  # Treat strings as version objects.
+  #
+  # @see Chef::Sugar::Constraints::Version
+  #
+  # @example Using pure string objects like versions
+  #   '1.2.3'.satisfies?('~> 1.2.0')
+  #
+  # @param [String, Array<String>] constraints
+  #   the list of constraints to satisfy
+  #
+  def satisfies?(*constraints)
+    Chef::Sugar::Constraints::Version.new(dup).satisfies?(*constraints)
+  end unless method_defined?(:satisfies?)
+
+  #
+  # Treat strings as version constraints.
+  #
+  # @see Chef::Sugar::Constraints::Constraint
+  #
+  # @example Using pure string objects like constraints
+  #   '~> 1.2.0'.satisfied_by?('1.2.3')
+  #
+  # @param [String] version
+  #   the version to check if it is satisfied
+  #
+  def satisfied_by?(version)
+    Chef::Sugar::Constraints::Constraint.new(dup).satisfied_by?(version)
+  end unless method_defined?(:satisfied_by?)
+
+  #
+  # Left-flush a string based off of the number of whitespace characters on the
+  # first line. This is especially useful for heredocs when whitespace matters.
+  #
+  # @example Remove leading whitespace and flush
+  #   <<-EOH.flush
+  #     def method
+  #       'This is a string!'
+  #     end
+  #   EOH #=>"def method\n  'This is a string!'\nend"
+  #
+  # @return [String]
+  #
+  def flush
+    gsub(/^#{self[/\A\s*/]}/, '').chomp
+  end unless method_defined?(:flush)
+end

data/lib/chef/sugar/core_extensions.rb

@@ -0,0 +1,19 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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 'core_extensions/array'
+require_relative 'core_extensions/string'
+require_relative 'core_extensions/object'

data/lib/chef/sugar/data_bag.rb

@@ -0,0 +1,146 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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.
+#
+
+class Chef
+  module Sugar
+    module DataBag
+      class EncryptedDataBagSecretNotGiven < StandardError
+        def initialize
+          super <<-EOH
+You did not set your `encrypted_data_bag_secret'! In order to use the
+`encrypted_data_bag_item' helper, you must load your encrypted data bag secret
+into the `Chef::Config'.
+
+Alternatively, you can pass the secret key as the last parameter to the method
+call. For more information, please see
+http://docs.opscode.com/chef/essentials_data_bags.html#access-from-recipe.
+EOH
+        end
+      end
+
+      extend self
+
+      #
+      # Helper method for loading an encrypted data bag item in a similar
+      # syntax/recipe DSL method.
+      #
+      # @param [String] bag
+      #   the name of the encrypted data bag
+      # @param [String] id
+      #   the id of the encrypted data bag
+      # @param [String] secret
+      #   the encrypted data bag secret raw value
+      #
+      # @return [Hash]
+      #
+      def encrypted_data_bag_item(bag, id, secret = nil)
+        Chef::Log.debug "Loading encrypted data bag item #{bag}/#{id}"
+
+        if secret.nil? && Chef::Config[:encrypted_data_bag_secret].nil?
+          raise EncryptedDataBagSecretNotGiven.new
+        end
+
+        secret ||= File.read(Chef::Config[:encrypted_data_bag_secret]).strip
+        Chef::EncryptedDataBagItem.load(bag, id, secret)
+      end
+
+      #
+      # This algorithm attempts to find the data bag entry for the current
+      # node's Chef environment. If there are no environment-specific
+      # values, the "default" bucket is used. The data bag must follow the
+      # schema:
+      #
+      #   {
+      #     "default": {...},
+      #     "environment_name": {...},
+      #     "other_environment": {...},
+      #   }
+      #
+      # @param [Node] node
+      #   the current Chef node
+      # @param [String] bag
+      #   the name of the encrypted data bag
+      # @param [String] id
+      #   the id of the encrypted data bag
+      # @param [String] secret
+      #   the encrypted data bag secret (default's to the +Chef::Config+ value)
+      #
+      # @return [Hash]
+      #
+      def encrypted_data_bag_item_for_environment(node, bag, id, secret = nil)
+        data = encrypted_data_bag_item(bag, id, secret)
+
+        if data[node.chef_environment]
+          Chef::Log.debug "Using #{node.chef_environment} as the key"
+          data[node.chef_environment]
+        else
+          Chef::Log.debug "#{node.chef_environment} key does not exist, using `default`"
+          data['default']
+        end
+      end
+
+      #
+      # This algorithm attempts to find the data bag entry for the current
+      # node's Chef environment. If there are no environment-specific
+      # values, the "default" bucket is used. The data bag must follow the
+      # schema:
+      #
+      #   {
+      #     "default": {...},
+      #     "environment_name": {...},
+      #     "other_environment": {...},
+      #   }
+      #
+      # @param [Node] node
+      #   the current Chef node
+      # @param [String] bag
+      #   the name of the data bag
+      # @param [String] id
+      #   the id of the data bag
+      #
+      # @return [Hash]
+      #
+      def data_bag_item_for_environment(node, bag, id)
+        data = Chef::DataBagItem.load(bag, id)
+
+        if data[node.chef_environment]
+          Chef::Log.debug "Using #{node.chef_environment} as the key"
+          data[node.chef_environment]
+        else
+          Chef::Log.debug "#{node.chef_environment} key does not exist, using `default`"
+          data['default']
+        end
+      end
+    end
+
+    module DSL
+      # @see Chef::Sugar::DataBag#encrypted_data_bag_item
+      def encrypted_data_bag_item(bag, id, secret = nil)
+        Chef::Sugar::DataBag.encrypted_data_bag_item(bag, id, secret)
+      end
+
+      # @see Chef::Sugar::DataBag#encrypted_data_bag_item_for_environment
+      def encrypted_data_bag_item_for_environment(bag, id, secret = nil)
+        Chef::Sugar::DataBag.encrypted_data_bag_item_for_environment(node, bag, id, secret)
+      end
+
+      # @see Chef::Sugar::DataBag#data_bag_item_for_environment
+      def data_bag_item_for_environment(bag, id)
+        Chef::Sugar::DataBag.data_bag_item_for_environment(node, bag, id)
+      end
+    end
+  end
+end

data/lib/chef/sugar/deprecation.rb

@@ -0,0 +1,45 @@
+#
+# 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.
+#
+
+if defined?(Chef::Deprecated::Base)
+  class Chef
+    class Deprecated
+      class ChefSugar < Base
+        def id
+          28
+        end
+        def target
+          "chef_sugar.html"
+        end
+      end
+    end
+  end
+end
+
+class Chef
+  module Sugar
+    module Deprecation
+      if defined?(Chef::Deprecated::Base)
+        def deprecated(message)
+          Chef.deprecated(:chef_sugar, message)
+        end
+      else
+        def deprecated(message)
+          Chef::Log.warn(message)
+        end
+      end
+      extend self
+    end
+  end
+end

data/lib/chef/sugar/docker.rb

@@ -0,0 +1,45 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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.
+#
+
+class Chef
+  module Sugar
+    module Docker
+      extend self
+
+      # these helpers have been moved to core chef
+      if !defined?(Chef::VERSION) || Gem::Requirement.new("< 15.4.70").satisfied_by?(Gem::Version.new(Chef::VERSION))
+        #
+        # Returns true if the current node is a docker container.
+        #
+        # @param [Chef::Node] node
+        #   the node to check
+        #
+        # @return [Boolean]
+        #
+        def docker?(node)
+          File.exist?('/.dockerinit') || File.exist?('/.dockerenv')
+        end
+      end
+    end
+
+    module DSL
+      if !defined?(Chef::VERSION) || Gem::Requirement.new("< 15.4.70").satisfied_by?(Gem::Version.new(Chef::VERSION))
+        # @see Chef::Sugar::Docker#docker?
+        def docker?; Chef::Sugar::Docker.docker?(node); end
+      end
+    end
+  end
+end

data/lib/chef/sugar/filters.rb

@@ -0,0 +1,227 @@
+class Chef
+  module Sugar
+    module Filters
+      #
+      # Evaluate resources at compile time instead of converge time.
+      #
+      class AtCompileTime
+        def initialize(recipe)
+          @recipe = recipe
+        end
+
+        def evaluate(&block)
+          instance_eval(&block)
+        end
+
+        def method_missing(m, *args, &block)
+          resource = @recipe.send(m, *args, &block)
+
+          if resource.is_a?(Chef::Resource)
+            actions = Array(resource.action)
+            resource.action(:nothing)
+
+            actions.each do |action|
+              resource.run_action(action)
+            end
+          end
+
+          resource
+        end
+      end
+
+      #
+      # A top-level class for manipulation the resource collection.
+      #
+      class Injector
+        def initialize(recipe, identifier, placement)
+          @recipe              = recipe
+          @resource_collection = @recipe.run_context.resource_collection
+          @resource            = @resource_collection.lookup(identifier)
+          @placement           = placement
+        end
+
+        def evaluate(&block)
+          instance_eval(&block)
+        end
+
+        def insert_before(resource, new_resource)
+          @resource_collection.instance_eval do
+            # Remove the resource because it's automatically created
+            @resources.delete_at(@resources_by_name[new_resource.to_s])
+            @resources_by_name.delete(new_resource.to_s)
+
+            index = @resources_by_name[resource.to_s]
+            @resources.insert(index, new_resource)
+            @resources_by_name[new_resource.to_s] = index
+          end
+        end
+
+        def insert_after(resource, new_resource)
+          @resource_collection.instance_eval do
+            # Remove the resource because it's automatically created
+            @resources.delete_at(@resources_by_name[new_resource.to_s])
+            @resources_by_name.delete(new_resource.to_s)
+
+            index = @resources_by_name[resource.to_s] + 2
+            @resources.insert(index, new_resource)
+            @resources_by_name[new_resource.to_s] = index
+          end
+        end
+
+        def method_missing(m, *args, &block)
+          new_resource = @recipe.send(m, *args, &block)
+
+          case @placement
+          when :before
+            insert_before(@resource, new_resource)
+          when :after
+            insert_after(@resource, new_resource)
+          else
+            super
+          end
+        end
+      end
+    end
+
+    module DSL
+      #
+      # Dynamically run resources specified in the block during the compilation
+      # phase, instead of the convergence phase.
+      #
+      # @example The old way
+      #   package('apache2') do
+      #     action :nothing
+      #   end.run_action(:install)
+      #
+      # @example The new way
+      #   at_compile_time do
+      #     package('apache2')
+      #   end
+      #
+      # @example Resource actions are run in order
+      #   at_compile_time do
+      #     service 'apache2' do
+      #       action [:enable, :start] # run_action(:enable), run_action(:start)
+      #     end
+      #   end
+      #
+      def at_compile_time(&block)
+        Chef::Sugar::Filters::AtCompileTime.new(self).evaluate(&block)
+      end
+
+      #
+      # Dynamically insert resources before an existing resource in the
+      # resource_collection.
+      #
+      # @example Write a custom template before the apache2 service actions
+      #          are run
+      #   before 'service[apache2]' do
+      #     template '/etc/apache2/thing.conf' do
+      #       source '...'
+      #     end
+      #   end
+      #
+      #
+      # @param [String] identifier
+      #   the +resource[name]+ identifier string
+      #
+      def before(identifier, &block)
+        Chef::Sugar::Filters::Injector.new(self, identifier, :before).evaluate(&block)
+      end
+
+      #
+      # Dynamically insert resources after an existing resource in the
+      # resource_collection.
+      #
+      # @example Write a custom template after the apache2 service actions
+      #          are run
+      #   after 'service[apache2]' do
+      #     template '/etc/apache2/thing.conf' do
+      #       source '...'
+      #     end
+      #   end
+      #
+      #
+      # @param [String] identifier
+      #   the +resource[name]+ identifier string
+      #
+      def after(identifier, &block)
+        Chef::Sugar::Filters::Injector.new(self, identifier, :after).evaluate(&block)
+      end
+    end
+
+    module RecipeDSL
+      #
+      # @deprecated The description is in the method body pretty accurately...
+      #
+      def compile_time(&block)
+        message = <<-EOH
+
+The Chef Sugar recipe DSL method `compile_time' has been renamed to
+`at_compile_time'! This is a breaking change that was released in a patch
+version, so please continue reading to understand the necessary semantic
+versioning violation.
+
+Chef Software implemented a version of `compile_time' in Chef 12.1, breaking any 
+cookbook that uses or depends on Chef Sugar on Chef 12.1:
+
+    https://www.chef.io/blog/2015/03/03/chef-12-1-0-released
+
+In order to progress Chef Sugar forward, the DSL method has been renamed to
+avoid the namespace collision.
+
+In short, you should change this:
+
+    compile_time do
+      # ...
+    end
+
+to this:
+
+    at_compile_time do
+      # ...
+    end
+
+EOH
+
+        if Chef::Resource::ChefGem.instance_methods(false).include?(:compile_time)
+          message << <<-EOH
+You are running a version of Chef Client that includes the `compile_time'
+attribute on core Chef resources (most likely Chef 12.1+). Instead of continuing
+and having Chef provide you with an obscure error message, I am going to error
+here. There is no way for the Chef Recipe to successfully continue unless you
+change the Chef Sugar `compile_time' method to `at_compile_time' in your Chef
+recipes.
+
+You should NOT change resource-level `compile_time' attributes:
+
+    package "foo" do
+      compile_time true # Do NOT change these
+    end
+
+I truly apologize for the inconvienence and hope the reason for introducing this
+breaking change is clear. I am sorry if it causes extra work, but I promise this
+error message is much more informative than "wrong number of arguments".
+
+If you have any questions, please feel free to open an issue on GitHub at:
+
+    https://github.com/sethvargo/chef-sugar
+
+Thank you, and have a great day!
+EOH
+          raise RuntimeError, message
+        else
+          message << <<-EOH
+You are running a version of Chef Client that does not include the
+`compile_time' attribute on core Chef resources (most likely less than
+Chef 12.1), so this is just a warning. Please consider changing the Chef Sugar
+`compile_time' method to `at_compile_time' in your Chef recipes. If you upgrade
+Chef, your recipes WILL break.
+EOH
+          Chef::Log.warn(message)
+          at_compile_time(&block)
+        end
+      end
+    end
+  end
+end