stack_master 1.6.0-x64-mingw32

data/bin/stack_master

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'stack_master'
+
+if ENV['STUB_AWS'] == 'true'
+  require 'stack_master/testing'
+end
+
+trap("SIGINT") { raise StackMaster::CtrlC }
+
+begin
+  result = StackMaster::CLI.new(ARGV.dup).execute!
+  exit !!result
+rescue StackMaster::CtrlC
+  StackMaster.stdout.puts "Exiting..."
+end

data/lib/stack_master.rb

@@ -0,0 +1,159 @@
+require 'commander'
+require 'yaml'
+require "aws-sdk-cloudformation"
+require "aws-sdk-ec2"
+require "aws-sdk-s3"
+require "aws-sdk-sns"
+require "aws-sdk-ssm"
+require "colorize"
+require 'active_support/core_ext/string'
+require 'multi_json'
+
+MultiJson.use :json_gem
+
+module StackMaster
+  extend self
+
+  autoload :Initializable, 'stack_master/utils/initializable'
+  autoload :ChangeSet, 'stack_master/change_set'
+  autoload :CLI, 'stack_master/cli'
+  autoload :CtrlC, 'stack_master/ctrl_c'
+  autoload :Command, 'stack_master/command'
+  autoload :VERSION, 'stack_master/version'
+  autoload :Stack, 'stack_master/stack'
+  autoload :Prompter, 'stack_master/prompter'
+  autoload :StackStates, 'stack_master/stack_states'
+  autoload :StackStatus, 'stack_master/stack_status'
+  autoload :SnsTopicFinder, 'stack_master/sns_topic_finder'
+  autoload :SecurityGroupFinder, 'stack_master/security_group_finder'
+  autoload :ParameterLoader, 'stack_master/parameter_loader'
+  autoload :ParameterResolver, 'stack_master/parameter_resolver'
+  autoload :ResolverArray, 'stack_master/resolver_array'
+  autoload :Resolver, 'stack_master/resolver_array'
+  autoload :Utils, 'stack_master/utils'
+  autoload :TemplateUtils, 'stack_master/template_utils'
+  autoload :Config, 'stack_master/config'
+  autoload :PagedResponseAccumulator, 'stack_master/paged_response_accumulator'
+  autoload :StackDefinition, 'stack_master/stack_definition'
+  autoload :TemplateCompiler, 'stack_master/template_compiler'
+
+  autoload :StackDiffer, 'stack_master/stack_differ'
+  autoload :Validator, 'stack_master/validator'
+
+  require 'stack_master/template_compilers/sparkle_formation'
+  require 'stack_master/template_compilers/json'
+  require 'stack_master/template_compilers/yaml'
+  require 'stack_master/template_compilers/cfndsl'
+
+  module Commands
+    autoload :TerminalHelper, 'stack_master/commands/terminal_helper'
+    autoload :Apply, 'stack_master/commands/apply'
+    autoload :Events, 'stack_master/commands/events'
+    autoload :Outputs, 'stack_master/commands/outputs'
+    autoload :Init, 'stack_master/commands/init'
+    autoload :Diff, 'stack_master/commands/diff'
+    autoload :ListStacks, 'stack_master/commands/list_stacks'
+    autoload :Validate, 'stack_master/commands/validate'
+    autoload :Resources, 'stack_master/commands/resources'
+    autoload :Delete, 'stack_master/commands/delete'
+    autoload :Status, 'stack_master/commands/status'
+  end
+
+  module ParameterResolvers
+    autoload :AmiFinder, 'stack_master/parameter_resolvers/ami_finder'
+    autoload :StackOutput, 'stack_master/parameter_resolvers/stack_output'
+    autoload :Secret, 'stack_master/parameter_resolvers/secret'
+    autoload :SnsTopicName, 'stack_master/parameter_resolvers/sns_topic_name'
+    autoload :SecurityGroup, 'stack_master/parameter_resolvers/security_group'
+    autoload :LatestAmiByTags, 'stack_master/parameter_resolvers/latest_ami_by_tags'
+    autoload :LatestAmi, 'stack_master/parameter_resolvers/latest_ami'
+    autoload :Env, 'stack_master/parameter_resolvers/env'
+    autoload :ParameterStore, 'stack_master/parameter_resolvers/parameter_store'
+  end
+
+  module AwsDriver
+    autoload :CloudFormation, 'stack_master/aws_driver/cloud_formation'
+    autoload :S3, 'stack_master/aws_driver/s3'
+  end
+
+  module TestDriver
+    autoload :CloudFormation, 'stack_master/test_driver/cloud_formation'
+    autoload :S3, 'stack_master/test_driver/s3'
+  end
+
+  module StackEvents
+    autoload :Fetcher, 'stack_master/stack_events/fetcher'
+    autoload :Presenter, 'stack_master/stack_events/presenter'
+    autoload :Streamer, 'stack_master/stack_events/streamer'
+  end
+
+  def interactive?
+    !non_interactive?
+  end
+
+  def non_interactive?
+    @non_interactive
+  end
+  @non_interactive = false
+
+  def non_interactive!
+    @non_interactive = true
+  end
+
+  def debug!
+    @debug = true
+  end
+  @debug = false
+
+  def debug?
+    @debug
+  end
+
+  def debug(message)
+    return unless debug?
+    stderr.puts "[DEBUG] #{message}".colorize(:green)
+  end
+
+  attr_accessor :non_interactive_answer
+  @non_interactive_answer = 'y'
+
+  def base_dir
+    File.expand_path(File.join(File.dirname(__FILE__), ".."))
+  end
+
+  def cloud_formation_driver
+    @cloud_formation_driver ||= AwsDriver::CloudFormation.new
+  end
+
+  def cloud_formation_driver=(value)
+    @cloud_formation_driver = value
+  end
+
+  def s3_driver
+    @s3_driver ||= AwsDriver::S3.new
+  end
+
+  def s3_driver=(value)
+    @s3_driver = value
+  end
+
+  def stdout
+    @stdout || $stdout
+  end
+
+  def stdout=(io)
+    @stdout = io
+  end
+
+  def stdin
+    $stdin
+  end
+
+  def stderr
+    @stderr || $stderr
+  end
+
+  def stderr=(io)
+    @stderr = io
+  end
+end

data/lib/stack_master/aws_driver/cloud_formation.rb

@@ -0,0 +1,41 @@
+module StackMaster
+  module AwsDriver
+    class CloudFormation
+      extend Forwardable
+
+      def region
+        @region ||= ENV['AWS_REGION'] || Aws.config[:region] || Aws.shared_config.region
+      end
+
+      def set_region(value)
+        if region != value
+          @region = value
+          @cf = nil
+        end
+      end
+
+      def_delegators :cf, :create_change_set,
+                          :describe_change_set,
+                          :execute_change_set,
+                          :delete_change_set,
+                          :delete_stack,
+                          :cancel_update_stack,
+                          :describe_stack_resources,
+                          :get_template,
+                          :get_stack_policy,
+                          :set_stack_policy,
+                          :describe_stack_events,
+                          :update_stack,
+                          :create_stack,
+                          :validate_template,
+                          :describe_stacks
+
+      private
+
+      def cf
+        @cf ||= Aws::CloudFormation::Client.new(region: region, retry_limit: 10)
+      end
+
+    end
+  end
+end

data/lib/stack_master/aws_driver/s3.rb

@@ -0,0 +1,68 @@
+require 'digest/md5'
+
+module StackMaster
+  module AwsDriver
+    class S3ConfigurationError < StandardError; end
+
+    class S3
+      def set_region(region)
+        @region = region
+        @s3 = nil
+      end
+
+      def upload_files(bucket: nil, prefix: nil, region: nil, files: {})
+        raise StackMaster::AwsDriver::S3ConfigurationError, 'A bucket must be specified in order to use S3' unless bucket
+
+        return if files.empty?
+
+        s3 = new_s3_client(region: region)
+
+        current_objects = s3.list_objects(
+          prefix: prefix,
+          bucket: bucket
+        ).map(&:contents).flatten.inject({}){|h,obj|
+          h.merge(obj.key => obj)
+        }
+
+        StackMaster.stdout.puts "Uploading files to S3:"
+
+        files.each do |template, file|
+          body = file.fetch(:body)
+          path = file.fetch(:path)
+          object_key = template.dup
+          object_key.prepend("#{prefix}/") if prefix
+          compiled_template_md5 = Digest::MD5.hexdigest(body).to_s
+          s3_md5 = current_objects[object_key] ? current_objects[object_key].etag.gsub("\"", '') : nil
+
+          next if compiled_template_md5 == s3_md5
+          s3_uri = "s3://#{bucket}/#{object_key}"
+          StackMaster.stdout.print "- #{File.basename(path)} => #{s3_uri} "
+
+          s3.put_object(
+            bucket: bucket,
+            key: object_key,
+            body: body,
+            metadata: { md5: compiled_template_md5 }
+          )
+          StackMaster.stdout.puts "done."
+        end
+      end
+
+      def url(bucket:, prefix:, region:, template:)
+        if region == 'us-east-1'
+          ["https://s3.amazonaws.com", bucket, prefix, template].compact.join('/')
+        elsif region.start_with? "cn-"
+          ["https://s3.#{region}.amazonaws.com.cn", bucket, prefix, template].compact.join('/')
+        else
+          ["https://s3-#{region}.amazonaws.com", bucket, prefix, template].compact.join('/')
+        end
+      end
+
+      private
+
+      def new_s3_client(region: nil)
+        Aws::S3::Client.new(region: region || @region)
+      end
+    end
+  end
+end

data/lib/stack_master/change_set.rb

@@ -0,0 +1,109 @@
+module StackMaster
+  class ChangeSet
+    END_STATES = [
+      'CREATE_COMPLETE',
+      'DELETE_COMPLETE',
+      'FAILED'
+    ]
+
+    def self.generate_change_set_name(stack_name)
+      stack_name + '-StackMaster' + Time.now.strftime('%Y-%m-%d-%H%M-%s')
+    end
+
+    def self.create(create_options)
+      cf = StackMaster.cloud_formation_driver
+      change_set_name = generate_change_set_name(create_options.fetch(:stack_name))
+      change_set_id = cf.create_change_set(create_options.merge(change_set_name: change_set_name)).id
+      find(change_set_id)
+    end
+
+    def self.find(id)
+      begin
+        response = PagedResponseAccumulator.call(cf, :describe_change_set, { change_set_name: id }, :changes)
+      end while !END_STATES.include?(response.status)
+      new(response)
+    end
+
+    def self.delete(id)
+      cf.delete_change_set(change_set_name: id)
+    end
+
+    def self.execute(id, stack_name)
+      cf.execute_change_set(change_set_name: id,
+                            stack_name: stack_name)
+    end
+
+    def self.cf
+      StackMaster.cloud_formation_driver
+    end
+
+    def initialize(describe_change_set_response)
+      @response = describe_change_set_response
+    end
+
+    def display(io)
+      io.puts <<-EOL
+
+========================================
+Proposed change set:
+EOL
+      @response.changes.each do |change|
+        display_resource_change(io, change.resource_change)
+      end
+io.puts "========================================"
+    end
+
+    def failed?
+      @response.status == 'FAILED'
+    end
+
+    def status_reason
+      @response.status_reason
+    end
+
+    def id
+      @response.change_set_id
+    end
+
+    private
+
+    def display_resource_change(io, resource_change)
+      action_name = if resource_change.replacement == 'True'
+                      'Replace'
+                    else
+                      resource_change.action
+                    end
+      message = "#{action_name} #{resource_change.resource_type} #{resource_change.logical_resource_id}"
+      color = action_color(action_name)
+      io.puts message.colorize(color)
+      resource_change.details.each do |detail|
+        display_resource_change_detail(io, action_name, color, detail)
+      end
+    end
+
+    def display_resource_change_detail(io, action_name, color, detail)
+      target_name = [detail.target.attribute, detail.target.name].compact.join('.')
+      detail_messages = [target_name]
+      if action_name == 'Replace'
+        detail_messages << "#{detail.target.requires_recreation} requires recreation"
+      end
+      triggered_by = [detail.change_source, detail.causing_entity].compact.join('.')
+      if detail.evaluation != 'Static'
+        triggered_by << "(#{detail.evaluation})"
+      end
+      detail_messages << "Triggered by: #{triggered_by}"
+      io.puts "- #{detail_messages.join('. ')}. ".colorize(color)
+    end
+
+    def action_color(action_name)
+      case action_name
+      when 'Add'
+        :green
+      when 'Modify'
+        :yellow
+      when 'Remove', 'Replace'
+        :red
+      end
+    end
+  end
+end

data/lib/stack_master/cli.rb

@@ -0,0 +1,208 @@
+require 'commander'
+require 'table_print'
+
+module StackMaster
+  class CLI
+    include Commander::Methods
+
+    def initialize(argv, stdin=STDIN, stdout=STDOUT, stderr=STDERR, kernel=Kernel)
+      @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+      Commander::Runner.instance_variable_set('@singleton', Commander::Runner.new(argv))
+      StackMaster.stdout = @stdout
+      StackMaster.stderr = @stderr
+      TablePrint::Config.io = StackMaster.stdout
+    end
+
+    def default_config_file
+      "stack_master.yml"
+    end
+
+    def execute!
+      program :name, 'StackMaster'
+      program :version, StackMaster::VERSION
+      program :description, 'AWS Stack Management'
+
+      global_option '-c', '--config FILE', String, 'Config file to use'
+      global_option '--changed', 'filter stack selection to only ones that have changed'
+      global_option '-y', '--yes', 'Run in non-interactive mode answering yes to any prompts' do
+        StackMaster.non_interactive!
+        StackMaster.non_interactive_answer = 'y'
+      end
+      global_option '-n', '--no', 'Run in non-interactive mode answering no to any prompts' do
+        StackMaster.non_interactive!
+        StackMaster.non_interactive_answer = 'n'
+      end
+      global_option '-d', '--debug', 'Run in debug mode' do
+        StackMaster.debug!
+      end
+
+      command :apply do |c|
+        c.syntax = 'stack_master apply [region_or_alias] [stack_name]'
+        c.summary = 'Creates or updates a stack'
+        c.description = "Creates or updates a stack. Shows a diff of the proposed stack's template and parameters. Tails stack events until CloudFormation has completed."
+        c.example 'update a stack named myapp-vpc in us-east-1', 'stack_master apply us-east-1 myapp-vpc'
+        c.option '--on-failure ACTION', String, "Action to take on CREATE_FAILURE. Valid Values: [ DO_NOTHING | ROLLBACK | DELETE ]. Default: ROLLBACK\nNote: You cannot use this option with Serverless Application Model (SAM) templates."
+        c.action do |args, options|
+          options.defaults config: default_config_file
+          execute_stacks_command(StackMaster::Commands::Apply, args, options)
+        end
+      end
+
+      command :outputs do |c|
+        c.syntax = 'stack_master outputs [region_or_alias] [stack_name]'
+        c.summary = 'Displays outputs for a stack'
+        c.description = "Displays outputs for a stack"
+        c.action do |args, options|
+          options.defaults config: default_config_file
+          execute_stacks_command(StackMaster::Commands::Outputs, args, options)
+        end
+      end
+
+      command :init do |c|
+        c.syntax = 'stack_master init [region_or_alias] [stack_name]'
+        c.summary = 'Initialises the expected directory structure and stack_master.yml file'
+        c.description = 'Initialises the expected directory structure and stack_master.yml file'
+        c.option('--overwrite', 'Overwrite existing files')
+        c.action do |args, options|
+          options.defaults config: default_config_file
+          unless args.size == 2
+            say "Invalid arguments. stack_master init [region] [stack_name]"
+          else
+            StackMaster::Commands::Init.perform(options.overwrite, *args)
+          end
+        end
+      end
+
+      command :diff do |c|
+        c.syntax = 'stack_master diff [region_or_alias] [stack_name]'
+        c.summary = "Shows a diff of the proposed stack's template and parameters"
+        c.description = "Shows a diff of the proposed stack's template and parameters"
+        c.example 'diff a stack named myapp-vpc in us-east-1', 'stack_master diff us-east-1 myapp-vpc'
+        c.action do |args, options|
+          options.defaults config: default_config_file
+          execute_stacks_command(StackMaster::Commands::Diff, args, options)
+        end
+      end
+
+      command :events do |c|
+        c.syntax = 'stack_master events [region_or_alias] [stack_name]'
+        c.summary = "Shows events for a stack"
+        c.description = "Shows events for a stack"
+        c.example 'show events for myapp-vpc in us-east-1', 'stack_master events us-east-1 myapp-vpc'
+        c.option '--number Integer', Integer, 'Number of recent events to show'
+        c.option '--all', 'Show all events'
+        c.option '--tail', 'Tail events'
+        c.action do |args, options|
+          options.defaults config: default_config_file
+          execute_stacks_command(StackMaster::Commands::Events, args, options)
+        end
+      end
+
+      command :resources do |c|
+        c.syntax = 'stack_master resources [region] [stack_name]'
+        c.summary = "Shows stack resources"
+        c.description = "Shows stack resources"
+        c.action do |args, options|
+          options.defaults config: default_config_file
+          execute_stacks_command(StackMaster::Commands::Resources, args, options)
+        end
+      end
+
+      command :list do |c|
+        c.syntax = 'stack_master list'
+        c.summary = 'List stack definitions'
+        c.description = 'List stack definitions'
+        c.action do |args, options|
+          options.defaults config: default_config_file
+          say "Invalid arguments." if args.size > 0
+          config = load_config(options.config)
+          StackMaster::Commands::ListStacks.perform(config)
+        end
+      end
+
+      command :validate do |c|
+        c.syntax = 'stack_master validate [region_or_alias] [stack_name]'
+        c.summary = 'Validate a template'
+        c.description = 'Validate a template'
+        c.example 'validate a stack named myapp-vpc in us-east-1', 'stack_master validate us-east-1 myapp-vpc'
+        c.action do |args, options|
+          options.defaults config: default_config_file
+          execute_stacks_command(StackMaster::Commands::Validate, args, options)
+        end
+      end
+
+      command :status do |c|
+        c.syntax = 'stack_master status'
+        c.summary = 'Check the current status stacks.'
+        c.description = 'Checks the status of all stacks defined in the stack_master.yml file. Warning this operation can be somewhat slow.'
+        c.example 'description', 'Check the status of all stack definitions'
+        c.action do |args, options|
+          options.defaults config: default_config_file
+          say "Invalid arguments. stack_master status" and return unless args.size == 0
+          config = load_config(options.config)
+          StackMaster::Commands::Status.perform(config)
+        end
+      end
+
+      command :delete do |c|
+        c.syntax = 'stack_master delete [region] [stack_name]'
+        c.summary = 'Delete an existing stack'
+        c.description = 'Deletes a stack. The stack does not necessarily have to appear in the stack_master.yml file.'
+        c.example 'description', 'Delete a stack'
+        c.action do |args, options|
+          options.default config: default_config_file
+          unless args.size == 2
+            say "Invalid arguments. stack_master delete [region] [stack_name]"
+            return
+          end
+
+          # Because delete can work without a stack_master.yml
+          if options.config and File.file?(options.config)
+            config = load_config(options.config)
+            region = Utils.underscore_to_hyphen(config.unalias_region(args[0]))
+          else
+            region = args[0]
+          end
+
+          StackMaster.cloud_formation_driver.set_region(region)
+          StackMaster::Commands::Delete.perform(region, args[1])
+        end
+      end
+
+      run!
+    end
+
+    def load_config(file)
+      stack_file = file || default_config_file
+      StackMaster::Config.load!(stack_file)
+    rescue Errno::ENOENT => e
+      say "Failed to load config file #{stack_file}"
+      exit 1
+    end
+
+    def execute_stacks_command(command, args, options)
+      command_results = []
+      config = load_config(options.config)
+      args = [nil, nil] if args.size == 0
+      args.each_slice(2) do |aliased_region, stack_name|
+        region = Utils.underscore_to_hyphen(config.unalias_region(aliased_region))
+        stack_name = Utils.underscore_to_hyphen(stack_name)
+        stack_definitions = config.filter(region, stack_name)
+        if stack_definitions.empty?
+          StackMaster.stdout.puts "Could not find stack definition #{stack_name} in region #{region}"
+        end
+        stack_definitions = stack_definitions.select do |stack_definition|
+          StackStatus.new(config, stack_definition).changed?
+        end if options.changed
+        stack_definitions.each do |stack_definition|
+          StackMaster.cloud_formation_driver.set_region(stack_definition.region)
+          StackMaster.stdout.puts "Executing #{command.command_name} on #{stack_definition.stack_name} in #{stack_definition.region}"
+          command_results.push command.perform(config, stack_definition, options).success?
+        end
+      end
+
+      # Return success/failure
+      command_results.all?
+    end
+  end
+end