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 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
|
require "pathname"
require "tempfile"
require "vagrant/util/downloader"
require "vagrant/util/retryable"
module VagrantPlugins
module Shell
class Provisioner < Vagrant.plugin("2", :provisioner)
include Vagrant::Util::Retryable
def provision
args = ""
if config.args.is_a?(String)
args = " #{config.args.to_s}"
elsif config.args.is_a?(Array)
args = config.args.map { |a| quote_and_escape(a) }
args = " #{args.join(" ")}"
end
# In cases where the connection is just being reset
# bail out before attempting to do any actual provisioning
return if !config.path && !config.inline
case @machine.config.vm.communicator
when :winrm
provision_winrm(args)
when :winssh
provision_winssh(args)
else
provision_ssh(args)
end
ensure
if config.reboot
@machine.guest.capability(:reboot)
else
@machine.communicate.reset! if config.reset
end
end
protected
# This handles outputting the communication data back to the UI
def handle_comm(type, data)
if [:stderr, :stdout].include?(type)
# Output the data with the proper color based on the stream.
color = type == :stdout ? :green : :red
# Clear out the newline since we add one
data = data.chomp
return if data.empty?
options = {}
options[:color] = color if !config.keep_color
@machine.ui.detail(data.chomp, options)
end
end
# This is the provision method called if SSH is what is running
# on the remote end, which assumes a POSIX-style host.
def provision_ssh(args)
env = config.env.map { |k,v| "#{k}=#{quote_and_escape(v.to_s)}" }
env = env.join(" ")
command = "chmod +x '#{config.upload_path}'"
command << " &&"
command << " #{env}" if !env.empty?
command << " #{config.upload_path}#{args}"
with_script_file do |path|
# Upload the script to the machine
@machine.communicate.tap do |comm|
# Reset upload path permissions for the current ssh user
info = nil
retryable(on: Vagrant::Errors::SSHNotReady, tries: 3, sleep: 2) do
info = @machine.ssh_info
raise Vagrant::Errors::SSHNotReady if info.nil?
end
user = info[:username]
comm.sudo("chown -R #{user} #{config.upload_path}",
error_check: false)
comm.upload(path.to_s, config.upload_path)
if config.name
@machine.ui.detail(I18n.t("vagrant.provisioners.shell.running",
script: "script: #{config.name}"))
elsif config.path
@machine.ui.detail(I18n.t("vagrant.provisioners.shell.running",
script: path.to_s))
else
@machine.ui.detail(I18n.t("vagrant.provisioners.shell.running",
script: "inline script"))
end
# Execute it with sudo
comm.execute(
command,
sudo: config.privileged,
error_key: :ssh_bad_exit_status_muted
) do |type, data|
handle_comm(type, data)
end
end
end
end
# This is the provision method called if Windows OpenSSH is what is running
# on the remote end, which assumes a non-POSIX-style host.
def provision_winssh(args)
with_script_file do |path|
# Upload the script to the machine
@machine.communicate.tap do |comm|
env = config.env.map{|k,v| comm.generate_environment_export(k, v)}.join
upload_path = config.upload_path.to_s
if File.extname(upload_path).empty?
remote_ext = @machine.config.winssh.shell == "powershell" ? "ps1" : "bat"
upload_path << ".#{remote_ext}"
end
if remote_ext == "ps1"
# Copy powershell_args from configuration
shell_args = config.powershell_args
# For PowerShell scripts bypass the execution policy unless already specified
shell_args += " -ExecutionPolicy Bypass" if config.powershell_args !~ /[-\/]ExecutionPolicy/i
# CLIXML output is kinda useless, especially on non-windows hosts
shell_args += " -OutputFormat Text" if config.powershell_args !~ /[-\/]OutputFormat/i
command = "#{env}\npowershell #{shell_args} #{upload_path}#{args}"
else
command = "#{env}\n#{upload_path}#{args}"
end
# Reset upload path permissions for the current ssh user
info = nil
retryable(on: Vagrant::Errors::SSHNotReady, tries: 3, sleep: 2) do
info = @machine.ssh_info
raise Vagrant::Errors::SSHNotReady if info.nil?
end
comm.upload(path.to_s, upload_path)
if config.name
@machine.ui.detail(I18n.t("vagrant.provisioners.shell.running",
script: "script: #{config.name}"))
elsif config.path
@machine.ui.detail(I18n.t("vagrant.provisioners.shell.running",
script: path.to_s))
else
@machine.ui.detail(I18n.t("vagrant.provisioners.shell.running",
script: "inline script"))
end
# Execute it with sudo
comm.execute(
command,
sudo: config.privileged,
error_key: :ssh_bad_exit_status_muted
) do |type, data|
handle_comm(type, data)
end
end
end
end
# This provisions using WinRM, which assumes a PowerShell
# console on the other side.
def provision_winrm(args)
if @machine.guest.capability?(:wait_for_reboot)
@machine.guest.capability(:wait_for_reboot)
end
with_script_file do |path|
@machine.communicate.tap do |comm|
# Make sure that the upload path has an extension, since
# having an extension is critical for Windows execution
upload_path = config.upload_path.to_s
if File.extname(upload_path) == ""
upload_path += File.extname(path.to_s)
end
# Upload it
comm.upload(path.to_s, upload_path)
# Build the environment
env = config.env.map { |k,v| "$env:#{k} = #{quote_and_escape(v.to_s)}" }
env = env.join("; ")
# Calculate the path that we'll be executing
exec_path = upload_path
exec_path.gsub!('/', '\\')
exec_path = "c:#{exec_path}" if exec_path.start_with?("\\")
# Copy powershell_args from configuration
shell_args = config.powershell_args
# For PowerShell scripts bypass the execution policy unless already specified
shell_args += " -ExecutionPolicy Bypass" if config.powershell_args !~ /[-\/]ExecutionPolicy/i
# CLIXML output is kinda useless, especially on non-windows hosts
shell_args += " -OutputFormat Text" if config.powershell_args !~ /[-\/]OutputFormat/i
command = "\"#{exec_path}\"#{args}"
if File.extname(exec_path).downcase == ".ps1"
command = "powershell #{shell_args.to_s} -file #{command}"
else
command = "cmd /q /c #{command}"
end
# Append the environment
if !env.empty?
command = "#{env}; #{command}"
end
if config.name
@machine.ui.detail(I18n.t("vagrant.provisioners.shell.running",
script: "script: #{config.name}"))
elsif config.path
@machine.ui.detail(I18n.t("vagrant.provisioners.shell.runningas",
local: config.path.to_s, remote: exec_path))
else
@machine.ui.detail(I18n.t("vagrant.provisioners.shell.running",
script: "inline PowerShell script"))
end
# Execute it with sudo
comm.sudo(command, { elevated: config.privileged, interactive: config.powershell_elevated_interactive }) do |type, data|
handle_comm(type, data)
end
end
end
end
# Quote and escape strings for shell execution, thanks to Capistrano.
def quote_and_escape(text, quote = '"')
"#{quote}#{text.gsub(/#{quote}/) { |m| "#{m}\\#{m}#{m}" }}#{quote}"
end
# This method yields the path to a script to upload and execute
# on the remote server. This method will properly clean up the
# script file if needed.
def with_script_file
ext = nil
script = nil
if config.remote?
download_path = @machine.env.tmp_path.join(
"#{@machine.id}-remote-script")
download_path.delete if download_path.file?
begin
Vagrant::Util::Downloader.new(
config.path,
download_path,
md5: config.md5,
sha1: config.sha1
).download!
ext = File.extname(config.path)
script = download_path.read
ensure
download_path.delete if download_path.file?
end
elsif config.path
# Just yield the path to that file...
root_path = @machine.env.root_path
ext = File.extname(config.path)
script = Pathname.new(config.path).expand_path(root_path).read
else
# The script is just the inline code...
ext = ".ps1"
script = config.inline
end
# Replace Windows line endings with Unix ones unless binary file
# or we're running on Windows.
if !config.binary && @machine.config.vm.communicator != :winrm
begin
script = script.gsub(/\r\n?$/, "\n")
rescue ArgumentError
script = script.force_encoding("ASCII-8BIT").gsub(/\r\n?$/, "\n")
end
end
# Otherwise we have an inline script, we need to Tempfile it,
# and handle it specially...
file = Tempfile.new(['vagrant-shell', ext])
# Unless you set binmode, on a Windows host the shell script will
# have CRLF line endings instead of LF line endings, causing havoc
# when the guest executes it. This fixes [GH-1181].
file.binmode
begin
file.write(script)
file.fsync
file.close
yield file.path
ensure
file.close
file.unlink
end
end
end
end
end
|