chef-sugar 1.0.0.beta.1

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/chef-extensions.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chef/sugar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chef-sugar'
+  spec.version       = Chef::Sugar::VERSION
+  spec.authors       = ['Seth Vargo']
+  spec.email         = ['sethvargo@gmail.com']
+  spec.description   = 'A series of helpful sugar of the Chef core and ' \
+                       'other resources to make a cleaner, more lean recipe ' \
+                       'DSL, enforce DRY principles, and make writing Chef '  \
+                       'recipes an awesome experience!'
+  spec.summary       = 'A collection of helper methods and modules that '     \
+                       'make working with Chef recipes awesome.'
+  spec.homepage      = 'https://github.com/sethvargo/chef-sugar'
+  spec.license       = 'Apache 2.0'
+
+  spec.required_ruby_version = '>= 1.9'
+
+  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 = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'chef',  '~> 11.0'
+  spec.add_development_dependency 'rspec', '~> 2.11'
+
+  spec.add_development_dependency 'chefspec',        '~> 3.0.0.beta'
+  spec.add_development_dependency 'foodcritic',      '~> 3.0'
+  spec.add_development_dependency 'test-kitchen',    '~> 1.0.0.beta'
+  spec.add_development_dependency 'kitchen-vagrant', '~> 0.11'
+end

data/lib/chef/sugar.rb

@@ -0,0 +1,38 @@
+#
+# Copyright 2013, 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 'chef/recipe'
+require 'chef/resource'
+require 'chef/provider'
+
+class Chef
+  module Sugar
+    require_relative 'sugar/architecture'
+    require_relative 'sugar/cloud'
+    require_relative 'sugar/ip'
+    require_relative 'sugar/node'
+    require_relative 'sugar/platform'
+    require_relative 'sugar/platform_family'
+    require_relative 'sugar/ruby'
+    require_relative 'sugar/shell'
+    require_relative 'sugar/vagrant'
+    require_relative 'sugar/version'
+  end
+end
+
+Chef::Recipe.send(:include, Chef::Sugar::DSL)
+Chef::Resource.send(:include, Chef::Sugar::DSL)
+Chef::Provider.send(:include, Chef::Sugar::DSL)

data/lib/chef/sugar/architecture.rb

@@ -0,0 +1,53 @@
+#
+# Copyright 2013, 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 Architecture
+      extend self
+
+      #
+      # Determine if the current architecture is 64-bit
+      #
+      # @return [Boolean]
+      #
+      def _64_bit?(node)
+        node['kernel']['machine'] == 'x86_64'
+      end
+
+      #
+      # Determine if the current architecture is 32-bit
+      #
+      # @todo Make this more than "not 64-bit"
+      #
+      # @return [Boolean]
+      #
+      def _32_bit?(node)
+        !_64_bit?(node)
+      end
+      alias_method :i386?, :_32_bit?
+    end
+
+    module DSL
+      # @see Chef::Sugar::Architecture#_64_bit?
+      def _64_bit?; Chef::Sugar::Architecture._64_bit?(node); end
+
+      # @see Chef::Sugar::Architecture#_32_bit?
+      def _32_bit?; Chef::Sugar::Architecture._32_bit?(node); end
+      alias_method :i386?, :_32_bit?
+    end
+  end
+end

data/lib/chef/sugar/cloud.rb

@@ -0,0 +1,147 @@
+#
+# Copyright 2013, 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 Cloud
+      extend self
+
+      #
+      # Return true if the current current node is in "the cloud".
+      #
+      # @param [Chef::Node] node
+      #   the node to check
+      #
+      # @return [Boolean]
+      #
+      def cloud?(node)
+        node.key?('cloud')
+      end
+
+      #
+      # Return true if the current current node is in EC2
+      #
+      # @param [Chef::Node] node
+      #   the node to check
+      #
+      # @return [Boolean]
+      #
+      def ec2?(node)
+        node.key?('ec2')
+      end
+
+      #
+      # Return true if the current current node is in GCE
+      #
+      # @param [Chef::Node] node
+      #   the node to check
+      #
+      # @return [Boolean]
+      #
+      def gce?(node)
+        node.key?('gce')
+      end
+
+      #
+      # Return true if the current current node is in Rackspace
+      #
+      # @param [Chef::Node] node
+      #   the node to check
+      #
+      # @return [Boolean]
+      #
+      def rackspace?(node)
+        node.key?('rackspace')
+      end
+
+      #
+      # Return true if the current current node is in Eucalyptus
+      #
+      # @param [Chef::Node] node
+      #   the node to check
+      #
+      # @return [Boolean]
+      #
+      def eucalyptus?(node)
+        node.key?('eucalyptus')
+      end
+      alias_method :euca?, :eucalyptus?
+
+      #
+      # Return true if the current current node is in Linode
+      #
+      # @param [Chef::Node] node
+      #   the node to check
+      #
+      # @return [Boolean]
+      #
+      def linode?(node)
+        node.key?('linode')
+      end
+
+      #
+      # Return true if the current current node is in Openstack
+      #
+      # @param [Chef::Node] node
+      #   the node to check
+      #
+      # @return [Boolean]
+      #
+      def openstack?(node)
+        node.key?('openstack')
+      end
+
+      #
+      # Return true if the current current node is in Azure
+      #
+      # @param [Chef::Node] node
+      #   the node to check
+      #
+      # @return [Boolean]
+      #
+      def azure?(node)
+        node.key?('azure')
+      end
+    end
+
+    module DSL
+      # @see Chef::Sugar::Cloud#cloud?
+      def cloud?; Chef::Sugar::Cloud.cloud?(node); end
+
+      # @see Chef::Sugar::Cloud#ec2?
+      def ec2?; Chef::Sugar::Cloud.ec2?(node); end
+
+      # @see Chef::Sugar::Cloud#gce?
+      def gce?; Chef::Sugar::Cloud.gce?(node); end
+
+      # @see Chef::Sugar::Cloud#rackspace?
+      def rackspace?; Chef::Sugar::Cloud.rackspace?(node); end
+
+      # @see Chef::Sugar::Cloud#eucalyptus?
+      def eucalyptus?; Chef::Sugar::Cloud.eucalyptus?(node); end
+      alias_method :euca?, :eucalyptus?
+
+      # @see Chef::Sugar::Cloud#linode?
+      def linode?; Chef::Sugar::Cloud.linode?(node); end
+
+      # @see Chef::Sugar::Cloud#openstack?
+      def openstack?; Chef::Sugar::Cloud.openstack?(node); end
+
+      # @see Chef::Sugar::Cloud#azure?
+      def azure?; Chef::Sugar::Cloud.azure?(node); end
+    end
+  end
+end

data/lib/chef/sugar/ip.rb

@@ -0,0 +1,48 @@
+#
+# Copyright 2013, 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/node.rb

@@ -0,0 +1,41 @@
+#
+# Copyright 2013, 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
+  class Node
+    #
+    # 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)
+      environment === chef_environment
+    end
+
+    #
+    # Determine if the current node includes the given recipe name.
+    #
+    # @param [String] recipe_name
+    #
+    def includes_recipe?(recipe_name)
+      run_list.include?(recipe_name)
+    end
+    alias_method :include_recipe?, :includes_recipe?
+  end
+end

data/lib/chef/sugar/platform.rb

@@ -0,0 +1,166 @@
+#
+# Copyright 2013, 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 Platform
+      extend self
+
+      PLATFORM_VERSIONS = {
+        'debian' => {
+          'squeeze' => '6.0',
+          'wheezy'  => '7.0',
+          'jessie'  => '8.0',
+        },
+        'linuxmint' => {
+          'olivia' => '15',
+          'nadia'  => '14',
+          'maya'   => '13',
+          'lisa'   => '12',
+        },
+        'mac_os_x' => {
+          'lion'          => '10.7',
+          'mountain_lion' => '10.8',
+          'mavericks'     => '10.9',
+        },
+        'ubuntu' => {
+          'lucid'    => '10.04',
+          'maverick' => '10.10',
+          'natty'    => '11.04',
+          'oneiric'  => '11.10',
+          'precise'  => '12.04',
+          'quantal'  => '12.10',
+          'raring'   => '13.04',
+          'saucy'    => '13.10',
+        },
+      }
+
+      COMPARISON_OPERATORS = {
+        'after'        => ->(a, b) { a > b },
+        'after_or_at'  => ->(a, b) { a >= b },
+        ''             => ->(a, b) { a == b },
+        'before'       => ->(a, b) { a < b },
+        'before_or_at' => ->(a, b) { a <= b },
+      }
+
+      # Dynamically define custom matchers at runtime in a matrix. For each
+      # Platform, we create a map of named versions to their numerical
+      # equivalents (e.g. debian_before_squeeze?).
+      PLATFORM_VERSIONS.each do |platform, versions|
+        versions.each do |name, version|
+          COMPARISON_OPERATORS.each do |operator, block|
+            method_name = "#{platform}_#{operator}_#{name}?".squeeze('_').to_sym
+            define_method(method_name) do |node|
+              # Calling #to_f will ensure we only check major versions since
+              # '10.04.4'.to_f #=> 10.04.
+              node['platform'] == platform && block.call(node['platform_version'].to_f, version.to_f)
+            end
+          end
+        end
+      end
+
+      #
+      # Determine if the current node is linux mint.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def linux_mint?(node)
+        node['platform'] == 'linuxmint'
+      end
+      alias_method :mint?, :linux_mint?
+
+      #
+      # Determine if the current node is ubuntu.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def ubuntu?(node)
+        node['platform'] == 'ubuntu'
+      end
+
+      #
+      # Determine if the current node is amazon linux.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def amazon_linux?(node)
+        node['platform'] == 'amazon'
+      end
+      alias_method :amazon?, :amazon_linux?
+
+      #
+      # Determine if the current node is centos.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def centos?(node)
+        node['platform'] == 'centos'
+      end
+
+      #
+      # Determine if the current node is oracle linux.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def oracle_linux?(node)
+        node['platform'] == 'oracle'
+      end
+      alias_method :oracle?, :oracle_linux?
+
+      #
+      # Determine if the current node is scientific linux.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def scientific_linux?(node)
+        node['platform'] == 'scientific'
+      end
+      alias_method :scientific?, :scientific_linux?
+
+      #
+      # Determine if the current node is redhat enterprise.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def redhat_enterprise_linux?(node)
+        node['platform'] == 'enterprise'
+      end
+      alias_method :redhat_enterprise?, :redhat_enterprise_linux?
+    end
+
+    module DSL
+      Chef::Sugar::Platform.instance_methods.each do |name|
+        define_method(name) do
+          Chef::Sugar::Platform.send(name, node)
+        end
+      end
+    end
+  end
+end