sfn 1.1.2 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57c0b106d6e595a6ccae1b8242e1b57dbf1418db
-  data.tar.gz: b5aaa5b140fc279e39edcaa83bfd3a004e3b3208
+  metadata.gz: 1ff41b031d25b35807d32b321e518418884367eb
+  data.tar.gz: c640f2e35f83d0f3e5244e75c4237e2860586d5c
 SHA512:
-  metadata.gz: 8d8e5a5bd254e7112df68538b644663b678797ca64dc78f971b252ae42fb7599a0207050d45f97ee333a18dd739e0ead80e58bd466b6f7794d7793826417acc7
-  data.tar.gz: 63983740fed1f8fb70317410da8a1e844181de88115f2c745ce8be1091636ec8310ca44099125fe8af52cf4d7339706e7b46d37b5a65ca5d9efa5caaa5f15ffd
+  metadata.gz: 809fa0ab54b3e669963ed04f6e02cee4fac79d9983e4e2857e20074d54157582ed7a1093d25428b8ecb035bcb8cb835e43c256c3bb1b2ad49c97c173032158b4
+  data.tar.gz: 45bb35b42769af49bb4042417fe2034b16f07316001273ab59721c3e5128106985e17f14d212e1947e71652b6552a698b3a09d61b0ab3aea0c9455fb2df16823

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v1.1.4
+* [feature] Add new `diff` command
+
 ## v1.1.2
 * [fix] stack update when extracting compile time state
 * [fix] remove use of `root_path` method when shallow nesting is in use

data/README.md

@@ -163,6 +163,7 @@ end
 * `sfn describe`
 * `sfn inspect`
 * `sfn validate`
+* `sfn diff`
 
 _NOTE: All commands respond to `--help` and will provide a full list of valid options._
 
@@ -251,6 +252,11 @@ resources are supported.
 
 Update an existing stack.
 
+### `sfn diff STACK`
+
+View resources differences that would be applied to a running stack
+on update.
+
 ### `sfn destroy STACK`
 
 Destroy an existing stack.

data/docs/callbacks.md

@@ -17,6 +17,11 @@ are generally invoked in two places:
 * `before` - Prior to the command's remote API request
 * `after` - Following the command's remote API request
 
+There are also callbacks available prior to the execution
+of a command. These can also be isolated to specific commands:
+
+* `before_config` - Prior to the execution of the command.
+
 ### Enabling Callbacks
 
 Callbacks can be applied globally (to all commands) or

data/lib/sfn/callback.rb

@@ -10,6 +10,10 @@ module Sfn
     attr_reader :ui
     # @return [Smash]
     attr_reader :config
+    # @return [Array<String>] CLI arguments
+    attr_reader :arguments
+    # @return [Miasma::Models::Orchestration] remote API
+    attr_reader :api
 
     # Create a new callback instance
     #

data/lib/sfn/command.rb

@@ -7,6 +7,7 @@ module Sfn
     autoload :Create, 'sfn/command/create'
     autoload :Describe, 'sfn/command/describe'
     autoload :Destroy, 'sfn/command/destroy'
+    autoload :Diff, 'sfn/command/diff'
     autoload :Events, 'sfn/command/events'
     autoload :Export, 'sfn/command/export'
     autoload :Import, 'sfn/command/import'
@@ -23,6 +24,8 @@ module Sfn
         discover_config(cli_opts)
       end
       super(cli_opts, args)
+      run_callbacks_for(:after_config)
+      run_callbacks_for("after_config_#{Bogo::Utility.snake(self.class.name)}")
     end
 
     # @return [Smash]

data/lib/sfn/command/create.rb

@@ -3,7 +3,7 @@ require 'sfn'
 
 module Sfn
   class Command
-    # Cloudformation create command
+    # Create command
     class Create < Command
 
       include Sfn::CommandModule::Base

data/lib/sfn/command/diff.rb

@@ -0,0 +1,168 @@
+require 'sparkle_formation'
+require 'sfn'
+require 'hashdiff'
+
+module Sfn
+  class Command
+    # Diff command
+    class Diff < Command
+
+      include Sfn::CommandModule::Base
+      include Sfn::CommandModule::Template
+      include Sfn::CommandModule::Stack
+
+      # Diff the stack with existing stack
+      def execute!
+        name_required!
+        name = name_args.first
+
+        begin
+          stack = provider.connection.stacks.get(name)
+        rescue Miasma::Error::ApiError::RequestError
+          stack = nil
+        end
+
+        if(stack)
+          config[:print_only] = true
+          file = load_template_file
+          file.delete('sfn_nested_stack')
+          file = Sfn::Utils::StackParameterScrubber.scrub!(file)
+          file = translate_template(file)
+
+          ui.info "#{ui.color('SparkleFormation:', :bold)} #{ui.color('diff', :blue)} - #{name}"
+          ui.puts
+
+          diff_stack(stack, MultiJson.load(MultiJson.dump(file)).to_smash)
+        else
+          ui.fatal "Failed to locate requested stack: #{ui.color(name, :red, :bold)}"
+          raise "Failed to locate stack: #{name}"
+        end
+      end
+
+      def diff_stack(stack, file, parent_names=[])
+        stack_template = stack.template
+        nested_stacks = Hash[
+          file['Resources'].find_all do |name, value|
+            value.fetch('Properties', {})['Stack']
+          end
+        ]
+        nested_stacks.each do |name, value|
+          n_stack = stack.nested_stacks(false).detect do |ns|
+            ns.data[:logical_id] == name
+          end
+          if(n_stack)
+            diff_stack(n_stack, value['Properties']['Stack'], [*parent_names, stack.data.fetch(:logical_id, stack.name)].compact)
+          end
+          file['Resources'][name]['Properties'].delete('Stack')
+        end
+
+        ui.info "#{ui.color('Stack diff:', :bold)} #{ui.color((parent_names + [stack.data.fetch(:logical_id, stack.name)]).compact.join(' > '), :blue)}"
+
+        stack_diff = HashDiff.diff(stack.template, file)
+
+        if(config[:raw_diff])
+          ui.info "Dumping raw template diff:"
+          require 'pp'
+          pp stack_diff
+        else
+
+          added_resources = stack_diff.find_all do |item|
+            item.first == '+' && item[1].match(/Resources\.[^.]+$/)
+          end
+          removed_resources = stack_diff.find_all do |item|
+            item.first == '-' && item[1].match(/Resources\.[^.]+$/)
+          end
+          modified_resources = stack_diff.find_all do |item|
+            item[1].start_with?('Resources.') &&
+              !item[1].end_with?('TemplateURL') &&
+              !item[1].include?('Properties.Parameters')
+          end - added_resources - removed_resources
+
+          if(added_resources.empty? && removed_resources.empty? && modified_resources.empty?)
+            ui.info 'No changes detected'
+            ui.puts
+          else
+
+            unless(added_resources.empty?)
+              ui.info ui.color('Added Resources:', :green, :bold)
+              added_resources.each do |item|
+                ui.print ui.color("  -> #{item[1].split('.').last}", :green)
+                ui.puts " [#{item[2]['Type']}]"
+              end
+              ui.puts
+            end
+
+            unless(modified_resources.empty?)
+              ui.info ui.color('Modified Resources:', :yellow, :bold)
+              m_resources = Hash.new.tap do |hash|
+                modified_resources.each do |item|
+                  _, key, path = item[1].split('.', 3)
+                  hash[key] ||= {}
+                  prefix, a_key = path.split('.', 2)
+                  hash[key][prefix] ||= []
+                  matched = hash[key][prefix].detect do |i|
+                    i[:path] == a_key
+                  end
+                  if(matched)
+                    if(item.first == '-')
+                      matched[:original] = item[2]
+                    else
+                      matched[:new] = item[2]
+                    end
+                  else
+                    hash[key][prefix] << Hash.new.tap do |info|
+                      info[:path] = a_key
+                      case item.first
+                      when '~'
+                        info[:original] = item[2]
+                        info[:new] = item[3]
+                      when '+'
+                        info[:new] = item[2]
+                      else
+                        info[:original] = item[2]
+                      end
+                    end
+                  end
+                end
+              end.to_smash(:sorted).each do |key, value|
+                ui.puts ui.color("  - #{key}", :yellow) + " [#{stack.template['Resources'][key]['Type']}]"
+                value.each do |prefix, items|
+                  ui.puts ui.color("    #{prefix}:", :bold)
+                  items.each do |item|
+                    original = item[:original].nil? ? ui.color('(none)', :yellow) : ui.color(item[:original].inspect, :red)
+                    new_val = item[:new].nil? ? ui.color('(deleted)', :red) : ui.color(item[:new].inspect, :green)
+                    ui.puts "      #{item[:path]}: #{original} -> #{new_val}"
+                  end
+                end
+              end
+              ui.puts
+            end
+
+            unless(removed_resources.empty?)
+              ui.info ui.color('Removed Resources:', :red, :bold)
+              removed_resources.each do |item|
+                ui.print ui.color("  <- #{item[1].split('.').last}", :red)
+                ui.puts " [#{item[2]['Type']}]"
+              end
+              ui.puts
+            end
+
+            run_callbacks_for(:after_stack_diff,
+              :diff => stack_diff,
+              :diff_info => {
+                :added => added_resources,
+                :modified => modified_resources,
+                :removed => removed_resources
+              },
+              :api_stack => stack,
+              :new_template => file
+            )
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/sfn/command_module/template.rb

@@ -233,6 +233,7 @@ module Sfn
             if(current_stack && current_stack.data[:parent_stack])
               current_parameters.merge!(current_stack.data[:parent_stack].template.fetch('Resources', stack_name, 'Properties', 'Parameters', Smash.new))
             end
+            full_stack_name = stack.root_path.map(&:name).map(&:to_s).join('_')
             unless(config[:print_only])
               result = Smash.new(
                 'Parameters' => populate_parameters!(stack,
@@ -247,7 +248,6 @@ module Sfn
               unless(bucket)
                 raise "Failed to locate configured bucket for stack template storage (#{bucket})!"
               end
-              full_stack_name = stack.root_path.map(&:name).map(&:to_s).join('_')
               file = bucket.files.build
               file.name = "#{full_stack_name}.json"
               file.content_type = 'text/json'

data/lib/sfn/config.rb

@@ -13,6 +13,7 @@ module Sfn
     autoload :Describe, 'sfn/config/describe'
     autoload :Destroy, 'sfn/config/destroy'
     autoload :Describe, 'sfn/config/describe'
+    autoload :Diff, 'sfn/config/diff'
     autoload :Events, 'sfn/config/events'
     autoload :Export, 'sfn/config/export'
     autoload :Import, 'sfn/config/import'

data/lib/sfn/config/diff.rb

@@ -0,0 +1,14 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # Diff new template with existing stack template
+    class Diff < Update
+      attribute(
+        :raw_diff, [TrueClass, FalseClass],
+        :default => false,
+        :description => 'Display raw diff information'
+      )
+    end
+  end
+end

data/lib/sfn/version.rb

@@ -1,4 +1,4 @@
 module Sfn
   # Current library version
-  VERSION = Gem::Version.new('1.1.2')
+  VERSION = Gem::Version.new('1.1.4')
 end

data/sfn.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'miasma-aws', '~> 0.1.16'
   s.add_dependency 'net-ssh'
   s.add_dependency 'sparkle_formation', '~> 1.1'
+  s.add_dependency 'hashdiff', '~> 0.2.2'
   s.executables << 'sfn'
   s.files = Dir['{lib,bin,docs}/**/*'] + %w(sfn.gemspec README.md CHANGELOG.md LICENSE)
   s.post_install_message = <<-EOF

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfn
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.4
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo-cli
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
 description: SparkleFormation CLI
 email: code@chrisroberts.org
 executables:
@@ -113,6 +127,7 @@ files:
 - lib/sfn/command/create.rb
 - lib/sfn/command/describe.rb
 - lib/sfn/command/destroy.rb
+- lib/sfn/command/diff.rb
 - lib/sfn/command/events.rb
 - lib/sfn/command/export.rb
 - lib/sfn/command/import.rb
@@ -131,6 +146,7 @@ files:
 - lib/sfn/config/create.rb
 - lib/sfn/config/describe.rb
 - lib/sfn/config/destroy.rb
+- lib/sfn/config/diff.rb
 - lib/sfn/config/events.rb
 - lib/sfn/config/export.rb
 - lib/sfn/config/import.rb