chef-sugar 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e465a9d96bf0fdbc8f6456ea39bc616d2cbc7a8d
-  data.tar.gz: 16bb961fe714064dd2e06460db620053ee7274f5
+  metadata.gz: cb7fd64f85beb2f7d54f0db0eeeddc14a7062c4c
+  data.tar.gz: 81314e1d07f9f66f6aaacec9791c136f18742e7d
 SHA512:
-  metadata.gz: aad1b49fee02c34af4a72acfbe0aeadfc0c875fd6fbf654f83331f73b2608736d75b4404d1640a38cf6ba2f9ee66c9ba11bd62ce0ad60855094771e1a070bcf6
-  data.tar.gz: fb9fbad59102cfba1a21603d8982aeff403bb97a2442ae91c2179e33e825db5be42b560955d7c477415e0e6028757aead9b6c4205f9cbf7d48893db27e16291f
+  metadata.gz: c253b9e100abc3d1b37282b31bef7044dcbc89d198624ea921e1ad9110d5eae03158c0b1bd981c284db9182db58390254fc99ef0f6ac3c92bcff92f104d77f5c
+  data.tar.gz: e52323a36a787b6daf95e1ccef69e16c30f2bc92ca1e5ff2e8cbf82d981109cf31c6f18bafc895e8a8bbdc5c554deaae2088a9a80d6cbb707b83bfd411926c5e

data/CHANGELOG.md

@@ -2,6 +2,17 @@ Chef Sugar Changelog
 =========================
 This file is used to list changes made in each version of the chef-sugar cookbook and gem.
 
+v2.5.0 (2015-01-05)
+-------------------
+### Improvements
+- Add `data_bag_item_for_environment` function
+- Add `kvm?` matcher
+- Add `virtualbox?` matcher
+
+### Bug Fixes
+- Use `.key?` to check for hash key presence, raising an `AttributeDoesNotExist`
+  error sooner
+
 v2.4.1 (2014-10-12)
 -------------------
 - No changes from v2.4.0 - forced a new version upload to the Chef Supermarket

data/README.md

@@ -139,7 +139,8 @@ require 'chef/sugar/core_extensions'
 
 ### Data Bag
 - `encrypted_data_bag_item` - a handy DSL method for loading encrypted data bag items the same way you load a regular data bag item; this requires `Chef::Config[:encrypted_data_bag_secret]` is set!
-- `encrypted_data_bag_item_for_environment` - find the data bag entry for the current node's Chef environment.
+- `encrypted_data_bag_item_for_environment` - find the encrypted data bag entry for the current node's Chef environment.
+- `data_bag_item_for_environment` - find the data bag entry for the current node's Chef environment.
 
 #### Examples
 ```ruby
@@ -150,6 +151,10 @@ encrypted_data_bag_item('accounts', 'hipchat')
 encrypted_data_bag_item_for_environment('accounts', 'github')
 ```
 
+```ruby
+data_bag_item_for_environment('accounts', 'github')
+```
+
 ### Docker
 Chef Sugar looks for hints to see if the node being converged is a Docker container. When [Ohai supports checking other nodes](https://github.com/opscode/ohai/pull/428), Chef Sugar will automatically pick up the information.
 
@@ -258,13 +263,16 @@ end
 ```
 
 ### Node
+
+Additional methods for the `node` object
+
 - `deep_fetch` - safely fetch a nested attribute.
 - `deep_fetch!` - fetch a nested attribute, raising a more semantic error if the key does not exist.
 - `in?` - determine if the node is in the given Chef environment.
 
 #### Examples
 ```ruby
-credentials = if in?('production')
+credentials = if node.in?('production')
                 Chef::EncryptedDataBag.new('...')
               else
                 data_bag('...')
@@ -389,7 +397,9 @@ end
 ```
 
 ### Virtualization
+- `kvm?`
 - `lxc?`
+- `virtualbox?`
 - `vmware?`
 
 #### Examples

data/lib/chef/sugar/data_bag.rb

@@ -91,6 +91,39 @@ EOH
           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
@@ -103,6 +136,11 @@ EOH
       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/node.rb

@@ -73,10 +73,12 @@ EOH
       keys.map!(&:to_s)
 
       keys.inject(attributes.to_hash) do |hash, key|
-        hash[key]
+        if hash.key?(key)
+          hash[key]
+        else
+          raise AttributeDoesNotExistError.new(keys)
+        end
       end
-    rescue NoMethodError
-      raise AttributeDoesNotExistError.new(keys)
     end
 
     #

data/lib/chef/sugar/version.rb

@@ -16,6 +16,6 @@
 
 class Chef
   module Sugar
-    VERSION = '2.4.1'
+    VERSION = '2.5.0'
   end
 end

data/lib/chef/sugar/virtualization.rb

@@ -19,6 +19,19 @@ class Chef
     module Virtualization
       extend self
 
+      #
+      # Determine if the current node is running under KVM.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running under KVM, false
+      #   otherwise
+      #
+      def kvm?(node)
+        node.key?('virtualization') && node['virtualization']['system'] == 'kvm'
+      end
+
       #
       # Determine if the current node is running in a linux container.
       #
@@ -32,6 +45,19 @@ class Chef
         node.key?('virtualization') && node['virtualization']['system'] == 'lxc'
       end
 
+      #
+      # Determine if the current node is running under VirtualBox.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running under VirtualBox, false
+      #   otherwise
+      #
+      def virtualbox?(node)
+        node.key?('virtualization') && node['virtualization']['system'] == 'vbox'
+      end
+
       #
       # Determine if the current node is running under VMware.
       #
@@ -47,11 +73,17 @@ class Chef
     end
 
     module DSL
+      # @see Chef::Sugar::Virtualization#kvm?
+      def kvm?; Chef::Sugar::Virtualization.kvm?(node); end
+
       # @see Chef::Sugar::Virtualization#lxc?
       def lxc?; Chef::Sugar::Virtualization.lxc?(node); end
 
+      # @see Chef::Sugar::Virtualization#virtualbox?
+      def virtualbox?; Chef::Sugar::Virtualization.virtualbox?(node); end
+
       # @see Chef::Sugar::Virtualization#vmware?
       def vmware?; Chef::Sugar::Virtualization.vmware?(node); end
-	  end
+    end
   end
 end

data/spec/unit/chef/sugar/data_bag_spec.rb

@@ -71,4 +71,48 @@ describe Chef::Sugar::DataBag do
       end
     end
   end
+
+  describe '#data_bag_item_for_environment' do
+    let(:node) { double(:node, chef_environment: 'production') }
+
+    context 'when the environment exists' do
+      it 'loads the data from the environment' do
+        allow(Chef::DataBagItem).to receive(:load).and_return(
+          'production' => {
+            'username' => 'sethvargo',
+            'comment' => 'loves bacon',
+          },
+          'default' => {
+            'username' => 'schisamo',
+            'comment' => 'more of a ham guy',
+          }
+        )
+
+        expect(described_class.data_bag_item_for_environment(node, 'accounts', 'github')).to eq(
+          'comment' => 'loves bacon',
+          'username' => 'sethvargo',
+        )
+      end
+    end
+
+    context 'when the environment does not exist' do
+      it 'loads the data from the default bucket' do
+        allow(Chef::DataBagItem).to receive(:load).and_return(
+          'staging' => {
+            'username' => 'sethvargo',
+            'comment' => 'loves bacon',
+          },
+          'default' => {
+            'username' => 'schisamo',
+            'comment' => 'more of a ham guy',
+          }
+        )
+
+        expect(described_class.data_bag_item_for_environment(node, 'accounts', 'github')).to eq(
+          'comment' => 'more of a ham guy',
+          'username' => 'schisamo',
+        )
+      end
+    end
+  end
 end

data/spec/unit/chef/sugar/node_spec.rb

@@ -46,7 +46,7 @@ describe Chef::Node do
 
     it 'raises an error if a key does not exist' do
       expect {
-        node.deep_fetch!(:apache2, :not_real, :nested, :yup)
+        node.deep_fetch!(:apache2, :not_real)
       }.to raise_error(Chef::Node::AttributeDoesNotExistError)
     end
   end

data/spec/unit/chef/sugar/virtualization_spec.rb

@@ -3,6 +3,23 @@ require 'spec_helper'
 describe Chef::Sugar::Virtualization do
   it_behaves_like 'a chef sugar'
 
+  describe '#kvm?' do
+    it 'returns true when the machine is under kvm' do
+      node = { 'virtualization' => { 'system' => 'kvm' } }
+      expect(described_class.kvm?(node)).to be true
+    end
+
+    it 'returns false when the virtual machine is not under kvm' do
+      node = { 'virtualization' => { 'system' => 'vbox' } }
+      expect(described_class.kvm?(node)).to be false
+    end
+
+    it 'returns false when the machine is not virtual' do
+      node = {}
+      expect(described_class.kvm?(node)).to be false
+    end
+  end
+
   describe '#lxc?' do
     it 'returns true when the machine is a linux contianer' do
       node = { 'virtualization' => { 'system' => 'lxc' } }
@@ -20,6 +37,23 @@ describe Chef::Sugar::Virtualization do
     end
   end
 
+  describe '#virtualbox?' do
+    it 'returns true when the machine is under virtualbox' do
+      node = { 'virtualization' => { 'system' => 'vbox' } }
+      expect(described_class.virtualbox?(node)).to be true
+    end
+
+    it 'returns false when the virtual machine is not under virtualbox' do
+      node = { 'virtualization' => { 'system' => 'kvm' } }
+      expect(described_class.virtualbox?(node)).to be false
+    end
+
+    it 'returns false when the machine is not virtual' do
+      node = {}
+      expect(described_class.virtualbox?(node)).to be false
+    end
+  end
+
   describe '#vmware?' do
     it 'returns true when the machine is under vmware' do
       node = { 'virtualization' => { 'system' => 'vmware' } }

data/spec/unit/recipes/default_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'chef-sugar::default' do
-  let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+  let(:chef_run) { ChefSpec::ServerRunner.new.converge(described_recipe) }
 
   it 'installs the chef gem' do
     expect(chef_run).to install_chef_gem('chef-sugar').with(version: Chef::Sugar::VERSION)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-sugar
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A collection of helper methods and modules that make working with Chef recipes