chef-sugar-ng 4.2.2

data/lib/chef/sugar/constraints.rb

@@ -0,0 +1,108 @@
+#
+# 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 Constraints
+      #
+      # This class is a wrapper around a version requirement that adds a nice
+      # DSL for comparing constraints:
+      #
+      # @example Comparing a single constraint
+      #   Constraint.new('~> 1.2.3').satisfied_by?('1.2.7')
+      #
+      # @example Comparing multiple constraints
+      #   Constraint.new('> 1.2.3', '< 2.0.0').satisfied_by?('1.2.7')
+      #
+      class Constraint
+        #
+        # Create a new constraint object.
+        #
+        # @param [String, Array<String>] constraints
+        #   the list of constraints
+        #
+        def initialize(*constraints)
+          @requirement = Gem::Requirement.new(*constraints)
+        end
+
+        #
+        # Determine if the given version string is satisfied by this constraint
+        # or group of constraints.
+        #
+        # @example Given a satisified constraint
+        #   Constraint.new('~> 1.2.0').satisfied_by?('1.2.5') #=> true
+        #
+        # @example Given an unsatisfied constraint
+        #   Constraint.new('~> 1.2.0').satisfied_by?('2.0.0') #=> false
+        #
+        #
+        # @param [String] version
+        #   the version to compare
+        #
+        # @return [Boolean]
+        #   true if the constraint is satisfied, false otherwise
+        #
+        def satisfied_by?(version)
+          @requirement.satisfied_by?(Gem::Version.new(version))
+        end
+      end
+
+      #
+      # This class exposes a single version constraint object that wraps the
+      # string representation of a version string and proved helpful comparator
+      # methods.
+      #
+      # @example Create a new version
+      #   Chef::Sugar::Version('1.2.3')
+      #
+      # @example Compare a version with constraints
+      #   Chef::Sugar::Version('1.2.3').satisfies?('~> 1.3.4', '< 2.0.5')
+      #
+      class Version < String
+        #
+        # Create a new version object.
+        #
+        # @param [String] version
+        #   the version to create
+        #
+        def initialize(version)
+          super
+          @version = Gem::Version.new(version)
+        end
+
+        #
+        # Determine if the given constraint is satisfied by this version.
+        #
+        # @example Given a satisified version
+        #   Version.new('1.2.5').satisfies?('~> 1.2.0') #=> true
+        #
+        # @example Given an unsatisfied version
+        #   Version.new('2.0.0').satisfies?('~> 1.2.0') #=> false
+        #
+        #
+        # @param [String, Array<String>] constraints
+        #   the constraints to satisfy
+        #
+        # @return [Boolean]
+        #   true if the version satisfies the constraints, false otherwise
+        #
+        def satisfies?(*constraints)
+          Gem::Requirement.new(*constraints).satisfied_by?(@version)
+        end
+      end
+    end
+  end
+end

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.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/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/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