fezzik 0.6.4 → 0.7.0

data/README.md

@@ -17,7 +17,8 @@ Require Fezzik in your project Rakefile and define a destination:
 require "fezzik"
 
 Fezzik.destination :prod do
-  set :domain, "root@myapp.com"
+  set :user, "root"
+  set :domain, "myapp.com"
 end
 ```
 
@@ -57,11 +58,11 @@ set :local_path, Dir.pwd
 set :user, "root"
 
 Fezzik.destination :staging do
-  set :domain, "#{user}@myapp-staging.com"
+  set :domain, "myapp-staging.com"
 end
 
 Fezzik.destination :prod do
-  set :domain, "#{user}@myapp.com"
+  set :domain, "myapp.com"
 end
 ```
 
@@ -116,7 +117,7 @@ $ fez get environment
 
 ```ruby
 Fezzik.destination :prod do
-  set :domain, "#{user}@myapp.com"
+  set :domain, "myapp.com"
   Fezzik.env :rack_env, "production"
 end
 ```
@@ -137,7 +138,7 @@ You can assign different environments to a subset of the hosts you deploy to.
 
 ```ruby
 Fezzik.destination :prod do
-  set :domain, ["#{user}@myapp1.com", "#{user}@myapp2.com"]
+  set :domain, ["myapp1.com", "myapp2.com"]
   Fezzik.env :rack_env, "production"
   Fezzik.env :is_canary, "true", :hosts => ["myapp1.com"]
 end
@@ -151,6 +152,54 @@ task :inspect_environment do
 end
 ```
 
+
+## Roles
+
+Fezzik supports role deployments. Roles allow you to assign remote_tasks different configurations according
+to their purpose. For example, you might want to perform your initial package installations as root, but run
+your app as an unprivileged user.
+
+```ruby
+Fezzik.destination :prod do
+  set :domain, "myapp.com"
+  Fezzik.role :root_user, :user => "root"
+  Fezzik.role :run_user, :user => "app"
+end
+
+remote_task :install, :roles => :root_user
+  # Install all the things.
+end
+
+remote_task :run, :roles => :run_user
+  # Run all the things.
+end
+```
+
+Or, you might have different domains for database deployment and app deployment.
+
+```ruby
+Fezzik.destination :prod do
+  set :user, "root"
+  Fezzik.role :db, :domain => "db.myapp.com"
+  Fezzik.role :app, :domain => "myapp.com"
+end
+```
+
+Roles in destination blocks can override global role settings.
+
+```ruby
+Fezzik.role :app, :domain => "localhost"
+
+Fezzik.destination :prod do
+  Fezzik.role :app, :domain => "myapp.com"
+end
+```
+
+The `Fezzik.role` method accepts a role name and a hash of values that you want assigned with the
+`set :var, value` syntax. These will override the global or destination settings when that remote_task is
+run.
+
+
 ## Utilities
 
 Fezzik exposes some functions that can be useful when running remote tasks.
@@ -192,6 +241,7 @@ the following functions:
 ```
 destination
 env
+role
 capture_output
 ```
 
@@ -202,9 +252,11 @@ include Fezzik::DSL
 
 destination :prod do
   env :rack_env, "production"
+  role :root_user, :user => "root"
 end
 ```
 
+
 ## Tasks
 
 Fezzik has a number of useful tasks other than deploy.rake and environment.rake. These can also be downloaded

data/bin/fez

@@ -67,8 +67,8 @@ def run_fezzik_tasks
   begin
     tasks = ARGV[1..-1]
     tasks.each do |task_with_params|
-      task, params = Fezzik::Util.split_task_and_params(task_with_params)
-      Rake::Task["fezzik:#{task}"].invoke(params)
+      task_name, params = Fezzik::Util.split_task_and_params(task_with_params)
+      Rake::Task["fezzik:#{task_name}"].invoke(params)
     end
     puts "[success]".green
   rescue SystemExit, Rake::CommandFailedError => e

data/lib/fezzik.rb

@@ -6,6 +6,7 @@ require "colorize"
 require "fezzik/base"
 require "fezzik/dsl"
 require "fezzik/environment"
+require "fezzik/role"
 require "fezzik/io"
 require "fezzik/util"
 require "fezzik/version"

data/lib/fezzik/dsl.rb

@@ -1,15 +1,13 @@
 module Fezzik
   module DSL
-    def destination(name, &block)
-      Fezzik.destination(name, &block)
-    end
-
-    def env(*args)
-      Fezzik.env(*args)
-    end
-
-    def capture_output(&block)
-      Fezzik::Util.capture_output(&block)
+    # This is necessary to override Rake::RemoteTask's globally eval'ed method definitions.
+    def self.included(klass)
+      klass.class_eval do
+        def role(*args) Fezzik.role(*args) end
+      end
     end
+    def destination(name, &block) Fezzik.destination(name, &block) end
+    def env(*args) Fezzik.env(*args) end
+    def capture_output(&block) Fezzik::Util.capture_output(&block) end
   end
 end

data/lib/fezzik/role.rb

@@ -0,0 +1,39 @@
+module Fezzik
+  def self.role(role_name, settings)
+    @roles ||= {}
+    @roles[role_name] = settings
+  end
+
+  def self.roles() @roles ||= {} end
+
+  def self.with_role(role_name, &block)
+    return block.call if roles[role_name].nil?
+
+    old_settings = Hash[roles[role_name].map { |setting, value| [setting, self.send(setting)] }]
+    override_settings(roles[role_name])
+    begin
+      block.call
+    ensure
+      override_settings(old_settings)
+    end
+  end
+
+  def self.override_settings(settings)
+    settings.each { |setting, value| self.send(:set, setting, value) }
+  end
+end
+
+module Rake
+  class RemoteTask
+    def defined_target_hosts?() true end
+    def target_hosts() domain end
+
+    alias remote_task_execute execute
+    def execute(args = nil)
+      return Fezzik::Util.with_prepended_user { remote_task_execute(args) } if options[:roles].empty?
+      options[:roles].each do |role|
+        Fezzik.with_role(role) { Fezzik::Util.with_prepended_user { remote_task_execute(args) } }
+      end
+    end
+  end
+end

data/lib/fezzik/util.rb

@@ -20,5 +20,21 @@ module Fezzik
       end
       [task, params]
     end
+
+    # Blocks passed to this function will ensure `domain` is always an Array. In addition, if `user` is set it
+    # will automatically prepend the value of `user` to the front of any domains missing a username. This allows a
+    # fezzik user to write the following in their configuration and have it "just work":
+    #     set :domain, ["example.com", "test@example2.com"]
+    #     set :user, "root"
+    # `domain` will be equal to ["root@example.com", "test@example2.com"]
+    def self.with_prepended_user(&block)
+      old_domain = domain
+      begin
+        set :domain, Array(domain).map { |d| (defined?(user) && !d.include?("@")) ? "#{user}@#{d}" : d }
+        block.call
+      ensure
+        set :domain, old_domain
+      end
+    end
   end
 end

data/lib/fezzik/version.rb

@@ -1,3 +1,3 @@
 module Fezzik
-  VERSION = "0.6.4"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fezzik
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000Z
+date: 2012-05-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &12238520 !ruby/object:Gem::Requirement
+  requirement: &70336101632020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.8.7
   type: :runtime
   prerelease: false
-  version_requirements: *12238520
+  version_requirements: *70336101632020
 - !ruby/object:Gem::Dependency
   name: rake-remote_task
-  requirement: &12236440 !ruby/object:Gem::Requirement
+  requirement: &70336101631220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 2.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *12236440
+  version_requirements: *70336101631220
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &12233680 !ruby/object:Gem::Requirement
+  requirement: &70336101630760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: 0.5.8
   type: :runtime
   prerelease: false
-  version_requirements: *12233680
+  version_requirements: *70336101630760
 description: A light deployment system that gets out of your way
 email: dmacdougall@gmail.com
 executables:
@@ -64,6 +64,7 @@ files:
 - lib/fezzik/dsl.rb
 - lib/fezzik/environment.rb
 - lib/fezzik/io.rb
+- lib/fezzik/role.rb
 - lib/fezzik/util.rb
 - lib/fezzik/version.rb
 - tasks/command.rake