/usr/lib/ruby/vendor_ruby/capistrano/command.rb is in capistrano 2.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | require 'benchmark'
require 'capistrano/errors'
require 'capistrano/processable'
module Capistrano
# This class encapsulates a single command to be executed on a set of remote
# machines, in parallel.
class Command
include Processable
class Tree
attr_reader :configuration
attr_reader :branches
attr_reader :fallback
include Enumerable
class Branch
attr_accessor :command, :callback
attr_reader :options
def initialize(command, options, callback)
@command = command.strip.gsub(/\r?\n/, "\\\n")
@callback = callback || Capistrano::Configuration.default_io_proc
@options = options
@skip = false
end
def last?
options[:last]
end
def skip?
@skip
end
def skip!
@skip = true
end
def match(server)
true
end
def to_s
command.inspect
end
end
class ConditionBranch < Branch
attr_accessor :configuration
attr_accessor :condition
class Evaluator
attr_reader :configuration, :condition, :server
def initialize(config, condition, server)
@configuration = config
@condition = condition
@server = server
end
def in?(role)
configuration.roles[role].include?(server)
end
def result
eval(condition, binding)
end
def method_missing(sym, *args, &block)
if server.respond_to?(sym)
server.send(sym, *args, &block)
elsif configuration.respond_to?(sym)
configuration.send(sym, *args, &block)
else
super
end
end
end
def initialize(configuration, condition, command, options, callback)
@configuration = configuration
@condition = condition
super(command, options, callback)
end
def match(server)
Evaluator.new(configuration, condition, server).result
end
def to_s
"#{condition.inspect} :: #{command.inspect}"
end
end
def initialize(config)
@configuration = config
@branches = []
yield self if block_given?
end
def when(condition, command, options={}, &block)
branches << ConditionBranch.new(configuration, condition, command, options, block)
end
def else(command, &block)
@fallback = Branch.new(command, {}, block)
end
def branches_for(server)
seen_last = false
matches = branches.select do |branch|
success = !seen_last && !branch.skip? && branch.match(server)
seen_last = success && branch.last?
success
end
matches << fallback if matches.empty? && fallback
return matches
end
def each
branches.each { |branch| yield branch }
yield fallback if fallback
return self
end
end
attr_reader :tree, :sessions, :options
def self.process(tree, sessions, options={})
new(tree, sessions, options).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(tree, sessions, options={}, &block)
if String === tree
tree = Tree.new(nil) { |t| t.else(tree, &block) }
elsif block
raise ArgumentError, "block given with tree argument"
end
@tree = tree
@sessions = sessions
@options = options
@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!
elapsed = Benchmark.realtime do
loop do
break unless process_iteration { @channels.any? { |ch| !ch[:closed] } }
end
end
logger.trace "command finished in #{(elapsed * 1000).round}ms" if logger
if (failed = @channels.select { |ch| ch[:status] != 0 }).any?
commands = failed.inject({}) { |map, ch| (map[ch[:command]] ||= []) << ch[:server]; map }
message = commands.map { |command, list| "#{command.inspect} on #{list.join(',')}" }.join("; ")
error = CommandError.new("failed: #{message}")
error.hosts = commands.values.flatten
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|
server = session.xserver
tree.branches_for(server).map do |branch|
session.open_channel do |channel|
channel[:server] = server
channel[:host] = server.host
channel[:options] = options
channel[:branch] = branch
request_pty_if_necessary(channel) do |ch, success|
if success
logger.trace "executing command", ch[:server] if logger
cmd = replace_placeholders(channel[:branch].command, ch)
if options[:shell] == false
shell = nil
else
shell = "#{options[:shell] || "sh"} -c"
cmd = cmd.gsub(/'/) { |m| "'\\''" }
cmd = "'#{cmd}'"
end
command_line = [environment, shell, cmd].compact.join(" ")
ch[:command] = command_line
ch.exec(command_line)
ch.send_data(options[:data]) if options[:data]
else
# 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
end
channel.on_data do |ch, data|
ch[:branch].callback[ch, :out, data]
end
channel.on_extended_data do |ch, type, data|
ch[:branch].callback[ch, :err, data]
end
channel.on_request("exit-status") do |ch, data|
ch[:status] = data.read_long
end
channel.on_close do |ch|
ch[:closed] = true
end
end
end
end.flatten
end
def request_pty_if_necessary(channel)
if options[:pty]
channel.request_pty do |ch, success|
yield ch, success
end
else
yield channel, true
end
end
def replace_placeholders(command, channel)
roles = @tree.configuration && @tree.configuration.role_names_for_host(channel[:server])
command = command.gsub(/\$CAPISTRANO:HOST\$/, channel[:host])
command.gsub!(/\$CAPISTRANO:HOSTROLES\$/, roles.join(',')) if roles
command
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
|