sfn 3.0.30 → 3.0.32

data/lib/sfn/command/print.rb

@@ -1,5 +1,5 @@
-require 'sparkle_formation'
-require 'sfn'
+require "sparkle_formation"
+require "sfn"
 
 module Sfn
   class Command
@@ -16,7 +16,7 @@ module Sfn
 
         output_content = parameter_scrub!(template_content(file))
         if config[:yaml]
-          require 'yaml'
+          require "yaml"
           output_content = YAML.dump(output_content)
         else
           output_content = format_json(output_content)
@@ -24,7 +24,7 @@ module Sfn
 
         if config[:write_to_file]
           unless File.directory?(File.dirname(config[:write_to_file]))
-            run_action 'Creating parent directory' do
+            run_action "Creating parent directory" do
               FileUtils.mkdir_p(File.dirname(config[:write_to_file]))
               nil
             end

data/lib/sfn/command/promote.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Command
@@ -7,7 +7,7 @@ module Sfn
       include Sfn::CommandModule::Base
 
       def execute!
-        raise NotImplementedError.new 'Implementation updates required'
+        raise NotImplementedError.new "Implementation updates required"
         stack_name, destination = name_args
       end
     end

data/lib/sfn/command/update.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Command
@@ -7,13 +7,14 @@ module Sfn
       include Sfn::CommandModule::Base
       include Sfn::CommandModule::Template
       include Sfn::CommandModule::Stack
+      include Sfn::CommandModule::Planning
 
-      # Run the stack creation command
+      # Run the stack update command
       def execute!
         name_required!
         name = name_args.first
 
-        stack_info = "#{ui.color('Name:', :bold)} #{name}"
+        stack_info = "#{ui.color("Name:", :bold)} #{name}"
         begin
           stack = provider.stacks.get(name)
         rescue Miasma::Error::ApiError::RequestError
@@ -28,13 +29,13 @@ module Sfn
           c_setter = lambda do |c_stack|
             if c_stack.outputs
               compile_params = c_stack.outputs.detect do |output|
-                output.key == 'CompileState'
+                output.key == "CompileState"
               end
             end
             if compile_params
               compile_params = MultiJson.load(compile_params.value)
-              c_current = config[:compile_parameters].fetch(s_name.join('__'), Smash.new)
-              config[:compile_parameters][s_name.join('__')] = compile_params.merge(c_current)
+              c_current = config[:compile_parameters].fetch(s_name.join("__"), Smash.new)
+              config[:compile_parameters][s_name.join("__")] = compile_params.merge(c_current)
             end
             c_stack.nested_stacks(false).each do |n_stack|
               s_name.push(n_stack.data.fetch(:logical_id, n_stack.name))
@@ -49,7 +50,7 @@ module Sfn
 
           ui.debug "Compile parameters - #{config[:compile_parameters]}"
           file = load_template_file(:stack => stack)
-          stack_info << " #{ui.color('Path:', :bold)} #{config[:file]}"
+          stack_info << " #{ui.color("Path:", :bold)} #{config[:file]}"
         else
           file = stack.template.dup if config[:plan]
         end
@@ -60,15 +61,15 @@ module Sfn
         end
 
         unless config[:print_only]
-          ui.info "#{ui.color('SparkleFormation:', :bold)} #{ui.color('update', :green)}"
+          ui.info "#{ui.color("SparkleFormation:", :bold)} #{ui.color("update", :green)}"
         end
 
         unless file
           if config[:template]
             file = config[:template]
-            stack_info << " #{ui.color('(template provided)', :green)}"
+            stack_info << " #{ui.color("(template provided)", :green)}"
           else
-            stack_info << " #{ui.color('(no template update)', :yellow)}"
+            stack_info << " #{ui.color("(no template update)", :yellow)}"
           end
         end
         unless config[:print_only]
@@ -101,16 +102,16 @@ module Sfn
                 display_plan_information(result)
               end
             rescue => e
-              unless e.message.include?('Confirmation declined')
+              unless e.message.include?("Confirmation declined")
                 ui.error "Unexpected error when generating plan information: #{e.class} - #{e}"
                 ui.debug "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
-                ui.confirm 'Continue with stack update?' unless config[:plan_only]
+                ui.confirm "Continue with stack update?" unless config[:plan_only]
               else
                 raise
               end
             end
             if config[:plan_only]
-              ui.info 'Plan only mode requested. Exiting.'
+              ui.info "Plan only mode requested. Exiting."
               exit 0
             end
           end
@@ -144,151 +145,25 @@ module Sfn
             if config[:poll]
               poll_stack(stack.name)
               if stack.reload.state == :update_complete
-                ui.info "Stack update complete: #{ui.color('SUCCESS', :green)}"
+                ui.info "Stack update complete: #{ui.color("SUCCESS", :green)}"
                 namespace.const_get(:Describe).new({:outputs => true}, [name]).execute!
               else
-                ui.fatal "Update of stack #{ui.color(name, :bold)}: #{ui.color('FAILED', :red, :bold)}"
-                raise 'Stack did not reach a successful update completion state.'
+                ui.fatal "Update of stack #{ui.color(name, :bold)}: #{ui.color("FAILED", :red, :bold)}"
+                raise "Stack did not reach a successful update completion state."
               end
             else
-              ui.warn 'Stack state polling has been disabled.'
+              ui.warn "Stack state polling has been disabled."
               ui.info "Stack update initialized for #{ui.color(name, :green)}"
             end
           end
         rescue Miasma::Error::ApiError::RequestError => e
-          if e.message.downcase.include?('no updates')
+          if e.message.downcase.include?("no updates")
             ui.warn "No updates detected for stack (#{stack.name})"
           else
             raise
           end
         end
       end
-
-      def build_planner(stack)
-        klass_name = stack.api.class.to_s.split('::').last
-        if Planner.const_defined?(klass_name)
-          Planner.const_get(klass_name).new(ui, config, arguments, stack)
-        else
-          warn "Failed to build planner for current provider. No provider implemented. (`#{klass_name}`)"
-          nil
-        end
-      end
-
-      def display_plan_information(result)
-        ui.info ui.color('Pre-update resource planning report:', :bold)
-        unless print_plan_result(result)
-          ui.info 'No resources life cycle changes detected in this update!'
-        end
-        ui.confirm 'Apply this stack update?' unless config[:plan_only]
-      end
-
-      def print_plan_result(info, names = [])
-        said_any_things = false
-        unless info[:stacks].empty?
-          info[:stacks].each do |s_name, s_info|
-            result = print_plan_result(s_info, [*names, s_name].compact)
-            said_any_things ||= result
-          end
-        end
-        unless names.flatten.compact.empty?
-          said_things = false
-          ui.puts
-          ui.puts "  #{ui.color('Update plan for:', :bold)} #{ui.color(names.join(' > '), :blue)}"
-          unless info[:unknown].empty?
-            ui.puts "    #{ui.color('!!! Unknown update effect:', :red, :bold)}"
-            print_plan_items(info, :unknown, :red)
-            ui.puts
-            said_any_things = said_things = true
-          end
-          unless info[:unavailable].empty?
-            ui.puts "    #{ui.color('Update request not allowed:', :red, :bold)}"
-            print_plan_items(info, :unavailable, :red)
-            ui.puts
-            said_any_things = said_things = true
-          end
-          unless info[:replace].empty?
-            ui.puts "    #{ui.color('Resources to be replaced:', :red, :bold)}"
-            print_plan_items(info, :replace, :red)
-            ui.puts
-            said_any_things = said_things = true
-          end
-          unless info[:interrupt].empty?
-            ui.puts "    #{ui.color('Resources to be interrupted:', :yellow, :bold)}"
-            print_plan_items(info, :interrupt, :yellow)
-            ui.puts
-            said_any_things = said_things = true
-          end
-          unless info[:removed].empty?
-            ui.puts "    #{ui.color('Resources to be removed:', :red, :bold)}"
-            print_plan_items(info, :removed, :red)
-            ui.puts
-            said_any_things = said_things = true
-          end
-          unless info[:added].empty?
-            ui.puts "    #{ui.color('Resources to be added:', :green, :bold)}"
-            print_plan_items(info, :added, :green)
-            ui.puts
-            said_any_things = said_things = true
-          end
-          unless said_things
-            ui.puts "    #{ui.color('No resource lifecycle changes detected!', :green)}"
-            ui.puts
-            said_any_things = true
-          end
-        end
-        said_any_things
-      end
-
-      # Print planning items
-      #
-      # @param info [Hash] plan
-      # @param key [Symbol] key of items
-      # @param color [Symbol] color to flag
-      def print_plan_items(info, key, color)
-        max_name = info[key].keys.map(&:size).max
-        max_type = info[key].values.map { |i| i[:type] }.map(&:size).max
-        max_p = info[key].values.map { |i| i.fetch(:diffs, []) }.flatten(1).map { |d| d.fetch(:property_name, :path).to_s.size }.max
-        max_o = info[key].values.map { |i| i.fetch(:diffs, []) }.flatten(1).map { |d| d[:original].to_s.size }.max
-        info[key].each do |name, val|
-          ui.print ' ' * 6
-          ui.print ui.color("[#{val[:type]}]", color)
-          ui.print ' ' * (max_type - val[:type].size)
-          ui.print ' ' * 4
-          ui.print ui.color(name, :bold)
-          unless val[:properties].nil? || val[:properties].empty?
-            ui.print ' ' * (max_name - name.size)
-            ui.print ' ' * 4
-            ui.print "Reason: Updated properties: `#{val[:properties].join('`, `')}`"
-          end
-          ui.puts
-          if config[:diffs]
-            unless val[:diffs].empty?
-              p_name = nil
-              val[:diffs].each do |diff|
-                if !diff[:updated].nil? || !diff[:original].nil?
-                  p_name = diff.fetch(:property_name, :path)
-                  ui.print ' ' * 8
-                  ui.print "#{p_name}: "
-                  ui.print ' ' * (max_p - p_name.size)
-                  ui.print ui.color("-#{diff[:original]}", :red) unless diff[:original].nil?
-                  ui.print ' ' * (max_o - diff[:original].to_s.size)
-                  ui.print ' '
-                  if diff[:updated] == Sfn::Planner::RUNTIME_MODIFIED
-                    ui.puts ui.color("+#{diff[:original]} <Dependency Modified>", :green)
-                  else
-                    if diff[:updated].nil?
-                      ui.puts
-                    else
-                      ui.puts ui.color("+#{diff[:updated].to_s.gsub('__MODIFIED_REFERENCE_VALUE__', '<Dependency Modified>')}", :green)
-                    end
-                  end
-                end
-              end
-              ui.puts if p_name
-            end
-          end
-        end
-      end
     end
   end
 end

data/lib/sfn/command/validate.rb

@@ -1,5 +1,5 @@
-require 'sparkle_formation'
-require 'sfn'
+require "sparkle_formation"
+require "sfn"
 
 module Sfn
   class Command
@@ -13,7 +13,7 @@ module Sfn
         print_only_original = config[:print_only]
         config[:print_only] = true
         file = load_template_file
-        ui.info "#{ui.color("Template Validation (#{provider.connection.provider}): ", :bold)} #{config[:file].sub(Dir.pwd, '').sub(%r{^/}, '')}"
+        ui.info "#{ui.color("Template Validation (#{provider.connection.provider}): ", :bold)} #{config[:file].sub(Dir.pwd, "").sub(%r{^/}, "")}"
         config[:print_only] = print_only_original
 
         raw_template = _format_json(parameter_scrub!(template_content(file)))
@@ -23,7 +23,11 @@ module Sfn
         else
           validate_stack(
             file.respond_to?(:dump) ? file.dump : file,
-            sparkle_collection.get(:template, config[:file])[:name]
+            if config[:processing]
+              sparkle_collection.get(:template, config[:file])[:name]
+            else
+              config[:file]
+            end
           )
         end
       end
@@ -34,36 +38,36 @@ module Sfn
       # @param name [String] name of template
       # @return [TrueClass]
       def validate_stack(template, name)
-        resources = template.fetch('Resources', {})
+        resources = template.fetch("Resources", {})
         nested_stacks = resources.find_all do |r_name, r_value|
           r_value.is_a?(Hash) &&
-            provider.connection.data[:stack_types].include?(r_value['Type'])
+            provider.connection.data[:stack_types].include?(r_value["Type"])
         end
         nested_stacks.each do |n_name, n_resource|
-          validate_stack(n_resource.fetch('Properties', {}).fetch('Stack', {}), "#{name} > #{n_name}")
-          n_resource['Properties'].delete('Stack')
+          validate_stack(n_resource.fetch("Properties", {}).fetch("Stack", {}), "#{name} > #{n_name}")
+          n_resource["Properties"].delete("Stack")
         end
         begin
           ui.info "Validating: #{ui.color(name, :bold)}"
           if config[:upload_root_template]
-            upload_result = store_template('validation-stack', template, Smash.new)
+            upload_result = store_template("validation-stack", template, Smash.new)
             stack = provider.connection.stacks.build(
-              :name => 'validation-stack',
+              :name => "validation-stack",
               :template_url => upload_result[:url],
             )
           else
             stack = provider.connection.stacks.build(
-              :name => 'validation-stack',
+              :name => "validation-stack",
               :template => parameter_scrub!(template),
             )
           end
           result = api_action!(:api_stack => stack) do
             stack.validate
           end
-          ui.info ui.color('  -> VALID', :bold, :green)
+          ui.info ui.color("  -> VALID", :bold, :green)
           true
         rescue => e
-          ui.info ui.color('  -> INVALID', :bold, :red)
+          ui.info ui.color("  -> INVALID", :bold, :red)
           ui.fatal e.message
           raise e
         end

data/lib/sfn/command_module.rb

@@ -1,10 +1,11 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   module CommandModule
-    autoload :Base, 'sfn/command_module/base'
-    autoload :Callbacks, 'sfn/command_module/callbacks'
-    autoload :Stack, 'sfn/command_module/stack'
-    autoload :Template, 'sfn/command_module/template'
+    autoload :Base, "sfn/command_module/base"
+    autoload :Callbacks, "sfn/command_module/callbacks"
+    autoload :Planning, "sfn/command_module/planning"
+    autoload :Stack, "sfn/command_module/stack"
+    autoload :Template, "sfn/command_module/template"
   end
 end

data/lib/sfn/command_module/base.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   module CommandModule
@@ -23,7 +23,7 @@ module Sfn
         # @param location [Symbol, String] name of location
         # @return [Sfn::Provider]
         def provider_for(location = nil)
-          key = ['provider', location].compact.map(&:to_s).join('_')
+          key = ["provider", location].compact.map(&:to_s).join("_")
           if location
             credentials = config.get(:locations, location)
             unless credentials
@@ -55,7 +55,7 @@ module Sfn
               result
             end
           rescue => e
-            ui.error 'Failed to create remote API connection. Please validate configuration!'
+            ui.error "Failed to create remote API connection. Please validate configuration!"
             ui.error "Connection failure reason - #{e.class} - #{e}"
             raise
           end
@@ -70,7 +70,7 @@ module Sfn
         def _debug(e, *args)
           if config[:verbose] || config[:debug]
             ui.fatal "Exception information: #{e.class}: #{e.message}"
-            if ENV['DEBUG'] || config[:debug]
+            if ENV["DEBUG"] || config[:debug]
               puts "#{e.backtrace.join("\n")}\n"
               if e.is_a?(Miasma::Error::ApiError)
                 ui.fatal "Response body: #{e.response.body.to_s.inspect}"
@@ -87,7 +87,7 @@ module Sfn
         # @param string [String, Symbol]
         # @return [String
         def as_title(string)
-          string.to_s.split('_').map(&:capitalize).join(' ')
+          string.to_s.split("_").map(&:capitalize).join(" ")
         end
 
         # Get stack
@@ -137,7 +137,7 @@ module Sfn
           begin
             yield
           rescue => e
-            ui.fatal "#{message || 'Failed to retrieve information'}#{" for requested stack: #{stack}" if stack}"
+            ui.fatal "#{message || "Failed to retrieve information"}#{" for requested stack: #{stack}" if stack}"
             ui.fatal "Reason: #{e}"
             _debug(e)
             exit 1
@@ -172,8 +172,8 @@ module Sfn
         # @raise [ArgumentError]
         def name_required!
           if name_args.empty?
-            ui.error 'Name argument must be provided!'
-            raise ArgumentError.new 'Missing required name argument'
+            ui.error "Name argument must be provided!"
+            raise ArgumentError.new "Missing required name argument"
           end
         end
       end

data/lib/sfn/command_module/callbacks.rb

@@ -1,5 +1,5 @@
-require 'sfn'
-require 'sparkle_formation'
+require "sfn"
+require "sparkle_formation"
 
 module Sfn
   module CommandModule
@@ -13,7 +13,7 @@ module Sfn
       # @yieldresult [Object] result from call
       # @return [Object] result of yield block
       def api_action!(*args)
-        type = self.class.name.split('::').last.downcase
+        type = self.class.name.split("::").last.downcase
         run_callbacks_for(["before_#{type}", :before], *args)
         result = nil
         begin
@@ -38,13 +38,13 @@ module Sfn
         end.flatten(1).compact.uniq.each do |item|
           callback_name, callback, quiet = item
           quiet = true if config[:print_only]
-          ui.info "Callback #{ui.color(type.to_s, :bold)} #{callback_name}: #{ui.color('starting', :yellow)}" unless quiet
+          ui.info "Callback #{ui.color(type.to_s, :bold)} #{callback_name}: #{ui.color("starting", :yellow)}" unless quiet
           if args.empty?
             callback.call
           else
             callback.call(*args)
           end
-          ui.info "Callback #{ui.color(type.to_s, :bold)} #{callback_name}: #{ui.color('complete', :green)}" unless quiet
+          ui.info "Callback #{ui.color(type.to_s, :bold)} #{callback_name}: #{ui.color("complete", :green)}" unless quiet
         end
         nil
       end