tdd_deploy 0.1.5 → 0.1.6

data/bin/tdd_deploy_context

@@ -19,7 +19,7 @@ class TddDeployEnv
 
   def show_env
     puts "============================================="
-    self.env_types.keys.each do |k|
+    self.env_types.keys.sort.each do |k|
       v = self.send(k.to_sym)
       printf "%-20s: %s\n", k, v
     end

data/lib/tdd_deploy/capfile.rb

@@ -0,0 +1,40 @@
+require 'capistrano/configuration'
+
+module TddDeploy
+  # == TddDeploy::Capfile - interface to capistrano capfile
+  #
+  # uses Capistrano to parse recipe file(s) and provides convenient access to server
+  # definitions
+  class Capfile
+    # creates a Capfile::Configuration object to use, but does not read any Capistrano Recipe files
+    def initialize
+      @capfile_config = Capistrano::Configuration.new
+    end
+
+    # returns the Capistrano::Configuration::Roles object
+    def roles
+      @capfile_config.roles
+    end
+
+    # returns list of host strings defined for specified 'role'
+    def role_to_host_list role
+      servers(role).map { |srv| srv.to_s }
+    end
+    
+    # returns list of host strings which are in the 'db' role and for which 'primary' is true
+    def migration_host_list
+      servers(:db).select { |srv| srv.options[:primary] == true }.map { |x| x.to_s }
+    end
+    
+    # returns the array of Capistrano::ServerDefinition objects defined for 'role'
+    def servers role
+      @capfile_config.roles[role].servers
+    end
+
+    # loads the specified recipie file. Defaults to './config/deploy.rb' which is standard
+    # for rails apps. May be called multiple times
+    def load_recipes(path = './config/deploy.rb')
+      @capfile_config.load path
+    end
+  end
+end

data/lib/tdd_deploy/environ.rb

@@ -1,3 +1,5 @@
+require 'tdd_deploy/capfile'
+
 module TddDeploy
 
     # == module TddDeploy::Environ
@@ -37,14 +39,23 @@ module TddDeploy
     # know how to included globbed paths]
     #
     # === List Variables
+    # * 'app_hosts' - hosts running a ruby app which must have a ruby available and will be served
+    #via a reverse proxy
     # * 'balance_hosts' - load balancing servers [may be empty, in which case 'hosts' is used]
     # * 'db_hosts' - hosts which run the database server [may be empty, in which case 'hosts' is used]
     # * 'web_hosts' - hosts which run the web server [may be empty, in which case 'hosts' is used]
+    # * 'capfile_paths' - relative paths to capistrano recipe files. Defaults to './config/deploy.rb'
     #
-    # === Pseudo Variable
+    # === Pseudo Variables
     # * 'hosts' - list of all hosts - always returns balance_hosts + db_hosts + web_hosts.
     #may be assigned to if all three host lists are identical, otherwise raises an exception.
-    # 'tdd_deploy_context' hides it from view unless it can be assigned
+    #'tdd_deploy_context' hides it from view unless it can be assigned
+    # * 'app' - list of all hosts in the :app role of the Capistrano recipes
+    # * 'db' - list of all hosts in the :db role of the Capistrano recipes
+    # * 'migration_hosts' - list of all hosts in the :db role with option :primary => true
+    #of the Capistrano recipes
+    # * 'web' - list of all hosts in the :web role of the Capistrano recipes
+    
     
   module Environ
     
@@ -54,7 +65,7 @@ module TddDeploy
     # include TddDeploy::Environ
     class DataCache
       class << self
-        attr_accessor :env_hash, :env_types, :env_defaults
+        attr_accessor :env_hash, :env_types, :env_defaults, :capfile
       end
     end
     
@@ -77,6 +88,17 @@ module TddDeploy
         DataCache.env_hash = hash
       end
     end
+
+    def capfile
+      raise RuntimeError.new('Attempt to access capfile data w/o capfile_paths defined') unless DataCache.env_hash['capfile_paths']
+      unless DataCache.capfile
+        DataCache.capfile = TddDeploy::Capfile.new
+        DataCache.env_hash['capfile_paths'].each do |path|
+          DataCache.capfile.load_recipes path
+        end
+      end
+      DataCache.capfile
+    end
     
     DataCache.env_types = {
       'ssh_timeout' => :int,
@@ -93,10 +115,17 @@ module TddDeploy
       'site_path' => :string,
       'site_user' => :string,
 
-      # 'hosts' => :list,
+      'app_hosts' => :list,
       'balance_hosts' => :list,
+      'capfile_paths' => :list,
       'db_hosts' => :list,
       'web_hosts' => :list,
+      
+      'hosts' => :pseudo,
+      'app' => :pseudo,
+      'db' => :pseudo,
+      'migration_hosts'  => :pseudo,
+      'web' => :pseudo,
     }
     
     DataCache.env_defaults ||= {
@@ -114,7 +143,10 @@ module TddDeploy
       'site_path' => '/home/site_user/site.d/current',   # default for Capistrano
       'site_user' => "site_user",
 
+      'capfile_paths' => './config/deploy.rb',
+
       # 'hosts' => "bar,foo",
+      'app_hosts' => 'arch',
       'balance_hosts' => 'arch',
       'db_hosts' => 'arch',
       'web_hosts' => 'arch',
@@ -140,19 +172,24 @@ module TddDeploy
         when :int then DataCache.env_hash[k] = v.to_i
         when :string then DataCache.env_hash[k] = v.to_s
         when :list then DataCache.env_hash[k] = self.str_to_list(v)
-        else
+        when :pseudo then
           if k == 'hosts'
-            if DataCache.env_hash['web_hosts'] == DataCache.env_hash['db_hosts'] &&  DataCache.env_hash['web_hosts'] == DataCache.env_hash['balance_hosts']
+            if (tmp = DataCache.env_hash['web_hosts']) == DataCache.env_hash['db_hosts'] \
+                &&  tmp == DataCache.env_hash['balance_hosts'] \
+                &&  tmp == DataCache.env_hash['app_hosts']
               DataCache.env_hash['web_hosts'] =
                 DataCache.env_hash['db_hosts'] =
-                  DataCache.env_hash['balance_hosts'] = self.str_to_list(v)
+                  DataCache.env_hash['balance_hosts'] =
+                    DataCache.env_hash['app_hosts'] = self.str_to_list(v)
             else
               raise RuntimeError.new("#{self}#reset_env(): Cannot assign value to 'hosts' if web_hosts &/or db_hosts already set.\n web_hosts: #{DataCache.env_hash['web_hosts']}\n db_hosts: #{DataCache.env_hash['db_hosts']}")
               # raise RuntimeError.new("Cannot change hosts key if web_hosts != db_hosts")
             end
           else
-            raise ArgumentError.new("#{self}#reset_env(): Illegal environment key: #{k}")
+            next
           end
+        else
+          raise ArgumentError.new("#{self}#reset_env(): Illegal environment key: #{k}")
         end
       end
     end
@@ -198,7 +235,13 @@ module TddDeploy
             end
             # add any missing env keys
             (self.env_types.keys - self.env_hash.keys).each do |key|
-              self.env_hash[key] = self.env_defaults[key]
+              case self.env_types[key]
+              when :pseudo then next
+              when :list
+                self.env_hash[key] = str_to_list(self.env_defaults[key])
+              else
+                self.env_hash[key] = self.env_defaults[key]
+              end
             end
             return self.env_hash
           else
@@ -243,31 +286,19 @@ module TddDeploy
         when :string then f.write "#{k}=#{v}\n"
         when :list then
           f.write "#{k}=#{self.list_to_str(k)}\n" unless k == 'hosts'
+        when :pseudo then next
         else
           raise RuntimeError("unknown key: #{k}")
         end
       end
       f.close
     end
-
-    # accessors for all defined env variables
-    def hosts
-      (self.web_hosts.to_a + self.db_hosts.to_a + self.balance_hosts.to_a).uniq.sort
-    end
     
-    def hosts=(list)
-      if (self.web_hosts.nil? && self.db_hosts.nil?) || self.web_hosts == self.db_hosts
-        self.web_hosts =
-          self.db_hosts =
-            self.balance_hosts = self.str_to_list(list)
-      else
-        raise RuntimeError.new("Cannot assign value to 'hosts' if web_hosts &/or db_hosts already set.\n web_hosts: #{self.web_hosts}\n db_hosts: #{self.db_hosts}")
-      end
-    end
-
-    # create accessors for all keys in env_types
+    # create accessors for all keys in env_types which are not :pseudo variables
     tmp = ''
     DataCache.env_types.each do |k, t|
+      next if t == :pseudo
+      
       tmp +=<<-EOF
       def #{k}
         self.env_hash['#{k}']
@@ -290,11 +321,40 @@ module TddDeploy
         tmp +=<<-EOF
         def #{k}=(v)
          self.env_hash['#{k}'] = self.str_to_list(v)
+         DataCache.capfile = nil if '#{k}' == 'capfile_paths'
         end
         EOF
       end
     end
+    
+    ['app', 'db', 'web'].each do |k|
+      tmp +=<<-EOF
+      def #{k}
+        self.capfile.role_to_host_list :#{k}
+      end
+      EOF
+    end
 
     class_eval tmp
+
+    # accessors for all defined env variables
+    def hosts
+      (self.web_hosts.to_a + self.db_hosts.to_a + self.balance_hosts.to_a + self.app_hosts.to_a).uniq.sort
+    end
+    
+    def hosts=(list)
+      if (self.web_hosts.nil? && self.db_hosts.nil?) || self.web_hosts == self.db_hosts
+        self.web_hosts =
+          self.db_hosts =
+            self.balance_hosts =
+              self.app_hosts = self.str_to_list(list)
+      else
+        raise RuntimeError.new("Cannot assign value to 'hosts' if web_hosts &/or db_hosts already set.\n web_hosts: #{self.web_hosts}\n db_hosts: #{self.db_hosts}")
+      end
+    end
+    
+    def migration_hosts
+      self.capfile.migration_host_list
+    end
   end
 end

data/lib/tdd_deploy/server-templates/test_results.html.erb

@@ -11,7 +11,7 @@ end
 <html lang="en">
 <head>
 	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-	<title>TddDeploy for <%= site %></title>
+	<title>TddDeploy (<%= TddDeploy::VERSION %>) for <%= site %></title>
 	<meta name="generator" content="TextMate http://macromates.com/">
 	<meta name="author" content="Mike">
 	<style type="text/css" media="screen">
@@ -74,7 +74,7 @@ end
 </head>
 <body>
   <div id="test-summary">
-    <h1>TddDeloy Test Results: site: <%= site %> / hosts: <%= hosts %></h1>
+    <h1>TddDeploy (<%= TddDeploy::VERSION %>) Test Results: site: <%= site %> / hosts: <%= hosts %></h1>
   
     <% if (failures = total_failures) == 0 %>
     <p id="test-summary-passed">All Tests Passed</p>

data/lib/tdd_deploy/version.rb

@@ -1,3 +1,3 @@
 module TddDeploy
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/lib/tdd_deploy.rb

@@ -2,6 +2,7 @@ $:.unshift File.expand_path('..', __FILE__)
 
 require 'tdd_deploy/base'
 require 'tdd_deploy/assertions'
+require 'tdd_deploy/capfile'
 require 'tdd_deploy/deploy_test_methods'
 require 'tdd_deploy/environ'
 require 'tdd_deploy/run_methods'

data/tests/test_capfile.rb

@@ -0,0 +1,51 @@
+$:.unshift File.expand_path('..', __FILE__)
+require 'test_helpers'
+require 'tdd_deploy/capfile'
+
+class TestCapfileTestCase < Test::Unit::TestCase
+  
+  def setup
+    @capfile = TddDeploy::Capfile.new
+  end
+  
+  def teardown
+    @capfile = nil
+  end
+  
+  def test_load_recipes
+    assert_raises LoadError, "@capfile.load_recipes(no-file) should fail" do
+      @capfile.load_recipes('no-file')
+    end
+    assert @capfile.load_recipes('./config/deploy.rb'), "@capfile should load recipies"
+  end
+
+  def test_role_keys
+    @capfile.load_recipes('./config/deploy.rb')
+    assert_equal [:app, :db, :web], @capfile.roles.keys.sort, "capfile roles should be app, db, web"
+  end
+  
+  def test_role_values
+    @capfile.load_recipes  # ('./config/deploy.rb')
+    assert_equal ['app1', 'app2', 'app3'], @capfile.roles[:app].servers.map {|x| x.to_s }.sort, "app servers should be app1, app2, app3"
+    assert_equal ['db2', 'db3', 'db_primary'], @capfile.roles[:db].servers.map {|x| x.to_s }.sort, "db servers should be db_primary, db2, db3"
+    assert_equal ['web1', 'web2'], @capfile.roles[:web].servers.map {|x| x.to_s }.sort, "web servers should be web1, web2"
+  end
+
+  def test_role_to_host_list
+    @capfile.load_recipes('./config/deploy.rb')
+    assert_equal ['app1', 'app2', 'app3'], @capfile.role_to_host_list(:app).sort, "app servers should be app1, 2, 3"
+  end
+  
+  def test_migration_host_list
+    @capfile.load_recipes('./config/deploy.rb')
+    assert_equal ['db_primary'], @capfile.migration_host_list, "migration_host_list should be ['db_primary']"
+  end
+  
+  def test_simple_deploy_rb_file
+    @capfile.load_recipes('./config/simple_deploy.rb')
+    assert_equal ['app_server'], @capfile.role_to_host_list(:app), "app server should be ['app_server']"
+    assert_equal ['app_server'], @capfile.role_to_host_list(:db), "db server should be ['app_server']"
+    assert_equal ['app_server'], @capfile.role_to_host_list(:web), "web server should be ['app_server']"
+    assert_equal ['app_server'], @capfile.migration_host_list, "migration host server should be ['app_server']"
+  end
+end

data/tests/test_environ.rb

@@ -40,7 +40,8 @@ class TestEnvironTestCase < Test::Unit::TestCase
     @foo.clear_env
     system('TMP=/tmp/t-$$; trap "rm $TMP; exit" 0 1 2 3 15 ;cp site_host_setup.env $TMP ; sed -e 1d $TMP >site_host_setup.env')
     @foo.read_env
-    assert_equal @foo.env_types.keys.sort, @foo.env_hash.keys.sort, "read_env should set all keys"
+    non_pseudo_keys = @foo.env_types.reject {|k,t| t == :pseudo }.keys.sort
+    assert_equal non_pseudo_keys, @foo.env_hash.keys.sort, "read_env should set all keys"
   end
   
   def test_response_to_accessors
@@ -61,7 +62,8 @@ class TestEnvironTestCase < Test::Unit::TestCase
     [:env_hash, :ssh_timeout, :site_base_port, :site_num_servers,
       :host_admin, :local_admin, :local_admin_email,
       :site, :site_user, :site_path, :site_url,
-      :hosts, :balance_hosts, :db_hosts, :web_hosts].each do |meth|
+      :capfile_paths, :app, :db, :migration_hosts, :web,
+      :hosts, :app_hosts, :balance_hosts, :db_hosts, :web_hosts].each do |meth|
       assert @foo.respond_to?(meth), "@foo should respond to #{meth}"
       assert @foo.respond_to?("#{meth}".to_sym), "@foo should respond to #{meth}="
     end
@@ -69,7 +71,7 @@ class TestEnvironTestCase < Test::Unit::TestCase
   
   def test_env_type
     ["ssh_timeout", "site_base_port", "site_num_servers", "host_admin", "local_admin", "local_admin_email",
-    "site", "site_user", "site_path", "site_url", "balance_hosts", "db_hosts", "web_hosts"].each do |sym|
+    "site", "site_user", "site_path", "site_url", 'app_hosts', "balance_hosts", "db_hosts", "web_hosts"].each do |sym|
       assert @foo.env_types.keys.include?(sym.to_s), "@foo.env_types.keys includes #{sym}"
     end
     ["ssh_timeout", "site_base_port", "site_num_servers"].each do |key|
@@ -78,33 +80,34 @@ class TestEnvironTestCase < Test::Unit::TestCase
     ["host_admin", "local_admin", "local_admin_email", "site", "site_user",  "site_path", "site_url"].each do |key|
       assert_equal :string, @foo.env_types[key], "@foo.env_types[#{key}] should be :string"
     end
-    ["balance_hosts", "db_hosts", "web_hosts"].each do |key|
+    ['app_hosts', "balance_hosts", "capfile_paths", "db_hosts", "web_hosts"].each do |key|
       assert_equal :list, @foo.env_types[key], "@foo.env_types[#{key}] should be :list"
     end
   end
   
   def test_hosts_pseudokey
-    @foo.set_env :web_hosts => '', :db_hosts => '', :balance_hosts => ''
+    @foo.set_env :web_hosts => '', :db_hosts => '', :app_hosts => '', :balance_hosts => ''
     assert_equal [], @foo.web_hosts, "assigning '' to web_hosts should create empty list"
     assert_equal [], @foo.db_hosts, "assigning '' to db_hosts should create empty list"
     assert_equal [], @foo.balance_hosts, "assigning '' to balance_hosts should create empty list"
+    assert_equal [], @foo.app_hosts, "assigning '' to app_hosts should create empty list"
     @foo.set_env :hosts => 'foo,bar'
     assert_equal ['bar', 'foo'], @foo.hosts, "assigning foo,bar to hosts should create ['bar', 'foo']"
-    ['web_hosts', 'db_hosts', 'balance_hosts'].each do |hst|
+    ['app_hosts', 'web_hosts', 'db_hosts', 'balance_hosts'].each do |hst|
       assert_equal @foo.send(hst.to_sym), @foo.hosts, "hosts should be same as @foo.#{hst}"
     end
   end
   
   def test_env_hash
     ["ssh_timeout", "site_base_port", "site_num_servers", "host_admin", "local_admin", "local_admin_email",
-    "site", "site_user", "site_path", "site_url", "balance_hosts", "db_hosts", "web_hosts"].each do |key|
+    "site", "site_user", "site_path", "site_url", 'app_hosts', "balance_hosts", "db_hosts", "web_hosts"].each do |key|
       assert_not_nil @foo.env_hash[key], "@foo.env_hash[#{key}] should not be nil"
     end
   end
   
   def test_env_defaults
     ["ssh_timeout", "site_base_port", "site_num_servers", "host_admin", "local_admin", "local_admin_email",
-    "site", "site_user", "site_path", "site_url", "balance_hosts", "db_hosts", "web_hosts"].each do |key|
+    "site", "site_user", "site_path", "site_url", 'app_hosts', "balance_hosts", "db_hosts", "web_hosts"].each do |key|
       assert_not_nil @foo.env_defaults[key], "@foo.env_defaults[#{key}] should not be nil"
     end
   end
@@ -124,18 +127,22 @@ class TestEnvironTestCase < Test::Unit::TestCase
       @foo.send "#{key}=", tmp
       assert_equal tmp, @foo.send(key.to_sym), "@foo.#{key} should now be #{tmp}"
     end
-    ["balance_hosts", "db_hosts", "web_hosts"].each do |key|
+    ['app_hosts', "balance_hosts", "db_hosts", "web_hosts"].each do |key|
       tmp = @foo.send(key.to_sym).join(',') + ',new,values'
       @foo.send "#{key}=", tmp
       assert_equal tmp.split(/,/), @foo.send(key.to_sym), "@foo.#{key} should now be #{tmp}"
     end
   end
   
+  def test_capfile_variables
+    assert_equal ['app1', 'app2', 'app3'], @foo.app, "@foo.app should return all the hosts in :app role"
+  end
+  
   def test_instance_level_reset_env
     tmp = @foo.env_hash['ssh_timeout']
     @foo.set_env 'ssh_timeout' => 12
     assert_equal 12, @foo.env_hash['ssh_timeout'], "reset_env should change env_hash"
-    assert_equal 12, @foo.ssh_timeout, "reset_env change should show up in instance method"
+    assert_equal 12, @foo.ssh_timeout, "reset_env change should show in instance method"
   end
   
   def test_instance_env_hash_assign
@@ -153,6 +160,7 @@ class TestEnvironTestCase < Test::Unit::TestCase
       when :int then expect = 0
       when :string then expect = ''
       when :list then expect = []
+      when :pseudo then next
       end
       assert_equal expect, @foo.env_hash[k], "After Zapping, env_hash['#{k}'] should be #{expect}"
       assert_equal expect, @foo.send(k.to_sym), "After Zapping, @foo.#{k} should be #{expect}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tdd_deploy
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-08-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &2153508840 !ruby/object:Gem::Requirement
+  requirement: &2165394200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153508840
+  version_requirements: *2165394200
 - !ruby/object:Gem::Dependency
   name: net-ping
-  requirement: &2153508100 !ruby/object:Gem::Requirement
+  requirement: &2165393520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153508100
+  version_requirements: *2165393520
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &2153507580 !ruby/object:Gem::Requirement
+  requirement: &2165392800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153507580
+  version_requirements: *2165392800
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &2153506700 !ruby/object:Gem::Requirement
+  requirement: &2165392020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 4.5.0
   type: :development
   prerelease: false
-  version_requirements: *2153506700
+  version_requirements: *2165392020
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &2153506060 !ruby/object:Gem::Requirement
+  requirement: &2165391360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153506060
+  version_requirements: *2165391360
 description: Test driven support for host provisioning & Capistrano deployment - for
   those who don't want to bother learning too much
 email: ! ' mike@clove.com '
@@ -82,6 +82,7 @@ files:
 - bin/tdd_deploy_server
 - lib/tdd_deploy/assertions.rb
 - lib/tdd_deploy/base.rb
+- lib/tdd_deploy/capfile.rb
 - lib/tdd_deploy/configurator.rb
 - lib/tdd_deploy/copy_methods.rb
 - lib/tdd_deploy/deploy_test_methods.rb
@@ -103,6 +104,7 @@ files:
 - lib/tdd_deploy.rb
 - tests/test_assertions.rb
 - tests/test_base.rb
+- tests/test_capfile.rb
 - tests/test_configurator.rb
 - tests/test_copy_methods.rb
 - tests/test_deploy_test_methods.rb