cloudformation_wrapper 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20f9a4efe8adbabb2c6d7d28b9ea9e43563fd622029fe83e6c0d719060aae5ed
-  data.tar.gz: bb5b22a94052890e4f1a634ded06598657c0cbf24923c0578e187595cc4b2f78
+  metadata.gz: f47bebe1f3736722886538c27e2accf2ec8443ca3b0948e9650cafe78868d50e
+  data.tar.gz: fc7824704acde353e69c2e5a43fc27782f513891e187b7eabf178f6c64666f4e
 SHA512:
-  metadata.gz: 554bd6b6abd082f1395fd03a2d47568c4d2bb70cdb77f2fc19ea6e49563c6eb2b59dfda4d993bda5a0213287971f0bb6880d84ac61e6251eb452d164697a9a68
-  data.tar.gz: 2ada52243c7cb5d439f140a6fc6f87876547230ad4122209e3ec9cf653c57ea0f63f47af62c3866687a8459a7d5ccd29c3b613a1ea1a0aaaf48f7e196df2855d
+  metadata.gz: 63819c959001cbb13e3fc989ef12a66aee9504cdef4d2bc6add26dfbdcd5c42065deff4716d7be18654010ffbbab49c68c8a5fbda44064997d1b5cbffa35e471
+  data.tar.gz: 9a419c5daefdd69cf5c5712db8e721f1decf18d11da07224c97aebf0b1994ed63aa4a3c14c3f6c495f8ef13b763744976d8515ad56858226645b88e2fc32987b

data/lib/cloudformation_wrapper/stack_manager.rb

@@ -1,227 +1,227 @@
-module CloudFormationWrapper
-  # Stack Manager Class
-  # Class containing static convenience methods for deploying and managing CloudFormation Stacks.
-  # @since 1.0
-  class StackManager
-    def self.deploy(options)
-      unless options[:client]
-        access_key_id = options[:access_key_id] || ENV['AWS_ACCESS_KEY_ID'] || ENV['ACCESS_KEY'] ||
-                        raise(ArgumentError, 'Cannot find AWS Access Key ID.')
-
-        secret_access_key = options[:secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY'] || ENV['SECRET_KEY'] ||
-                            raise(ArgumentError, 'Cannot find AWS Secret Key.')
-
-        credentials = Aws::Credentials.new(access_key_id, secret_access_key)
-      end
-
-      region = options[:region] || ENV['AWS_REGION'] || ENV['AMAZON_REGION'] || ENV['AWS_DEFAULT_REGION'] ||
-               raise(ArgumentError, 'Cannot find AWS Region.')
-
-      verified_options = verify_options(options)
-
-      cf_client = verified_options[:client] || Aws::CloudFormation::Client.new(credentials: credentials, region: region)
-
-      deploy_stack(
-        verified_options[:parameters],
-        verified_options[:name],
-        verified_options[:template_path],
-        verified_options[:wait_for_stack],
-        cf_client
-      )
-    end
-
-    private
-
-    def verify_options(options)
-      defaults = {
-        description: 'Deployed with CloudFormation Wrapper.', parameters: {}, wait_for_stack: true
-      }
-
-      options_with_defaults = options.reverse_merge(defaults)
-
-      unless options_with_defaults[:template_path] && (options_with_defaults[:template_path].is_a? String)
-        raise ArgumentError, 'template_path must be provided (String)'
-      end
-
-      unless options_with_defaults[:parameters] && (options_with_defaults[:parameters].is_a? Hash)
-        raise ArgumentError, 'parameters must be provided (Hash)'
-      end
-
-      unless options_with_defaults[:client] && (options_with_defaults[:client].is_a? Aws::CloudFormation::Client)
-        raise ArgumentError, 'If you\'re providing a client, it must be an Aws::CloudFormation::Client.'
-      end
-
-      return if options_with_defaults[:name] && (options_with_defaults[:name].is_a? String)
-      raise ArgumentError, 'name must be provided (String)'
-    end
-
-    def deploy_stack(parameters, stack_name, template_path, cf_client, _wait)
-      template_parameters = construct_template_parameters(parameters)
-      client_token = ENV.fetch('BUILD_NUMBER', SecureRandom.uuid.delete('-'))
-      change_set_type = describe_stack(stack_name, cf_client) ? 'UPDATE' : 'CREATE'
-
-      create_change_set_params = {
-        stack_name: stack_name,
-        template_body: File.read(template_path),
-        parameters: template_parameters,
-        change_set_name: "ChangeSet-#{client_token}",
-        client_token: client_token,
-        description: ENV.fetch('BUILD_TAG', 'Stack Updates.'),
-        change_set_type: change_set_type
-      }
-
-      change_set_id = cf_client.create_change_set(create_change_set_params).id
-
-      unless wait_for_stack_change_set_creation(change_set_id, cf_client)
-        puts "No changes required for #{stack_name}"
-        delete_change_set(change_set_id, cf_client)
-        return nil
-      end
-
-      list_changes(change_set_id, cf_client)
-      time_change_set_executed = Time.now
-      execute_change_set(change_set_id, cf_client)
-      updated_stack = wait_for_stack_to_complete(stack_name, time_change_set_executed, cf_client)
-      if updated_stack.stack_status == 'CREATE_COMPLETE' || updated_stack.stack_status == 'UPDATE_COMPLETE'
-        puts "Stack finished updating: #{updated_stack.stack_status}"
-      else
-        puts "Stack failed to update: #{updated_stack.stack_status} (#{updated_stack.stack_status_reason})"
-        return false
-      end
-      true
-    end
-
-    def construct_template_parameters(parameters)
-      template_parameters = []
-      parameters.each do |k, v|
-        template_parameters.push(
-          parameter_key: k.to_s,
-          parameter_value: v.to_s
-        )
-      end
-      template_parameters
-    end
-
-    def describe_stack(stack_name, cf_client)
-      response = cf_client.describe_stacks(stack_name: stack_name)
-      return false if response.stacks.length != 1
-      return response.stacks[0]
-    rescue Aws::CloudFormation::Errors::ServiceError
-      return false
-    end
-
-    def wait_for_stack_change_set_creation(change_set_id, cf_client)
-      polling_period = 1 # second
-
-      puts "Waiting for the Change Set (#{change_set_id}) to be reviewed..."
-
-      loop do
-        sleep(polling_period)
-        response = cf_client.describe_change_set(change_set_name: change_set_id)
-        if response.status == 'CREATE_COMPLETE'
-          puts "Change Set (#{change_set_id}) created."
-          return true
-        end
-        if response.status == 'FAILED'
-          puts "Change Set (#{change_set_id}) creation failed: #{response.status_reason}"
-          return false
-        end
-        puts '...'
-      end
-    end
-
-    def list_changes(change_set_id, cf_client)
-      response = cf_client.describe_change_set(change_set_name: change_set_id)
-      puts
-      puts 'Stack Set Changes:'
-      response.changes.each do |change|
-        resource_change = change.resource_change
-        puts "\t#{resource_change.action} - " \
-          "#{resource_change.logical_resource_id} " \
-          "aka #{resource_change.physical_resource_id} " \
-          "(#{resource_change.resource_type})"
-        puts "\t\tScope: #{resource_change.scope}"
-        puts "\t\tReplacment: #{resource_change.replacement}"
-        puts "\t\tDetails:"
-        resource_change.details.each do |detail|
-          puts "\t\t\tTarget: #{detail.target.attribute} - " \
-            "#{detail.target.name} - " \
-            "recreate:#{detail.target.requires_recreation}"
-          puts "\t\t\tCaused By: #{detail.causing_entity}"
-          puts "\t\t\tChange Source: #{detail.change_source}"
-        end
-      end
-      puts
-    end
-
-    def execute_change_set(change_set_id, cf_client)
-      puts 'Executing Change Set...'
-
-      client_token = ENV.fetch('BUILD_NUMBER', SecureRandom.uuid.delete('-'))
-
-      cf_client.execute_change_set(change_set_name: change_set_id, client_request_token: client_token)
-    end
-
-    def wait_for_stack_to_complete(stack_name, minimum_timestamp_for_events, cf_client)
-      timestamp_width = 30
-      logical_resource_width = 40
-      resource_status_width = 40
-      polling_period = 3 # seconds
-      most_recent_event_id = ''
-
-      puts
-      puts "#{'Timestamp'.ljust(timestamp_width)} " \
-      "#{'Logical Resource Id'.ljust(logical_resource_width)} " \
-      "#{'Status'.ljust(resource_status_width)} "
-
-      puts "#{'-'.center(timestamp_width, '-')} " \
-        "#{'-'.center(logical_resource_width, '-')} " \
-        "#{'-'.center(resource_status_width, '-')}"
-
-      stack = {}
-      loop do
-        sleep(polling_period)
-        stack = describe_stack(stack_name, cf_client)
-        events = get_latest_events(stack_name, minimum_timestamp_for_events, most_recent_event_id, cf_client)
-        most_recent_event_id = events[0].event_id unless events.empty?
-        events.reverse_each do |event|
-          line = "#{event.timestamp.to_s.ljust(timestamp_width)} " \
-          "#{event.logical_resource_id.ljust(logical_resource_width)} " \
-          "#{event.resource_status.ljust(resource_status_width)} "
-          if !event.resource_status.end_with?('IN_PROGRESS') && !event.resource_status_reason.nil?
-            line << event.resource_status_reason
-          end
-          puts line
-        end
-        break unless stack.stack_status.end_with?('IN_PROGRESS')
-      end
-      stack
-    end
-
-    def get_latest_events(stack_name, minimum_timestamp_for_events, most_recent_event_id, cf_client)
-      no_new_events = false
-      response = nil
-      events = []
-      loop do
-        params = {
-          stack_name: stack_name
-        }
-
-        params[:next_token] = response.next_token unless response.nil?
-
-        response = cf_client.describe_stack_events(params)
-
-        response.stack_events.each do |event|
-          if (event.event_id == most_recent_event_id) || (event.timestamp < minimum_timestamp_for_events)
-            no_new_events = true
-            break
-          end
-          events << event
-        end
-
-        break if no_new_events || !response.next_token
-      end
-      events
-    end
-  end
-end
+module CloudFormationWrapper
+  # Stack Manager Class
+  # Class containing static convenience methods for deploying and managing CloudFormation Stacks.
+  # @since 1.0
+  class StackManager
+    def self.deploy(options)
+      unless options[:client]
+        access_key_id = options[:access_key_id] || ENV['AWS_ACCESS_KEY_ID'] || ENV['ACCESS_KEY'] ||
+                        raise(ArgumentError, 'Cannot find AWS Access Key ID.')
+
+        secret_access_key = options[:secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY'] || ENV['SECRET_KEY'] ||
+                            raise(ArgumentError, 'Cannot find AWS Secret Key.')
+
+        credentials = Aws::Credentials.new(access_key_id, secret_access_key)
+      end
+
+      region = options[:region] || ENV['AWS_REGION'] || ENV['AMAZON_REGION'] || ENV['AWS_DEFAULT_REGION'] ||
+               raise(ArgumentError, 'Cannot find AWS Region.')
+
+      verified_options = verify_options(options)
+
+      cf_client = verified_options[:client] || Aws::CloudFormation::Client.new(credentials: credentials, region: region)
+
+      deploy_stack(
+        verified_options[:parameters],
+        verified_options[:name],
+        verified_options[:template_path],
+        verified_options[:wait_for_stack],
+        cf_client
+      )
+    end
+
+    private
+
+    def verify_options(options)
+      defaults = {
+        description: 'Deployed with CloudFormation Wrapper.', parameters: {}, wait_for_stack: true
+      }
+
+      options_with_defaults = options.reverse_merge(defaults)
+
+      unless options_with_defaults[:template_path] && (options_with_defaults[:template_path].is_a? String)
+        raise ArgumentError, 'template_path must be provided (String)'
+      end
+
+      unless options_with_defaults[:parameters] && (options_with_defaults[:parameters].is_a? Hash)
+        raise ArgumentError, 'parameters must be provided (Hash)'
+      end
+
+      unless options_with_defaults[:client] && (options_with_defaults[:client].is_a? Aws::CloudFormation::Client)
+        raise ArgumentError, 'If you\'re providing a client, it must be an Aws::CloudFormation::Client.'
+      end
+
+      return if options_with_defaults[:name] && (options_with_defaults[:name].is_a? String)
+      raise ArgumentError, 'name must be provided (String)'
+    end
+
+    def deploy_stack(parameters, stack_name, template_path, cf_client, _wait)
+      template_parameters = construct_template_parameters(parameters)
+      client_token = ENV.fetch('BUILD_NUMBER', SecureRandom.uuid.delete('-'))
+      change_set_type = describe_stack(stack_name, cf_client) ? 'UPDATE' : 'CREATE'
+
+      create_change_set_params = {
+        stack_name: stack_name,
+        template_body: File.read(template_path),
+        parameters: template_parameters,
+        change_set_name: "ChangeSet-#{client_token}",
+        client_token: client_token,
+        description: ENV.fetch('BUILD_TAG', 'Stack Updates.'),
+        change_set_type: change_set_type
+      }
+
+      change_set_id = cf_client.create_change_set(create_change_set_params).id
+
+      unless wait_for_stack_change_set_creation(change_set_id, cf_client)
+        puts "No changes required for #{stack_name}"
+        delete_change_set(change_set_id, cf_client)
+        return nil
+      end
+
+      list_changes(change_set_id, cf_client)
+      time_change_set_executed = Time.now
+      execute_change_set(change_set_id, cf_client)
+      updated_stack = wait_for_stack_to_complete(stack_name, time_change_set_executed, cf_client)
+      if updated_stack.stack_status == 'CREATE_COMPLETE' || updated_stack.stack_status == 'UPDATE_COMPLETE'
+        puts "Stack finished updating: #{updated_stack.stack_status}"
+      else
+        puts "Stack failed to update: #{updated_stack.stack_status} (#{updated_stack.stack_status_reason})"
+        return false
+      end
+      true
+    end
+
+    def construct_template_parameters(parameters)
+      template_parameters = []
+      parameters.each do |k, v|
+        template_parameters.push(
+          parameter_key: k.to_s,
+          parameter_value: v.to_s
+        )
+      end
+      template_parameters
+    end
+
+    def describe_stack(stack_name, cf_client)
+      response = cf_client.describe_stacks(stack_name: stack_name)
+      return false if response.stacks.length != 1
+      return response.stacks[0]
+    rescue Aws::CloudFormation::Errors::ServiceError
+      return false
+    end
+
+    def wait_for_stack_change_set_creation(change_set_id, cf_client)
+      polling_period = 1 # second
+
+      puts "Waiting for the Change Set (#{change_set_id}) to be reviewed..."
+
+      loop do
+        sleep(polling_period)
+        response = cf_client.describe_change_set(change_set_name: change_set_id)
+        if response.status == 'CREATE_COMPLETE'
+          puts "Change Set (#{change_set_id}) created."
+          return true
+        end
+        if response.status == 'FAILED'
+          puts "Change Set (#{change_set_id}) creation failed: #{response.status_reason}"
+          return false
+        end
+        puts '...'
+      end
+    end
+
+    def list_changes(change_set_id, cf_client)
+      response = cf_client.describe_change_set(change_set_name: change_set_id)
+      puts
+      puts 'Stack Set Changes:'
+      response.changes.each do |change|
+        resource_change = change.resource_change
+        puts "\t#{resource_change.action} - " \
+          "#{resource_change.logical_resource_id} " \
+          "aka #{resource_change.physical_resource_id} " \
+          "(#{resource_change.resource_type})"
+        puts "\t\tScope: #{resource_change.scope}"
+        puts "\t\tReplacment: #{resource_change.replacement}"
+        puts "\t\tDetails:"
+        resource_change.details.each do |detail|
+          puts "\t\t\tTarget: #{detail.target.attribute} - " \
+            "#{detail.target.name} - " \
+            "recreate:#{detail.target.requires_recreation}"
+          puts "\t\t\tCaused By: #{detail.causing_entity}"
+          puts "\t\t\tChange Source: #{detail.change_source}"
+        end
+      end
+      puts
+    end
+
+    def execute_change_set(change_set_id, cf_client)
+      puts 'Executing Change Set...'
+
+      client_token = ENV.fetch('BUILD_NUMBER', SecureRandom.uuid.delete('-'))
+
+      cf_client.execute_change_set(change_set_name: change_set_id, client_request_token: client_token)
+    end
+
+    def wait_for_stack_to_complete(stack_name, minimum_timestamp_for_events, cf_client)
+      timestamp_width = 30
+      logical_resource_width = 40
+      resource_status_width = 40
+      polling_period = 3 # seconds
+      most_recent_event_id = ''
+
+      puts
+      puts "#{'Timestamp'.ljust(timestamp_width)} " \
+      "#{'Logical Resource Id'.ljust(logical_resource_width)} " \
+      "#{'Status'.ljust(resource_status_width)} "
+
+      puts "#{'-'.center(timestamp_width, '-')} " \
+        "#{'-'.center(logical_resource_width, '-')} " \
+        "#{'-'.center(resource_status_width, '-')}"
+
+      stack = {}
+      loop do
+        sleep(polling_period)
+        stack = describe_stack(stack_name, cf_client)
+        events = get_latest_events(stack_name, minimum_timestamp_for_events, most_recent_event_id, cf_client)
+        most_recent_event_id = events[0].event_id unless events.empty?
+        events.reverse_each do |event|
+          line = "#{event.timestamp.to_s.ljust(timestamp_width)} " \
+          "#{event.logical_resource_id.ljust(logical_resource_width)} " \
+          "#{event.resource_status.ljust(resource_status_width)} "
+          if !event.resource_status.end_with?('IN_PROGRESS') && !event.resource_status_reason.nil?
+            line << event.resource_status_reason
+          end
+          puts line
+        end
+        break unless stack.stack_status.end_with?('IN_PROGRESS')
+      end
+      stack
+    end
+
+    def get_latest_events(stack_name, minimum_timestamp_for_events, most_recent_event_id, cf_client)
+      no_new_events = false
+      response = nil
+      events = []
+      loop do
+        params = {
+          stack_name: stack_name
+        }
+
+        params[:next_token] = response.next_token unless response.nil?
+
+        response = cf_client.describe_stack_events(params)
+
+        response.stack_events.each do |event|
+          if (event.event_id == most_recent_event_id) || (event.timestamp < minimum_timestamp_for_events)
+            no_new_events = true
+            break
+          end
+          events << event
+        end
+
+        break if no_new_events || !response.next_token
+      end
+      events
+    end
+  end
+end

data/lib/cloudformation_wrapper/version.rb

@@ -1,4 +1,4 @@
-module CloudFormationWrapper
-  # @!visibility private
-  VERSION = '0.1.2'.freeze
-end
+module CloudFormationWrapper
+  # @!visibility private
+  VERSION = '0.1.4'.freeze
+end

data/lib/cloudformation_wrapper.rb

@@ -1,9 +1,9 @@
-require 'cloudformation_wrapper/version'
-
-require 'aws-sdk-cloudformation'
-require 'active_support/core_ext/hash'
-
-require 'cloudformation_wrapper/stack_manager'
-
-STDOUT.sync
-STDERR.sync
+require 'cloudformation_wrapper/version'
+
+require 'aws-sdk-cloudformation'
+require 'active_support/core_ext/hash'
+
+require 'cloudformation_wrapper/stack_manager'
+
+STDOUT.sync
+STDERR.sync

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Ted Armstrong
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.1
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Easy deployment of AWS CloudFormation stacks