140 lines
3.9 KiB
Ruby
140 lines
3.9 KiB
Ruby
module Kamal::Utils
|
|
extend self
|
|
|
|
DOLLAR_SIGN_WITHOUT_SHELL_EXPANSION_REGEX = /\$(?!{[^\}]*\})/
|
|
|
|
# Return a list of escaped shell arguments using the same named argument against the passed attributes (hash or array).
|
|
def argumentize(argument, attributes, sensitive: false)
|
|
Array(attributes).flat_map do |key, value|
|
|
if value.present?
|
|
attr = "#{key}=#{escape_shell_value(value)}"
|
|
attr = self.sensitive(attr, redaction: "#{key}=[REDACTED]") if sensitive
|
|
[ argument, attr]
|
|
else
|
|
[ argument, key ]
|
|
end
|
|
end
|
|
end
|
|
|
|
def env_file_with_secrets(env)
|
|
env_file = StringIO.new.tap do |contents|
|
|
if (secrets = env["secret"]).present?
|
|
env.fetch("secret", env)&.each do |key|
|
|
contents << docker_env_file_line(key, ENV.fetch(key))
|
|
end
|
|
env["clear"]&.each do |key, value|
|
|
contents << docker_env_file_line(key, value)
|
|
end
|
|
else
|
|
env.fetch("clear", env)&.each do |key, value|
|
|
contents << docker_env_file_line(key, value)
|
|
end
|
|
end
|
|
end.string
|
|
|
|
# Ensure the file has some contents to avoid the SSHKIT empty file warning
|
|
env_file || "\n"
|
|
end
|
|
|
|
# Returns a list of shell-dashed option arguments. If the value is true, it's treated like a value-less option.
|
|
def optionize(args, with: nil)
|
|
options = if with
|
|
flatten_args(args).collect { |(key, value)| value == true ? "--#{key}" : "--#{key}#{with}#{escape_shell_value(value)}" }
|
|
else
|
|
flatten_args(args).collect { |(key, value)| [ "--#{key}", value == true ? nil : escape_shell_value(value) ] }
|
|
end
|
|
|
|
options.flatten.compact
|
|
end
|
|
|
|
# Flattens a one-to-many structure into an array of two-element arrays each containing a key-value pair
|
|
def flatten_args(args)
|
|
args.flat_map { |key, value| value.try(:map) { |entry| [key, entry] } || [ [ key, value ] ] }
|
|
end
|
|
|
|
# Marks sensitive values for redaction in logs and human-visible output.
|
|
# Pass `redaction:` to change the default `"[REDACTED]"` redaction, e.g.
|
|
# `sensitive "#{arg}=#{secret}", redaction: "#{arg}=xxxx"
|
|
def sensitive(...)
|
|
Kamal::Utils::Sensitive.new(...)
|
|
end
|
|
|
|
def redacted(value)
|
|
case
|
|
when value.respond_to?(:redaction)
|
|
value.redaction
|
|
when value.respond_to?(:transform_values)
|
|
value.transform_values { |value| redacted value }
|
|
when value.respond_to?(:map)
|
|
value.map { |element| redacted element }
|
|
else
|
|
value
|
|
end
|
|
end
|
|
|
|
def unredacted(value)
|
|
case
|
|
when value.respond_to?(:unredacted)
|
|
value.unredacted
|
|
when value.respond_to?(:transform_values)
|
|
value.transform_values { |value| unredacted value }
|
|
when value.respond_to?(:map)
|
|
value.map { |element| unredacted element }
|
|
else
|
|
value
|
|
end
|
|
end
|
|
|
|
# Escape a value to make it safe for shell use.
|
|
def escape_shell_value(value)
|
|
value.to_s.dump
|
|
.gsub(/`/, '\\\\`')
|
|
.gsub(DOLLAR_SIGN_WITHOUT_SHELL_EXPANSION_REGEX, '\$')
|
|
end
|
|
|
|
# Abbreviate a git revhash for concise display
|
|
def abbreviate_version(version)
|
|
if version
|
|
# Don't abbreviate <sha>_uncommitted_<etc>
|
|
if version.include?("_")
|
|
version
|
|
else
|
|
version[0...7]
|
|
end
|
|
end
|
|
end
|
|
|
|
def uncommitted_changes
|
|
`git status --porcelain`.strip
|
|
end
|
|
|
|
def docker_env_file_line(key, value)
|
|
if key.include?("\n") || value.to_s.include?("\n")
|
|
raise ArgumentError, "docker env file format does not support newlines in keys or values, key: #{key}"
|
|
end
|
|
|
|
"#{key.to_s}=#{value.to_s}\n"
|
|
end
|
|
|
|
def poll(max_attempts:, exception:, &block)
|
|
attempt = 1
|
|
|
|
begin
|
|
block.call
|
|
rescue exception => e
|
|
if attempt <= max_attempts
|
|
info "#{e.message}, retrying in #{attempt}s (attempt #{attempt}/#{max_attempts})..."
|
|
sleep attempt
|
|
attempt += 1
|
|
retry
|
|
else
|
|
raise
|
|
end
|
|
end
|
|
end
|
|
|
|
def info(message)
|
|
SSHKit.config.output.info(message)
|
|
end
|
|
end
|