cloudformation-ruby-dsl 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b15b3c213315ed742f352355a160fef24a34caf9
-  data.tar.gz: eb14df333ca82b033edfc5f9c01c86bafd6f52fa
+  metadata.gz: a11f29dffaf1e90a64925175605665a5e4df4941
+  data.tar.gz: 88c50e0aa3172bdf01b200db843c1925848317fa
 SHA512:
-  metadata.gz: d246665dff0d61b0a92199c2eef070f82e2f7fd5c1702552c3998675a809e40b30d7d4dfd927804331c7cf9da3897f0c7b7bcfa76a5a6a34c8000bea2e5a9597
-  data.tar.gz: 20ad8cb58f3bd94d8bf4639236517c0555598a181490000376f4ecf7e66444a9836da7713a2cfe480c9b56d6023270cfbc1c183a96c27ef4f2d8e8d9bf5f46f8
+  metadata.gz: fcf34d371bccdb4164ff7483f618464ce15f755ca11178e26f52ec191147718dc8efd1daea2e87d760353811290f2fa74fd104a8f1a90a4da459185431f7ee87
+  data.tar.gz: 35b55ccd50f0bdee6b52422606c1ad0c167bc8c2afa9e725d914a7fede723ae0f49621fefa3197f75351335a2fab22206e914397a4f9c2e4888545107a59d06c

data/cloudformation-ruby-dsl.gemspec

@@ -37,4 +37,5 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency    'bundler'
   gem.add_runtime_dependency    'aws-sdk'
   gem.add_runtime_dependency    'diffy'
+  gem.add_runtime_dependency    'highline'
 end

data/lib/cloudformation-ruby-dsl/cfntemplate.rb

@@ -27,15 +27,20 @@ require 'yaml'
 require 'erb'
 require 'aws-sdk'
 require 'diffy'
+require 'highline/import'
 
 ############################# AWS SDK Support
 
 class AwsCfn
   attr_accessor :cfn_client_instance
 
+  def initialize(**args)
+    Aws.config[:region] = args[:region] if args.key?(:region)
+  end
+
   def cfn_client
     if @cfn_client_instance == nil
-        # region and credentials are loaded from the environment; see http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Client.html
+        # credentials are loaded from the environment; see http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Client.html
         @cfn_client_instance = Aws::CloudFormation::Client.new(
         # we don't validate parameters because the aws-ruby-sdk gets a number parameter and expects it to be a string and fails the validation
         # see: https://github.com/aws/aws-sdk-ruby/issues/848
@@ -46,6 +51,20 @@ class AwsCfn
   end
 end
 
+# utility class to deserialize Structs as JSON
+# borrowed from http://ruhe.tumblr.com/post/565540643/generate-json-from-ruby-struct
+class Struct
+  def to_map
+    map = Hash.new
+    self.members.each { |m| map[m] = self[m] }
+    map
+  end
+
+  def to_json(*a)
+    to_map.to_json(*a)
+  end
+end
+
 ############################# Command-line support
 
 # Parse command-line arguments and return the parameters and region
@@ -69,25 +88,54 @@ def parse_args
   [stack_name, parameters, region, nopretty]
 end
 
-def cfn(template)
-  aws_cfn = AwsCfn.new
-  cfn_client = aws_cfn.cfn_client
-
-  action = ARGV[0]
+def validate_action(action)
+  valid = %w[
+    expand
+    diff
+    validate
+    create
+    update
+    cancel-update
+    delete
+    describe
+    describe-resource
+    get-template
+  ]
+  removed = %w[
+    cfn-list-stack-resources
+    cfn-list-stacks
+  ]
   deprecated = {
-    "cfn-validate-template" => "validate",
-    "cfn-create-stack" => "create",
-    "cfn-update-stack" => "update"
+    "cfn-validate-template"        => "validate",
+    "cfn-create-stack"             => "create",
+    "cfn-update-stack"             => "update",
+    "cfn-cancel-update-stack"      => "cancel-update",
+    "cfn-delete-stack"             => "delete",
+    "cfn-describe-stack-events"    => "describe",
+    "cfn-describe-stack-resources" => "describe",
+    "cfn-describe-stack-resource"  => "describe-resource",
+    "cfn-get-template"             => "get-template"
   }
   if deprecated.keys.include? action
     replacement = deprecated[action]
-    $stderr.puts "WARNING: '#{action}' is deprecated and will be removed; use '#{replacement}' instead"
+    $stderr.puts "WARNING: '#{action}' is deprecated and will be removed in a future version. Please use '#{replacement}' instead."
     action = replacement
   end
-  unless %w(expand diff validate create update).include? action
-    $stderr.puts "usage: #{$PROGRAM_NAME} <expand|diff|validate|create|update>"
+  unless valid.include? action
+    if removed.include? action
+      $stderr.puts "ERROR: native command #{action} is no longer supported by cloudformation-ruby-dsl."
+    end
+    $stderr.puts "usage: #{$PROGRAM_NAME} <#{valid.join('|')}>"
     exit(2)
   end
+  action
+end
+
+def cfn(template)
+  aws_cfn = AwsCfn.new(region: template.aws_region)
+  cfn_client = aws_cfn.cfn_client
+
+  action = validate_action( ARGV[0] )
 
   # Find parameters where extension attribute :Immutable is true then remove it from the
   # cfn template since we can't pass it to CloudFormation.
@@ -106,8 +154,10 @@ def cfn(template)
   # Derive stack name from ARGV
   _, options = extract_options(ARGV[1..-1], %w(--nopretty), %w(--stack-name --region --parameters --tag))
   # If the first argument is not an option and stack_name is undefined, assume it's the stack name
+  # The second argument, if present, is the resource name used by the describe-resource command
   if template.stack_name.nil?
     stack_name = options.shift if options[0] && !(/^-/ =~ options[0])
+    resource_name = options.shift if options[0] && !(/^-/ =~ options[0])
   else
     stack_name = template.stack_name
   end
@@ -201,14 +251,16 @@ def cfn(template)
   when 'validate'
     begin
       valid = cfn_client.validate_template({template_body: template_string})
-      exit(valid.successful?)
+      if valid.successful?
+        puts "Validation successful"
+        exit(true)
+      end
     rescue Aws::CloudFormation::Errors::ValidationError => e
       $stderr.puts "Validation error: #{e}"
       exit(false)
     end
 
   when 'create'
-
     begin
       create_result = cfn_client.create_stack({
           stack_name: stack_name,
@@ -226,6 +278,96 @@ def cfn(template)
       exit(false)
     end
 
+  when 'cancel-update'
+    begin
+      cancel_update_result = cfn_client.cancel_update_stack({stack_name: stack_name})
+      if cancel_update_result.successful?
+        $stderr.puts "Canceled updating stack #{stack_name}."
+        exit(true)
+      end
+    rescue Aws::CloudFormation::Errors::ServiceError => e
+      $stderr.puts "Failed to cancel updating stack: #{e}"
+      exit(false)
+    end
+
+  when 'delete'
+    begin
+      if HighLine.agree("Really delete #{stack_name} in #{cfn_client.config.region}? [Y/n]")
+        delete_result = cfn_client.delete_stack({stack_name: stack_name})
+        if delete_result.successful?
+          $stderr.puts "Deleted stack #{stack_name}."
+          exit(true)
+        end
+      else
+        $stderr.puts "Canceled deleting stack #{stack_name}."
+        exit(true)
+      end
+      rescue Aws::CloudFormation::Errors::ServiceError => e
+        $stderr.puts "Failed to delete stack: #{e}"
+        exit(false)
+    end
+
+  when 'describe'
+    begin
+      describe_stack = cfn_client.describe_stacks({stack_name: stack_name})
+      describe_stack_resources = cfn_client.describe_stack_resources({stack_name: stack_name})
+      if describe_stack.successful? and describe_stack_resources.successful?
+        stacks = {}
+        stack_resources = {}
+        describe_stack_resources.stack_resources.each { |stack_resource|
+          if stack_resources[stack_resource.stack_name].nil?
+            stack_resources[stack_resource.stack_name] = []
+          end
+          stack_resources[stack_resource.stack_name].push({
+            logical_resource_id: stack_resource.logical_resource_id,
+            physical_resource_id: stack_resource.physical_resource_id,
+            resource_type: stack_resource.resource_type,
+            timestamp: stack_resource.timestamp,
+            resource_status: stack_resource.resource_status,
+            resource_status_reason: stack_resource.resource_status_reason,
+            description: stack_resource.description,
+          })
+        }
+        describe_stack.stacks.each { |stack| stacks[stack.stack_name] = stack.to_map.merge!({resources: stack_resources[stack.stack_name]}) }
+        puts JSON.pretty_generate(stacks)
+        exit(true)
+      end
+    rescue Aws::CloudFormation::Errors::ServiceError => e
+      $stderr.puts "Failed describe stack #{stack_name}: #{e}"
+      exit(false)
+    end
+
+  when 'describe-resource'
+    begin
+      describe_stack_resource = cfn_client.describe_stack_resource({
+        stack_name: stack_name,
+        logical_resource_id: resource_name,
+      })
+      if describe_stack_resource.successful?
+        unless template.nopretty
+          puts JSON.pretty_generate(describe_stack_resource.stack_resource_detail)
+        else
+          puts JSON.generate(describe_stack_resource.stack_resource_detail)
+        end
+        exit(true)
+      end
+    rescue Aws::CloudFormation::Errors::ServiceError => e
+      $stderr.puts "Failed get stack resource details: #{e}"
+      exit(false)
+    end
+
+  when 'get-template'
+    begin
+      get_template_result = cfn_client.get_template({stack_name: stack_name})
+      if get_template_result.successful?
+        puts get_template_result.template_body
+        exit(true)
+      end
+    rescue Aws::CloudFormation::Errors::ServiceError => e
+      $stderr.puts "Failed get stack template: #{e}"
+      exit(false)
+    end
+
   when 'update'
 
     # Run CloudFormation command to describe the existing stack

data/lib/cloudformation-ruby-dsl/version.rb

@@ -15,7 +15,7 @@
 module Cfn
   module Ruby
     module Dsl
-      VERSION = "1.0.1"
+      VERSION = "1.0.3"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-ruby-dsl
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Shawn Smith
@@ -15,76 +15,90 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detabulator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby DSL library that provides a wrapper around the CloudFormation.
@@ -102,7 +116,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -138,17 +152,17 @@ require_paths:
 - bin
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Ruby DSL library that provides a wrapper around the CloudFormation.  Written