require_relative '../core/client' require 'uri' module Cfer::Cfn class Client < Cfer::Core::Client attr_reader :name attr_reader :stack def initialize(options) super(options) @name = options[:stack_name] @options = options @options.delete :stack_name @cfn = Aws::CloudFormation::Client.new(@options) flush_cache end def create_stack(*args) begin @cfn.create_stack(*args) rescue Aws::CloudFormation::Errors::AlreadyExistsException raise Cfer::Util::StackExistsError end end def responds_to?(method) @cfn.responds_to? method end def method_missing(method, *args, &block) @cfn.send(method, *args, &block) end def estimate(stack, options = {}) estimate_options = upload_or_return_template(stack.to_cfn, options) response = validate_template(estimate_options) estimate_params = [] response.parameters.each do |tmpl_param| input_param = stack.input_parameters[tmpl_param.parameter_key] if input_param output_val = tmpl_param.no_echo ? '*****' : input_param Cfer::LOGGER.debug "Parameter #{tmpl_param.parameter_key}=#{output_val}" p = { parameter_key: tmpl_param.parameter_key, parameter_value: input_param, use_previous_value: false } estimate_params << p end end estimate_response = estimate_template_cost(estimate_options.merge(parameters: estimate_params)) estimate_response.url end def converge(stack, options = {}) Preconditions.check(@name).is_not_nil Preconditions.check(stack) { is_not_nil and has_type(Cfer::Core::Stack) } template_options = upload_or_return_template(stack.to_cfn, options) response = validate_template(template_options) create_params = [] update_params = [] previous_parameters = fetch_parameters rescue nil current_version = Cfer::SEMANTIC_VERSION previous_version = fetch_cfer_version rescue nil current_hash = stack.git_state.sha rescue nil previous_hash = fetch_git_hash rescue nil # Compare current and previous versions and hashes? response.parameters.each do |tmpl_param| input_param = stack.input_parameters[tmpl_param.parameter_key] old_param = previous_parameters[tmpl_param.parameter_key] if previous_parameters Cfer::LOGGER.debug "== Evaluating Parameter '#{tmpl_param.parameter_key.to_s}':" Cfer::LOGGER.debug "Input value: #{input_param.to_s || 'nil'}" Cfer::LOGGER.debug "Previous value: #{old_param.to_s || 'nil'}" if input_param output_val = tmpl_param.no_echo ? '*****' : input_param Cfer::LOGGER.debug "Parameter #{tmpl_param.parameter_key}=#{output_val}" p = { parameter_key: tmpl_param.parameter_key, parameter_value: input_param, use_previous_value: false } create_params << p update_params << p else if old_param Cfer::LOGGER.debug "Parameter #{tmpl_param.parameter_key} is unspecified (unchanged)" update_params << { parameter_key: tmpl_param.parameter_key, use_previous_value: true } else Cfer::LOGGER.debug "Parameter #{tmpl_param.parameter_key} is unspecified (default)" end end end Cfer::LOGGER.debug "===================" stack_options = options[:stack_options] || {} stack_options.merge! stack_name: name, capabilities: response.capabilities stack_options[:on_failure] = options[:on_failure] if options[:on_failure] stack_options[:timeout_in_minutes] = options[:timeout] if options[:timeout] stack_options[:role_arn] = options[:role_arn] if options[:role_arn] stack_options[:notification_arns] = options[:notification_arns] if options[:notification_arns] stack_options[:enable_termination_protection] = options[:enable_termination_protection] if options[:enable_termination_protection] stack_options.merge! parse_stack_policy(:stack_policy, options[:stack_policy]) stack_options.merge! template_options cfn_stack = begin create_stack stack_options.merge parameters: create_params :created rescue Cfer::Util::StackExistsError if options[:change] create_change_set stack_options.merge change_set_name: options[:change], description: options[:change_description], parameters: update_params else stack_options.merge! parse_stack_policy(:stack_policy_during_update, options[:stack_policy_during_update]) update_stack stack_options.merge parameters: update_params end :updated end flush_cache cfn_stack end # Yields to the given block for each CloudFormation event that qualifies, given the specified options. # @param options [Hash] The options hash # @option options [Fixnum] :number The maximum number of already-existing CloudFormation events to yield. # @option options [Boolean] :follow Set to true to wait until the stack enters a `COMPLETE` or `FAILED` state, yielding events as they occur. # @option options [Boolean] :no_sleep Don't pause between polling. This is used for tests, and shouldn't be when polling the AWS API. # @option options [Fixnum] :backoff The exponential backoff factor (default 1.5) # @option options [Fixnum] :backoff_max_wait The maximum amount of time that exponential backoff will wait before polling agian (default 15s) def tail(options = {}) q = [] event_id_highwater = nil counter = 0 number = options[:number] || 0 for_each_event name do |fetched_event| q.unshift fetched_event if counter < number counter = counter + 1 end while q.size > 0 event = q.shift yield event event_id_highwater = event.event_id end sleep_time = 1 running = true if options[:follow] while running sleep_time = [sleep_time * (options[:backoff] || 1), options[:backoff_max_wait] || 15].min begin stack_status = describe_stacks(stack_name: name).stacks.first.stack_status running = running && (/.+_(COMPLETE|FAILED)$/.match(stack_status) == nil) yielding = true for_each_event name do |fetched_event| if event_id_highwater == fetched_event.event_id yielding = false end if yielding q.unshift fetched_event end end rescue Aws::CloudFormation::Errors::Throttling Cfer::LOGGER.debug "AWS SDK is being throttled..." # Keep going though. rescue Aws::CloudFormation::Errors::ValidationError running = false end while q.size > 0 event = q.shift yield event event_id_highwater = event.event_id sleep_time = 1 end sleep sleep_time if running unless options[:no_sleep] end end end def stack_cache(stack_name) @stack_cache[stack_name] ||= {} end def fetch_stack(stack_name = @name) raise Cfer::Util::StackDoesNotExistError, 'Stack name must be specified' if stack_name == nil begin stack_cache(stack_name)[:stack] ||= describe_stacks(stack_name: stack_name).stacks.first.to_h rescue Aws::CloudFormation::Errors::ValidationError => e raise Cfer::Util::StackDoesNotExistError, e.message end end def fetch_summary(stack_name = @name) begin stack_cache(stack_name)[:summary] ||= get_template_summary(stack_name: stack_name) rescue Aws::CloudFormation::Errors::ValidationError => e raise Cfer::Util::StackDoesNotExistError, e.message end end def fetch_metadata(stack_name = @name) md = fetch_summary(stack_name).metadata stack_cache(stack_name)[:metadata] ||= if md JSON.parse(md) else {} end end def remove(stack_name, options = {}) delete_stack(stack_name) end def fetch_cfer_version(stack_name = @name) previous_version = Semantic::Version.new('0.0.0') if previous_version_hash = fetch_metadata(stack_name).fetch('Cfer', {}).fetch('Version', nil) previous_version_hash.each { |k, v| previous_version.send(k + '=', v) } previous_version end end def fetch_git_hash(stack_name = @name) fetch_metadata(stack_name).fetch('Cfer', {}).fetch('Git', {}).fetch('Rev', nil) end def fetch_parameters(stack_name = @name) stack_cache(stack_name)[:parameters] ||= cfn_list_to_hash('parameter', fetch_stack(stack_name)[:parameters]) end def fetch_outputs(stack_name = @name) stack_cache(stack_name)[:outputs] ||= cfn_list_to_hash('output', fetch_stack(stack_name)[:outputs]) end def fetch_output(stack_name, output_name) fetch_outputs(stack_name)[output_name] || raise(Cfer::Util::CferError, "Stack #{stack_name} has no output named `#{output_name}`") end def fetch_parameter(stack_name, param_name) fetch_parameters(stack_name)[param_name] || raise(Cfer::Util::CferError, "Stack #{stack_name} has no parameter named `#{param_name}`") end def to_h @stack.to_h end private def upload_or_return_template(cfn_hash, options = {}) @template_options ||= if cfn_hash.bytesize <= 51200 && !options[:force_s3] { template_body: cfn_hash } else raise Cfer::Util::CferError, 'Cfer needs to upload the template to S3, but no bucket was specified.' unless options[:s3_path] uri = URI(options[:s3_path]) template = Aws::S3::Object.new bucket_name: uri.host, key: uri.path.reverse.chomp('/').reverse template.put body: cfn_hash template_url = template.public_url template_url = template_url + '?versionId=' + template.version_id if template.version_id { template_url: template_url } end end def cfn_list_to_hash(attribute, list) return {} unless list key = :"#{attribute}_key" value = :"#{attribute}_value" HashWithIndifferentAccess[ *list.map { |kv| [ kv[key].to_s, kv[value].to_s ] }.flatten ] end def flush_cache Cfer::LOGGER.debug "*********** FLUSH CACHE ***************" Cfer::LOGGER.debug "Stack cache: #{@stack_cache}" Cfer::LOGGER.debug "***************************************" @stack_cache = {} end def for_each_event(stack_name) describe_stack_events(stack_name: stack_name).stack_events.each do |event| yield event end end # Validates a string as json # # @param string [String] def is_json?(string) JSON.parse(string) true rescue JSON::ParserError false end # Parses stack-policy-* options as an S3 URL, file to read, or JSON string # # @param name [String] Name of option: 'stack_policy' or 'stack_policy_during_update' # @param value [String] String containing URL, filename or JSON string # @return [Hash] Hash suitable for merging into options for create_stack or update_stack def parse_stack_policy(name, value) Cfer::LOGGER.debug "Using #{name} from: #{value}" if value.nil? {} elsif value.is_a?(Hash) {"#{name}_body".to_sym => value.to_json} elsif value.match(/\A#{URI::regexp(%w[http https s3])}\z/) # looks like a URL {"#{name}_url".to_sym => value} elsif File.exist?(value) # looks like a file to read {"#{name}_body".to_sym => File.read(value)} elsif is_json?(value) # looks like a JSON string {"#{name}_body".to_sym => value} else # none of the above raise Cfer::Util::CferError, "Stack policy must be an S3 url, a filename, or a valid json string" end end end end