hubcap 0.0.3 → 0.0.4

data/.gitignore

@@ -1 +1,2 @@
 .screenrc
+Capfile

data/README.md

@@ -17,23 +17,25 @@ derive from decentralization and pushing changes on-demand.)
 
 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)
-      }
-    }
+```ruby
+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.
@@ -42,54 +44,55 @@ 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') {
-      # Set a capistrano variable.
-      cap_set('repository', 'git@github.com:joseph/readme.git')
-
-      # Declare that all servers will have the 'baseline' puppet class.
-      role(:puppet => 'baseline')
-
-      group('staging') {
-        # Puppet gets a $::exception_subject_prefix variable on these servers.
-        param('exception_subject_prefix' => '[STAGING] ')
-        # For simple staging, just one server that does everything.
-        server('readme.stage') {
-          role(:cap => [:web, :app, :db], :puppet => ['proxy', 'app', 'db'])
-        }
+```ruby
+# An application called 'readme' that uses Cap's default deployment recipe.
+application('readme', :recipes => 'deploy') {
+  # Set a capistrano variable.
+  cap_set('repository', 'git@github.com:joseph/readme.git')
+
+  # Declare that all servers will have the 'baseline' puppet class.
+  role(:puppet => 'baseline')
+
+  group('staging') {
+    # Puppet gets a $::exception_subject_prefix variable on these servers.
+    param('exception_subject_prefix' => '[STAGING] ')
+    # For simple staging, just one server that does everything.
+    server('readme.stage') {
+      role(:cap => [:web, :app, :db], :puppet => ['proxy', 'app', 'db'])
+    }
+  }
+
+  group('production') {
+    # Puppet gets these top-scope variables on servers in this group.
+    param(
+      'exception_subject_prefix' => '[PRODUCTION] ',
+      'env' => {
+        'FORCE_SSL' => true,
+        'S3_KEY' => 'AKIAKJRK23943202JK',
+        'S3_SECRET' => 'KDJkaddsalkjfkawjri32jkjaklvjgakljkj'
       }
+    )
 
-      group('production') {
-        # Puppet gets these top-scope variables on servers in this group.
-        param(
-          'exception_subject_prefix' => '[PRODUCTION] ',
-          'env' => {
-            'FORCE_SSL' => true,
-            'S3_KEY' => 'AKIAKJRK23943202JK',
-            'S3_SECRET' => 'KDJkaddsalkjfkawjri32jkjaklvjgakljkj'
-          }
-        )
-
-        group('proxy') {
-          # Servers will have the :web role and the 'proxy' puppet class.
-          role(:cap => :web, :puppet => 'proxy')
-          server('proxy-1', :address => '10.10.10.5')
-        }
-
-        group('app') {
-          # Servers will have the :app role and the 'app' puppet class.
-          role(:app)
-          server('app-1', :address => '10.10.10.10')
-          server('app-2', :address => '10.10.10.11')
-        }
-
-        group('db') {
-          role(:db)
-          server('db-1', :address => '10.10.10.50')
-        }
-      }
+    group('proxy') {
+      # Servers will have the :web role and the 'proxy' puppet class.
+      role(:cap => :web, :puppet => 'proxy')
+      server('proxy-1', :address => '10.10.10.5')
     }
 
+    group('app') {
+      # Servers will have the :app role and the 'app' puppet class.
+      role(:app)
+      server('app-1', :address => '10.10.10.10')
+      server('app-2', :address => '10.10.10.11')
+    }
+
+    group('db') {
+      role(:db)
+      server('db-1', :address => '10.10.10.50')
+    }
+  }
+}
+```
 
 Save this as `example.rb` in a `hub` subdirectory of the location of your
 `Capfile`.
@@ -167,8 +170,10 @@ http://docs.puppetlabs.com/guides/external_nodes.html
 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:
 
-     require('hubcap')
-     Hubcap.load('', 'hub').configure_capistrano(self)
+```ruby
+require('hubcap')
+Hubcap.load('', 'hub').configure_capistrano(self)
+```
 
 The two arguments to `Hubcap.load` are the filter (where `''` means no filter),
 and the path to the hub configuration. This will load `*.rb` in the `hub`
@@ -178,15 +183,17 @@ arguments -- whole directories or specific files.
 If you want to simulate the behaviour of the `hubcap` script, you could do it
 with something like this in your `Capfile`.
 
-     # Load servers and sets from node config. Any recipes loaded after this
-     # point will be available only in application mode.
-     if (target = ENV['TO']) && !ENV['TO'].empty?
-       target = ''  if target == 'ALL'
-       require('hubcap')
-       Hubcap.load(target, 'hub').configure_capistrano(self)
-     else
-       warn('NB: No servers specified. Target a Hubcap group with TO.')
-     end
+```ruby
+# Load servers and sets from node config. Any recipes loaded after this
+# point will be available only in application mode.
+if (target = ENV['TO']) && !ENV['TO'].empty?
+  target = ''  if target == 'ALL'
+  require('hubcap')
+  Hubcap.load(target, 'hub').configure_capistrano(self)
+else
+  warn('NB: No servers specified. Target a Hubcap group with TO.')
+end
+```
 
 In this set-up, you'd run `cap` like this:
 

data/lib/hubcap/group.rb

@@ -1,5 +1,7 @@
 class Hubcap::Group
 
+  IP_PATTERN = /\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/
+
   attr_reader(:name, :parent, :children)
 
   # Supply the parent group, the name of this new group and a block of code to
@@ -198,7 +200,7 @@ class Hubcap::Group
   # the IP of a hostname just for a child-group, you can (but: caveat emptor).
   #
   def host(hash)
-    @hosts = hash
+    @hosts.update(hash)
   end
 
 
@@ -232,13 +234,32 @@ class Hubcap::Group
   #
   def resolv(*hnames)
     if hnames.size == 1
-      hosts[hnames.first] || Resolv.getaddress(hnames.first)
+      result = lookup(hnames.first)
+      result.match(IP_PATTERN) ? result : Resolv.getaddress(result)
     else
       hnames.collect { |hname| resolv(hname) }
     end
   end
 
 
+  # Dereferences the host name using the @hosts table. Follows references.
+  # Returns the first value that looks like an IP address OR that it can't
+  # find in the table. (So, if there's no match, you just get the name back.
+  #
+  def lookup(hname, history = [])
+    return hname  if hname.match(IP_PATTERN)
+    result = hosts[hname]
+    if !result
+      return hname
+    elsif history.include?(result)
+      raise(Hubcap::HostCircularReference, history.to_s)
+    else
+      history << hname
+      lookup(result, history)
+    end
+  end
+
+
   # Instantiate an application as a child of this group.
   #
   def application(name, options = {}, &blk)
@@ -301,5 +322,6 @@ class Hubcap::Group
 
   class Hubcap::GroupWithoutParent < StandardError; end
   class Hubcap::InvalidParamKeyType < StandardError; end
+  class Hubcap::HostCircularReference < StandardError; end
 
 end

data/lib/hubcap/recipes/puppet.rb

@@ -55,7 +55,7 @@ Capistrano::Configuration.instance(:must_exist).load do
           'echo "Ruby 1.9 verified";',
         'else',
           "#{apt_cmd} update;",
-          "#{apt_cmd} install ruby1.9.1 ruby1.9.1-dev git-core;",
+          "#{apt_cmd} install ruby1.9.1 ruby1.9.1-dev git-core build-essential;",
         'fi'
       ].join(' '))
 

data/lib/hubcap/recipes/servers.rb

@@ -18,4 +18,11 @@ Capistrano::Configuration.instance(:must_exist).load do
 
   end
 
+
+  task(:ssh) do
+    host = hubcap.servers.first.address
+    puts("SSH connect to: #{user}@#{host}")
+    system("ssh -A #{user}@#{host}")
+  end
+
 end

data/lib/hubcap/server.rb

@@ -4,8 +4,14 @@ class Hubcap::Server < Hubcap::Group
 
 
   def initialize(parent, name, options = {}, &blk)
-    @address = options[:address] || name
     super(parent, name, &blk)
+    # If name is an IP, or is not in hosts hash, use name as address
+    # Otherwise, dereference it from the hash and assign it
+    unless @address = options[:address]
+      hist = history.join('.')
+      @address = lookup(hist)
+      @address = lookup(name)  if @address == hist
+    end
   end
 
 

data/lib/hubcap/version.rb

@@ -1,5 +1,5 @@
 module Hubcap
 
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 
 end

data/test/unit/test_server.rb

@@ -66,4 +66,104 @@ class Hubcap::TestServer < Test::Unit::TestCase
     assert_equal([1, 2], hash['parameters'].values.sort)
   end
 
+
+  def test_host_lookup_single_level
+    hub = Hubcap.hub {
+      host('test' => '0.0.0.0')
+      server('test')
+    }
+    assert_equal('0.0.0.0', hub.servers.first.address)
+  end
+
+
+  def test_host_lookup_multiple_levels
+    hub = Hubcap.hub {
+      host('g1.t1' => '1.1.1.1')
+      host('g1.a1.t2' => '2.2.2.2')
+      group('g1') {
+        server('t1')
+        application('a1') {
+          server('t2')
+        }
+      }
+    }
+    assert_equal('1.1.1.1', hub.servers[0].address)
+    assert_equal('2.2.2.2', hub.servers[1].address)
+  end
+
+
+  def test_host_lookup_where_name_is_ip
+    hub = Hubcap.hub {
+      host(
+        'foo' => '255.255.255.255',
+        '1.1.1.1' => '255.255.255.254'
+      )
+      server('1.1.1.1')
+    }
+    assert_equal('1.1.1.1', hub.servers.first.address)
+  end
+
+
+  def test_host_lookup_where_name_is_not_in_hosts
+    hub = Hubcap.hub {
+      host(
+        'foo.bar.com' => '255.255.255.255',
+        'baz.bar.com' => '255.255.255.254'
+      )
+      server('garply.bar.com')
+    }
+    assert_equal('garply.bar.com', hub.servers.first.address)
+  end
+
+
+  def test_host_lookup_dereferencing
+    hub = Hubcap.hub {
+      host('some.other.thing' => '1.1.1.1')
+      group('g1') {
+        host('g1.t1' => 'some.other.thing')
+        server('t1')
+      }
+    }
+    assert_equal('1.1.1.1', hub.servers.first.address)
+  end
+
+
+  def test_host_lookup_handle_circular_reference
+    assert_raises(Hubcap::HostCircularReference) {
+      hub = Hubcap.hub {
+        host('some.other.thing' => 'g1.t1')
+        group('g1') {
+          host('g1.t1' => 'some.other.thing')
+          server('t1')
+        }
+      }
+    }
+  end
+
+
+  def test_host_lookup_where_hosts_is_overridden_in_subgroup
+    hub = Hubcap.hub {
+      host('g1.t1' => '2.2.2.2')
+      group('g1') {
+        host('g1.t1' => '1.1.1.1')
+        server('t1')
+      }
+    }
+    assert_equal('1.1.1.1', hub.servers[0].address)
+  end
+
+
+  def test_resolv
+    hub = Hubcap.hub {
+      host('g1.t1' => '2.2.2.2')
+      group('g1') {
+        host('g1.t1' => '1.1.1.1')
+        server('t1')
+      }
+      server('t2', :address => resolv('g1.t1'))
+    }
+    assert_equal('1.1.1.1', hub.servers[0].address)
+    assert_equal('2.2.2.2', hub.servers[1].address)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubcap
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2012-09-29 00:00:00.000000000 Z
 dependencies: []
 description: Create a hub for your server configuration. Use it with Capistrano, Puppet
   and others.