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
|
require "log4r"
require "securerandom"
require Vagrant.source_root.join("plugins/provisioners/shell/config")
module VagrantPlugins
module Kernel_V2
# Represents a single configured provisioner for a VM.
class VagrantConfigTrigger < Vagrant.plugin("2", :config)
# Defaults
DEFAULT_ON_ERROR = :halt
DEFAULT_EXIT_CODE = 0
#-------------------------------------------------------------------
# Config class for a given Trigger
#-------------------------------------------------------------------
# Internal unique name for this trigger
#
# Note: This is for internal use only.
#
# @return [String]
attr_reader :id
# Name for the given Trigger. Defaults to nil.
#
# @return [String]
attr_accessor :name
# Command to fire the trigger on
#
# @return [Symbol]
attr_reader :command
# A string to print at the WARN level
#
# @return [String]
attr_accessor :info
# A string to print at the WARN level
#
# @return [String]
attr_accessor :warn
# Determines what how a Trigger should behave if it runs into an error.
# Defaults to :halt, otherwise can only be set to :continue.
#
# @return [Symbol]
attr_accessor :on_error
# If set, will not run trigger for the configured Vagrant commands.
#
# @return [Symbol, Array]
attr_accessor :ignore
# If set, will only run trigger for guests that match keys for this parameter.
#
# @return [String, Regex, Array]
attr_accessor :only_on
# A local inline or file script to execute for the trigger
#
# @return [Hash]
attr_accessor :run
# A remote inline or file script to execute for the trigger
#
# @return [Hash]
attr_accessor :run_remote
# If set, will not run trigger for the configured Vagrant commands.
#
# @return [Integer, Array]
attr_accessor :exit_codes
# If set to true, trigger will halt Vagrant immediately and exit 0
# Can also be configured to have a custom exit code
#
# @return [Integer]
attr_accessor :abort
# Internal reader for the internal variable ruby_block
#
# @return [Proc]
attr_reader :ruby_block
# Variable used to store ruby proc when defining a ruby trigger
# with the "hash" syntax
#
# @return [Proc]
attr_accessor :ruby
def initialize(command)
@logger = Log4r::Logger.new("vagrant::config::vm::trigger::config")
@name = UNSET_VALUE
@info = UNSET_VALUE
@warn = UNSET_VALUE
@on_error = UNSET_VALUE
@ignore = UNSET_VALUE
@only_on = UNSET_VALUE
@run = UNSET_VALUE
@run_remote = UNSET_VALUE
@exit_codes = UNSET_VALUE
@abort = UNSET_VALUE
@ruby = UNSET_VALUE
# Internal options
@id = SecureRandom.uuid
@command = command.to_sym
@ruby_block = UNSET_VALUE
@logger.debug("Trigger defined for command: #{command}")
end
# Config option `ruby` for a trigger which reads in a ruby block and sets
# it to be evaluated when the configured trigger fires. This method is only
# invoked when the regular "block" syntax is used. Otherwise the proc is
# set through the attr_accessor if the hash syntax is used.
#
# @param [Proc] block
def ruby(&block)
@ruby_block = block
end
def finalize!
# Ensure all config options are set to nil or default value if untouched
# by user
@name = nil if @name == UNSET_VALUE
@info = nil if @info == UNSET_VALUE
@warn = nil if @warn == UNSET_VALUE
@on_error = DEFAULT_ON_ERROR if @on_error == UNSET_VALUE
@ignore = [] if @ignore == UNSET_VALUE
@run = nil if @run == UNSET_VALUE
@run_remote = nil if @run_remote == UNSET_VALUE
@only_on = nil if @only_on == UNSET_VALUE
@exit_codes = DEFAULT_EXIT_CODE if @exit_codes == UNSET_VALUE
@abort = nil if @abort == UNSET_VALUE
@ruby_block = nil if @ruby_block == UNSET_VALUE
@ruby = nil if @ruby == UNSET_VALUE
@ruby_block = @ruby if @ruby
# These values are expected to always be an Array internally,
# but can be set as a single String or Symbol
#
# Guests are stored internally as strings
if @only_on
@only_on = Array(@only_on)
end
# Commands must be stored internally as symbols
if @ignore
@ignore = Array(@ignore)
@ignore.map! { |i| i.to_sym }
end
if @exit_codes
@exit_codes = Array(@exit_codes)
end
# Convert @run and @run_remote to be a "Shell provisioner" config
if @run && @run.is_a?(Hash)
# Powershell args and privileged for run commands is currently not supported
# so by default use empty string or false if unset. This helps the validate
# function determine if the setting was purposefully set, to print a warning
if !@run.key?(:powershell_args)
@run[:powershell_args] = ""
end
if !@run.key?(:privileged)
@run[:privileged] = false
end
new_run = VagrantPlugins::Shell::Config.new
new_run.set_options(@run)
new_run.finalize!
@run = new_run
end
if @run_remote && @run_remote.is_a?(Hash)
new_run = VagrantPlugins::Shell::Config.new
new_run.set_options(@run_remote)
new_run.finalize!
@run_remote = new_run
end
if @abort == true
@abort = 1
end
end
# @return [Array] array of strings of error messages from config option validation
def validate(machine)
errors = _detected_errors
commands = []
Vagrant.plugin("2").manager.commands.each do |key,data|
commands.push(key)
end
if !commands.include?(@command) && @command != :all
machine.ui.warn(I18n.t("vagrant.config.triggers.bad_command_warning",
cmd: @command))
end
if @run
errorz = @run.validate(machine)
errors.concat errorz["shell provisioner"] if !errorz.empty?
if @run.privileged == true
machine.ui.warn(I18n.t("vagrant.config.triggers.privileged_ignored",
command: @command))
end
if @run.powershell_args != ""
machine.ui.warn(I18n.t("vagrant.config.triggers.powershell_args_ignored"))
end
end
if @run_remote
errorz = @run_remote.validate(machine)
errors.concat errorz["shell provisioner"] if !errorz.empty?
end
if @name && !@name.is_a?(String)
errors << I18n.t("vagrant.config.triggers.name_bad_type", cmd: @command)
end
if @info && !@info.is_a?(String)
errors << I18n.t("vagrant.config.triggers.info_bad_type", cmd: @command)
end
if @warn && !@warn.is_a?(String)
errors << I18n.t("vagrant.config.triggers.warn_bad_type", cmd: @command)
end
if @on_error != :halt
if @on_error != :continue
errors << I18n.t("vagrant.config.triggers.on_error_bad_type", cmd: @command)
end
end
if @exit_codes
if !@exit_codes.all? {|i| i.is_a?(Integer)}
errors << I18n.t("vagrant.config.triggers.exit_codes_bad_type", cmd: @command)
end
end
if @abort && !@abort.is_a?(Integer)
errors << I18n.t("vagrant.config.triggers.abort_bad_type", cmd: @command)
elsif @abort == false
machine.ui.warn(I18n.t("vagrant.config.triggers.abort_false_type"))
end
if @ruby_block && !ruby_block.is_a?(Proc)
errors << I18n.t("vagrant.config.triggers.ruby_bad_type", cmd: @command)
end
errors
end
# The String representation of this Trigger.
#
# @return [String]
def to_s
"trigger config"
end
end
end
end
|