chef-sugar 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75de0550f84f3b8ef3b94926f60c2b3a7a757c02
-  data.tar.gz: 081a7e696179a33958fe4a38cf7022da9c8c0d0b
+  metadata.gz: 222ec2b0f50c5d0a482190cc2b4baec1423f124d
+  data.tar.gz: 09af24376426ba383f8b85c4e08c8ab6ad4ceef9
 SHA512:
-  metadata.gz: f506eb432d8a39cfdea1b709fe760c9994887655503cb2e539bc1ffe5e299d49513a4a0f3928b1ac02e8c42e453726979df4f76d4c2f3c2f69a9d5b663fc337d
-  data.tar.gz: d6e52403bf24e0a37b61432373b455806d563004773a757fc2d61eff4103e4dbe89796ede0c3d67eea01ab332cdf63d64f25f9c429ea367f6367ec9bb8294983
+  metadata.gz: 3341414fb14b31ca32baf45395e084f1d095cb830569669b7048429c66d92bbfa6a10103da4273cd554496289c27958fa09f03db2c3da1e7a1cb37892f2f94d7
+  data.tar.gz: 0eb0b352c56911e7c55d26f85259baf418e32c8731401ba37b6ce134b5561549ccdd2e3824a80b14018ad37b17a12bd6f322b4d89f232590cc01a9923625b1d8

data/.gitignore

@@ -20,3 +20,4 @@ bin/
 pkg/
 tmp/
 vendor/
+.rspec

data/.travis.yml

@@ -3,4 +3,3 @@ rvm:
   - 2.0.0
 script:
   - bundle exec rspec --color --format progress
-  - bundle exec foodcritic . -f any

data/CHANGELOG.md

@@ -3,6 +3,14 @@ Chef Sugar Changelog
 This file is used to list changes made in each version of the chef-sugar cookbook and gem.
 
 
+v1.1.0 (2013-12-10)
+-------------------
+- Add `cloudstack?` helper
+- Add data bag helpers
+- Remove foodcritic checks
+- Upgrade development gem versions
+- Randomize spec order
+
 v1.0.1 (2013-10-15)
 -------------------
 - Add development recipe

data/README.md

@@ -93,6 +93,7 @@ end
 - `gce?`
 - `linode?`
 - `openstack?`
+- `cloudstack?`
 - `rackspace?`
 
 #### Examples
@@ -105,6 +106,19 @@ template '/tmp/config' do
 end
 ```
 
+### 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.
+
+#### Examples
+```ruby
+encrypted_data_bag_item('accounts', 'hipchat')
+```
+
+```ruby
+encrypted_data_bag_item_for_environment('accounts', 'github')
+```
+
 ### IP
 - `best_ip_for` - determine the best IP address for the given "other" node, preferring local IP addresses over public ones.
 
@@ -251,7 +265,7 @@ end
 
 # This is equivalent to
 package 'apache2' do
-  'apache2'
+  action :nothing
 end.run_action(:install)
 ```
 

data/chef-extensions.gemspec

@@ -30,8 +30,7 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'chefspec',        '~> 3.0'
+  spec.add_development_dependency 'test-kitchen',    '~> 1.0'
+  spec.add_development_dependency 'kitchen-vagrant', '~> 0.14'
 end

data/lib/chef/sugar.rb

@@ -22,6 +22,7 @@ class Chef
   module Sugar
     require_relative 'sugar/architecture'
     require_relative 'sugar/cloud'
+    require_relative 'sugar/data_bag'
     require_relative 'sugar/filters'
     require_relative 'sugar/ip'
     require_relative 'sugar/node'

data/lib/chef/sugar/cloud.rb

@@ -104,6 +104,18 @@ class Chef
         node.key?('openstack')
       end
 
+      #
+      # Return true if the current current node is in Cloudstack
+      #
+      # @param [Chef::Node] node
+      #   the node to check
+      #
+      # @return [Boolean]
+      #
+      def cloudstack?(node)
+        node.key?('cloudstack')
+      end
+
       #
       # Return true if the current current node is in Azure
       #
@@ -140,6 +152,9 @@ class Chef
       # @see Chef::Sugar::Cloud#openstack?
       def openstack?; Chef::Sugar::Cloud.openstack?(node); end
 
+      # @see Chef::Sugar::Cloud#cloudstack?
+      def cloudstack?; Chef::Sugar::Cloud.cloudstack?(node); end
+
       # @see Chef::Sugar::Cloud#azure?
       def azure?; Chef::Sugar::Cloud.azure?(node); end
     end

data/lib/chef/sugar/data_bag.rb

@@ -0,0 +1,84 @@
+#
+# 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 DataBag
+      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
+      #
+      # @return [Hash]
+      #
+      def encrypted_data_bag_item(bag, id)
+        Chef::Log.debug "Loading encrypted data bag item #{bag}/#{id}"
+        Chef::EncryptedDataBagItem.load(bag, id)
+      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
+      #
+      # @return [Hash]
+      #
+      def encrypted_data_bag_item_for_environment(node, bag, id)
+        data = encrypted_data_bag_item(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)
+        Chef::Sugar::DataBag.encrypted_data_bag_item(bag, id)
+      end
+
+      # @see Chef::Sugar::DataBag#encrypted_data_bag_item_for_environment?
+      def encrypted_data_bag_item_for_environment(bag, id)
+        Chef::Sugar::DataBag.encrypted_data_bag_item_for_environment(node, bag, id)
+      end
+    end
+  end
+end

data/lib/chef/sugar/version.rb

@@ -16,6 +16,6 @@
 
 class Chef
   module Sugar
-    VERSION = '1.0.1'
+    VERSION = '1.1.0'
   end
 end

data/spec/spec_helper.rb

@@ -3,3 +3,19 @@ require 'chefspec'
 require 'chef/sugar'
 
 require_relative 'support/shared_examples'
+
+RSpec.configure do |config|
+  # Prohibit using the should syntax
+  config.expect_with :rspec do |spec|
+    spec.syntax = :expect
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  # ChefSpec configuration
+  config.log_level = :fatal
+end

data/spec/unit/chef/extensions/cloud_spec.rb

@@ -99,6 +99,18 @@ describe Chef::Sugar::Cloud do
     end
   end
 
+  describe '#cloudstack?' do
+    it 'is true when the node is on cloudstack' do
+      node = { 'cloudstack' => nil }
+      expect(described_class.cloudstack?(node)).to be_true
+    end
+
+    it 'is false when the node is not on cloudstack' do
+      node = {}
+      expect(described_class.cloudstack?(node)).to be_false
+    end
+  end
+
   describe '#azure?' do
     it 'is true when the node is on azure' do
       node = { 'azure' => nil }

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

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Chef::Sugar::DataBag do
+  describe '#encrypted_data_bag_item' do
+    before { Chef::EncryptedDataBagItem.stub(:load) }
+
+    it 'loads the encrypted data bag item' do
+      expect(Chef::EncryptedDataBagItem).to receive(:load)
+        .with('accounts', 'github')
+
+      described_class.encrypted_data_bag_item('accounts', 'github')
+    end
+  end
+
+  describe '#encrypted_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
+        Chef::EncryptedDataBagItem.stub(:load).and_return(
+          'production' => {
+            'username' => 'sethvargo',
+            'password' => 'bacon',
+          }
+        )
+
+        expect(described_class.encrypted_data_bag_item_for_environment(node, 'accounts', 'github')).to eq(
+          'password' => 'bacon',
+          'username' => 'sethvargo',
+        )
+      end
+    end
+
+    context 'when the environment does not exist' do
+      it 'loads the data from the default bucket' do
+        Chef::EncryptedDataBagItem.stub(:load).and_return(
+          'staging' => {
+            'username' => 'sethvargo',
+            'password' => 'bacon',
+          },
+          'default' => {
+            'username' => 'schisamo',
+            'password' => 'ham',
+          }
+        )
+
+        expect(described_class.encrypted_data_bag_item_for_environment(node, 'accounts', 'github')).to eq(
+          'password' => 'ham',
+          'username' => 'schisamo',
+        )
+      end
+    end
+  end
+end

data/spec/unit/recipes/default_spec.rb

@@ -4,6 +4,6 @@ describe 'chef-sugar::default' do
   let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
 
   it 'installs the chef gem' do
-    expect(chef_run).to install_chef_gem('chef-sugar').with(version: '1.0.0')
+    expect(chef_run).to install_chef_gem('chef-sugar')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-sugar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,20 +68,6 @@ dependencies:
         version: '2.11'
 - !ruby/object:Gem::Dependency
   name: chefspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.0.0.beta
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.0.0.beta
-- !ruby/object:Gem::Dependency
-  name: foodcritic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -100,28 +86,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: kitchen-vagrant
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.14'
 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!
@@ -144,6 +130,7 @@ files:
 - lib/chef/sugar.rb
 - lib/chef/sugar/architecture.rb
 - lib/chef/sugar/cloud.rb
+- lib/chef/sugar/data_bag.rb
 - lib/chef/sugar/filters.rb
 - lib/chef/sugar/ip.rb
 - lib/chef/sugar/node.rb
@@ -160,6 +147,7 @@ files:
 - spec/support/shared_examples.rb
 - spec/unit/chef/extensions/architecture_spec.rb
 - spec/unit/chef/extensions/cloud_spec.rb
+- spec/unit/chef/extensions/data_bag_spec.rb
 - spec/unit/chef/extensions/ip_spec.rb
 - spec/unit/chef/extensions/node_spec.rb
 - spec/unit/chef/extensions/platform_family_spec.rb
@@ -188,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A collection of helper methods and modules that make working with Chef recipes
@@ -198,6 +186,7 @@ test_files:
 - spec/support/shared_examples.rb
 - spec/unit/chef/extensions/architecture_spec.rb
 - spec/unit/chef/extensions/cloud_spec.rb
+- spec/unit/chef/extensions/data_bag_spec.rb
 - spec/unit/chef/extensions/ip_spec.rb
 - spec/unit/chef/extensions/node_spec.rb
 - spec/unit/chef/extensions/platform_family_spec.rb
@@ -206,4 +195,3 @@ test_files:
 - spec/unit/chef/extensions/shell_spec.rb
 - spec/unit/chef/extensions/vagrant_spec.rb
 - spec/unit/recipes/default_spec.rb
-has_rdoc: