sfn 3.0.4 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5dbbdec8d298bd67a3aefc4165d871d263619df
-  data.tar.gz: 5170f01c227cf78fd58342c21487fa4d6793fecb
+  metadata.gz: e3df819d62b28c079cec72e3d62adb265a83f854
+  data.tar.gz: 49e78edc88c14d463e4bd68e1cacb60acf50680d
 SHA512:
-  metadata.gz: 00763fc81a15a13447d6b1f72088b2231801d44512445c2e4046f4b0df1ccfd48018183a3f6e6581c237cb093cf8b9a8f0ba3292788add746de39fd9c07b0a55
-  data.tar.gz: 05238e596ac34dec5ccada596e7cfae2251af646600a44c3e0a20af94892664771251376035f0bba56b09826022b27b8f7acd313c2c0bcc7e5543c5e36dc828d
+  metadata.gz: 33d2a858b98d1892197885c934830ef146f44e27a48303a3aa29b1b2ca5a6a46b1db3afcf2737d48d49ac5bc65f0a1bc0b96a62008c3382b48391ae2571db217
+  data.tar.gz: f4662e9cc07cbc33464455e57987903b0bfdf054021d705d0ae1b538b8d56ab4833af0155e67cd2a7ea9e7feafbe9f71fae34bb6dd1343e965f4b54d61d112da

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v3.0.6
+* [fix] Cast all value types to String within AWS planner (#194)
+* [fix] Fix template names on create/update prompting (#197)
+* [enhancement] Extend validation support for compile time parameters (#199)
+* [enhancement] Add parameter validation control on stack updates (#198)
+* [feature] Support remote locations when using apply stack (#196)
+
 # v3.0.4
 * [fix] Update parameter values extraction location in planner
 * [fix] Merge compile time parameters when existing are available

data/docs/command-config.md

@@ -109,6 +109,9 @@ $ sfn conf
 | `--parameter` | Description | [DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue) |
 | | Valid | `Bogo::Smash` |
 | | Default | |
+| `--parameter-validation` | Description | Stack parameter validation behavior |
+| | Valid | `String` |
+| | Default | "default"|
 | `--parameters` | Description | Pass template parameters directly (Key:Value[,Key:Value,...]) |
 | | Valid | `Bogo::Smash` |
 | | Default | |
@@ -220,6 +223,9 @@ $ sfn create
 | `--parameter` | Description | [DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue) |
 | | Valid | `Bogo::Smash` |
 | | Default | |
+| `--parameter-validation` | Description | Stack parameter validation behavior |
+| | Valid | `String` |
+| | Default | "default"|
 | `--parameters` | Description | Pass template parameters directly (Key:Value[,Key:Value,...]) |
 | | Valid | `Bogo::Smash` |
 | | Default | |
@@ -433,6 +439,9 @@ $ sfn diff
 | `--parameter` | Description | [DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue) |
 | | Valid | `Bogo::Smash` |
 | | Default | |
+| `--parameter-validation` | Description | Stack parameter validation behavior |
+| | Valid | `String` |
+| | Default | "default"|
 | `--parameters` | Description | Pass template parameters directly (Key:Value[,Key:Value,...]) |
 | | Valid | `Bogo::Smash` |
 | | Default | |
@@ -1165,6 +1174,9 @@ $ sfn update
 | `--parameter` | Description | [DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue) |
 | | Valid | `Bogo::Smash` |
 | | Default | |
+| `--parameter-validation` | Description | Stack parameter validation behavior |
+| | Valid | `String` |
+| | Default | "default"|
 | `--parameters` | Description | Pass template parameters directly (Key:Value[,Key:Value,...]) |
 | | Valid | `Bogo::Smash` |
 | | Default | |

data/docs/commands.md

@@ -1,5 +1,5 @@
 ---
-title: "Commands"
+title: "CLI Commands"
 weight: 4
 anchors:
   - title: "Lifecycle commands"
@@ -53,6 +53,8 @@ status code. The automatic polling behavior can be disabled:
 $ sfn create my-stack --file my_template --no-poll
 ~~~
 
+##### Apply stack
+
 The `--apply-stack` option allows providing the name of an existing
 stack when creating or updating. Applying stacks is simply fetching
 the outputs from the applied stacks and automatically defaulting the
@@ -103,6 +105,42 @@ when prompted for the stack parameters, we will find the parameter
 value for `LoadBalancerAddress` to be filled in with the output
 provided from StackA.
 
+##### Remote location apply stack
+
+Stacks that are defined in a different region, or within a
+different provider, can be applied by prefixing stack names with
+the configured location name. Using the defined `.sfn` configuration:
+
+~~~ruby
+Configuration.new do
+  ...
+  credentials do
+    provider :aws
+    aws_access_key_id ENV['AWS_ACCESS_KEY_ID']
+    aws_secret_access_key ENV['AWS_SECRET_ACCESS_KEY']
+    aws_region 'us-west-2'
+  end
+  locations do
+    ca_west do
+      provider :aws
+      aws_access_key_id ENV['AWS_ACCESS_KEY_ID']
+      aws_secret_access_key ENV['AWS_SECRET_ACCESS_KEY']
+      aws_region 'us-west-1'
+    end
+  end
+end
+~~~
+
+Now, when creating a new stack (which uses the configured credentials
+targeting `us-west-2`) a stack from the `us-west-1` region can be applied
+by prefixing the location name to the stack name:
+
+~~~
+$ sfn create StackB --apply-stack ca_west__StackA
+~~~
+
+_NOTE: Location providers are not required to be common._
+
 Example of stack creation:
 
 ![stack create](./images/d_create.png)

data/lib/sfn/command_module/base.rb

@@ -18,12 +18,24 @@ module Sfn
           [config.fetch(:stack_types, [])].flatten.compact
         end
 
-        # @return [KnifeCloudformation::Provider]
-        def provider
+        # Build provider connection for given location
+        #
+        # @param location [Symbol, String] name of location
+        # @return [Sfn::Provider]
+        def provider_for(location=nil)
+          key = ['provider', location].compact.map(&:to_s).join('_')
+          if(location)
+            credentials = config.get(:locations, location)
+            unless(credentials)
+              raise ArgumentError.new "Failed to locate provider credentials for location `#{location}`!"
+            end
+          else
+            credentials = config[:credentials]
+          end
           begin
-            memoize(:provider) do
+            memoize(key) do
               result = Sfn::Provider.new(
-                :miasma => config[:credentials],
+                :miasma => credentials,
                 :async => false,
                 :fetch => false
               )
@@ -38,17 +50,21 @@ module Sfn
                 config.fetch(:retries, {})
               )
               result.connection.data[:retry_ui] = ui
+              result.connection.data[:location] = location.to_s
               result.connection.data[:locations] = config.fetch(:locations, {})
               result.connection.data[:retry_type] = retry_config.fetch(:type, :exponential)
               result.connection.data[:retry_interval] = retry_config.fetch(:interval, 5)
               result.connection.data[:retry_max] = retry_config.fetch(:max_attempts, 20)
               result
             end
-          rescue
+          rescue => e
             ui.error 'Failed to create remote API connection. Please validate configuration!'
+            ui.error "Connection failure reason - #{e.class} - #{e}"
             raise
           end
         end
+        alias_method :provider, :provider_for
+
 
         # Write exception information if debug is enabled
         #

data/lib/sfn/command_module/stack.rb

@@ -22,7 +22,10 @@ module Sfn
         def apply_stacks!(stack)
           remote_stacks = [config[:apply_stack]].flatten.compact
           remote_stacks.each do |stack_name|
-            remote_stack = provider.stack(stack_name)
+            stack_info = stack_name.split('__')
+            stack_info.shift(nil) if stack_info.size == 1
+            stack_location, stack_name = stack_info
+            remote_stack = provider_for(stack_location).stack(stack_name)
             if(remote_stack)
               apply_nested_stacks!(remote_stack, stack)
               mappings = generate_custom_apply_mappings(remote_stack)
@@ -60,8 +63,18 @@ module Sfn
           if(config[:apply_mapping])
             valid_keys = config[:apply_mapping].keys.find_all do |a_key|
               a_key = a_key.to_s
-              !a_key.include?('__') ||
-                a_key.split('__').first == provider_stack.name
+              key_parts = a_key.split('__')
+              case key_parts.size
+              when 3
+                provider_stack.api.data[:location] == key_parts[0] &&
+                  provider_stack.name == key_parts[1]
+              when 2
+                provider_stack.name == key_parts[1]
+              when 1
+                true
+              else
+                raise ArgumentError "Invalid name format for apply stack mapping (`#{a_key}`)"
+              end
             end
             to_remove = valid_keys.find_all do |key|
               valid_keys.any?{|v_key| v_key.match(/__#{Regexp.escape(key)}$/)}
@@ -69,7 +82,7 @@ module Sfn
             valid_keys -= to_remove
             Hash[
               valid_keys.map do |a_key|
-                cut_key = a_key.include?('__') ? a_key.slice(a_key.index('__') + 2, a_key.length) : a_key
+                cut_key = a_key.split('__').last
                 [cut_key, config[:apply_mapping][a_key]]
               end
             ]
@@ -226,32 +239,39 @@ module Sfn
         def validate_stack_parameter(c_stack, p_key, p_ns_key, c_value)
           stack_value = c_stack.parameters[p_key]
           p_stack = c_stack.data[:parent_stack]
-          if(c_value.is_a?(Hash))
-            case c_value.keys.first
-            when 'Ref'
-              current_value = p_stack.parameters[c_value.values.first]
-            when 'Fn::Att'
-              resource_name, output_name = c_value.values.first.split('.', 2)
-              ref_stack = p_stack.nested_stacks.detect{|i| i.data[:logical_id] == resource_name}
-              if(ref_stack)
-                output = ref_stack.outputs.detect do |o|
-                  o.key == output_name
-                end
-                if(output)
-                  current_value = output.value
+          unless(config[:parameter_validation] == 'none')
+            if(c_value.is_a?(Hash))
+              case c_value.keys.first
+              when 'Ref'
+                current_value = p_stack.parameters[c_value.values.first]
+              when 'Fn::Att'
+                resource_name, output_name = c_value.values.first.split('.', 2)
+                ref_stack = p_stack.nested_stacks.detect{|i| i.data[:logical_id] == resource_name}
+                if(ref_stack)
+                  output = ref_stack.outputs.detect do |o|
+                    o.key == output_name
+                  end
+                  if(output)
+                    current_value = output.value
+                  end
                 end
               end
+            else
+              current_value = c_value
+            end
+            if(current_value && current_value.to_s != stack_value.to_s)
+              if(config[:parameter_validation] == 'default')
+                ui.warn 'Nested stack has been altered directly! This update may cause unexpected modifications!'
+                ui.warn "Stack name: #{c_stack.name}. Parameter: #{p_key}. Current value: #{stack_value}. Expected value: #{current_value} (via: #{c_value.inspect})"
+                answer = ui.ask_question("Use current value or expected value for #{p_key} [current/expected]?", :valid => ['current', 'expected'])
+              else
+                answer = config[:parameter_validation]
+              end
+              answer == 'expected'
+            else
+              true
             end
           else
-            current_value = c_value
-          end
-          if(current_value && current_value.to_s != stack_value.to_s)
-            ui.warn 'Nested stack has been altered directly! This update may cause unexpected modifications!'
-            ui.warn "Stack name: #{c_stack.name}. Parameter: #{p_key}. Current value: #{stack_value}. Expected value: #{current_value} (via: #{c_value.inspect})"
-            answer = ui.ask_question("Use current value or expected value for #{p_key} [current/expected]?", :valid => ['current', 'expected'])
-            answer == 'expected'
-          else
-#            ui.warn "Unable to check #{p_key} for direct value modification. (Cannot auto-check expected value #{c_value.inspect})"
             true
           end
         end

data/lib/sfn/command_module/template.rb

@@ -82,12 +82,17 @@ module Sfn
             else
               raise ArgumentError.new "Unknown compile time parameter type provided: `#{p_config[:type].inspect}` (Parameter: #{p_name})"
             end
+            valid = validate_parameter(result, p_config.to_smash)
+            unless(valid == true)
+              result = nil
+              valid.each do |invalid_msg|
+                ui.error invalid_msg.last
+              end
+            end
             if(result.nil? || (result.respond_to?(:empty?) && result.empty?))
               if(attempts > MAX_PARAMETER_ATTEMPTS)
                 ui.fatal "Failed to receive allowed parameter! (Parameter: #{p_name})"
                 exit 1
-              else
-                ui.error "Invalid value provided for parameter `#{p_name}`. Must be type: `#{p_config[:type].to_s.capitalize}`"
               end
             end
           end
@@ -489,7 +494,7 @@ module Sfn
               t_name.to_s.start_with?(prefix.to_s)
             end
           else
-            template_names = sparkle_collection.templates.keys
+            template_names = sparkle_collection.templates.fetch(provider.connection.provider, {}).keys
           end
           collections = template_names.map do |t_name|
             t_name = t_name.to_s.sub(/^#{Regexp.escape(prefix.to_s)}/, '')

data/lib/sfn/config/update.rb

@@ -59,6 +59,12 @@ module Sfn
         :description => 'Merge API options defined within configuration on update',
         :default => false
       )
+      attribute(
+        :parameter_validation, String,
+        :allowed => ['default', 'none', 'current', 'expected'],
+        :description => 'Stack parameter validation behavior',
+        :default => 'default'
+      )
 
     end
   end

data/lib/sfn/planner/aws.rb

@@ -101,7 +101,11 @@ module Sfn
               end
             end
           end
-          result.nil? ? super : result
+          result = result.nil? ? super : result
+          unless(result.is_a?(Enumerable))
+            result = result.to_s
+          end
+          result
         end
 
       end

data/lib/sfn/version.rb

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

data/sfn.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'miasma-rackspace', '>= 0.1.0', '< 0.3'
   s.add_runtime_dependency 'miasma-google', '>= 0.1.0', '< 0.3'
   s.add_runtime_dependency 'net-ssh'
-  s.add_runtime_dependency 'sparkle_formation', '>= 3', '< 4'
+  s.add_runtime_dependency 'sparkle_formation', '>= 3.0.3', '< 4'
   s.add_runtime_dependency 'hashdiff', '~> 0.2.2'
   s.add_runtime_dependency 'graph', '~> 2.8.1'
   s.add_development_dependency 'rake', '~> 10'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfn
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.0.6
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo-cli
@@ -190,7 +190,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.0.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -200,7 +200,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.0.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'