stack_master 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 106f5899a9d5076230bdf26135167adf3d658182
-  data.tar.gz: 8fd1dea5cd5026d8c316b641928ba14457c5fa8c
+  metadata.gz: 2a13283a8d2b9fc7717a9f49f38919761f818db3
+  data.tar.gz: 973ef37d67af339860b676584b92646c2c667b1e
 SHA512:
-  metadata.gz: 6db154802da177625841f36cbc9924140990a92133c57cbd080643849b2d58cc1b2a6e7ed0bdc80c4fca5d2df2e0391a5d1e077a361914cfb6cc533f18e9e20d
-  data.tar.gz: 6d657581c952323eb3fe878094fd3f86847f01525f65bddd21cdb5be473a47d9770e095b5cbd51d8abfe9ff373e8f3649f27917cbac8ef6803defbb7819c4265
+  metadata.gz: 0a34296f6a8fcf99c0c87ac6f5c3cdd3630de041ea3ee420c5a3a4df6741559caf49e1fcc41c1ea9c4d55ec979edbb1625018c7937b1a2ac7ee3a1c5faa5f703
+  data.tar.gz: 47902c47d322c770f65a1547a0bf6bdd5997191989f86b58b8bdd2d89714d52c6446b625fac94a4fca7a13d4a29dcf0f2d28dcf2fdd9691c5ab322beff58a5bd

data/features/apply.feature

@@ -15,6 +15,10 @@ Feature: Apply command
       """
       KeyName: my-key
       """
+    And a file named "parameters/myapp_web.yml" with:
+      """
+      VpcId: vpc-blah
+      """
     And a directory named "templates"
     And a file named "templates/myapp_vpc.rb" with:
       """
@@ -157,7 +161,7 @@ Feature: Apply command
     And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
     Then the exit status should be 0
 
-  Scenario: Run apply on an existing stack
+  Scenario: Update a stack
     Given I stub the following stack events:
       | stack_id | event_id | stack_name | logical_resource_id | resource_status | resource_type              | timestamp           |
       | 1        | 1        | myapp-vpc  | TestSg              | CREATE_COMPLETE | AWS::EC2::SecurityGroup    | 2020-10-29 00:00:00 |
@@ -203,9 +207,12 @@ Feature: Apply command
       | Stack diff:                                                                    |
       | -    "TestSg2": {                                                              |
       | Parameters diff: No changes                                                    |
+      | Proposed change set:                                                           |
+      | Replace                                                                        |
+      | Apply change set (y/n)?                                                              |
     Then the exit status should be 0
 
-  Scenario: Update an existing stack that has changed with --changed
+  Scenario: Update a stack that has changed with --changed
     Given I stub the following stack events:
       | stack_id | event_id | stack_name | logical_resource_id | resource_status | resource_type              | timestamp           |
       | 1        | 1        | myapp-vpc  | TestSg              | CREATE_COMPLETE | AWS::EC2::SecurityGroup    | 2020-10-29 00:00:00 |

data/lib/stack_master.rb

@@ -35,10 +35,14 @@ require "stack_master/parameter_resolvers/security_group"
 require "stack_master/parameter_resolvers/latest_ami_by_tags"
 require "stack_master/utils"
 require "stack_master/config"
+require "stack_master/paged_response_accumulator"
 require "stack_master/stack_definition"
 require "stack_master/template_compiler"
+require "stack_master/template_compilers/sparkle_formation"
+require "stack_master/template_compilers/json"
 require "stack_master/commands/terminal_helper"
 require "stack_master/commands/apply"
+require "stack_master/change_set"
 require "stack_master/commands/events"
 require "stack_master/commands/outputs"
 require "stack_master/commands/init"
@@ -60,13 +64,28 @@ module StackMaster
   end
 
   def non_interactive?
-    @non_interactive || false
+    @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'
 

data/lib/stack_master/aws_driver/cloud_formation.rb

@@ -1,14 +1,26 @@
 module StackMaster
   module AwsDriver
     class CloudFormation
+      extend Forwardable
+
       def set_region(region)
         @region = region
         @cf = nil
       end
 
-      def delete_stack(options)
-        cf.delete_stack(options)
-      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,
+                          :describe_stack_events,
+                          :update_stack,
+                          :create_stack,
+                          :validate_template
 
       def describe_stacks(options)
         retry_with_backoff do
@@ -16,38 +28,6 @@ module StackMaster
         end
       end
 
-      def cancel_update_stack(options)
-        cf.cancel_update_stack(options)
-      end
-
-      def describe_stack_resources(options)
-        cf.describe_stack_resources(options)
-      end
-
-      def get_template(options)
-        cf.get_template(options)
-      end
-
-      def get_stack_policy(options)
-        cf.get_stack_policy(options)
-      end
-
-      def describe_stack_events(options)
-        cf.describe_stack_events(options)
-      end
-
-      def update_stack(options)
-        cf.update_stack(options)
-      end
-
-      def create_stack(options)
-        cf.create_stack(options)
-      end
-
-      def validate_template(options)
-        cf.validate_template(options)
-      end
-
       private
 
       def cf

data/lib/stack_master/change_set.rb

@@ -0,0 +1,104 @@
+module StackMaster
+  class ChangeSet
+    END_STATES = [
+      'CREATE_COMPLETE',
+      'DELETE_COMPLETE',
+      'FAILED'
+    ]
+
+    def self.generate_change_set_name
+      'StackMaster' + Time.now.strftime('%Y-%m-%e-%H%M-%s')
+    end
+
+    def self.create(create_options)
+      cf = StackMaster.cloud_formation_driver
+      change_set_name = generate_change_set_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 "Proposed change set:"
+      @response.changes.each do |change|
+        display_resource_change(io, change.resource_change)
+      end
+    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

@@ -31,6 +31,9 @@ module StackMaster
         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]'

data/lib/stack_master/command.rb

@@ -2,11 +2,14 @@ module StackMaster
   module Command
     def self.included(base)
       base.extend ClassMethods
+      base.prepend Perform
     end
 
     module ClassMethods
       def perform(*args)
-        new(*args).tap { |command| command.perform }
+        new(*args).tap do |command|
+          command.perform
+        end
       end
 
       def command_name
@@ -14,12 +17,35 @@ module StackMaster
       end
     end
 
-    def failed
-      @failed = true
+    module Perform
+      def perform
+        catch(:halt) do
+          super
+        end
+      rescue Aws::CloudFormation::Errors::ServiceError => e
+        failed "#{e.class} #{e.message}"
+      end
     end
 
     def success?
       @failed != true
     end
+
+    private
+
+    def failed(message = nil)
+      StackMaster.stderr.puts(message) if message
+      @failed = true
+    end
+
+    def failed!(message = nil)
+      failed(message)
+      halt!
+    end
+
+    def halt!(message = nil)
+      StackMaster.stdout.puts(message) if message
+      throw :halt
+    end
   end
 end

data/lib/stack_master/commands/apply.rb

@@ -4,29 +4,20 @@ module StackMaster
       include Command
       include Commander::UI
       include StackMaster::Prompter
+      TEMPLATE_TOO_LARGE_ERROR_MESSAGE = 'The (space compressed) stack is larger than the limit set by AWS. See http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html'
 
       def initialize(config, stack_definition, options = {})
         @config = config
         @stack_definition = stack_definition
         @from_time = Time.now
-        @updating = false
       end
 
       def perform
         diff_stacks
-        unless ask?("Continue and apply the stack (y/n)? ")
-          StackMaster.stdout.puts "Stack update aborted"
-          return
-        end
-        begin
-          return if stack_too_big
-          create_or_update_stack
-          tail_stack_events
-        rescue StackMaster::CtrlC
-          cancel
-        end
-      rescue Aws::CloudFormation::Errors::ServiceError => e
-        StackMaster.stdout.puts "#{e.class} #{e.message}"
+        ensure_valid_parameters!
+        ensure_valid_template_body_size!
+        create_or_update_stack
+        tail_stack_events
       end
 
       private
@@ -36,7 +27,7 @@ module StackMaster
       end
 
       def stack
-        @stack ||= Stack.find(@stack_definition.region, @stack_definition.stack_name)
+        @stack ||= Stack.find(region, stack_name)
       end
 
       def proposed_stack
@@ -51,16 +42,6 @@ module StackMaster
         StackDiffer.new(proposed_stack, stack).output_diff
       end
 
-      def cancel
-        if @updating
-          if ask?("Cancel stack update?")
-            StackMaster.stdout.puts "Attempting to cancel stack update"
-            cf.cancel_update_stack({stack_name: @stack_definition.stack_name})
-            tail_stack_events
-          end
-        end
-      end
-
       def create_or_update_stack
         if stack_exists?
           update_stack
@@ -69,27 +50,35 @@ module StackMaster
         end
       end
 
-      def stack_too_big
-        if proposed_stack.too_big?
-          StackMaster.stdout.puts 'The (space compressed) stack is larger than the limit set by AWS. See http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html'
-          true
-        else
-          false
+      def create_stack
+        unless ask?("Create stack (y/n)? ")
+          failed!("Stack creation aborted")
         end
+        cf.create_stack(stack_options.merge(tags: proposed_stack.aws_tags))
       end
 
-      def update_stack
-        @updating = true
-        cf.update_stack(stack_options)
+      def ask_to_cancel_stack_update
+        if ask?("Cancel stack update?")
+          StackMaster.stdout.puts "Attempting to cancel stack update"
+          cf.cancel_update_stack(stack_name: stack_name)
+          tail_stack_events
+        end
       end
 
-      def create_stack
-        cf.create_stack(stack_options.merge(tags: proposed_stack.aws_tags))
+      def update_stack
+        @change_set = ChangeSet.create(stack_options)
+        halt!(@change_set.status_reason) if @change_set.failed?
+        @change_set.display(StackMaster.stdout)
+        unless ask?("Apply change set (y/n)? ")
+          ChangeSet.delete(@change_set.id)
+          halt! "Stack update aborted"
+        end
+        execute_change_set
       end
 
       def stack_options
         {
-          stack_name: @stack_definition.stack_name,
+          stack_name: stack_name,
           template_body: proposed_stack.maybe_compressed_template_body,
           parameters: proposed_stack.aws_parameters,
           capabilities: ['CAPABILITY_IAM'],
@@ -99,8 +88,35 @@ module StackMaster
       end
 
       def tail_stack_events
-        StackEvents::Streamer.stream(@stack_definition.stack_name, @stack_definition.region, io: StackMaster.stdout, from: @from_time)
+        StackEvents::Streamer.stream(stack_name, region, io: StackMaster.stdout, from: @from_time)
+      rescue StackMaster::CtrlC
+        ask_to_cancel_stack_update
+      end
+
+      def execute_change_set
+        ChangeSet.execute(@change_set.id, stack_name)
+      rescue StackMaster::CtrlC
+        ask_to_cancel_stack_update
+      end
+
+      def ensure_valid_parameters!
+        if @proposed_stack.missing_parameters?
+          StackMaster.stderr.puts "Empty/blank parameters detected, ensure values exist for those parameters. Parameters will be read from the following locations:"
+          @stack_definition.parameter_files.each do |parameter_file|
+            StackMaster.stderr.puts " - #{parameter_file}"
+          end
+          halt!
+        end
       end
+
+      def ensure_valid_template_body_size!
+        if proposed_stack.too_big?
+          failed! TEMPLATE_TOO_LARGE_ERROR_MESSAGE
+        end
+      end
+
+      extend Forwardable
+      def_delegators :@stack_definition, :stack_name, :region
     end
   end
 end