sfn 2.1.2 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef688f38c0f0be5810c525cd37e77d5a4216756a
-  data.tar.gz: 1f3e4f9a893e376b9c7e77fda5f1e495e27df905
+  metadata.gz: 16cbb5ea90df094029c2f7cdbc83087652dc5807
+  data.tar.gz: a2646f89707aa719a18c5a3907501f4043dce02a
 SHA512:
-  metadata.gz: be3015b69f844371bff9588753a0cec1b9ca1dfb05cb957106583e62ed8a5a9b4284b052938ddb53ace50c8f85f0a73a4884b0131c2948a5d49693f41d3a88d7
-  data.tar.gz: ae268210135a9b5bbc406a1c7684a5e560f16548b21f2b29bd3c8164c66ffe0668c189f995a4c27f86797047f997c3ef3be12d809135b229f86cf3ac049b9225
+  metadata.gz: 4796f389bf2333281966e9ba04b03de4ffe47c76db4fbc552e6835379eec230ae89945c11057eb063dc4b2dd5d6ea947c5e073468bc5b3d195466fb88ab3f3f2
+  data.tar.gz: 1abc4ab0b61f2a24a32051f1cbb90573a43d8c7e865456b5eda19aa8d603ba7bc91cd304fe6e3bac44c7a1bd3ac36f9f089fdc1a33d9657fc243248ef8596527

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v2.1.4
+* [fix] Update environment variable name used for azure credentials (#135)
+* [fix] Cast all parameters to String types within planner (#137)
+* [fix] Properly support compile time parameters via CLI (#141)
+* [enhancement] Add diff output support to planner (#142)
+* [enhancement] Support writing template to file via `print` command (#139)
+
 # v2.1.2
 * [enhancement] Include parameter name on error output when failed to receive (#116)
 * [enhancement] Rescue planner errors and notify user. Allow update to proceed (#124)
@@ -6,6 +13,7 @@
 * [fix] Remove policy modification on stack delete within AWS (#127)
 * [feature] Support optional stack policy removal prior to update (#127)
 * [feature] Add built-in callback for AWS Assume Role credential caching (#128)
+* [feature] Add load balancer specific inspection (#129)
 
 # v2.1.0
 * [fix] Use SparkleFormation::Collection helper to ensure proper pack ordering (#115)

data/docs/usage.md

@@ -92,7 +92,7 @@ end
 
 The default nesting functionality is `"deep"`. To learn more about
 the nesting functionality please refer to the [SparkleFormation nested
-stacks][nested-stacks] documentation.
+stacks][nested_stacks] documentation.
 
 When using nested stacks, a bucket is required for storage of the
 nested stack templates. `sfn` will automatically store nested templates
@@ -132,5 +132,6 @@ $ sfn inspect my-stack --attribute 'resources.all.at(0).expand.addresses'
 
 [knife]: https://docs.chef.io/knife.html
 [sparkle_formation]: https://github.com/sparkleformation/sparkle_formation
+[nested_stacks]: http://www.sparkleformation.io/docs/sparkle_formation/nested-stacks.html
 [sparkle_packs]: https://sparkleformation.github.io/sparkle_formation/UserDocs/sparkle-packs.html
 [miasma]: https://github.com/miasma-rb/miasma

data/lib/sfn/command/conf.rb

@@ -97,7 +97,7 @@ Configuration.new do
     azure_tenant_id ENV['AZURE_TENANT_ID']
     azure_client_id ENV['AZURE_CLIENT_ID']
     azure_subscription_id ENV['AZURE_SUBSCRIPTION_ID']
-    azure_client_secret ENV['AZURE_CLIENT_ID']
+    azure_client_secret ENV['AZURE_CLIENT_SECRET']
     azure_region ENV['AZURE_REGION']
     azure_blob_account_name ENV['AZURE_BLOB_ACCOUNT_NAME']
     azure_blob_secret_key ENV['AZURE_BLOB_SECRET_KEY']

data/lib/sfn/command/print.rb

@@ -17,7 +17,21 @@ module Sfn
         file = Sfn::Utils::StackParameterScrubber.scrub!(file)
         file = translate_template(file)
 
-        ui.puts _format_json(file)
+        json_content = _format_json(file)
+        if(config[:write_to_file])
+          unless(File.directory?(File.dirname(config[:write_to_file])))
+            run_action 'Creating parent directory' do
+              FileUtils.mkdir_p(File.dirname(config[:write_to_file]))
+              nil
+            end
+          end
+          run_action "Writing template to file - #{config[:write_to_file]}" do
+            File.write(config[:write_to_file], json_content)
+            nil
+          end
+        else
+          ui.puts json_content
+        end
       end
 
     end

data/lib/sfn/command/update.rb

@@ -96,9 +96,13 @@ module Sfn
                   display_plan_information(result)
                 end
               rescue => e
-                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(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?'
+                else
+                  raise
+                end
               end
             end
 
@@ -234,6 +238,8 @@ module Sfn
       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)
@@ -246,6 +252,27 @@ module Sfn
             ui.print "Reason: Updated properties: `#{val[:properties].join('`, `')}`"
           end
           ui.puts
+          if(config[:diffs])
+            unless(val[:diffs].empty?)
+              val[:diffs].each do |diff|
+                if(diff[:updated] && diff[:original])
+                  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)
+                  ui.print ' ' * (max_o - diff[:original].size)
+                  ui.print ' '
+                  if(diff[:updated] == Sfn::Planner::RUNTIME_MODIFIED)
+                    ui.puts ui.color("+#{diff[:original]} <Dependency Modified>", :green)
+                  else
+                    ui.puts ui.color("+#{diff[:updated]}", :green)
+                  end
+                end
+              end
+              ui.puts
+            end
+          end
         end
       end
 

data/lib/sfn/command_module/template.rb

@@ -145,8 +145,19 @@ module Sfn
               sf.compile_time_parameter_setter do |formation|
                 f_name = formation.root_path.map(&:name).map(&:to_s)
                 pathed_name = f_name.join(' > ')
-                f_name = f_name.join('_')
-                current_state = compile_state.fetch(f_name, Smash.new)
+                f_name = f_name.join('__')
+                current_state = compile_state[f_name]
+                unless(current_state)
+                  f_name = f_name.split('__')
+                  f_name.shift
+                  f_name = f_name.join('__')
+                  current_state = f_name.empty? ? compile_state : compile_state[f_name]
+                end
+                if(formation.root? && compile_state[f_name].nil?)
+                  current_state = compile_state
+                else
+                  current_state = compile_state.fetch(f_name, Smash.new)
+                end
                 if(formation.compile_state)
                   current_state = current_state.merge(formation.compile_state)
                 end

data/lib/sfn/config/print.rb

@@ -5,6 +5,12 @@ module Sfn
     # Print command configurationUpdate command configuration
     class Print < Validate
 
+      attribute(
+        :write_to_file, String,
+        :description => 'Write compiled SparkleFormation template to path provided',
+        :short_flag => 'w'
+      )
+
     end
   end
 end

data/lib/sfn/config/update.rb

@@ -41,9 +41,9 @@ module Sfn
         :short_flag => 'l'
       )
       attribute(
-        :compile_parameters, Smash,
-        :description => 'Pass template compile time parameters directly',
-        :short_flag => 'o'
+        :diffs, [TrueClass, FalseClass],
+        :description => 'Show planner content diff',
+        :short_flag => 'D'
       )
 
     end

data/lib/sfn/config/validate.rb

@@ -72,6 +72,28 @@ module Sfn
         :coerce => lambda{|s| s.to_s},
         :short_flag => 's'
       )
+      attribute(
+        :compile_parameters, Smash,
+        :description => 'Pass template compile time parameters directly',
+        :short_flag => 'o',
+        :coerce => lambda{|v|
+          case v
+          when String
+            result = Smash.new
+            v.split(',').each do |item_pair|
+              key, value = item_pair.split(/[=:]/, 2)
+              key = key.split('__')
+              key = [key.pop, key.map{|x| Bogo::Utility.camel(x)}.join('__')].reverse
+              result.set(*key, value)
+            end
+            result
+          when Hash
+            v.to_smash
+          else
+            v
+          end
+        }
+      )
 
     end
   end

data/lib/sfn/planner.rb

@@ -6,6 +6,9 @@ module Sfn
 
     autoload :Aws, 'sfn/planner/aws'
 
+    # Value to flag runtime modification
+    RUNTIME_MODIFIED = '__MODIFIED_REFERENCE_VALUE__'
+
     # @return [Bogo::Ui]
     attr_reader :ui
     # @return [Smash]

data/lib/sfn/planner/aws.rb

@@ -90,14 +90,14 @@ module Sfn
           result = nil
           if(hash.is_a?(Hash))
             if(hash.keys.first == 'Ref' && flagged?(hash.values.first))
-              result = '__MODIFIED_REFERENCE_VALUE__'
+              result = RUNTIME_MODIFIED
             elsif(hash.keys.first == 'Fn::GetAtt')
               if(hash.values.last.last.start_with?('Outputs.'))
                 if(flagged?(hash.values.join('_')))
-                  result = '__MODIFIED_REFERENCE_VALUE__'
+                  result = RUNTIME_MODIFIED
                 end
               elsif(flagged?(hash.values.first))
-                result = '__MODIFIED_REFERENCE_VALUE__'
+                result = RUNTIME_MODIFIED
               end
             end
           end
@@ -129,6 +129,7 @@ module Sfn
       #
       # @return [Hash] report
       def generate_plan(template, parameters)
+        parameters = Smash[parameters.map{|k,v| [k, v.to_s]}]
         Smash.new(
           :stacks => Smash.new(
             origin_stack.name => plan_stack(
@@ -185,7 +186,7 @@ module Sfn
         origin_template = dereference_template(
           "#{stack.data.checksum}_origin",
           stack.template,
-          stack.parameters.merge(get_global_parameters(stack))
+          Smash[stack.parameters.map{|k,v| [k, v.to_s]}].merge(get_global_parameters(stack))
         )
 
         t_key = "#{stack.data.checksum}_#{stack.data.fetch(:logical_id, stack.name)}"
@@ -319,6 +320,23 @@ module Sfn
       # @option :templates [Hash] :origin
       # @option :templates [Hash] :update
       def register_diff(results, path, diff, translator, templates)
+        diff_info = Smash.new.tap do |di|
+          if(diff.size > 1)
+            updated = diff.detect{|x| x.first == '+'}
+            original = diff.detect{|x| x.first == '-'}
+            di[:original] = original.last.to_s
+            di[:updated] = updated.last.to_s
+          else
+            diff_data = diff.first
+            di[:path] = path
+            if(diff_data.size == 3)
+              di[diff_data.first == '+' ? :updated : :original] = diff_data.last
+            else
+              di[:original] = diff_data[diff_data.size - 2].to_s
+              di[:updated] = diff_data.last.to_s
+            end
+          end
+        end
         if(path.start_with?('Resources'))
           p_path = path.split('.')
           if(p_path.size == 2)
@@ -328,7 +346,10 @@ module Sfn
             results[key][p_path.last] = Smash.new(
               :name => p_path.last,
               :type => type,
-              :properties => []
+              :properties => [],
+              :diffs => [
+                diff_info
+              ]
             )
           else
             if(p_path.include?('Properties'))
@@ -340,7 +361,10 @@ module Sfn
               resource = Smash.new(
                 :name => resource_name,
                 :type => type,
-                :properties => [property_name]
+                :properties => [property_name],
+                :diffs => [
+                  diff_info.merge(:property_name => property_name)
+                ]
               )
               case effect
               when :replacement
@@ -362,7 +386,10 @@ module Sfn
                   Smash.new(
                     :name => resource_name,
                     :type => type,
-                    :properties => ['AWS::CloudFormation::Init']
+                    :properties => ['AWS::CloudFormation::Init'],
+                    :diffs => [
+                      diff_info
+                    ]
                   )
                 )
               end
@@ -373,7 +400,10 @@ module Sfn
           if(o_resource_name)
             set_resource(
               :outputs, results, o_resource_name,
-              :properties => []
+              :properties => [],
+              :diffs => [
+                diff_info
+              ]
             )
           end
         end
@@ -389,6 +419,8 @@ module Sfn
         if(results[kind][name])
           results[kind][name][:properties] += resource[:properties]
           results[kind][name][:properties].uniq!
+          results[kind][name][:diffs] += resource[:diffs]
+          results[kind][name][:diffs].uniq!
         else
           results[kind][name] = resource
         end

data/lib/sfn/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfn
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.4
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo-cli