bora 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3b7fb07038e20354a749af9db174d21fca4a3ab
-  data.tar.gz: 923412c975c6d3c2454d7dd616ed7b2339bb7646
+  metadata.gz: af9562b301a731f8fee40274923e356d3541ca98
+  data.tar.gz: 3a2cc26919d1502e0e272e16a47331426b38e2d3
 SHA512:
-  metadata.gz: f89db4d0f3175157424d9ea86ddb3fa6ec8aacabac8a762d8a7ad1e8f08f217c489f92d8fe2a72dfc287dfb6c82cf88bee97d5674d4b6961b00ab01808f15272
-  data.tar.gz: 039661e930401f3ac1c59bf122fd7aa67b60aaf79a5d129ec269a6dcb125d54f2667fdb6c626f0a8c35f1c90584a1fc111b9759a72907184af1a76f8a700bcc6
+  metadata.gz: 64fb26a2e2d65fe271346fdfbdb2f0f81f100135d149314d469b7d9b6b8f006cf25d13bfeefaaaa350110e2a9cb1a5d540919080b841c36532ccd41747c9f61f
+  data.tar.gz: c9de80ce38c97800dd0e03e84aa5f51be532350219915a61634fa6a4cdfbbda535a798afc6eee20997add492766e50c40c47e28377c38340300c0eb1c8c556ba

data/.gitignore

@@ -9,3 +9,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.editorconfig

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  CountComments: false
+  Max: 30
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/README.md

@@ -76,11 +76,14 @@ templates:
   app:
     # This template is a plain old CloudFormation JSON file
     template_file: app.json
-
-    # Optional. An array of "capabilities" to be passed to the CloudFormation API
-    # (see CloudFormation docs for more details)
-    capabilities: [CAPABILITY_IAM]
-
+    # Tag Key / Value pairs for the Cloudformation stack
+    # Tags are inherited by stack resources
+    tags:
+      Name: my-app
+    # Optional create stack parameters
+    # See - http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Client.html#create_stack-instance_method
+    capabilities: [CAPABILITY_IAM] # An array of "capabilities" to be passed to the CloudFormation API
+    on_failure: DO_NOTHING # See CloudFormation API docs for valid values and their meanings; "disable_rollback" is also supported
     # Optional. The default region for all stacks in this template.
     # Overrides "default_region" at the global level.
     # See below for further information.
@@ -91,24 +94,27 @@ templates:
     stacks:
       # The "uat" stack
       uat:
-        # The CloudFormation parameters to pass into the stack
+
         params:
           InstanceType: t2.micro
           AMI: ami-11032472
-
       # The "prod" stack
       prod:
+        # Overrides template level
+        on_failure: DELETE
+        # Tags here are merged with the template
+        tags:
+          Environment: uat
+        # The CloudFormation parameters to pass into the stack
         # Optional. The stack name to use in CloudFormation
         # If you don't supply this, the name will be the template
         # name concatenated with the stack name as defined in this file,
         # eg: "app-prod".
         cfn_stack_name: prod-application-stack
-
         # Optional. Default region for this stack.
         # Overrides "default_region" at the template level.
         # See below for further information.
         default_region: ap-southeast-2
-
         params:
           InstanceType: m4.xlarge
           AMI: ami-11032472

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "bora"
+require 'bundler/setup'
+require 'bora'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "bora"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bora.gemspec

@@ -4,30 +4,31 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bora/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "bora"
+  spec.name          = 'bora'
   spec.version       = Bora::VERSION
-  spec.authors       = ["Charles Blaxland"]
-  spec.email         = ["charles.blaxland@gmail.com"]
+  spec.authors       = ['Charles Blaxland']
+  spec.email         = ['charles.blaxland@gmail.com']
 
-  spec.summary       = %q{A tool (including rake tasks) for working with cloudformation stacks}
-  spec.homepage      = "https://github.com/ampedandwired/bora"
+  spec.summary       = 'A tool (including rake tasks) for working with cloudformation stacks'
+  spec.homepage      = 'https://github.com/ampedandwired/bora'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.1.0'
 
-  spec.add_dependency "aws-sdk", "~> 2.0"
-  spec.add_dependency "cfndsl", "~> 0.4"
-  spec.add_dependency "colorize", "~> 0.7"
-  spec.add_dependency "diffy", "~> 3.0"
-  spec.add_dependency "rake", "~> 10.0"
-  spec.add_dependency "thor", "~> 0.19"
-  spec.add_dependency "hashie", "~> 3.4.6"
+  spec.add_dependency 'aws-sdk', '~> 2.0'
+  spec.add_dependency 'cfndsl', '~> 0.4'
+  spec.add_dependency 'colorize', '~> 0.7'
+  spec.add_dependency 'diffy', '~> 3.0'
+  spec.add_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'hashie', '~> 3.4.6'
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov", "~> 0.12"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
 end

data/lib/bora.rb

@@ -1,18 +1,18 @@
-require "yaml"
-require "colorize"
-require "bora/version"
-require "bora/template"
-require "bora/tasks"
+require 'yaml'
+require 'colorize'
+require 'bora/version'
+require 'bora/template'
+require 'bora/tasks'
 
 class Bora
-  DEFAULT_CONFIG_FILE = "bora.yml"
-  INHERITABLE_PROPERTIES = ["default_region"]
+  DEFAULT_CONFIG_FILE = 'bora.yml'.freeze
+  INHERITABLE_PROPERTIES = ['default_region'].freeze
 
   def initialize(config_file_or_hash: DEFAULT_CONFIG_FILE, override_config: {}, colorize: true)
     @templates = {}
     config = load_config(config_file_or_hash)
     String.disable_colorization = !colorize
-    raise "No templates defined" if !config['templates']
+    raise 'No templates defined' unless config['templates']
     config['templates'].each do |template_name, template_config|
       resolved_config = resolve_template_config(config, template_config, override_config)
       @templates[template_name] = Template.new(template_name, resolved_config, override_config)
@@ -28,7 +28,7 @@ class Bora
   end
 
   def stack(stack_name)
-    t = @templates.find { |_, template| template.stack(stack_name) != nil }
+    t = @templates.find { |_, template| !template.stack(stack_name).nil? }
     t ? t[1].stack(stack_name) : nil
   end
 
@@ -36,18 +36,16 @@ class Bora
     @templates.each { |_, t| t.rake_tasks }
   end
 
-
   protected
 
   def load_config(config)
     if config.class == String
-      return YAML.load_file(config)
+      YAML.load_file(config)
     elsif config.class == Hash
-      return config
+      config
     end
   end
 
-
   private
 
   def resolve_template_config(bora_config, template_config, override_config)
@@ -57,5 +55,4 @@ class Bora
   def inheritable_properties(config)
     config.select { |k| INHERITABLE_PROPERTIES.include?(k) }
   end
-
 end

data/lib/bora/cfn/change.rb

@@ -1,4 +1,4 @@
-require "bora/cfn/change_set_action"
+require 'bora/cfn/change_set_action'
 
 class Bora
   module Cfn

data/lib/bora/cfn/change_set.rb

@@ -1,5 +1,5 @@
-require "bora/cfn/change"
-require "bora/cfn/status"
+require 'bora/cfn/change'
+require 'bora/cfn/status'
 
 class Bora
   module Cfn
@@ -24,19 +24,19 @@ class Bora
         status_success? || status_failure?
       end
 
-      def has_changes?
-        @status.success? && @changes.size > 0
+      def changes?
+        @status.success? && !@changes.empty?
       end
 
       def to_s(changes_only: false)
-        reason = @change_set.status_reason ? " (#{@change_set.status_reason})" : ""
-        description = @change_set.description ? " - #{@change_set.description}" : ""
-        changes_str = !@is_summary ? @changes.map(&:to_s).join("\n") : ""
+        reason = @change_set.status_reason ? " (#{@change_set.status_reason})" : ''
+        description = @change_set.description ? " - #{@change_set.description}" : ''
+        changes_str = !@is_summary ? @changes.map(&:to_s).join("\n") : ''
         if changes_only
           s = changes_str
         else
           s = "#{@change_set.change_set_name.bold} - #{@change_set.creation_time.getlocal} - #{@status}#{reason} - #{@execution_status}#{description}"
-          s += "\n#{changes_str}" if !changes_str.empty?
+          s += "\n#{changes_str}" unless changes_str.empty?
         end
         s
       end

data/lib/bora/cfn/change_set_action.rb

@@ -10,27 +10,26 @@ class Bora
 
       def to_s
         action_str = @action
-        if @action == "Modify"
-          action_str = case @replacement
-            when "True" then "Replace"
-            when "Conditional" then "Replace (conditional)"
+        if @action == 'Modify'
+          action_str =
+            case @replacement
+            when 'True' then 'Replace'
+            when 'Conditional' then 'Replace (conditional)'
             else action_str
-          end
+            end
         end
         action_str.colorize(color)
       end
 
-
       private
 
       def color
         case @action
-          when "Add" then :green
-          when "Remove" then :red
-          else :yellow
+        when 'Add' then :green
+        when 'Remove' then :red
+        else :yellow
         end
       end
     end
-
   end
 end

data/lib/bora/cfn/event.rb

@@ -2,15 +2,23 @@ require 'bora/cfn/status'
 
 class Bora
   module Cfn
-
     class Event
       def initialize(event)
         @event = event
         @status = Status.new(@event.resource_status)
       end
 
-      def method_missing(sym, *args, &block)
-        @event.send(sym, *args, &block)
+      def respond_to_missing?(method_name, include_private = false)
+        return false if method_name == :to_ary
+        super
+      end
+
+      def method_missing(method_name, *args, &block)
+        if method_name.to_s =~ /(.*)/
+          @event.send(Regexp.last_match[1], *args, &block)
+        else
+          super
+        end
       end
 
       def status_success?
@@ -26,10 +34,9 @@ class Bora
       end
 
       def to_s
-        status_reason = @event.resource_status_reason ? " - #{@event.resource_status_reason}" : ""
+        status_reason = @event.resource_status_reason ? " - #{@event.resource_status_reason}" : ''
         "#{@event.timestamp.getlocal} - #{@event.resource_type} - #{@event.logical_resource_id} - #{@status}#{status_reason}"
       end
     end
-
   end
 end

data/lib/bora/cfn/output.rb

@@ -1,6 +1,5 @@
 class Bora
   module Cfn
-
     class Output
       def initialize(output)
         @output = output
@@ -15,10 +14,9 @@ class Bora
       end
 
       def to_s
-        desc = @output.description ? " (#{@output.description})" : ""
+        desc = @output.description ? " (#{@output.description})" : ''
         "#{@output.output_key} - #{@output.output_value} #{desc}"
       end
     end
-
   end
 end

data/lib/bora/cfn/parameter.rb

@@ -17,6 +17,5 @@ class Bora
         "#{key} - #{value}"
       end
     end
-
   end
 end

data/lib/bora/cfn/stack.rb

@@ -9,9 +9,8 @@ require 'bora/cfn/parameter'
 
 class Bora
   module Cfn
-
     class Stack
-      NO_UPDATE_MESSAGE = "No updates are to be performed"
+      NO_UPDATE_MESSAGE = 'No updates are to be performed'.freeze
 
       def initialize(stack_name, region = nil)
         @stack_name = stack_name
@@ -24,7 +23,10 @@ class Bora
       end
 
       def update(options, &block)
-        call_cfn_action(:update_stack, options, &block)
+        # Parameters that are not valid for the update_stack api
+        invalid_update_stack_options = %i(on_failure disable_rollback)
+        update_options = options.select { |key| !invalid_update_stack_options.include?(key) }
+        call_cfn_action(:update_stack, update_options, &block)
       end
 
       def create_or_update(options, &block)
@@ -33,7 +35,7 @@ class Bora
 
       def recreate(options, &block)
         delete(&block) if exists?
-        create(options, &block) if !exists?
+        create(options, &block) unless exists?
       end
 
       def delete(&block)
@@ -41,24 +43,24 @@ class Bora
       end
 
       def events
-        return if !exists?
-        events = cloudformation.describe_stack_events({stack_name: underlying_stack.stack_id}).stack_events
+        return unless exists?
+        events = cloudformation.describe_stack_events(stack_name: underlying_stack.stack_id).stack_events
         events.reverse.map { |e| Event.new(e) }
       end
 
       def outputs
-        return if !exists?
+        return unless exists?
         underlying_stack.outputs.map { |output| Output.new(output) }
       end
 
       def parameters
-        return if !exists?
+        return unless exists?
         underlying_stack.parameters.map { |parameter| Parameter.new(parameter) }
       end
 
       def template
-        return if !exists?
-        cloudformation.get_template({stack_name: @stack_name}).template_body
+        return unless exists?
+        cloudformation.get_template(stack_name: @stack_name).template_body
       end
 
       def validate(options)
@@ -79,11 +81,11 @@ class Bora
           change_set_name: change_set_name
         }
         cloudformation.create_change_set(change_set_options.merge(options))
-        begin
+        loop do
           change_set = ChangeSet.new(cloudformation.describe_change_set(change_set_options))
-          sleep 5 unless change_set.status_complete?
-        end until change_set.status_complete?
-        change_set
+          return change_set if change_set.status_complete?
+          sleep 5
+        end
       end
 
       def list_change_sets
@@ -100,10 +102,9 @@ class Bora
       end
 
       def execute_change_set(change_set_name, &block)
-        call_cfn_action(:execute_change_set, {change_set_name: change_set_name}, &block)
+        call_cfn_action(:execute_change_set, { change_set_name: change_set_name }, &block)
       end
 
-
       # =============================================================================================
       private
 
@@ -118,7 +119,7 @@ class Bora
         return true if action == :delete_stack && !exists?
         @previous_event_time = last_event_time
         begin
-          action_options = {stack_name: @stack_name}.merge(options)
+          action_options = { stack_name: @stack_name }.merge(options)
           cloudformation.method(action.to_s.downcase).call(action_options)
           wait_for_completion(&block)
         rescue Aws::CloudFormation::Errors::ValidationError => e
@@ -129,21 +130,22 @@ class Bora
       end
 
       def wait_for_completion
-        begin
+        loop do
           events = unprocessed_events
           events.each { |e| yield e } if block_given?
           finished = events.find do |e|
             e.resource_type == 'AWS::CloudFormation::Stack' && e.logical_resource_id == @stack_name && e.status_complete?
           end
-          sleep 10 unless finished
-        end until finished
+          break if finished
+          sleep 10
+        end
         underlying_stack(refresh: true)
       end
 
       def underlying_stack(refresh: false)
         if !@_stack || refresh
           begin
-            response = cloudformation.describe_stacks({stack_name: @stack_name})
+            response = cloudformation.describe_stacks(stack_name: @stack_name)
             @_stack = response.stacks[0]
           rescue Aws::CloudFormation::Errors::ValidationError
             @_stack = nil
@@ -153,8 +155,8 @@ class Bora
       end
 
       def unprocessed_events
-        return [] if !underlying_stack
-        events = cloudformation.describe_stack_events({stack_name: underlying_stack.stack_id}).stack_events
+        return [] unless underlying_stack
+        events = cloudformation.describe_stack_events(stack_name: underlying_stack.stack_id).stack_events
         unprocessed_events = events.select do |event|
           !@processed_events.include?(event.event_id) && @previous_event_time < event.timestamp
         end
@@ -163,13 +165,10 @@ class Bora
       end
 
       def last_event_time
-        return Time.at(0) if !underlying_stack
-        events = cloudformation.describe_stack_events({stack_name: @stack_name}).stack_events
-        events.length > 0 ? events[0].timestamp : Time.at(0)
+        return Time.at(0) unless underlying_stack
+        events = cloudformation.describe_stack_events(stack_name: @stack_name).stack_events
+        !events.empty? ? events[0].timestamp : Time.at(0)
       end
-
     end
-
-
   end
 end