capistrano-chef 0.0.2 → 0.0.3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -1,4 +1,10 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in capistrano-chef.gemspec
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'capistrano-spec'
+  gem 'guard-rspec'
+end
+
 gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -1,41 +1,97 @@
-capistrano-chef
-===============
+# Capistrano Chef [![Build Status](https://secure.travis-ci.org/cramerdev/capistrano-chef.png?branch=master)](http://travis-ci.org/cramerdev/capistrano-chef)
 
 A common use-case for applications is to have [Chef](http://www.opscode.com/chef/) configure your systems and use [Capistrano](http://capify.org/) to deploy the applications that run on them.
 
+Capistrano Chef is a Capistrano extension that makes Chef and Capistrano get along like best buds.
+
+## Roles
+
 The Capistrano configuration has a facility to specify the roles for your application and which servers are members of those roles. Chef has its own roles. If you're using both Chef and Capistrano, you don't want to have to tell them both about which servers you'll be deploying to, especially if they change often.
 
 capistrano-chef provides some helpers to query your Chef server from Capistrano to define these roles.
 
-Examples
---------
+### Examples
 
 A normal `deploy.rb` in an app using capistrano defines a roles like this:
 
-    role :web, 10.0.0.1, 10.0.0.2
-    role :db, 10.0.0.3, :primary => true
+    role :web, '10.0.0.2', '10.0.0.3'
+    role :db, '10.0.0.2', :primary => true
 
 Using capistrano-chef, you can do this:
 
     require 'capistrano/chef'
-    chef_role :web "roles:web"
-    chef_role :db, "roles:database_master", :primary => true,
-                                            :attribute => :private_ip
+    chef_role :web 'roles:web'
+    chef_role :db, 'roles:database_master', :primary   => true,
+                                            :attribute => :private_ip,
+                                            :limit     => 1
+
+Use a Hash to get a specific network interface:
+(the Hash must be in the form of { 'interface-name' => 'network-family-name' })
+
+    chef_role :web, 'roles:web', :attribute => { :eth1 => :inet }
+
+For a more deep and complex attribute search, use a Proc object:
+
+(Example, to get 'eth1.inet.ipaddress': http://wiki.opscode.com/display/chef/Search#Search-SearchonlyreturnsIPAddressoftheNode%2Cnotofaspecificinterface)
+
+    chef_role :web, 'roles:web', :attribute => Proc.new do |n|
+      n["network"]["interfaces"]["eth1"]["addresses"].select{|address, data| data["family"] == "inet" }.keys.first
+    end
+
+This defines the same roles using Chef's [search feature](http://wiki.opscode.com/display/chef/Search). Nodes are searched using the given query. The node's `ipaddress` attribute is used by default, but other attributes can be specified in the options as shown in the examples above. The rest of the options are the same as those used by Capistrano.
+
+The `limit` attribute of the options hash will make it so only that the given number of items will be returned from a search.
+
+## Data Bags
+
+Chef [Data Bags](http://wiki.opscode.com/display/chef/Data+Bags) let you store arbitrary JSON data. A common pattern is to use an _apps_ data bag to store data about an application for use in configuration and deployment.
+
+Chef also has a [Deploy Resource](http://wiki.opscode.com/display/chef/Deploy+Resource) described in on of their blog posts, [Data Driven Application Deployment with Chef](http://www.opscode.com/blog/2010/05/06/data-driven-application-deployment-with-chef/). This is one method of deploying, but, if you're reading this, you're probably interested in deploying with Capistrano.
+
+If you create an _apps_ data bag item (let's call it _myapp_), Capistrano Chef will let you use the data in your Capistrano recipes with the `set_from_data_bag` method.
+
+This will allow you to store all of your metadata about your app in one place.
+
+### Example
+
+In normal Capistrano `deploy.rb`:
+
+    set :application, 'myapp'
+    set :user, 'myapp'
+    set :deploy_to, '/var/apps/myapp'
+    set :scm, :git
+    ... # and so on
+
+With Capistrano Chef, an _apps_ data bag item:
+
+    {
+        "id": "myapp",
+        "user": "myapp",
+        "deploy_to": "/var/apps/myapp",
+        "scm": "git",
+        ... // and so on
+    }
+
+And in the`deploy.rb`:
+
+    set :application, 'myapp'
+    set_from_data_bag
 
-This defines the same roles using Chef's [search feature](http://wiki.opscode.com/display/chef/Search). Nodes are searched using the given query. The node's `ipaddress` attribute is used by default, but another (top-level) attribute can be specified in the options. The rest of the options are the same as those used by Capistrano.
+If you want to use a data bag other than _apps_, you can do `set_from_data_bag :my_other_data_bag`.
 
-Chef configuration options are loaded by [Knife](http://wiki.opscode.com/display/chef/Knifehttp://wiki.opscode.com/display/chef/Knife), looking for `.chef/knife.rb` in the current directory or one its parent directories. 
+## Chef Configuration
 
-To generate this file, run the following from the root of your project:  
+A Chef server is expected to be available and [Knife](http://wiki.opscode.com/display/chef/Knife) is used to configure the extension, looking for knife.rb the keys needed in .chef in the current directory or one its parent directories.
 
-    $ knife configure -i 
+If you're using [Opscode Hosted Chef](http://www.opscode.com/hosted-chef/) these files will be provided for you. If not, the configuration can be generated with `knife configure -i`. See the [Chef Documentation](http://wiki.opscode.com/display/chef/Chef+Repository#ChefRepository-Configuration) for more details.
 
+## Requirements
 
+Tested with Ruby Enterprise Edition 1.8.7, Ruby 1.9.2 and 1.9.3. Should work with Capistrano 2 or greater.
 
-License
--------
+## License
 
-Copyright (c) 2011 Cramer Development, Inc.
+Copyright (c) 2011-2012 Cramer Development, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/Rakefile

@@ -1,2 +1,9 @@
 require 'bundler'
+require 'rspec/core/rake_task'
 Bundler::GemHelper.install_tasks
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new

data/capistrano-chef.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.add_dependency 'capistrano', '~> 2.9.0'
+  s.add_dependency 'capistrano', '>= 2'
   s.add_dependency 'chef', '~> 0.10.8'
 end

data/lib/capistrano/chef/version.rb

@@ -1,3 +1,3 @@
 module CapistranoChef
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/lib/capistrano/chef.rb

@@ -1,17 +1,61 @@
+require 'capistrano'
 require 'chef/knife'
+require 'chef/data_bag_item'
 require 'chef/search/query'
 
-Capistrano::Configuration.instance.load do
-  Chef::Knife.new.configure_chef
+module Capistrano::Chef
+  # Set up chef configuration
+  def self.configure_chef
+    knife = Chef::Knife.new
+    # If you don't do this it gets thrown into debug mode
+    knife.config = { :verbosity => 1 }
+    knife.configure_chef
+  end
+
+  # Do a search on the Chef server and return an attary of the requested
+  # matching attributes
+  def self.search_chef_nodes(query = '*:*', arg = :ipaddress, limit = 1000)
+    search_proc = \
+      case arg
+      when Proc
+        arg
+      when Hash
+        iface, family = arg.keys.first.to_s, arg.values.first.to_s
+        Proc.new do |n|
+          addresses = n["network"]["interfaces"][iface]["addresses"]
+          addresses.select{|address, data| data["family"] == family }.keys.first
+        end
+      when Symbol, String
+        Proc.new{|n| n[arg.to_s]}
+      else
+        raise ArgumentError, 'Search arguments must be Proc, Hash, Symbol, String.'
+      end
+    Chef::Search::Query.new.search(:node, query, 'X_CHEF_id_CHEF_X asc', 0, limit)[0].map(&search_proc)
+  end
+
+  def self.get_data_bag_item(id, data_bag = :apps)
+    Chef::DataBagItem.load(data_bag, id).raw_data
+  end
+
+  # Load into Capistrano
+  def self.load_into(configuration)
+    self.configure_chef
+    configuration.set :capistrano_chef, self
+    configuration.load do
+      def chef_role(name, query = '*:*', options = {})
+        role name, *(capistrano_chef.search_chef_nodes(query, options.delete(:attribute), options.delete(:limit)) + [options])
+      end
 
-  # Define a role for capistrano, but instead of a list of addresses, use a chef
-  # query to search nodes.
-  def chef_role(name, query = "*:*", options = {})
-    # TODO: This can only get a node's top-level attributes. Make it get nested
-    # ones.
-    attr = options.delete(:attribute) || :ipaddress
-    nodes = Chef::Search::Query.new.search(:node, query)[0].map {|n| n[attr] }
-    role name, *nodes, options
-    nodes
+      def set_from_data_bag(data_bag = :apps)
+        raise ':application must be set' if fetch(:application).nil?
+        capistrano_chef.get_data_bag_item(application, data_bag).each do |k, v|
+          set k, v
+        end
+      end
+    end
   end
 end
+
+if Capistrano::Configuration.instance
+  Capistrano::Chef.load_into(Capistrano::Configuration.instance)
+end

data/spec/capistrano/chef_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+require 'capistrano/chef'
+
+MOCK_NODE_DATA = [{
+  "ipaddress" => '10.0.0.2',
+  "fqdn" => 'localhost.localdomain',
+  "hostname" => 'localhost',
+  "network" => {
+    "default_interface" => "eth0",
+    "interfaces" => {
+      "eth0" => {
+        "addresses" => {
+          "fe80::a00:27ff:feca:ab08" => {"scope" => "Link", "prefixlen" => "64", "family" => "inet6"},
+          "10.0.0.2" => {"netmask" => "255.255.255.0", "broadcast" => "10.0.0.255", "family" => "inet"},
+          "08:00:27:CA:AB:08" => {"family" => "lladdr"}
+        },
+      },
+      "lo" => {
+        "addresses" => {
+          "::1" => {"scope" => "Node", "prefixlen" => "128", "family" => "inet6"},
+          "127.0.0.1" => {"netmask" => "255.0.0.0", "family" => "inet"}
+        },
+      },
+      "eth1" => {
+        "addresses" => {
+          "fe80::a00:27ff:fe79:83fc" => {"scope" => "Link", "prefixlen" => "64", "family" => "inet6"},
+          "192.168.77.101" => {"netmask" => "255.255.255.0", "broadcast" => "192.168.77.255", "family" => "inet"},
+          "08:00:27:79:83:FC" => {"family" => "lladdr"}
+        },
+      },
+    },
+  }
+}]
+
+describe Capistrano::Chef do
+  before do
+    # Stub knife config
+    @knife = mock('Chef::Knife')
+    Chef::Knife.stub!(:new).and_return(@knife)
+    @knife.stub!(:configure_chef)
+    @knife.stub!(:config=)
+
+    # Load into capistrano configuration
+    @configuration = Capistrano::Configuration.new
+    Capistrano::Chef.load_into(@configuration)
+
+    # Data bag items
+    @other_item = mock('Chef::DataBagItem')
+    Chef::DataBagItem.stub(:load).with(:other_data_bag, 'other_test').and_return @other_item
+    @other_item.stub(:raw_data).and_return Mash.new({
+      :id        => 'other_test',
+      :deploy_to => '/dev/other_null'
+    })
+
+    @item = mock('Chef::DataBagItem')
+    Chef::DataBagItem.stub(:load).with(:apps, 'test').and_return @item
+    @item.stub(:raw_data).and_return Mash.new({
+      :id        => 'test',
+      :deploy_to => '/dev/null'
+    })
+  end
+
+  it 'should be a module' do
+    expect { described_class.to be_a Module }
+  end
+
+
+  describe 'search_chef_nodes' do
+    before(:each) do
+      Chef::Knife.new.configure_chef
+      @search = mock('Chef::Search::Query')
+      Chef::Search::Query.stub!(:new).and_return(@search)
+      @search.stub!(:search).and_return([::MOCK_NODE_DATA, 0, 1])
+    end
+
+    specify 'without argument (will get :ipaddress)' do
+      Capistrano::Chef.search_chef_nodes('*:*').should eql ['10.0.0.2']
+    end
+
+    # with Symbol(or String) will search top-level attributes
+    specify 'with Symbol argument' do
+      Capistrano::Chef.search_chef_nodes('*:*', :fqdn).should eql ['localhost.localdomain']
+    end
+
+    # with Hash, can specify "interface" and "family" by key and value.
+    specify 'with Hash argument' do
+      Capistrano::Chef.search_chef_nodes('*:*', {:eth0 => :inet}).should eql ['10.0.0.2']
+    end
+
+    # use Proc for more deep, complex attributes search.
+    specify 'with Proc argument' do
+      search_proc = Proc.new do |n|
+        n["network"]["interfaces"]["eth1"]["addresses"].select{|address, data| data["family"] == "inet" }.keys.first
+      end
+      Capistrano::Chef.search_chef_nodes('*:*', search_proc).should eql ['192.168.77.101']
+    end
+  end
+
+
+  specify 'get_data_bag_item' do
+    Capistrano::Chef.get_data_bag_item('test').should === Mash.new({
+      :id        => 'test',
+      :deploy_to => '/dev/null'
+    })
+    Capistrano::Chef.get_data_bag_item('other_test', :other_data_bag).should === Mash.new({
+      :id        => 'other_test',
+      :deploy_to => '/dev/other_null'
+    })
+  end
+
+  specify 'set_from_data_bag' do
+    expect { @configuration.set_from_data_bag }.to raise_error
+    @configuration.set(:application, 'test')
+    @configuration.set_from_data_bag
+    @configuration.fetch(:deploy_to).should === '/dev/null'
+    @configuration.fetch(:id).should === 'test'
+
+    @configuration.set(:application, 'other_test')
+    @configuration.set_from_data_bag :other_data_bag
+    @configuration.fetch(:deploy_to).should === '/dev/other_null'
+    @configuration.fetch(:id).should === 'other_test'
+  end
+
+  specify 'chef_role' do
+    Capistrano::Chef.stub!(:search_chef_nodes).and_return(['10.0.0.2'])
+    @search = mock('Chef::Search::Query')
+    @configuration.should respond_to :chef_role
+
+    @configuration.chef_role(:test)
+    @configuration.roles.should have_key :test
+    @configuration.roles[:test].to_a[0].host.should === '10.0.0.2'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-chef
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-10 00:00:00.000000000Z
+date: 2012-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70339838004600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *70339838004600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: chef
-  requirement: &70339838004040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +37,12 @@ dependencies:
         version: 0.10.8
   type: :runtime
   prerelease: false
-  version_requirements: *70339838004040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.8
 description: Allows capistrano to use Chef data for deployment
 email:
 - nlloyds@gmail.com
@@ -41,12 +51,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
 - capistrano-chef.gemspec
 - lib/capistrano/chef.rb
 - lib/capistrano/chef/version.rb
+- spec/capistrano/chef_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/cramerdev/capistrano-chef
 licenses:
 - MIT
@@ -60,17 +75,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3940310999397509065
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3940310999397509065
 requirements: []
 rubyforge_project: capistrano-chef
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Capistrano extensions for Chef integration
-test_files: []
-has_rdoc: 
+test_files:
+- spec/capistrano/chef_spec.rb
+- spec/spec_helper.rb