hubcap 0.0.1 → 0.0.2

data/README.md

@@ -15,7 +15,32 @@ manifests, plus a special host-specific file, and applies it to the server.
 (This is sometimes called "masterless Puppet". It has a lot of benefits that
 derive from decentralization and pushing changes on-demand.)
 
-Here's what your config file might look like:
+Here's a really simple infrastructure configuration file:
+
+    group('us') {
+      server('app.example.com') {
+        role(:app)
+        cap_attribute(:primary => true)
+      }
+      server('db.example.com') {
+        role(:db)
+        cap_attribute(:no_release => true)
+      }
+    }
+
+    group('au') {
+      server('example.com.au') {
+        role(:app, :db)
+        cap_attribute(:primary => true)
+      }
+    }
+
+Using this config, you could tell Capistrano to deploy to all servers, servers
+in one group, or just a single server.
+
+Here's a more advanced example - an application that can be deployed to a set
+of *staging* servers or a larger set of *production* servers. It has special
+parameters that Puppet will use.
 
     # An application called 'readme' that uses Cap's default deployment recipe.
     application('readme', :recipes => 'deploy') {
@@ -39,9 +64,9 @@ Here's what your config file might look like:
         param(
           'exception_subject_prefix' => '[PRODUCTION] ',
           'env' => {
-            "FORCE_SSL" => true,
-            "S3_KEY" => "AKIAKJRK23943202JK",
-            "S3_SECRET" => "KDJkaddsalkjfkawjri32jkjaklvjgakljkj"
+            'FORCE_SSL' => true,
+            'S3_KEY' => 'AKIAKJRK23943202JK',
+            'S3_SECRET' => 'KDJkaddsalkjfkawjri32jkjaklvjgakljkj'
           }
         )
 
@@ -66,7 +91,8 @@ Here's what your config file might look like:
     }
 
 
-Save this as `hub/example.rb`.
+Save this as `example.rb` in a `hub` subdirectory of the location of your
+`Capfile`.
 
 Run:
 
@@ -83,7 +109,7 @@ your filter:
     $ `hubcap example.production.db servers:tree`
 
 
-## Working with Puppet
+### Working with Puppet
 
 You should have your Puppet modules in a git repository. The location of this
 repository should be specified in your Capfile with
@@ -101,7 +127,7 @@ Once that's done, you can deploy your app in the usual way:
 
 
 
-## The Hubcap DSL
+### The Hubcap DSL
 
 The Hubcap DSL is very simple. This is the basic set of statements:
 
@@ -136,7 +162,7 @@ list of classes and parameters for a specific host. More info here:
 http://docs.puppetlabs.com/guides/external_nodes.html
 
 
-## Hubcap as a library
+### Hubcap as a library
 
 If you'd rather run `cap` than `hubcap`, you can load your hub configuration
 directly in your `Capfile`. Add this to the end of the file:
@@ -159,7 +185,7 @@ with something like this in your `Capfile`.
        require('hubcap')
        Hubcap.load(target, 'hub').configure_capistrano(self)
      else
-       warn("NB: No servers specified. Target a Hubcap group with TO.")
+       warn('NB: No servers specified. Target a Hubcap group with TO.')
      end
 
 In this set-up, you'd run `cap` like this:

data/hubcap.gemspec

@@ -4,7 +4,8 @@ require File.expand_path('../lib/hubcap/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors = ['Joseph Pearson']
   gem.email = ['joseph@booki.sh']
-  gem.description = 'Unite Capistrano and Puppet config in one Ruby file.'
+  gem.description = 'Create a hub for your server configuration. '+
+    'Use it with Capistrano, Puppet and others.'
   gem.summary = 'Hubcap Capistrano/Puppet extension'
   gem.homepage = ''
 

data/lib/hubcap/group.rb

@@ -1,14 +1,6 @@
 class Hubcap::Group
 
-  attr_reader(
-    :name,
-    :cap_attributes,
-    :cap_roles,
-    :puppet_roles,
-    :params,
-    :parent,
-    :children
-  )
+  attr_reader(:name, :parent, :children)
 
   # Supply the parent group, the name of this new group and a block of code to
   # evaluate in the context of this new group.
@@ -18,14 +10,14 @@ class Hubcap::Group
   #
   def initialize(parent, name, &blk)
     @name = name.to_s
-    if @parent = parent
-      @cap_attributes = parent.cap_attributes.clone
-      @cap_roles = parent.cap_roles.clone
-      @puppet_roles = parent.puppet_roles.clone
-      @params = parent.params.clone
-    elsif !kind_of?(Hubcap::Hub)
+    @parent = parent
+    unless @parent || kind_of?(Hubcap::Hub)
       raise(Hubcap::GroupWithoutParent, self.inspect)
     end
+    @cap_attributes = {}
+    @cap_roles = []
+    @puppet_roles = []
+    @params = {}
     @children = []
     instance_eval(&blk)  if blk && processable?
   end
@@ -58,14 +50,13 @@ class Hubcap::Group
 
 
   # Indicates whether we should process this group. We process all groups that
-  # match the filter or are below the furthest point in the filter.
+  # match any of the filters or are below the furthest point in the filter.
   #
   # "Match the filter" means that this group's history and the filter are
   # identical to the end of the shortest of the two arrays.
   #
   def processable?
-    s = [history.length, hub.filter.length].min
-    history.slice(0,s) == hub.filter.slice(0,s)
+    hub.filters.any? { |fr| matching_filter?(fr) }
   end
 
 
@@ -77,7 +68,7 @@ class Hubcap::Group
   # filter, but identical at each point in the filter.
   #
   def collectable?
-    (history.length >= hub.filter.length) && processable?
+    hub.filters.any? { |fr| history.size >= fr.size && matching_filter?(fr) }
   end
 
 
@@ -167,8 +158,45 @@ class Hubcap::Group
   #   params(:foo => 'bar')
   # ...then Puppet will have a top-level variable called $foo, containing 'bar'.
   #
+  # Note that hash keys that are not strings or symbols will raise an error,
+  # and symbol keys will be converted to strings. ie, :foo becomes 'foo' in the
+  # above example.
+  #
   def param(hash)
-    @params.update(hash)
+    hash.each_key { |k|
+      unless k.kind_of?(String) || k.kind_of?(Symbol)
+        raise(Hubcap::InvalidParamKeyType, k.inspect)
+      end
+    }
+
+    recurse = lambda { |dest, src|
+      src.each_pair { |k, v|
+        v = recurse.call({}, v)  if v.is_a?(Hash)
+        dest.update(k.to_s => v)
+      }
+      dest
+    }
+    recurse.call(@params, hash)
+  end
+
+
+  def cap_attributes
+    @parent ? @parent.cap_attributes.merge(@cap_attributes) : @cap_attributes
+  end
+
+
+  def cap_roles
+    @parent ? @parent.cap_roles + @cap_roles : @cap_roles
+  end
+
+
+  def puppet_roles
+    @parent ? @parent.puppet_roles + @puppet_roles : @puppet_roles
+  end
+
+
+  def params
+    @parent ? @parent.params.merge(@params) : @params
   end
 
 
@@ -199,9 +227,15 @@ class Hubcap::Group
   def tree(indent = "  ")
     outs = [self.class.name.split('::').last.upcase, "Name: #{@name}"]
     outs << "Atts: #{@cap_attributes.inspect}"  if @cap_attributes.any?
+    if @cap_roles == @puppet_roles
+      outs << "Role: #{@cap_roles.inspect}"  if @cap_roles.any?
+    else
+      cr = @cap_roles.any? ? 'Cap - '+@cap_roles.inspect : nil
+      pr = @puppet_roles.any? ? 'Puppet - '+@puppet_roles.inspect : nil
+      outs << "Role: #{[cr,pr].compact.join(' ')}"  if cr || pr
+    end
     outs << "Pram: #{@params.inspect}"  if @params.any?
     extend_tree(outs)  if respond_to?(:extend_tree)
-    outs << ""
     if @children.any?
       @children.each { |child| outs << child.tree(indent+"  ") }
     end
@@ -218,6 +252,23 @@ class Hubcap::Group
     end
 
 
+    def matching_filter?(fr)
+      s = [history.size, fr.size].min
+      history.slice(0, s) == fr.slice(0, s)
+    end
+
+
+    def resolv(*names)
+      require 'resolv'
+      if names.size == 1
+        Resolv.getaddress(names.first)
+      else
+        names.collect { |name| Resolv.getaddress(name) }
+      end
+    end
+
+
   class Hubcap::GroupWithoutParent < StandardError; end
+  class Hubcap::InvalidParamKeyType < StandardError; end
 
 end

data/lib/hubcap/hub.rb

@@ -1,16 +1,15 @@
+# encoding: utf-8
+
 class Hubcap::Hub < Hubcap::Group
 
-  attr_reader(:filter, :applications, :servers, :groups, :cap_sets)
+  attr_reader(:filters, :applications, :servers, :groups, :cap_sets)
 
 
   def initialize(filter_string)
-    @filter = filter_string.split('.')
+    @filters = filter_string.split(',').collect { |fltr| fltr.split('.') }
+    @filters = [[]]  if @filters.empty?
     @cap_sets = {}
     @cap_set_clashes = []
-    @cap_attributes = {}
-    @cap_roles = []
-    @puppet_roles = []
-    @params = {}
     @applications = []
     @servers = []
     @groups = []

data/lib/hubcap/recipes/puppet.rb

@@ -93,7 +93,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         out = case text
         when /\bpassword.*:/i, /passphrase/i  # Git password or SSH passphrase.
           "#{puppet_git_password}\n"
-        when %r{\(yes/no\)}                   # Should git connect?
+        when %r{\(yes\/no\)}                  # Should git connect?
           "yes\n"
         when /accept \(t\)emporarily/         # Should git accept certificate?
           "t\n"
@@ -101,7 +101,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         channel.send_data(out)  if out
       }
       sudo("mkdir -p #{File.dirname(puppet_path)}")
-      sudo("chown #{user} #{File.dirname(puppet_path)}")
+      sudo("chown -R #{user} #{File.dirname(puppet_path)}")
       run(
         "[ -d #{puppet_path} ] || git clone #{puppet_repository} #{puppet_path}",
         :shell => nil,

data/lib/hubcap/server.rb

@@ -35,8 +35,8 @@ class Hubcap::Server < Hubcap::Group
 
   def yaml
     {
-      'classes' => @puppet_roles.collect(&:to_s),
-      'parameters' => @params
+      'classes' => puppet_roles.collect(&:to_s),
+      'parameters' => params
     }.to_yaml
   end
 

data/lib/hubcap/version.rb

@@ -1,5 +1,5 @@
 module Hubcap
 
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
 end

data/test/data/readme.rb

@@ -20,9 +20,9 @@ application('readme', :recipes => 'deploy') {
     param(
       'exception_subject_prefix' => '[PRODUCTION] ',
       'env' => {
-        "FORCE_SSL" => true,
-        "S3_KEY" => "AKIAKJRK23943202JK",
-        "S3_SECRET" => "KDJkaddsalkjfkawjri32jkjaklvjgakljkj"
+        'FORCE_SSL' => true,
+        'S3_KEY' => 'AKIAKJRK23943202JK',
+        'S3_SECRET' => 'KDJkaddsalkjfkawjri32jkjaklvjgakljkj'
       }
     )
 

data/test/unit/test_group.rb

@@ -30,7 +30,7 @@ class Hubcap::TestGroup < Test::Unit::TestCase
     hub = Hubcap.hub {
       group('test') { absorb('test/data/parts/foo_param') }
     }
-    assert_equal('foo', hub.groups.first.params[:foo])
+    assert_equal('foo', hub.groups.first.params['foo'])
   end
 
 
@@ -171,6 +171,21 @@ class Hubcap::TestGroup < Test::Unit::TestCase
     }
     assert_equal(1, hub.servers.first.params['foo'])
     assert_equal(2, hub.servers.first.params['baz'])
+
+    # Recursive stringification of hash keys.
+    hub = Hubcap.hub {
+      server('test') {
+        param(:foo => { :bar => { :garply => 'grault' } })
+      }
+    }
+    assert_equal('foo', hub.servers.first.params.keys.first)
+    assert_equal('bar', hub.servers.first.params['foo'].keys.first)
+    assert_equal('garply', hub.servers.first.params['foo']['bar'].keys.first)
+
+    # Top-level keys other than strings or symbols are rejected.
+    assert_raises(Hubcap::InvalidParamKeyType) {
+      hub = Hubcap.hub { server('test') { param(1 => 'x') } }
+    }
   end
 
 end

metadata

@@ -1,33 +1,25 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hubcap
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Joseph Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-20 00:00:00 +10:00
-default_executable: 
+date: 2012-09-26 00:00:00.000000000 Z
 dependencies: []
-
-description: Unite Capistrano and Puppet config in one Ruby file.
-email: 
+description: Create a hub for your server configuration. Use it with Capistrano, Puppet
+  and others.
+email:
 - joseph@booki.sh
-executables: 
+executables:
 - hubcap
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - Capfile.example
 - README.md
 - Rakefile
@@ -51,37 +43,31 @@ files:
 - test/unit/test_hub.rb
 - test/unit/test_hubcap.rb
 - test/unit/test_server.rb
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Hubcap Capistrano/Puppet extension
-test_files: 
+test_files:
 - test/data/example.rb
 - test/data/parts/foo_param.rb
 - test/data/readme.rb