chef-sugar-sre 5.1.13

data/lib/chef/sugar/init.rb

@@ -0,0 +1,61 @@
+#
+# Copyright 2015, Nathan Williams <nath.e.will@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 Init
+      extend self
+
+      #
+      # Determine if the current init system is systemd.
+      #
+      # @return [Boolean]
+      #
+      def systemd?(node)
+        File.exist?('/bin/systemctl')
+      end
+
+      #
+      # Determine if the current init system is upstart.
+      #
+      # @return [Boolean]
+      #
+      def upstart?(node)
+        File.executable?('/sbin/initctl')
+      end
+
+      #
+      # Determine if the current init system is runit.
+      #
+      # @return [Boolean]
+      #
+      def runit?(node)
+        File.executable?('/sbin/runit-init')
+      end
+    end
+
+    module DSL
+      # @see Chef::Sugar::Init#systemd?
+      def systemd?; Chef::Sugar::Init.systemd?(node); end
+
+      # @see Chef::Sugar::Init#upstart?
+      def upstart?; Chef::Sugar::Init.upstart?(node); end
+
+      # @see Chef::Sugar::Init#runit?
+      def runit?; Chef::Sugar::Init.runit?(node); end
+    end
+  end
+end

data/lib/chef/sugar/ip.rb

@@ -0,0 +1,48 @@
+#
+# 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 IP
+      extend self
+
+      #
+      # The best IP address for the given node, in the context of
+      # the current node. Useful for choosing a local IP address
+      # over a public one to limit bandwidth on cloud providers.
+      #
+      # @param [Chef::Node] other
+      #   the node to calculate the best IP address for
+      #
+      def best_ip_for(node, other)
+        if other['cloud']
+          if node['cloud'] && other['cloud']['provider'] == node['cloud']['provider']
+            other['cloud']['local_ipv4']
+          else
+            other['cloud']['public_ipv4']
+          end
+        else
+          other['ipaddress']
+        end
+      end
+    end
+
+    module DSL
+      # @see Chef::Sugar::IP#best_ip_for
+      def best_ip_for(other); Chef::Sugar::IP.best_ip_for(node, other); end
+    end
+  end
+end

data/lib/chef/sugar/kernel.rb

@@ -0,0 +1,49 @@
+#
+# 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 Kernel
+      class ChefGemLoadError < StandardError
+        def initialize(name)
+          super <<-EOH
+Chef could not load the gem `#{name}'! You may need to install the gem manually
+with `gem install #{name}', or include a recipe before you can use this
+resource. Please consult the documentation for this cookbook for proper usage.
+EOH
+        end
+      end
+
+      #
+      # Require a gem that should have been installed by Chef, such as in a
+      # recipes as a +chef_gem+. This method will gracefully degrade if the
+      # gem cannot be loaded.
+      #
+      # @param [String] name
+      #   the name of the gem to install
+      #
+      # @return [Boolean]
+      #   true if the require is successful and false if the gem is already
+      #   loaded
+      #
+      def require_chef_gem(name)
+        require(name)
+      rescue LoadError
+        raise ChefGemLoadError.new(name)
+      end
+    end
+  end
+end

data/lib/chef/sugar/kitchen.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 Kitchen
+      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 provisioned by Test Kitchen.
+        #
+        # @param [Chef::Node] node
+        #   the node to check
+        #
+        # @return [Boolean]
+        #
+        def kitchen?(node)
+          !ENV['TEST_KITCHEN'].nil?
+        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::Kitchen#kitchen?
+        def kitchen?; Chef::Sugar::Kitchen.kitchen?(node); end
+      end
+    end
+  end
+end

data/lib/chef/sugar/node.rb

@@ -0,0 +1,219 @@
+#
+# 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 "deprecation"
+
+class Chef
+  class Node
+    class AttributeDoesNotExistError < StandardError
+      def initialize(keys, key)
+        hash = keys.map { |key| "['#{key}']" }
+
+        super <<-EOH
+No attribute `node#{hash.join}' exists on
+the current node. Specifically the `#{key}' attribute is not
+defined. Please make sure you have spelled everything correctly.
+EOH
+      end
+    end
+    #
+    # Determine if the current node is in the given Chef environment
+    # (or matches the given regular expression).
+    #
+    # @param [String, Regex] environment
+    #
+    # @return [Boolean]
+    #
+    def in?(environment)
+      Chef::Sugar::Deprecation.deprecated "the chef-sugar node.in? method is deprecated"
+      environment === chef_environment
+    end
+
+    #
+    # Safely fetch a deeply nested attribute by specifying a list of keys,
+    # bypassing Ruby's Hash notation. This method swallows +NoMethodError+
+    # exceptions, avoiding the most common error in Chef-land.
+    #
+    # This method will return +nil+ if any deeply nested key does not exist.
+    #
+    # @see [Node#deep_fetch!]
+    #
+    def deep_fetch(*keys)
+      Chef::Sugar::Deprecation.deprecated "the chef-sugar deep_fetch method is deprecated and should be replaced by node.read"
+      deep_fetch!(*keys)
+    rescue NoMethodError, AttributeDoesNotExistError
+      nil
+    end
+
+    #
+    # Deeply fetch a node attribute by specifying a list of keys, bypassing
+    # Ruby's Hash notation.
+    #
+    # This method will raise any exceptions, such as
+    # +undefined method `[]' for nil:NilClass+, just as if you used the native
+    # attribute notation. If you want a safely vivified hash, see {deep_fetch}.
+    #
+    # @example Fetch a deeply nested key
+    #   node.deep_fetch(:foo, :bar, :zip) #=> node['foo']['bar']['zip']
+    #
+    # @param [Array<String, Symbol>] keys
+    #   the list of keys to kdeep fetch
+    #
+    # @return [Object]
+    #
+    def deep_fetch!(*keys)
+      Chef::Sugar::Deprecation.deprecated "the chef-sugar deep_fetch method is deprecated and should be replaced by node.read!"
+      keys.map!(&:to_s)
+
+      keys.inject(attributes.to_hash) do |hash, key|
+        if hash.key?(key)
+          hash[key]
+        else
+          raise AttributeDoesNotExistError.new(keys, key)
+        end
+      end
+    end
+
+    #
+    # Dynamically define the current namespace. Multiple namespaces may be
+    # nested.
+    #
+    # @example Define a simple namespace
+    #
+    #   namespace 'apache2' do
+    #     # ...
+    #   end
+    #
+    # @example Define a nested namespace
+    #
+    #   namespace 'apache2', 'config' do
+    #     # ...
+    #   end
+    #
+    # @example Define a complex nested namespace
+    #
+    #   namespace 'apache2' do
+    #     namespace 'config' do
+    #       # ...
+    #     end
+    #   end
+    #
+    # @example Define a namespace with a custom precedence level
+    #
+    #   namespace 'apache2', precedence: normal do
+    #     # Attributes here will use the "normal" level
+    #   end
+    #
+    # @example Define different nested precedence levels
+    #
+    #   namespace 'apache2', precedence: normal do
+    #     # Attributes defined here will use the "normal" level
+    #
+    #     namespace 'config', precedence: override do
+    #       # Attributes defined  here will use the "override" level
+    #     end
+    #   end
+    #
+    #
+    # @param [Array] args
+    #   the list of arguments (such as the namespace and precedence levels)
+    #   the user gave
+    # @param [Proc] block
+    #   the nested evaluation context
+    #
+    # @return [nil]
+    #   to prevent accidential method chaining if the block isn't closed
+    #
+    def namespace(*args, &block)
+      Chef::Sugar::Deprecation.deprecated "the chef-sugar attribute namespace setting is deprecated, please use traditional chef attribute notation"
+      @namespace_options = namespace_options.merge(args.last.is_a?(Hash) ? args.pop : {})
+
+      keys = args.map(&:to_s)
+
+      @current_namespace = current_namespace + keys
+      instance_eval(&block)
+      @current_namespace = current_namespace - keys
+
+      if @current_namespace.empty?
+        @namespace_options = nil
+      end
+      nil
+    end
+
+    alias_method :old_method_missing, :method_missing
+    #
+    # Provide a nice DSL for defining attributes. +method_missing+ is called
+    # on all the attribute names. For more information on how to use the DSL,
+    # see the class-level documentation.
+    #
+    # @return [nil]
+    #   to prevent accidential method chaining if the block isn't closed
+    # @return [Object]
+    #   If no argument is passed in, method becomes an attribute accessor
+    #
+    def method_missing(m, *args, &block)
+      old_method_missing(m, *args, &block)
+    rescue NoMethodError
+      # The Node Attribute's key is the method name
+      key = m.to_s
+      # If arguments are passed in, set node attribute with args as the value
+      if args.size > 0
+        vivified[key] = args.size == 1 ? args.first : args
+        return nil
+      # If no arguments are passed in, attempt to access corresponding attribute
+      else
+        deep_key = current_namespace.dup << key
+        return deep_fetch!(*deep_key)
+      end
+    end
+
+    private
+
+    #
+    # The namespace options.
+    #
+    # @return [Hash]
+    #
+    def namespace_options
+      @namespace_options ||= {
+        precedence: default
+      }
+    end
+
+    #
+    # The current namespace. This is actually a reverse-ordered array that
+    # vivifies the correct hash.#
+    #
+    # @return [Array<String>]
+    #
+    def current_namespace
+      @current_namespace ||= []
+    end
+
+    #
+    # The vivified (fake-filled) hash. It is assumed that the default value
+    # for non-existent keys in the hash is a new, empty hash.
+    #
+    # @return [Hash<String, Hash>]
+    #
+    def vivified
+      current_namespace.inject(namespace_options[:precedence]) do |hash, item|
+        hash[item] ||= {}
+        hash[item]
+      end
+    end
+  end
+end