capistrano 2.1.0 → 3.0.0

data/lib/capistrano/cli/execute.rb

@@ -1,82 +0,0 @@
-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.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

data/lib/capistrano/cli/help.rb

@@ -1,102 +0,0 @@
-module Capistrano
-  class CLI
-    module Help
-      LINE_PADDING = 7
-      MIN_MAX_LEN  = 30
-      HEADER_LEN   = 60
-
-      def self.included(base) #:nodoc:
-        base.send :alias_method, :execute_requested_actions_without_help, :execute_requested_actions
-        base.send :alias_method, :execute_requested_actions, :execute_requested_actions_with_help
-      end
-
-      def execute_requested_actions_with_help(config)
-        if options[:tasks]
-          task_list(config)
-        elsif options[:explain]
-          explain_task(config, options[:explain])
-        else
-          execute_requested_actions_without_help(config)
-        end
-      end
-
-      def task_list(config) #:nodoc:
-        tasks = config.task_list(:all)
-
-        if tasks.empty?
-          warn "There are no tasks available. Please specify a recipe file to load."
-        else
-          all_tasks_length = tasks.length
-          if options[:verbose].to_i < 1
-            tasks = tasks.reject { |t| t.description.empty? || t.description =~ /^\[internal\]/ }
-          end
-
-          tasks = tasks.sort_by { |task| task.fully_qualified_name }
-
-          longest = tasks.map { |task| task.fully_qualified_name.length }.max
-          max_length = output_columns - longest - LINE_PADDING
-          max_length = MIN_MAX_LEN if max_length < MIN_MAX_LEN
-
-          tasks.each do |task|
-            puts "cap %-#{longest}s # %s" % [task.fully_qualified_name, task.brief_description(max_length)]
-          end
-
-          if all_tasks_length > tasks.length
-            puts
-            puts "Some tasks were not listed, either because they have no description,"
-            puts "or because they are only used internally by other tasks. To see all"
-            puts "tasks, type `#{File.basename($0)} -Tv'."
-          end
-
-          puts
-          puts "Extended help may be available for these tasks."
-          puts "Type `#{File.basename($0)} -e taskname' to view it."
-        end
-      end
-
-      def explain_task(config, name) #:nodoc:
-        task = config.find_task(name)
-        if task.nil?
-          warn "The task `#{name}' does not exist."
-        else
-          puts "-" * HEADER_LEN
-          puts "cap #{name}"
-          puts "-" * HEADER_LEN
-
-          if task.description.empty?
-            puts "There is no description for this task."
-          else
-            puts format_text(task.description)
-          end
-
-          puts
-        end
-      end
-
-      def long_help #:nodoc:
-        help_text = File.read(File.join(File.dirname(__FILE__), "help.txt"))
-        self.class.ui.page_at = self.class.ui.output_rows - 2
-        self.class.ui.say format_text(help_text)
-      end
-
-      def format_text(text) #:nodoc:
-        formatted = ""
-        text.each_line do |line|
-          indentation = line[/^\s+/] || ""
-          indentation_size = indentation.split(//).inject(0) { |c,s| c + (s[0] == ?\t ? 8 : 1) }
-          lines = line.strip.gsub(/(.{1,#{output_columns - indentation_size}})(?:\s+|\Z)/, "\\1\n").split(/\n/)
-          if lines.empty?
-            formatted << "\n"
-          else
-            formatted << lines.map { |l| "#{indentation}#{l}\n" }.join
-          end
-        end
-        formatted
-      end
-
-      def output_columns #:nodoc:
-        @output_columns ||= self.class.ui.output_cols > 80 ? 80 : self.class.ui.output_cols
-      end
-    end
-  end
-end

data/lib/capistrano/cli/help.txt

@@ -1,53 +0,0 @@
------------------------------
-<%= color('Capistrano', :bold) %>
------------------------------
-
-Capistrano is a utility for automating the execution of commands across multiple remote machines. It was originally conceived as an aid to deploy Ruby on Rails web applications, but has since evolved to become a much more general-purpose tool.
-
-The command-line interface to Capistrano is via the `cap' command.
-
-	cap [ option ] ... action ...
-
-The following options are understood:
-
-  <%= color '-e, --explain TASK', :bold %>
-	Displays the extended description of the given task. Not all tasks will have an extended description, but for those that do, this can provide a wealth of additional usage information, such as describing environment variables or settings that can affect the execution of the task.
-
-  <%= color '-F, --default-config', :bold %>
-	By default, cap will search for a config file named `Capfile' or `capfile' in the current directory, or in any parent directory, and will automatically load it. However, if you specify the -f flag (see below), cap will use that file instead of the default config. If you want to use both the default config, and files loaded via -f, you can specify -F to force cap to search for and load the default config, even if additional files were specified via -f.
-
-  <%= color '-f, --file FILE', :bold %>
-	Causes the named file to be loaded. Capistrano will search both its own recipe directory, as well as the current directory, looking for the named file. An ".rb" extension is optional. The -f option may be given any number of times, but if it is given, it will take the place of the normal `Capfile' or `capfile' detection. Use -F if you want the default capfile to be loaded when you use -f.
-
-  <%= color '-H, --long-help', :bold %>
-	Displays this document and exits.
-
-  <%= color '-h, --help', :bold %>
-	Shows a brief summary of these options and exits.
-
-  <%= color '-p, --password', :bold %>
-	Normally, cap will prompt for the password on-demand, the first time it is needed. This can make it hard to walk away from Capistrano, since you might not know if it will prompt for a password down the road. In such cases, you can use the -p option to force cap to prompt for the password immediately.
-
-  <%= color '-q, --quiet', :bold %>
-	Display only critical error messages. All other output is suppressed.
-
-  <%= color '-S, --set-before NAME=VALUE', :bold %>
-	Sets the given variable to the given value, before loading any recipe files. This is useful if you have a recipe file that depends on a certain variable being set, at the time it is loaded.
-
-  <%= color '-s, --set NAME=VALUE', :bold %>
-	Sets the given variable to the given value, after loading all recipe files. This is useful when you want to override the value of a variable which is used in a task. Note that this will set the variables too late for them to affect conditions that are executed as the recipes are loaded.
-
-  <%= color '-T, --tasks', :bold %>
-	Displays the list of all tasks in all loaded recipe files. If a task has no description, or if the description starts with the [internal] tag, the task will not be listed unless you also specify -v.
-
-  <%= color '-V, --version', :bold %>
-	Shows the current Capistrano version number and exits.
-
-  <%= color '-v, --verbose', :bold %>
-	Increase the verbosity. You can specify this option up to three times to further increase verbosity. By default, cap will use maximum verbosity, but if you specify an explicit verbosity, that will be used instead. See also -q.
-
-  <%= color '-X, --skip-system-config', :bold %>
-	By default, cap will look for and (if it exists) load the global system configuration file located in /etc/capistrano.conf. If you don't want cap to load that file, give this option.
-
-  <%= color '-x, --skip-user-config', :bold %>
-	By default, cap will look for and (if it exists) load the user-specific configuration file located in $HOME/.caprc. If you don't want cap to load that file, give this option.

data/lib/capistrano/cli/options.rb

@@ -1,183 +0,0 @@
-require 'optparse'
-
-module Capistrano
-  class CLI
-    module Options
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        # Return a new CLI instance with the given arguments pre-parsed and
-        # ready for execution.
-        def parse(args)
-          cli = new(args)
-          cli.parse_options!
-          cli
-        end
-      end
-
-      # The hash of (parsed) command-line options
-      attr_reader :options
-
-      # Return an OptionParser instance that defines the acceptable command
-      # line switches for Capistrano, and what their corresponding behaviors
-      # are.
-      def option_parser #:nodoc:
-        @option_parser ||= OptionParser.new do |opts|
-          opts.banner = "Usage: #{File.basename($0)} [options] action ..."
-
-          opts.on("-e", "--explain TASK",
-            "Displays help (if available) for the task."
-          ) { |value| options[:explain] = value }
-
-          opts.on("-F", "--default-config",
-            "Always use default config, even with -f."
-          ) { options[:default_config] = true }
-
-          opts.on("-f", "--file FILE",
-            "A recipe file to load. May be given more than once."
-          ) { |value| options[:recipes] << value }
-
-          opts.on("-H", "--long-help", "Explain these options.") do
-            long_help
-            exit
-          end
-
-          opts.on("-h", "--help", "Display this help message.") do
-            puts opts
-            exit
-          end
-
-          opts.on("-p", "--password",
-            "Immediately prompt for the password."
-          ) { options[:password] = nil }
-
-          opts.on("-q", "--quiet",
-            "Make the output as quiet as possible."
-          ) { options[:verbose] = 0 }
-
-          opts.on("-S", "--set-before NAME=VALUE",
-            "Set a variable before the recipes are loaded."
-          ) do |pair|
-            name, value = pair.split(/=/, 2)
-            options[:pre_vars][name.to_sym] = value
-          end
-
-          opts.on("-s", "--set NAME=VALUE",
-            "Set a variable after the recipes are loaded."
-          ) do |pair|
-            name, value = pair.split(/=/, 2)
-            options[:vars][name.to_sym] = value
-          end
-
-          opts.on("-T", "--tasks",
-            "List all tasks in the loaded recipe files."
-          ) do 
-            options[:tasks] = true
-            options[:verbose] ||= 0
-          end
-
-          opts.on("-V", "--version",
-            "Display the Capistrano version, and exit."
-          ) do
-            require 'capistrano/version'
-            puts "Capistrano v#{Capistrano::Version::STRING}"
-            exit
-          end
-
-          opts.on("-v", "--verbose",
-            "Be more verbose. May be given more than once."
-          ) { options[:verbose] ||= 0; options[:verbose] += 1 }
-
-          opts.on("-X", "--skip-system-config",
-            "Don't load the system config file (capistrano.conf)"
-          ) { options.delete(:sysconf) }
-
-          opts.on("-x", "--skip-user-config",
-            "Don't load the user config file (.caprc)"
-          ) { options.delete(:dotfile) }
-        end
-      end
-
-      # If the arguments to the command are empty, this will print the
-      # allowed options and exit. Otherwise, it will parse the command
-      # line and set up any default options.
-      def parse_options! #:nodoc:
-        @options = { :recipes => [], :actions => [],
-          :vars => {}, :pre_vars => {},
-          :sysconf => default_sysconf, :dotfile => default_dotfile }
-
-        if args.empty?
-          warn "Please specify at least one action to execute."
-          warn option_parser
-          exit
-        end
-
-        option_parser.parse!(args)
-
-        # if no verbosity has been specified, be verbose
-        options[:verbose] = 3 if !options.has_key?(:verbose)
-
-        look_for_default_recipe_file! if options[:default_config] || options[:recipes].empty?
-        extract_environment_variables!
-
-        options[:actions].concat(args)
-
-        password = options.has_key?(:password)
-        options[:password] = Proc.new { self.class.password_prompt }
-        options[:password] = options[:password].call if password
-      end
-
-      # Extracts name=value pairs from the remaining command-line arguments
-      # and assigns them as environment variables.
-      def extract_environment_variables! #:nodoc:
-        args.delete_if do |arg|
-          next unless arg.match(/^(\w+)=(.*)$/)
-          ENV[$1] = $2
-        end
-      end
-
-      # Looks for a default recipe file in the current directory.
-      def look_for_default_recipe_file! #:nodoc:
-        current = Dir.pwd
-
-        loop do
-          %w(Capfile capfile).each do |file|
-            if File.file?(file)
-              options[:recipes] << file
-              return
-            end
-          end
-
-          pwd = Dir.pwd
-          Dir.chdir("..")
-          break if pwd == Dir.pwd # if changing the directory made no difference, then we're at the top
-        end
-
-        Dir.chdir(current)
-      end
-
-      def default_sysconf #:nodoc:
-        File.join(sysconf_directory, "capistrano.conf")
-      end
-      
-      def default_dotfile #:nodoc:
-        File.join(home_directory, ".caprc")
-      end
-
-      def sysconf_directory #:nodoc:
-        # TODO if anyone cares, feel free to submit a patch that uses a more
-        # appropriate location for this file in Windows.
-        ENV["SystemRoot"] || '/etc'
-      end
-      
-      def home_directory #:nodoc:
-        ENV["HOME"] ||
-          (ENV["HOMEPATH"] && "#{ENV["HOMEDRIVE"]}#{ENV["HOMEPATH"]}") ||
-          "/"
-      end
-
-    end
-  end
-end

data/lib/capistrano/cli/ui.rb

@@ -1,28 +0,0 @@
-require 'highline'
-
-# work around problem where HighLine detects an eof on $stdin and raises an
-# error.
-HighLine.track_eof = false
-
-module Capistrano
-  class CLI
-    module UI
-      def self.included(base) #:nodoc:
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        # Return the object that provides UI-specific methods, such as prompts
-        # and more.
-        def ui
-          @ui ||= HighLine.new
-        end
-
-        # Prompt for a password using echo suppression.
-        def password_prompt(prompt="Password: ")
-          ui.ask(prompt) { |q| q.echo = false }
-        end
-      end
-    end
-  end
-end

data/lib/capistrano/cli.rb

@@ -1,47 +0,0 @@
-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/command.rb

@@ -1,161 +0,0 @@
-require 'capistrano/errors'
-
-module Capistrano
-
-  # This class encapsulates a single command to be executed on a set of remote
-  # machines, in parallel.
-  class Command
-    attr_reader :command, :sessions, :options
-
-    def self.process(command, sessions, options={}, &block)
-      new(command, sessions, options, &block).process!
-    end
-
-    # Instantiates a new command object. The +command+ must be a string
-    # containing the command to execute. +sessions+ is an array of Net::SSH
-    # session instances, and +options+ must be a hash containing any of the
-    # following keys:
-    #
-    # * +logger+: (optional), a Capistrano::Logger instance
-    # * +data+: (optional), a string to be sent to the command via it's stdin
-    # * +env+: (optional), a string or hash to be interpreted as environment
-    #   variables that should be defined for this command invocation.
-    def initialize(command, sessions, options={}, &block)
-      @command = command.strip.gsub(/\r?\n/, "\\\n")
-      @sessions = sessions
-      @options = options
-      @callback = block
-      @channels = open_channels
-    end
-
-    # Processes the command in parallel on all specified hosts. If the command
-    # fails (non-zero return code) on any of the hosts, this will raise a
-    # Capistrano::CommandError.
-    def process!
-      since = Time.now
-      loop do
-        active = 0
-        @channels.each do |ch|
-          next if ch[:closed]
-          active += 1
-          ch.connection.process(true)
-        end
-
-        break if active == 0
-        if Time.now - since >= 1
-          since = Time.now
-          @channels.each { |ch| ch.connection.ping! }
-        end
-        sleep 0.01 # a brief respite, to keep the CPU from going crazy
-      end
-
-      logger.trace "command finished" if logger
-
-      if (failed = @channels.select { |ch| ch[:status] != 0 }).any?
-        hosts = failed.map { |ch| ch[:server] }
-        error = CommandError.new("command #{command.inspect} failed on #{hosts.join(',')}")
-        error.hosts = hosts
-        raise error
-      end
-
-      self
-    end
-
-    # Force the command to stop processing, by closing all open channels
-    # associated with this command.
-    def stop!
-      @channels.each do |ch|
-        ch.close unless ch[:closed]
-      end
-    end
-
-    private
-
-      def logger
-        options[:logger]
-      end
-
-      def open_channels
-        sessions.map do |session|
-          session.open_channel do |channel|
-            server = session.xserver
-
-            channel[:server] = server
-            channel[:host] = server.host
-            channel[:options] = options
-
-            execute_command = Proc.new do |ch|
-              logger.trace "executing command", ch[:server] if logger
-              cmd = replace_placeholders(command, ch)
-
-              if options[:shell] == false
-                shell = nil
-              else
-                shell = "#{options[:shell] || "sh"} -c"
-                cmd = cmd.gsub(/[$\\`"]/) { |m| "\\#{m}" }
-                cmd = "\"#{cmd}\""
-              end
-
-              command_line = [environment, shell, cmd].compact.join(" ")
-
-              ch.exec(command_line)
-              ch.send_data(options[:data]) if options[:data]
-            end
-
-            if options[:pty]
-              channel.request_pty(:want_reply => true)
-              channel.on_success(&execute_command)
-              channel.on_failure do |ch|
-                # just log it, don't actually raise an exception, since the
-                # process method will see that the status is not zero and will
-                # raise an exception then.
-                logger.important "could not open channel", ch[:server] if logger
-                ch.close
-              end
-            else
-              execute_command.call(channel)
-            end
-              
-            channel.on_data do |ch, data|
-              @callback[ch, :out, data] if @callback
-            end
-
-            channel.on_extended_data do |ch, type, data|
-              @callback[ch, :err, data] if @callback
-            end
-
-            channel.on_request do |ch, request, reply, data|
-              ch[:status] = data.read_long if request == "exit-status"
-            end
-
-            channel.on_close do |ch|
-              ch[:closed] = true
-            end
-          end
-        end
-      end
-
-      def replace_placeholders(command, channel)
-        command.gsub(/\$CAPISTRANO:HOST\$/, channel[:host])
-      end
-
-      # prepare a space-separated sequence of variables assignments
-      # intended to be prepended to a command, so the shell sets
-      # the environment before running the command.
-      # i.e.: options[:env] = {'PATH' => '/opt/ruby/bin:$PATH',
-      #                        'TEST' => '( "quoted" )'}
-      # environment returns:
-      # "env TEST=(\ \"quoted\"\ ) PATH=/opt/ruby/bin:$PATH"
-      def environment
-        return if options[:env].nil? || options[:env].empty?
-        @environment ||= if String === options[:env]
-            "env #{options[:env]}"
-          else
-            options[:env].inject("env") do |string, (name, value)|
-              value = value.to_s.gsub(/[ "]/) { |m| "\\#{m}" }
-              string << " #{name}=#{value}"
-            end
-          end
-      end
-  end
-end

data/lib/capistrano/configuration/actions/file_transfer.rb

@@ -1,35 +0,0 @@
-require 'capistrano/upload'
-
-module Capistrano
-  class Configuration
-    module Actions
-      module FileTransfer
-
-        # Store the given data at the given location on all servers targetted
-        # by the current task. If <tt>:mode</tt> is specified it is used to
-        # set the mode on the file.
-        def put(data, path, options={})
-          execute_on_servers(options) do |servers|
-            targets = servers.map { |s| sessions[s] }
-            Upload.process(targets, path, :data => data, :mode => options[:mode], :logger => logger)
-          end
-        end
-    
-        # Get file remote_path from FIRST server targetted by
-        # the current task and transfer it to local machine as path.
-        #
-        # get "#{deploy_to}/current/log/production.log", "log/production.log.web"
-        def get(remote_path, path, options = {})
-          execute_on_servers(options.merge(:once => true)) do |servers|
-            logger.info "downloading `#{servers.first.host}:#{remote_path}' to `#{path}'"
-            sftp = sessions[servers.first].sftp
-            sftp.connect unless sftp.state == :open
-            sftp.get_file remote_path, path
-            logger.debug "download finished" 
-          end
-        end
-
-      end
-    end
-  end
-end