sfn 3.0.28 → 3.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 403602f06deb39fe3f2751236c97dd6f06443431
-  data.tar.gz: 69f16806fb62a281b40d8f6588b4d5bf5772419d
+SHA256:
+  metadata.gz: 8f2149802418fbce7d68ca416ec068c7190ac03050250fb8a0b9ad4fd35e4424
+  data.tar.gz: fc2970e2d4ca0b5e6548adbbf54c3026d6961c11d15def65f508a6a91fc4990d
 SHA512:
-  metadata.gz: b36166fbdb2424563aec23d2c068616264582b25192ab4e377ae7312aa210d1565d721270af1885bc14196e4f56a05afa47afa1b926a815de278aa8c90591415
-  data.tar.gz: 710cf024266fbe9725150f0930756e28d5a284b85db61ad033b048e106fd90bc3cd94c3c8e4b316f474b65e2148acc3e02afa9b06c2b3f676f557cb48a09c07d
+  metadata.gz: fb43de6444a47fa5e5b2a9ffd9d5e40c4ba2074b9c3bcfc2530e43956a9482f9ef9ae87ea66e4f992b7f131c18a32c90c9bb389a1d2d3eecf5eba4c82e5149d5
+  data.tar.gz: 67e9c1731ffddd88ab2e8706abcf590c18091b83a3bfae63cbbbee4c78b3d507df57db762927d0a36ca5e1041ae3397179d1a7f404b9b8154022f395ab70c6ac

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v3.0.30
+* [fix] Comma delimited parameter type parsing (#270)
+* [fix] Constant deprecations
+* [enhancement] Add support for failed callbacks (#271)
+
 # v3.0.28
 * [fix] Fix stack save policy callback (#264)
 * [fix] Prevent processing unset event arrays

data/docs/callbacks.md

@@ -20,6 +20,7 @@ are generally invoked in two places:
 
 * `before` - Prior to the command's remote API request
 * `after` - Following the command's remote API request
+* `failed` - Following failure of remote API request
 
 There are also callbacks available prior to the execution
 of a command. These can also be isolated to specific commands:

data/lib/chef/knife/knife_plugin_seed.rb

@@ -6,36 +6,31 @@ rescue Gem::LoadError => e
   # ignore
 end
 
-unless(defined?(Chef::Knife::CloudformationCreate))
-
+unless defined?(Chef::Knife::CloudformationCreate)
   require 'sfn'
   require 'bogo'
 
   Chef::Config[:knife][:cloudformation] = {
     :options => {},
     :create => {},
-    :update => {}
+    :update => {},
   }
   Chef::Config[:knife][:sparkleformation] = Chef::Config[:knife][:cloudformation]
 
   VALID_PREFIX = ['cloudformation', 'sparkleformation']
 
-
   Sfn::Config.constants.map do |konst|
     const = Sfn::Config.const_get(konst)
-    if(const.is_a?(Class) && const.ancestors.include?(Bogo::Config))
+    if const.is_a?(Class) && const.ancestors.include?(Bogo::Config)
       const
     end
   end.compact.sort_by(&:to_s).each do |klass|
-
     VALID_PREFIX.each do |prefix|
-
       klass_name = klass.name.split('::').last
       command_class = "#{prefix.capitalize}#{klass_name}"
 
       knife_klass = Class.new(Chef::Knife)
       knife_klass.class_eval do
-
         include Bogo::AnimalStrings
 
         # Stub in names so knife will detect
@@ -54,7 +49,7 @@ unless(defined?(Chef::Knife::CloudformationCreate))
         # Properly load in configurations and execute command
         def run
           knife = Chef::Config[:knife]
-          if(knife.respond_to?(:hash_dup))
+          if knife.respond_to?(:hash_dup)
             knife = knife.hash_dup
           end
           base = knife.to_smash
@@ -64,15 +59,15 @@ unless(defined?(Chef::Knife::CloudformationCreate))
           end.compact.first || {}
           cmd_config = cmd_config.to_smash
 
-          reconfig = config.find_all do |k,v|
+          reconfig = config.find_all do |k, v|
             !v.nil?
           end
           # Split up options provided multiple arguments
-          reconfig.map! do |k,v|
-            if(v.is_a?(String) && v.include?(','))
+          reconfig.map! do |k, v|
+            if v.is_a?(String) && v.include?(',')
               v = v.split(',').map(&:strip)
             end
-            [k,v]
+            [k, v]
           end
           n_config = Smash[reconfig]
           cmd_config = cmd_config.deep_merge(n_config)
@@ -83,7 +78,6 @@ unless(defined?(Chef::Knife::CloudformationCreate))
         def merge_configs
           config
         end
-
       end
       knife_klass.instance_variable_set(:@name, "Chef::Knife::#{command_class}")
       knife_klass.instance_variable_set(
@@ -93,12 +87,12 @@ unless(defined?(Chef::Knife::CloudformationCreate))
       knife_klass.banner "knife #{prefix} #{Bogo::Utility.snake(klass_name)}"
 
       Sfn::Config.options_for(klass).each do |name, info|
-        if(info[:boolean])
+        if info[:boolean]
           short = "-#{info[:short]}"
           long = "--[no-]#{info[:long]}"
         else
           val = 'VALUE'
-          if(info[:multiple])
+          if info[:multiple]
             val << '[,VALUE]'
           end
           short = "-#{info[:short]} #{val}"
@@ -110,7 +104,7 @@ unless(defined?(Chef::Knife::CloudformationCreate))
             :long => long,
             :boolean => info[:boolean],
             :default => info[:default],
-            :description => info[:description]
+            :description => info[:description],
           }
         )
       end

data/lib/sfn.rb

@@ -4,7 +4,6 @@ require 'bogo'
 require 'sparkle_formation'
 
 module Sfn
-
   autoload :ApiProvider, 'sfn/api_provider'
   autoload :Callback, 'sfn/callback'
   autoload :Provider, 'sfn/provider'
@@ -18,5 +17,4 @@ module Sfn
   autoload :CommandModule, 'sfn/command_module'
   autoload :Planner, 'sfn/planner'
   autoload :Lint, 'sfn/lint'
-
 end

data/lib/sfn/api_provider.rb

@@ -2,9 +2,7 @@ require 'sfn'
 
 module Sfn
   module ApiProvider
-
     autoload :Google, 'sfn/api_provider/google'
     autoload :Terraform, 'sfn/api_provider/terraform'
-
   end
 end

data/lib/sfn/api_provider/google.rb

@@ -2,7 +2,6 @@ require 'sfn'
 
 module Sfn
   module ApiProvider
-
     module Google
 
       # Disable remote template storage
@@ -21,11 +20,11 @@ module Sfn
       # @param c_stack [Miasma::Models::Orchestration::Stack]
       # @return [Hash]
       def extract_current_nested_template_parameters(stack, stack_name, c_stack)
-        if(c_stack && c_stack.data[:parent_stack])
+        if c_stack && c_stack.data[:parent_stack]
           c_stack.data[:parent_stack].sparkleish_template(:remove_wrapper).fetch(
             :resources, stack_name, :properties, :parameters, Smash.new
           )
-        elsif(stack.parent)
+        elsif stack.parent
           val = stack.parent.compile.resources.set!(stack_name).properties
           val.nil? ? Smash.new : val._dump
         else
@@ -43,16 +42,16 @@ module Sfn
       # @param val [Object]
       # @return [TrueClass, FalseClass]
       def function_set_parameter?(val)
-        if(val)
+        if val
           val.start_with?('$(') || val.start_with?('{{')
         end
       end
 
       # Set parameters into parent resource properites
-      def populate_parameters!(template, opts={})
+      def populate_parameters!(template, opts = {})
         result = super
         result.each_pair do |key, value|
-          if(template.parent)
+          if template.parent
             template.parent.compile.resources.set!(template.name).properties.set!(key, value)
           else
             template.compile.resources.set!(template.name).properties.set!(key, value)
@@ -71,14 +70,12 @@ module Sfn
       # @param thing [SparkleFormation, Hash]
       # @return [Hash]
       def template_content(thing, *_)
-        if(thing.is_a?(SparkleFormation))
+        if thing.is_a?(SparkleFormation)
           config[:sparkle_dump] ? thing.sparkle_dump : thing.dump
         else
           thing
         end
       end
-
     end
-
   end
 end

data/lib/sfn/api_provider/terraform.rb

@@ -2,7 +2,6 @@ require 'sfn'
 
 module Sfn
   module ApiProvider
-
     module Terraform
 
       # Disable remote template storage
@@ -21,11 +20,11 @@ module Sfn
       # @param c_stack [Miasma::Models::Orchestration::Stack]
       # @return [Hash]
       def extract_current_nested_template_parameters(stack, stack_name, c_stack)
-        if(c_stack && c_stack.data[:parent_stack])
+        if c_stack && c_stack.data[:parent_stack]
           c_stack.data[:parent_stack].sparkleish_template(:remove_wrapper).fetch(
             :resources, stack_name, :properties, :parameters, Smash.new
           )
-        elsif(stack.parent)
+        elsif stack.parent
           val = stack.parent.compile.resources.set!(stack_name).properties
           val.nil? ? Smash.new : val._dump
         else
@@ -43,7 +42,7 @@ module Sfn
       # @param val [Object]
       # @return [TrueClass, FalseClass]
       def function_set_parameter?(val)
-        if(val)
+        if val
           val.start_with?('${')
         end
       end
@@ -58,13 +57,12 @@ module Sfn
       # @param thing [SparkleFormation, Hash]
       # @return [Hash]
       def template_content(thing, *_)
-        if(thing.is_a?(SparkleFormation))
+        if thing.is_a?(SparkleFormation)
           config[:sparkle_dump] ? thing.sparkle_dump : thing.dump
         else
           thing
         end
       end
-
     end
   end
 end

data/lib/sfn/cache.rb

@@ -5,14 +5,13 @@ require 'sfn'
 module Sfn
   # Data caching helper
   class Cache
-
     class << self
 
       # Configure the caching approach to use
       #
       # @param type [Symbol] :redis or :local
       # @param args [Hash] redis connection arguments if used
-      def configure(type, args={})
+      def configure(type, args = {})
         type = type.to_sym
         case type
         when :redis
@@ -49,9 +48,9 @@ module Sfn
       # @param kind [String, Symbol] data type
       # @param seconds [Integer]
       # return [Integer] seconds
-      def apply_limit(kind, seconds=nil)
+      def apply_limit(kind, seconds = nil)
         @apply_limit ||= {}
-        if(seconds)
+        if seconds
           @apply_limit[kind.to_sym] = seconds.to_i
         end
         @apply_limit[kind.to_sym].to_i
@@ -64,12 +63,11 @@ module Sfn
 
       # Ping the redis connection and reconnect if dead
       def redis_ping!
-        if((@_pid && @_pid != Process.pid) || !Redis::Objects.redis.connected?)
+        if (@_pid && @_pid != Process.pid) || !Redis::Objects.redis.connected?
           Redis::Objects.redis.client.reconnect
           @_pid = Process.pid
         end
       end
-
     end
 
     # @return [String] custom key for this cache
@@ -79,7 +77,7 @@ module Sfn
     #
     # @param key [String, Array]
     def initialize(key)
-      if(key.respond_to?(:sort))
+      if key.respond_to?(:sort)
         key = key.flatten if key.respond_to?(:flatten)
         key = key.map(&:to_s).sort
       end
@@ -92,7 +90,7 @@ module Sfn
     # @param name [Symbol] name of data
     # @param kind [Symbol] data type
     # @param args [Hash] options for data type
-    def init(name, kind, args={})
+    def init(name, kind, args = {})
       get_storage(self.class.type, kind, name, args)
       true
     end
@@ -112,9 +110,9 @@ module Sfn
         args = registry.keys if args.empty?
         args.each do |key|
           value = self[key]
-          if(value.respond_to?(:clear))
+          if value.respond_to?(:clear)
             value.clear
-          elsif(value.respond_to?(:value))
+          elsif value.respond_to?(:value)
             value.value = nil
           end
           registry.delete(key)
@@ -131,7 +129,7 @@ module Sfn
     # @param name [Symbol] name of data
     # @param args [Hash] options for underlying storage
     # @return [Object]
-    def get_storage(store_type, data_type, name, args={})
+    def get_storage(store_type, data_type, name, args = {})
       full_name = "#{key}_#{name}"
       result = nil
       case store_type.to_sym
@@ -139,14 +137,14 @@ module Sfn
         result = get_redis_storage(data_type, full_name.to_s, args)
       when :local
         @_local_cache ||= {}
-        unless(@_local_cache[full_name.to_s])
+        unless @_local_cache[full_name.to_s]
           @_local_cache[full_name.to_s] = get_local_storage(data_type, full_name.to_s, args)
         end
         result = @_local_cache[full_name.to_s]
       else
         raise TypeError.new("Unsupported caching storage type encountered: #{store_type}")
       end
-      unless(full_name == "#{key}_registry_#{key}")
+      unless full_name == "#{key}_registry_#{key}"
         registry[name.to_s] = data_type
       end
       result
@@ -158,7 +156,7 @@ module Sfn
     # @param full_name [Symbol]
     # @param args [Hash]
     # @return [Object]
-    def get_redis_storage(data_type, full_name, args={})
+    def get_redis_storage(data_type, full_name, args = {})
       self.class.redis_ping!
       case data_type.to_sym
       when :array
@@ -183,22 +181,22 @@ module Sfn
     # @param args [Hash]
     # @return [Object]
     # @todo make proper singleton for local storage
-    def get_local_storage(data_type, full_name, args={})
+    def get_local_storage(data_type, full_name, args = {})
       @storage ||= {}
       @storage[full_name] ||= case data_type.to_sym
-        when :array
-          []
-        when :hash
-          {}
-        when :value
-          LocalValue.new
-        when :lock
-          LocalLock.new(full_name, {:expiration => 60, :timeout => 0.1}.merge(args))
-        when :stamped
-          Stamped.new(full_name.sub("#{key}_", '').to_sym, get_local_storage(:value, full_name), self)
-        else
-          raise TypeError.new("Unsupported caching data type encountered: #{data_type}")
-        end
+                              when :array
+                                []
+                              when :hash
+                                {}
+                              when :value
+                                LocalValue.new
+                              when :lock
+                                LocalLock.new(full_name, {:expiration => 60, :timeout => 0.1}.merge(args))
+                              when :stamped
+                                Stamped.new(full_name.sub("#{key}_", '').to_sym, get_local_storage(:value, full_name), self)
+                              else
+                                raise TypeError.new("Unsupported caching data type encountered: #{data_type}")
+                              end
     end
 
     # Execute block within internal lock
@@ -216,7 +214,7 @@ module Sfn
     # @param name [String, Symbol]
     # @return [Object, NilClass]
     def [](name)
-      if(kind = registry[name.to_s])
+      if kind = registry[name.to_s]
         get_storage(self.class.type, kind, name)
       else
         nil
@@ -246,9 +244,9 @@ module Sfn
     # @param kind [String, Symbol] data type
     # @param seconds [Integer]
     # return [Integer]
-    def apply_limit(kind, seconds=nil)
+    def apply_limit(kind, seconds = nil)
       @apply_limit ||= {}
-      if(seconds)
+      if seconds
         @apply_limit[kind.to_sym] = seconds.to_i
       end
       @apply_limit[kind.to_sym].to_i
@@ -259,13 +257,13 @@ module Sfn
     # @param lock_name [String, Symbol] name of lock
     # @param raise_on_locked [TrueClass, FalseClass] raise execption if lock wait times out
     # @return [Object] result of yield
-    def locked_action(lock_name, raise_on_locked=false)
+    def locked_action(lock_name, raise_on_locked = false)
       begin
         self[lock_name].lock do
           yield
         end
       rescue => e
-        if(e.class.to_s.end_with?('Timeout'))
+        if e.class.to_s.end_with?('Timeout')
           raise if raise_on_locked
         else
           raise
@@ -277,6 +275,7 @@ module Sfn
     class LocalValue
       # @return [Object] value
       attr_accessor :value
+
       def initialize(*args)
         @value = nil
       end
@@ -284,7 +283,6 @@ module Sfn
 
     # Simple lock for memory cache
     class LocalLock
-
       class LocalLockTimeout < RuntimeError
       end
 
@@ -300,7 +298,7 @@ module Sfn
       # @param name [Symbol] name of lock
       # @param args [Hash]
       # @option args [Numeric] :timeout
-      def initialize(name, args={})
+      def initialize(name, args = {})
         @_key = name
         @_timeout = args.fetch(:timeout, -1).to_f
         @_lock = Mutex.new
@@ -313,17 +311,17 @@ module Sfn
       def lock
         locked = false
         attempt_start = Time.now.to_f
-        while(!locked && (_timeout < 0 || Time.now.to_f - attempt_start < _timeout))
+        while (!locked && (_timeout < 0 || Time.now.to_f - attempt_start < _timeout))
           locked = _lock.try_lock
         end
-        if(locked)
+        if locked
           begin
             yield
           ensure
             _lock.unlock if _lock.locked?
           end
         else
-          if(defined?(Redis))
+          if defined?(Redis)
             raise Redis::Lock::LockTimeout.new "Timeout on lock #{_key} exceeded #{_timeout} sec"
           else
             raise LocalLockTimeout.new "Timeout on lock #{_key} exceeded #{_timeout} sec"
@@ -387,6 +385,5 @@ module Sfn
         !set? || @cache.time_check_allow?(@name, @base.value[:stamp])
       end
     end
-
   end
 end