sfn 2.1.10 → 2.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be1b4ec736e954ea46336a4a6e3a957c8331a450
-  data.tar.gz: a62b4144c909edaeaa66e0c871ed6fe23e66934b
+  metadata.gz: 1998884aef2f32da686903df01d5dbcd702e134d
+  data.tar.gz: 2d4cd76d833eaf5db2e3d05d69e815546d092b9f
 SHA512:
-  metadata.gz: a8a4930dc3f88d29f9c277cd40037fbb8e7b8fae0f21efe709271bde0ec9afec7a968cf50aed21dd708488ba3a3a3883e6d2b66a048479ef90dce3100095ba59
-  data.tar.gz: 6ad2aba6a8d844eb5984e5c147a0ec0bc11bcd4f29838d72df2ea4dc96ad61d47a2acf594b9194953f68e2f18beeb0ed19e765ad45e65462bf9327e2fdafb454
+  metadata.gz: 6c7021222f98ebbf2587d876172d02ee49e20c5eca73be13862ccb332c1674c4be34031963a69ff9dcf6739e9497e0d0ae4b8b778911d0e1b9e3946c350352c3
+  data.tar.gz: 30fbcb41c8291f6e77231c4c372d3a85d32dae4280a733efae28f64ab79bb966dc881dc7b52e5d11ed9e72343f4958d573b6289b166639a9f2126f7d76f77fdb

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v2.1.12
+* [fix] Provide useful error message when nesting_bucket is unset (#159)
+* [fix] Properly locate templates when relative path provided (#160)
+* [enhancement] Support plan only output on update via `--plan-only` (#158)
+* [enhancement] Allow tag updates on stack updates via `--merge-api-options` (see: #154)
+* [fix] Add `DependsOn` support to graph generation
+* [enhancement] Provide "dependency" style graph option
+
 # v2.1.10
 * [fix] Prevent direct output key modification on graph mapping
 * [enhancement] Restrict graph colors to readable values

data/bin/sfn

@@ -41,7 +41,11 @@ Bogo::Cli::Setup.define do
             o[:delimiter] = nil
           end
         end
-        on info[:short], on_name, info[:description], opts
+        if(info[:short])
+          on info[:short], on_name, info[:description], opts
+        else
+          on on_name, info[:description], opts
+        end
       end
 
       run do |opts, args|

data/docs/commands.md

@@ -327,6 +327,27 @@ Example of stack diff:
 
 ![stack diff](./images/d_diff.png)
 
+#### Template graphs
+
+Creation or dependency graphs can be created via `sfn`. Two styles of the graph can be
+generated:
+
+* `"creation"` - Resource creation flow (default)
+* `"dependency"` - Resource dependency composition
+
+To generate a graph:
+
+~~~
+$ sfn graph --file my_template --graph-style dependency
+~~~
+
+By default the graph command will create a Graphviz compatible dot format file. If Graphviz
+is installed on the local system, an image can be generated directly:
+
+~~~
+$ sfn graph --file my_template --graph-type png
+~~~
+
 ### Configuration commands
 
 To aid setup and configuration, `sfn` provides a configuration helper:

data/docs/configuration.md

@@ -77,6 +77,10 @@ $ knife sparkleformation --help
 |                            | Valid         | `Hash`
 |                            | Default       | none
 |----------------------------|---------------|---------------------------------------------------------------
+| `merge_api_options`        | Description   | Merges API options on stack update
+|                            | Valid         | `TrueClass`, `FalseClass`
+|                            | Default       | `false`
+|----------------------------|---------------|---------------------------------------------------------------
 | `ssh_attempt_users`        | Description   | List of users to attempt SSH connection on node failure
 |                            | Valid         | `Array<String>`
 |                            | Default       | none

data/lib/sfn/command/graph.rb

@@ -10,16 +10,23 @@ module Sfn
       include Sfn::CommandModule::Template
       include Sfn::CommandModule::Stack
 
+      # Valid graph styles
+      GRAPH_STYLES = [
+        'creation',
+        'dependency'
+      ]
+
       # Generate graph
       def execute!
         config[:print_only] = true
+        validate_graph_style!
         file = load_template_file
         file.delete('sfn_nested_stack')
         file = Sfn::Utils::StackParameterScrubber.scrub!(file)
         file = translate_template(file)
         @outputs = Smash.new
         file = file.to_smash
-        ui.info 'Template resource graph generation'
+        ui.info "Template resource graph generation - Style: #{ui.color(config[:graph_style], :bold)}"
         if(config[:file])
           ui.puts "  -> path: #{config[:file]}"
         end
@@ -162,7 +169,11 @@ module Sfn
             if(resources.keys.include?(dep_name))
               dep_name = [node_prefix, dep_name].join
             end
-            @root_graph.edge(dep_name, node_name)
+            if(config[:graph_style] == 'creation')
+              @root_graph.edge(dep_name, node_name)
+            else
+              @root_graph.edge(node_name, dep_name)
+            end
           end
         end
         resource_names.concat resources.keys.map{|r_name| [node_prefix, r_name].join}
@@ -174,6 +185,10 @@ module Sfn
           data.map do |key, value|
             if(key == 'Ref' && names.include?(value))
               value
+            elsif(key == 'DependsOn')
+              [value].flatten.compact.find_all do |dependson_name|
+                names.include?(dependson_name)
+              end
             elsif(key == 'Fn::GetAtt' && names.include?(res = [value].flatten.compact.first))
               res
             else
@@ -211,6 +226,17 @@ module Sfn
         color
       end
 
+      def validate_graph_style!
+        if(config[:luckymike])
+          ui.warn 'Detected luckymike power override. Forcing `dependency` style!'
+          config[:graph_style] = 'dependency'
+        end
+        config[:graph_style] = config[:graph_style].to_s
+        unless(GRAPH_STYLES.include?(config[:graph_style]))
+          raise ArgumentError.new "Invalid graph style provided `#{config[:graph_style]}`. Valid: `#{GRAPH_STYLES.join('`, `')}`"
+        end
+      end
+
       class GraphProcessor < SparkleFormation::Translation
         MAP = {}
         REF_MAPPING = {}

data/lib/sfn/command/update.rb

@@ -99,30 +99,33 @@ module Sfn
                 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?'
+                  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.'
+                exit 0
+              end
             end
 
             stack.parameters = config_root_parameters
             stack.template = scrub_template(update_template)
           else
             apply_stacks!(stack)
-
             original_parameters = stack.parameters
             populate_parameters!(stack.template, :current_parameters => stack.parameters)
+            stack.parameters = config_root_parameters
+          end
 
-            if(config[:plan])
-              stack.parameters = original_parameters
-              plan = build_planner(stack)
-              if(plan)
-                result = plan.generate_plan(stack.template, config_root_parameters)
-                display_plan_information(result)
+          # Set options defined within config into stack instance for update request
+          if(config[:merge_api_options])
+            config.fetch(:options, Smash.new).each_pair do |key, value|
+              if(stack.respond_to?("#{key}="))
+                stack.send("#{key}=", value)
               end
             end
-            stack.parameters = config_root_parameters
           end
 
           begin
@@ -168,7 +171,7 @@ module Sfn
         unless(print_plan_result(result))
           ui.info 'No resources life cycle changes detected in this update!'
         end
-        ui.confirm 'Apply this stack update?'
+        ui.confirm 'Apply this stack update?' unless config[:plan_only]
       end
 
 

data/lib/sfn/command_module/template.rb

@@ -180,6 +180,7 @@ module Sfn
               end
               run_callbacks_for(:template, :stack_name => arguments.first, :sparkle_stack => sf)
               if(sf.nested? && config[:apply_nesting])
+                validate_nesting_bucket!
                 if(config[:apply_nesting] == true)
                   config[:apply_nesting] = :deep
                 end
@@ -206,6 +207,14 @@ module Sfn
           end
         end
 
+        # Force user friendly error if nesting bucket is not set within configuration
+        def validate_nesting_bucket!
+          if(config[:nesting_bucket].to_s.empty?)
+            ui.error 'Missing required configuration value for `nesting_bucket`. Cannot generated nested templates!'
+            raise ArgumentError.new 'Required configuration value for `nesting_bucket` not provided.'
+          end
+        end
+
         # Processes template using the original shallow workflow
         #
         # @param sf [SparkleFormation] stack formation
@@ -406,7 +415,13 @@ module Sfn
             if(!config[:file] && config[:file_path_prompt])
               config[:file] = prompt_for_template
             else
-              config[:file] = sparkle_collection.get(:template, config[:file])[:path]
+              file_lookup_path = File.expand_path(config[:file])
+              unless(File.exists?(file_lookup_path))
+                file_lookup_path = config[:file]
+              end
+              config[:file] = sparkle_collection.get(
+                :template, file_lookup_path
+              )[:path]
             end
           else
             if(config[:file])

data/lib/sfn/config.rb

@@ -142,8 +142,10 @@ module Sfn
           if(!short.to_s.empty? && shorts.include?(short))
             raise ArgumentError.new "Short flag already in use! (`#{short}` not available for `#{klass}`)"
           end
-          shorts << short
-          info[:short] = short
+          unless(short.to_s.empty?)
+            shorts << short
+            info[:short] = short
+          end
           info[:long] = name.tr('_', '-')
           info[:boolean] = [info[:type]].compact.flatten.all?{|t| BOOLEAN_VALUES.include?(t)}
           [name, info]

data/lib/sfn/config/graph.rb

@@ -19,6 +19,18 @@ module Sfn
         :default => 'dot'
       )
 
+      attribute(
+        :graph_style, String,
+        :description => 'Style of graph (`dependency`, `creation`)',
+        :default => 'creation'
+      )
+
+      attribute(
+        :luckymike, [TrueClass, FalseClass],
+        :description => 'Force `dependency` style graph',
+        :default => false
+      )
+
     end
   end
 end

data/lib/sfn/config/update.rb

@@ -40,11 +40,21 @@ module Sfn
         :description => 'Provide planning information prior to update',
         :short_flag => 'l'
       )
+      attribute(
+        :plan_only, [TrueClass, FalseClass],
+        :default => false,
+        :description => 'Exit after plan display'
+      )
       attribute(
         :diffs, [TrueClass, FalseClass],
         :description => 'Show planner content diff',
         :short_flag => 'D'
       )
+      attribute(
+        :merge_api_options, [TrueClass, FalseClass],
+        :description => 'Merge API options defined within configuration on update',
+        :default => false
+      )
 
     end
   end

data/lib/sfn/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfn
 version: !ruby/object:Gem::Version
-  version: 2.1.10
+  version: 2.1.12
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo-cli