capistrano-scope 0.0.8 → 0.1.0

data/lib/capistrano/scope.rb

@@ -6,6 +6,10 @@
 
 module Scope
   @@servers = Hash.new {|h,k| h[k] = {:ip_address => nil, :roles => [] } }
+  
+  def task_list
+    @@servers.keys.map {|key| "@:#{key}"}
+  end
 
   def role(role, server_name, options={})
     @@servers[server_name][:roles] << {:name => role, :options => options}
@@ -17,6 +21,7 @@ module Scope
 
   def create_task(name, pattern, ns)
     ns.task(name) do
+      set :current_scope, true
       keys = @@servers.keys.grep(/^#{pattern}/)
       
       keys.each do |key|
@@ -43,7 +48,7 @@ module Scope
   end
 
   # Execution starts here.
-  def create_role_tasks(ns)
+  def create_server_tasks(ns)
     @@servers.keys.each do |name| 
       namespace_task name.split(':').reverse, ns
     end
@@ -84,8 +89,9 @@ Capistrano.plugin :scope, Scope
 Capistrano::Configuration.instance.load do
   namespace '@'.to_sym do
 
-    task :create_role_tasks do
-      scope.create_role_tasks self
+    desc "[internal] create the scope tasks."
+    task :create_server_tasks do
+      scope.create_server_tasks self
     end
 
     desc "Scope all defined servers"
@@ -104,9 +110,22 @@ Capistrano::Configuration.instance.load do
         puts "         #{defined_server}"
       end
     end
+    
+    desc "[internal] Ensure that a stage has been selected."
+    task :ensure do
+      if !exists?(:current_scope)
+        if exists?(:default_scope)
+          logger.important "Defaulting to `#{default_scope}'"
+          find_and_execute_task(default_scope)
+        # else
+        #   abort "No scope specified. Please specify one of: #{stages.join(', ')} (e.g. `cap #{stages.first} #{ARGV.last}')"
+        end
+      end 
+    end
 
   end
 
-  on :load, '@:create_role_tasks'
+  on :load, '@:create_server_tasks'
+  on :start, '@:ensure', :except => scope.task_list + ['@:all', '@:create_server_tasks']
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano-scope
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 8
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kirt Fitzpatrick
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-17 00:00:00 -07:00
+date: 2010-09-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,10 +40,9 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
-- README
 - lib/capistrano/scope.rb
 has_rdoc: true
 homepage: http://github.com/kirtfitzpatrick/capistrano-scope

data/README

@@ -1,369 +0,0 @@
-Lightweight command line server selection for capistrano.  Rather than having 
-to blast a task across all servers with a given role or as with
-multistage having to group all of your servers into separate files ahead of 
-time.  With this package you can pick groups or sub groups of servers or even 
-individual servers to execute tasks on via the command line.  For example:
-
-$ cap @:clienta:projectx:production:app:1 app:install_bundler
-$ cap @:clienta:projecty:all server:deploy_authorized_keys USERS='john_doe jane_doe'
-$ cap @:all nagios:nrpe:deploy
-
-Keep in mind that this offers additional functionality
-to capistrano and takes away nothing.  It can be used this in combination 
-with multistage and role based server and task definitions.
-
-
-From a config file perspective the only new functionality is the scope.server
-and scope.role methods.  From a command line persective all that has been 
-added is the @: namespace which contains all the server scope tasks.
-
-
-
--------------------------------------------------------------------------
-= Capfile
-
-require 'capistrano/scope'
-
-
-
-
-= clientx.rb capistrano config file
-
-The order you specify servers or roles doesn't matter, you can define
-scope.role for a server before you define scope.server or visa versa.
-You can give servers any name you like but they are broken into logical
-groups by using the ":" separator.
-
-scope.server 'clienta:projectx:staging:lb:1', '123.456.567.1'
-scope.server 'clienta:projectx:staging:lb:2', '123.456.567.2'
-scope.server 'clienta:projectx:staging:app:1', '123.456.567.3'
-scope.server 'clienta:projectx:staging:app:2', '123.456.567.4'
-scope.server 'clienta:projectx:staging:db:1', '123.456.567.5'
-scope.server 'clienta:projectx:staging:db:2', '123.456.567.6'
-
-scope.server 'clienta:projectx:production:lb:1', '123.456.567.7'
-scope.server 'clienta:projectx:production:lb:2', '123.456.567.8'
-scope.server 'clienta:projectx:production:app:1', '123.456.567.9'
-scope.server 'clienta:projectx:production:app:2', '123.456.567.10'
-scope.server 'clienta:projectx:production:db:1', '123.456.567.12'
-scope.server 'clienta:projectx:production:db:2', '123.456.567.13'
-
-scope.server 'clienta:projecty:staging:lb:1', '123.456.567.1'
-scope.server 'clienta:projecty:staging:lb:2', '123.456.567.2'
-scope.server 'clienta:projecty:staging:app:1', '123.456.567.3'
-scope.server 'clienta:projecty:staging:app:2', '123.456.567.4'
-scope.server 'clienta:projecty:staging:db:1', '123.456.567.5'
-scope.server 'clienta:projecty:staging:db:2', '123.456.567.6'
-
-scope.server 'clienta:projecty:production:lb:1', '123.456.567.7'
-scope.server 'clienta:projecty:production:lb:2', '123.456.567.8'
-scope.server 'clienta:projecty:production:app:1', '123.456.567.9'
-scope.server 'clienta:projecty:production:app:2', '123.456.567.10'
-scope.server 'clienta:projecty:production:db:1', '123.456.567.12'
-scope.server 'clienta:projecty:production:db:2', '123.456.567.13'
-
-
-scope.role :server, 'clienta:projectx:staging:lb:1'
-scope.role :server, 'clienta:projectx:staging:lb:2'
-scope.role :server, 'clienta:projectx:staging:app:1'
-scope.role :server, 'clienta:projectx:staging:app:2'
-scope.role :server, 'clienta:projectx:staging:db:1'
-scope.role :server, 'clienta:projectx:staging:db:2'
-scope.role :server, 'clienta:projectx:production:lb:1'
-scope.role :server, 'clienta:projectx:production:lb:2'
-scope.role :server, 'clienta:projectx:production:app:1'
-scope.role :server, 'clienta:projectx:production:app:2'
-scope.role :server, 'clienta:projectx:production:db:1'
-scope.role :server, 'clienta:projectx:production:db:2'
-scope.role :server, 'clienta:projecty:staging:lb:1'
-scope.role :server, 'clienta:projecty:staging:lb:2'
-scope.role :server, 'clienta:projecty:staging:app:1'
-scope.role :server, 'clienta:projecty:staging:app:2'
-scope.role :server, 'clienta:projecty:staging:db:1'
-scope.role :server, 'clienta:projecty:staging:db:2'
-scope.role :server, 'clienta:projecty:production:lb:1'
-scope.role :server, 'clienta:projecty:production:lb:2'
-scope.role :server, 'clienta:projecty:production:app:1'
-scope.role :server, 'clienta:projecty:production:app:2'
-scope.role :server, 'clienta:projecty:production:db:1'
-scope.role :server, 'clienta:projecty:production:db:2'
-
-scope.role :load_balancer, 'clienta:projectx:staging:lb:1'
-scope.role :load_balancer, 'clienta:projectx:staging:lb:2'
-scope.role :load_balancer, 'clienta:projectx:production:lb:1'
-scope.role :load_balancer, 'clienta:projectx:production:lb:2'
-scope.role :load_balancer, 'clienta:projecty:staging:lb:1'
-scope.role :load_balancer, 'clienta:projecty:staging:lb:2'
-scope.role :load_balancer, 'clienta:projecty:production:lb:1'
-scope.role :load_balancer, 'clienta:projecty:production:lb:2'
-
-scope.role :app, 'clienta:projectx:staging:app:1'
-scope.role :app, 'clienta:projectx:staging:app:2'
-scope.role :app, 'clienta:projectx:production:app:1'
-scope.role :app, 'clienta:projectx:production:app:2'
-scope.role :app, 'clienta:projecty:staging:app:1'
-scope.role :app, 'clienta:projecty:staging:app:2'
-scope.role :app, 'clienta:projecty:production:app:1'
-scope.role :app, 'clienta:projecty:production:app:2'
-
-scope.role :db, 'clienta:projectx:staging:db:1', :primary => true
-scope.role :db, 'clienta:projectx:staging:db:2'
-scope.role :db, 'clienta:projectx:production:db:1', :primary => true
-scope.role :db, 'clienta:projectx:production:db:2'
-scope.role :db, 'clienta:projecty:staging:db:1', :primary => true
-scope.role :db, 'clienta:projecty:staging:db:2'
-scope.role :db, 'clienta:projecty:production:db:1', :primary => true
-scope.role :db, 'clienta:projecty:production:db:2'
-
-
-
-
-
-# For the sake of demonstration lets assume we also have the following tasks
-# defined and included from somewhere else.
-# -------------------------------------------------------------------------
-# recipes.rb
-
-namespace :server do
-  desc "Concatenate Keys and upload new authorized_keys file to the server."
-  task :authorized_keys, :roles => :server do
-    ...
-  end
-
-  desc "Install Subversion"
-  task :install_subversion, :roles => :server do
-    ...
-  end
-end
-
-namespace :mysql do
-  desc "Backup Database"
-  task :backup, :roles => :db do
-    ...
-  end
-end
-
-namespace :app do
-  desc "Install bundler"
-  task :install_bundler, :roles => :app do
-    ...
-  end
-  
-  desc "Install nginx"
-  task :install_nginx, :roles => :app do
-    ...
-  end
-
-  desc "Install imagemagick"
-  task :install_imagemagick, :roles => :app do
-    ...
-  end
-end
-
-namespace :nagios do
-  desc "Update nagios config on the admin server and restart nagios service"
-  task :deploy, :roles => :admin do
-    ...
-  end
-
-  desc "Restart the nagios SMF Service"
-  task :restart, :roles => :admin do
-    ...
-  end
-  
-  namespace :nrpe do
-    desc "Install NRPE"
-    task :install, :roles => :server do
-      ...
-    end
-  
-    desc "Update NRPE Configuration"
-    task :deploy, :roles => :server do
-      ...
-    end
-  end
-
-  namespace :plugins do
-    desc "Copy plugins to servers"
-    task :deploy, :roles => :server do
-      ...
-    end
-  end
-end
-
-# end of recipes.rb
-# -------------------------------------------------------------------------
-
-
-
-# Now on the command line you can see the tasks that you normally would 
-# by listing out tasks with descriptions.
-
-$ cap -T
-
-cap @:all                                       # Scope all defined servers
-cap @:show                                      # Show the roles and servers ...
-cap app:install_bundler
-cap app:install_nginx
-cap app:install_image_magick
-cap mysql:backup
-cap nagios:deploy
-cap nagios:restart
-cap nagios:nrpe:install
-cap nagios:nrpe:deploy
-cap nagios:plugins:deploy
-cap server:authorized_keys
-cap server:install_subversion
-
-
-
-# And if you want to see a list of all the server scopes that you have 
-# defined  use the verbose flag.  Since we used the '@' as the top level
-# namespace for our scoping tasks they should all sort to the top of the
-# list and then be followed by your normal capistrano tasks.
-
-$ cap -vT
-
-cap @:all                                       # Scope all defined servers
-cap @:clienta:all                               # 
-cap @:clienta:projectx:all                      # 
-cap @:clienta:projectx:production:all           # 
-cap @:clienta:projectx:production:app:1         # 
-cap @:clienta:projectx:production:app:2         # 
-cap @:clienta:projectx:production:app:all       # 
-cap @:clienta:projectx:production:db:1          # 
-cap @:clienta:projectx:production:db:2          # 
-cap @:clienta:projectx:production:db:all        # 
-cap @:clienta:projectx:production:lb:1          # 
-cap @:clienta:projectx:production:lb:2          # 
-cap @:clienta:projectx:production:lb:all        # 
-cap @:clienta:projectx:staging:all              # 
-cap @:clienta:projectx:staging:app:1            # 
-cap @:clienta:projectx:staging:app:2            # 
-cap @:clienta:projectx:staging:app:all          # 
-cap @:clienta:projectx:staging:db:1             # 
-cap @:clienta:projectx:staging:db:2             # 
-cap @:clienta:projectx:staging:db:all           # 
-cap @:clienta:projectx:staging:lb:1             # 
-cap @:clienta:projectx:staging:lb:2             # 
-cap @:clienta:projectx:staging:lb:all           # 
-cap @:clienta:projecty:all                      # 
-cap @:clienta:projecty:production:all           # 
-cap @:clienta:projecty:production:app:1         # 
-cap @:clienta:projecty:production:app:2         # 
-cap @:clienta:projecty:production:app:all       # 
-cap @:clienta:projecty:production:db:1          # 
-cap @:clienta:projecty:production:db:2          # 
-cap @:clienta:projecty:production:db:all        # 
-cap @:clienta:projecty:production:lb:1          # 
-cap @:clienta:projecty:production:lb:2          # 
-cap @:clienta:projecty:production:lb:all        # 
-cap @:clienta:projecty:staging:all              # 
-cap @:clienta:projecty:staging:app:1            # 
-cap @:clienta:projecty:staging:app:2            # 
-cap @:clienta:projecty:staging:app:all          # 
-cap @:clienta:projecty:staging:db:1             # 
-cap @:clienta:projecty:staging:db:2             # 
-cap @:clienta:projecty:staging:db:all           # 
-cap @:clienta:projecty:staging:lb:1             # 
-cap @:clienta:projecty:staging:lb:2             # 
-cap @:clienta:projecty:staging:lb:all           # 
-cap @:create_role_tasks                         # 
-cap @:show                                      # Show the roles and servers ...
-cap app:install_bundler
-cap app:install_nginx
-cap app:install_image_magick
-cap mysql:backup
-cap nagios:deploy
-cap nagios:restart
-cap nagios:nrpe:install
-cap nagios:nrpe:deploy
-cap nagios:plugins:deploy
-cap server:authorized_keys
-cap server:install_subversion
-
-
-
-
-# Now to execute a task on a single server you can precede the task with the
-# scope task for that server.
-
-$ cap @:clienta:projectx:production:app:1 app:install_bundler
-
-
-# Or if you want to execute that task on a group of servers you can use the
-# all task that is defined for you at each level.
-
-$ cap @:clienta:projectx:production:app:all
-
-
-# Since we have added roles to our tasks and servers we can still execute
-# tasks on larger groups of servers that include servers that we don't want
-# the command to run on.  Because the task is role based it will only execute
-# the task on the correct servers.  For example if we wanted to install nginx
-# on all app servers of clientx but not clienty we could do this:
-
-$ cap @:clientx:all app:install_nginx
-
-# And if we really wanted to go global we can execute something across all
-# servers with the @:all scope.  Lets say we want to deploy they updated
-# nrpe config file and a new plugin we wrote to all our servers.
-
-$ cap @:all nagios:nrpe:deploy nagios:plugins:deploy
-
-
-# Included with this package is a @:show task that will list out all the
-# servers and roles that are defined for a given scope.
-
-$ cap @:clienta:projectx:all @:show
-
-    triggering load callbacks
-  * executing `@:create_role_tasks'
-  * executing `@:clienta:projectx:all'
-  * executing `@:show'
-Roles:
-         app
-         db
-         load_balancer
-         server
-Servers:
-         clienta:projectx:production:app:1
-         clienta:projectx:production:app:2
-         clienta:projectx:production:db:1
-         clienta:projectx:production:db:2
-         clienta:projectx:staging:app:1
-         clienta:projectx:staging:app:2
-         clienta:projectx:staging:db:2
-         clienta:projecty:production:lb:1
-         clienta:projecty:production:lb:2
-         clienta:projecty:staging:db:1
-         clienta:projecty:staging:lb:1
-         clienta:projecty:staging:lb:2
-
-
-
-
-$ cap @:clienta:projectx:staging:db:all @:show
-
-    triggering load callbacks
-  * executing `@:create_role_tasks'
-  * executing `@:clienta:projectx:staging:db:all'
-  * executing `@:show'
-Roles:
-         db
-         server
-Servers:
-         clienta:projectx:staging:db:2
-         clienta:projecty:staging:db:1
-
-
-
-
-= How it Works
-
-The implementation behind this is simple.  When the configuration is 
-loaded it generates tasks for each server and server group in memory.  Each of these
-tasks is not much more than a list of capistrano server and role method calls.
-When you call one of the scope tasks from the command line the task executes
-and the roles and servers are defined just in time for the next task on the 
-command line to execute on them.