wulffeld-capistrano 2.5.8

data/Manifest

@@ -0,0 +1,104 @@
+bin/cap
+bin/capify
+CHANGELOG.rdoc
+examples/sample.rb
+lib/capistrano/callback.rb
+lib/capistrano/cli/execute.rb
+lib/capistrano/cli/help.rb
+lib/capistrano/cli/help.txt
+lib/capistrano/cli/options.rb
+lib/capistrano/cli/ui.rb
+lib/capistrano/cli.rb
+lib/capistrano/command.rb
+lib/capistrano/configuration/actions/file_transfer.rb
+lib/capistrano/configuration/actions/inspect.rb
+lib/capistrano/configuration/actions/invocation.rb
+lib/capistrano/configuration/callbacks.rb
+lib/capistrano/configuration/connections.rb
+lib/capistrano/configuration/execution.rb
+lib/capistrano/configuration/loading.rb
+lib/capistrano/configuration/namespaces.rb
+lib/capistrano/configuration/roles.rb
+lib/capistrano/configuration/servers.rb
+lib/capistrano/configuration/variables.rb
+lib/capistrano/configuration.rb
+lib/capistrano/errors.rb
+lib/capistrano/extensions.rb
+lib/capistrano/logger.rb
+lib/capistrano/processable.rb
+lib/capistrano/recipes/compat.rb
+lib/capistrano/recipes/deploy/dependencies.rb
+lib/capistrano/recipes/deploy/local_dependency.rb
+lib/capistrano/recipes/deploy/remote_dependency.rb
+lib/capistrano/recipes/deploy/scm/accurev.rb
+lib/capistrano/recipes/deploy/scm/base.rb
+lib/capistrano/recipes/deploy/scm/bzr.rb
+lib/capistrano/recipes/deploy/scm/cvs.rb
+lib/capistrano/recipes/deploy/scm/darcs.rb
+lib/capistrano/recipes/deploy/scm/git.rb
+lib/capistrano/recipes/deploy/scm/mercurial.rb
+lib/capistrano/recipes/deploy/scm/none.rb
+lib/capistrano/recipes/deploy/scm/perforce.rb
+lib/capistrano/recipes/deploy/scm/subversion.rb
+lib/capistrano/recipes/deploy/scm.rb
+lib/capistrano/recipes/deploy/strategy/base.rb
+lib/capistrano/recipes/deploy/strategy/checkout.rb
+lib/capistrano/recipes/deploy/strategy/copy.rb
+lib/capistrano/recipes/deploy/strategy/export.rb
+lib/capistrano/recipes/deploy/strategy/remote.rb
+lib/capistrano/recipes/deploy/strategy/remote_cache.rb
+lib/capistrano/recipes/deploy/strategy.rb
+lib/capistrano/recipes/deploy/templates/maintenance.rhtml
+lib/capistrano/recipes/deploy.rb
+lib/capistrano/recipes/standard.rb
+lib/capistrano/recipes/templates/maintenance.rhtml
+lib/capistrano/recipes/upgrade.rb
+lib/capistrano/role.rb
+lib/capistrano/server_definition.rb
+lib/capistrano/shell.rb
+lib/capistrano/ssh.rb
+lib/capistrano/task_definition.rb
+lib/capistrano/transfer.rb
+lib/capistrano/version.rb
+lib/capistrano.rb
+Rakefile
+README.rdoc
+setup.rb
+test/cli/execute_test.rb
+test/cli/help_test.rb
+test/cli/options_test.rb
+test/cli/ui_test.rb
+test/cli_test.rb
+test/command_test.rb
+test/configuration/actions/file_transfer_test.rb
+test/configuration/actions/inspect_test.rb
+test/configuration/actions/invocation_test.rb
+test/configuration/callbacks_test.rb
+test/configuration/connections_test.rb
+test/configuration/execution_test.rb
+test/configuration/loading_test.rb
+test/configuration/namespace_dsl_test.rb
+test/configuration/roles_test.rb
+test/configuration/servers_test.rb
+test/configuration/variables_test.rb
+test/configuration_test.rb
+test/deploy/local_dependency_test.rb
+test/deploy/remote_dependency_test.rb
+test/deploy/scm/accurev_test.rb
+test/deploy/scm/base_test.rb
+test/deploy/scm/git_test.rb
+test/deploy/scm/mercurial_test.rb
+test/deploy/strategy/copy_test.rb
+test/extensions_test.rb
+test/fixtures/cli_integration.rb
+test/fixtures/config.rb
+test/fixtures/custom.rb
+test/logger_test.rb
+test/role_test.rb
+test/server_definition_test.rb
+test/shell_test.rb
+test/ssh_test.rb
+test/task_definition_test.rb
+test/transfer_test.rb
+test/utils.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,66 @@
+= Capistrano
+
+Capistrano is a utility and framework for executing commands in parallel on multiple remote machines, via SSH. It uses a simple DSL (borrowed in part from Rake, http://rake.rubyforge.org/) that allows you to define _tasks_, which may be applied to machines in certain roles. It also supports tunneling connections via some gateway machine to allow operations to be performed behind VPN's and firewalls.
+
+Capistrano was originally designed to simplify and automate deployment of web applications to distributed environments, and originally came bundled with a set of tasks designed for deploying Rails applications. The deployment tasks are now (as of Capistrano 2.0) opt-in and require clients to explicitly put
+"load 'deploy'" in their recipes.
+
+== DEPENDENCIES
+
+* Net::SSH v2 (http://net-ssh.rubyforge.org)
+* Net::SFTP v2 (http://net-ssh.rubyforge.org)
+* Net::SCP v1 (http://net-ssh.rubyforge.org)
+* Net::SSH::Gateway v1 (http://net-ssh.rubyforge.org)
+* HighLine (http://highline.rubyforge.org)
+
+If you want to run the tests, you'll also need to have the following dependencies installed:
+
+* Echoe (for the Rakefile)
+* Mocha (http://mocha.rubyforge.org)
+
+== ASSUMPTIONS
+
+Capistrano is "opinionated software", which means it has very firm ideas about how things ought to be done, and tries to force those ideas on you. Some of the assumptions behind these opinions are:
+
+* You are using SSH to access the remote servers.
+* You either have the same password to all target machines, or you have public keys in place to allow passwordless access to them.
+
+Do not expect these assumptions to change.
+
+== USAGE
+
+In general, you'll use Capistrano as follows:
+
+* Create a recipe file ("capfile" or "Capfile").
+* Use the +cap+ script to execute your recipe.
+
+Use the +cap+ script as follows:
+
+    cap sometask
+
+By default, the script will look for a file called one of +capfile+ or +Capfile+. The +someaction+ text indicates which task to execute. You can do "cap -h" to see all the available options and "cap -T" to see all the available tasks.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2005-2008 Jamis Buck <jamis@37signals.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,34 @@
+require "./lib/capistrano/version"
+
+begin
+  require 'echoe'
+rescue LoadError
+  abort "You'll need to have `echoe' installed to use Capistrano's Rakefile"
+end
+
+version = Capistrano::Version::STRING.dup
+if ENV['SNAPSHOT'].to_i == 1
+  version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
+end
+
+Echoe.new('capistrano', version) do |p|
+  p.changelog        = "CHANGELOG.rdoc"
+
+  p.author           = "Jamis Buck"
+  p.email            = "jamis@jamisbuck.org"
+
+  p.summary = <<-DESC.strip.gsub(/\n\s+/, " ")
+    Capistrano is a utility and framework for executing commands in parallel
+    on multiple remote machines, via SSH.
+  DESC
+
+  p.url              = "http://www.capify.org"
+  p.need_zip         = true
+  p.rdoc_pattern     = /^(lib|README.rdoc|CHANGELOG.rdoc)/
+
+  p.dependencies     = ["net-ssh         >=2.0.10",
+                        "net-sftp        >=2.0.0",
+                        "net-scp         >=1.0.0",
+                        "net-ssh-gateway >=1.0.0",
+                        "highline"]
+end

data/bin/cap

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'capistrano/cli'
+Capistrano::CLI.execute

data/bin/capify

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  opts.on("-h", "--help", "Displays this help info") do
+    puts opts
+    exit 0
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+if ARGV.empty?
+  abort "Please specify the directory to capify, e.g. `#{File.basename($0)} .'"
+elsif !File.exists?(ARGV.first)
+  abort "`#{ARGV.first}' does not exist."
+elsif !File.directory?(ARGV.first)
+  abort "`#{ARGV.first}' is not a directory."
+elsif ARGV.length > 1
+  abort "Too many arguments; please specify only the directory to capify."
+end
+
+def unindent(string)
+  indentation = string[/\A\s*/]
+  string.strip.gsub(/^#{indentation}/, "")
+end
+
+files = {
+  "Capfile" => unindent(<<-FILE),
+    load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+    Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+    load 'config/deploy'
+  FILE
+
+  "config/deploy.rb" => unindent(<<-FILE),
+    set :application, "set your application name here"
+    set :repository,  "set your repository location here"
+
+    # If you aren't deploying to /u/apps/\#{application} on the target
+    # servers (which is the default), you can specify the actual location
+    # via the :deploy_to variable:
+    # set :deploy_to, "/var/www/\#{application}"
+
+    # If you aren't using Subversion to manage your source code, specify
+    # your SCM below:
+    # set :scm, :subversion
+
+    role :app, "your app-server here"
+    role :web, "your web-server here"
+    role :db,  "your db-server here", :primary => true
+  FILE
+}
+
+base = ARGV.shift
+files.each do |file, content|
+  file = File.join(base, file)
+  if File.exists?(file)
+    warn "[skip] `#{file}' already exists"
+  elsif File.exists?(file.downcase)
+    warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+  elsif !File.exists?(File.dirname(file))
+    warn "[skip] directory `#{File.dirname(file)}' does not exist"
+  else
+    puts "[add] writing `#{file}'"
+    File.open(file, "w") { |f| f.write(content) }
+  end
+end
+
+puts "[done] capified!"

data/examples/sample.rb

@@ -0,0 +1,14 @@
+# set :user, "flippy"
+# set :password, "hello-flippy"
+# set :gateway, "gateway.example.com"
+
+role :web, "web1.example.com"
+role :app, "app1.example.com", "app2.example.com"
+
+desc <<-DESC
+This is a sample task. It is only intended to be used as a demonstration of \
+how you can define your own tasks.
+DESC
+task :sample_task, :roles => :app do
+  run "ls -l"
+end

data/lib/capistrano.rb

@@ -0,0 +1,2 @@
+require 'capistrano/configuration'
+require 'capistrano/extensions'

data/lib/capistrano/callback.rb

@@ -0,0 +1,45 @@
+module Capistrano
+  class Callback
+    attr_reader :source, :options, :only, :except
+
+    def initialize(source, options={})
+      @source = source
+      @options = options
+      @only = Array(options[:only]).map { |v| v.to_s }
+      @except = Array(options[:except]).map { |v| v.to_s }
+    end
+
+    def applies_to?(task)
+      if task && only.any?
+        return only.include?(task.fully_qualified_name)
+      elsif task && except.any?
+        return !except.include?(task.fully_qualified_name)
+      else
+        return true
+      end
+    end
+  end
+
+  class ProcCallback < Callback
+    def call
+      source.call
+    end
+  end
+
+  class TaskCallback < Callback
+    attr_reader :config
+
+    def initialize(config, source, options={})
+      super(source, options)
+      @config = config
+    end
+
+    def call
+      config.find_and_execute_task(source)
+    end
+
+    def applies_to?(task)
+      super && (task.nil? || task.fully_qualified_name != source.to_s)
+    end
+  end
+end

data/lib/capistrano/cli.rb

@@ -0,0 +1,47 @@
+require 'capistrano'
+require 'capistrano/cli/execute'
+require 'capistrano/cli/help'
+require 'capistrano/cli/options'
+require 'capistrano/cli/ui'
+
+module Capistrano
+  # The CLI class encapsulates the behavior of capistrano when it is invoked
+  # as a command-line utility. This allows other programs to embed Capistrano
+  # and preserve its command-line semantics.
+  class CLI
+    # The array of (unparsed) command-line options
+    attr_reader :args
+
+    # Create a new CLI instance using the given array of command-line parameters
+    # to initialize it. By default, +ARGV+ is used, but you can specify a
+    # different set of parameters (such as when embedded cap in a program):
+    #
+    #   require 'capistrano/cli'
+    #   Capistrano::CLI.parse(%w(-vvvv -r config/deploy update_code)).execute!
+    #
+    # Note that you can also embed cap directly by creating a new Configuration
+    # instance and setting it up, but you'll often wind up duplicating logic
+    # defined in the CLI class. The above snippet, redone using the Configuration
+    # class directly, would look like:
+    #
+    #   require 'capistrano'
+    #   require 'capistrano/cli'
+    #   config = Capistrano::Configuration.new
+    #   config.logger_level = Capistrano::Logger::TRACE
+    #   config.set(:password) { Capistrano::CLI.password_prompt }
+    #   config.load "config/deploy"
+    #   config.update_code
+    #
+    # There may be times that you want/need the additional control offered by
+    # manipulating the Configuration directly, but generally interfacing with
+    # the CLI class is recommended.
+    def initialize(args)
+      @args = args.dup
+      $stdout.sync = true # so that Net::SSH prompts show up
+    end
+
+    # Mix-in the actual behavior
+    include Execute, Options, UI
+    include Help # needs to be included last, because it overrides some methods
+  end
+end

data/lib/capistrano/cli/execute.rb

@@ -0,0 +1,84 @@
+require 'capistrano/configuration'
+
+module Capistrano
+  class CLI
+    module Execute
+      def self.included(base) #:nodoc:
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # Invoke capistrano using the ARGV array as the option parameters. This
+        # is what the command-line capistrano utility does.
+        def execute
+          parse(ARGV).execute!
+        end
+      end
+
+      # Using the options build when the command-line was parsed, instantiate
+      # a new Capistrano configuration, initialize it, and execute the
+      # requested actions.
+      #
+      # Returns the Configuration instance used, if successful.
+      def execute!
+        config = instantiate_configuration
+        config.debug = options[:debug]
+        config.dry_run = options[:dry_run]
+        config.logger.level = options[:verbose]
+
+        set_pre_vars(config)
+        load_recipes(config)
+
+        config.trigger(:load)
+        execute_requested_actions(config)
+        config.trigger(:exit)
+
+        config
+      rescue Exception => error
+        handle_error(error)
+      end
+
+      def execute_requested_actions(config)
+        Array(options[:vars]).each { |name, value| config.set(name, value) }
+
+        Array(options[:actions]).each do |action|
+          config.find_and_execute_task(action, :before => :start, :after => :finish)
+        end
+      end
+
+      def set_pre_vars(config) #:nodoc:
+        config.set :password, options[:password]
+        Array(options[:pre_vars]).each { |name, value| config.set(name, value) }
+      end
+
+      def load_recipes(config) #:nodoc:
+        # load the standard recipe definition
+        config.load "standard"
+      
+        # load systemwide config/recipe definition
+        config.load(options[:sysconf]) if options[:sysconf] && File.file?(options[:sysconf])        
+      
+        # load user config/recipe definition
+        config.load(options[:dotfile]) if options[:dotfile] && File.file?(options[:dotfile])
+
+        Array(options[:recipes]).each { |recipe| config.load(recipe) }
+      end
+
+      # Primarily useful for testing, but subclasses of CLI could conceivably
+      # override this method to return a Configuration subclass or replacement.
+      def instantiate_configuration #:nodoc:
+        Capistrano::Configuration.new
+      end
+
+      def handle_error(error) #:nodoc:
+        case error
+        when Net::SSH::AuthenticationFailed
+          abort "authentication failed for `#{error.message}'"
+        when Capistrano::Error
+          abort(error.message)
+        else raise error
+        end
+      end
+    end
+  end
+end