sfn 3.0.30 → 3.0.32

data/lib/sfn/config/lint.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Config
@@ -6,22 +6,22 @@ module Sfn
     class Lint < Validate
       attribute(
         :lint_directory, String,
-        :description => 'Directory containing lint rule sets',
+        :description => "Directory containing lint rule sets",
         :multiple => true,
       )
       attribute(
         :disabled_rule_set, String,
-        :description => 'Disable rule set from being applied',
+        :description => "Disable rule set from being applied",
         :multiple => true,
       )
       attribute(
         :enabled_rule_set, String,
-        :description => 'Only apply this rule set',
+        :description => "Only apply this rule set",
         :multiple => true,
       )
       attribute(
         :local_rule_sets_only, [TrueClass, FalseClass],
-        :description => 'Only apply rule sets provided by lint directory',
+        :description => "Only apply rule sets provided by lint directory",
         :default => false,
       )
     end

data/lib/sfn/config/list.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Config
@@ -7,19 +7,19 @@ module Sfn
       attribute(
         :attribute, String,
         :multiple => true,
-        :description => 'Attribute of stack to print',
-        :short_flag => 'a',
+        :description => "Attribute of stack to print",
+        :short_flag => "a",
       )
       attribute(
         :all_attributes, [TrueClass, FalseClass],
-        :description => 'Print all available attributes',
-        :short_flag => 'A',
+        :description => "Print all available attributes",
+        :short_flag => "A",
       )
       attribute(
         :status, String,
         :multiple => true,
         :description => 'Match stacks with given status. Use "none" to disable.',
-        :short_flag => 's',
+        :short_flag => "s",
       )
     end
   end

data/lib/sfn/config/plan.rb

@@ -0,0 +1,28 @@
+require "sfn"
+
+module Sfn
+  class Config
+    # Plan command configuration
+    class Plan < Create
+      # Remove the plan option. Command specific options will
+      # cause a conflict if same option name as command is used.
+      # Also, since this is a plan command, we are always running
+      # a plan, because that's the command.
+      attributes.delete(:plan)
+      # Default diffs to be enabled
+      attributes.set(:diffs, :default, true)
+
+      attribute(
+        :plan_name, String,
+        :description => "Custom plan name or ID (not applicable to all providers)",
+      )
+
+      attribute(
+        :list, BOOLEAN,
+        :description => "List all available plans for stack",
+        :default => false,
+        :short_flag => "l",
+      )
+    end
+  end
+end

data/lib/sfn/config/print.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Config
@@ -6,18 +6,18 @@ module Sfn
     class Print < Validate
       attribute(
         :write_to_file, String,
-        :description => 'Write compiled SparkleFormation template to path provided',
-        :short_flag => 'w',
+        :description => "Write compiled SparkleFormation template to path provided",
+        :short_flag => "w",
       )
 
       attribute(
         :sparkle_dump, [TrueClass, FalseClass],
-        :description => 'Do not use provider customized dump behavior',
+        :description => "Do not use provider customized dump behavior",
       )
 
       attribute(
         :yaml, [TrueClass, FalseClass],
-        :description => 'Output template content in YAML format',
+        :description => "Output template content in YAML format",
       )
     end
   end

data/lib/sfn/config/promote.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Config
@@ -6,15 +6,15 @@ module Sfn
     class Promote < Config
       attribute(
         :accounts, String,
-        :description => 'JSON accounts file path',
+        :description => "JSON accounts file path",
       )
       attribute(
         :bucket, String,
-        :description => 'Bucket name containing the exports',
+        :description => "Bucket name containing the exports",
       )
       attribute(
         :bucket_prefix, String,
-        :description => 'Key prefix within remote bucket',
+        :description => "Key prefix within remote bucket",
       )
     end
   end

data/lib/sfn/config/update.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Config
@@ -7,22 +7,22 @@ module Sfn
       attribute(
         :apply_stack, String,
         :multiple => true,
-        :description => 'Apply outputs from stack to input parameters',
-        :short_flag => 'A',
+        :description => "Apply outputs from stack to input parameters",
+        :short_flag => "A",
       )
       attribute(
         :apply_mapping, Smash,
-        :description => 'Customize apply stack mapping as [StackName__]OutputName:ParameterName',
+        :description => "Customize apply stack mapping as [StackName__]OutputName:ParameterName",
       )
       attribute(
         :parameter, Smash,
         :multiple => true,
-        :description => '[DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue)',
+        :description => "[DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue)",
         :coerce => lambda { |v, inst|
           result = inst.data[:parameter] || Array.new
           case v
           when String
-            v.split(',').each do |item|
+            v.split(",").each do |item|
               result.push(Smash[*item.split(/[=:]/, 2)])
             end
           else
@@ -30,39 +30,39 @@ module Sfn
           end
           {:bogo_multiple => result}
         },
-        :short_flag => 'R',
+        :short_flag => "R",
       )
       attribute(
         :parameters, Smash,
-        :description => 'Pass template parameters directly',
-        :short_flag => 'm',
+        :description => "Pass template parameters directly",
+        :short_flag => "m",
       )
       attribute(
         :plan, [TrueClass, FalseClass],
         :default => true,
-        :description => 'Provide planning information prior to update',
-        :short_flag => 'l',
+        :description => "Provide planning information prior to update",
+        :short_flag => "l",
       )
       attribute(
         :plan_only, [TrueClass, FalseClass],
         :default => false,
-        :description => 'Exit after plan display',
+        :description => "Exit after plan display",
       )
       attribute(
         :diffs, [TrueClass, FalseClass],
-        :description => 'Show planner content diff',
-        :short_flag => 'D',
+        :description => "Show planner content diff",
+        :short_flag => "D",
       )
       attribute(
         :merge_api_options, [TrueClass, FalseClass],
-        :description => 'Merge API options defined within configuration on update',
+        :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',
+        :allowed => ["default", "none", "current", "expected"],
+        :description => "Stack parameter validation behavior",
+        :default => "default",
       )
     end
   end

data/lib/sfn/config/validate.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Config
@@ -6,80 +6,80 @@ module Sfn
     class Validate < Config
       attribute(
         :processing, [TrueClass, FalseClass],
-        :description => 'Call the unicorns and explode the glitter bombs',
+        :description => "Call the unicorns and explode the glitter bombs",
         :default => true,
-        :short_flag => 'P',
+        :short_flag => "P",
       )
       attribute(
         :file, String,
-        :description => 'Path to template file',
+        :description => "Path to template file",
         :default => nil,
-        :short_flag => 'f',
+        :short_flag => "f",
       )
       attribute(
         :file_path_prompt, [TrueClass, FalseClass],
         :default => true,
-        :description => 'Enable interactive prompt for template path discovery',
-        :short_flag => 'F',
+        :description => "Enable interactive prompt for template path discovery",
+        :short_flag => "F",
       )
       attribute(
         :base_directory, String,
-        :description => 'Path to root of of templates directory',
-        :short_flag => 'b',
+        :description => "Path to root of of templates directory",
+        :short_flag => "b",
       )
       attribute(
         :no_base_directory, [TrueClass, FalseClass],
-        :description => 'Unset any value used for the template root directory path',
-        :short_flag => 'n',
+        :description => "Unset any value used for the template root directory path",
+        :short_flag => "n",
       )
       attribute(
         :translate, String,
-        :description => 'Translate generated template to given provider',
-        :short_flag => 't',
+        :description => "Translate generated template to given provider",
+        :short_flag => "t",
       )
       attribute(
         :translate_chunk, Integer,
-        :description => 'Chunk length for serialization',
+        :description => "Chunk length for serialization",
         :coerce => lambda { |v| v.to_i },
-        :short_flag => 'T',
+        :short_flag => "T",
       )
       attribute(
         :apply_nesting, [String, Symbol],
-        :default => 'deep',
-        :description => 'Apply stack nesting',
-        :short_flag => 'a',
+        :default => "deep",
+        :description => "Apply stack nesting",
+        :short_flag => "a",
       )
       attribute(
         :nesting_bucket, String,
-        :description => 'Bucket to use for storing nested stack templates',
-        :short_flag => 'N',
+        :description => "Bucket to use for storing nested stack templates",
+        :short_flag => "N",
       )
       attribute(
         :nesting_prefix, String,
-        :description => 'File name prefix for storing template in bucket',
-        :short_flag => 'Y',
+        :description => "File name prefix for storing template in bucket",
+        :short_flag => "Y",
       )
       attribute(
         :print_only, [TrueClass, FalseClass],
-        :description => 'Print the resulting stack template',
-        :short_flag => 'r',
+        :description => "Print the resulting stack template",
+        :short_flag => "r",
       )
       attribute(
         :sparkle_pack, String,
         :multiple => true,
-        :description => 'Load SparklePack gem',
+        :description => "Load SparklePack gem",
         :coerce => lambda { |s| s.to_s },
-        :short_flag => 's',
+        :short_flag => "s",
       )
       attribute(
         :compile_parameters, Smash,
-        :description => 'Pass template compile time parameters directly',
-        :short_flag => 'o',
+        :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|
+            v.split(",").each do |item_pair|
               key, value = item_pair.split(/[=:]/, 2)
               result[key] = value
             end
@@ -104,7 +104,7 @@ module Sfn
       )
       attribute(
         :upload_root_template, [TrueClass, FalseClass],
-        :description => 'Upload root template to storage bucket',
+        :description => "Upload root template to storage bucket",
       )
     end
   end

data/lib/sfn/lint.rb

@@ -1,10 +1,10 @@
-require 'sfn'
-require 'jmespath'
+require "sfn"
+require "jmespath"
 
 module Sfn
   module Lint
-    autoload :Definition, 'sfn/lint/definition'
-    autoload :Rule, 'sfn/lint/rule'
-    autoload :RuleSet, 'sfn/lint/rule_set'
+    autoload :Definition, "sfn/lint/definition"
+    autoload :Rule, "sfn/lint/rule"
+    autoload :RuleSet, "sfn/lint/rule_set"
   end
 end

data/lib/sfn/lint/definition.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   module Lint
@@ -20,7 +20,7 @@ module Sfn
       # @return [self]
       def initialize(expr, provider = :aws, evaluator = nil, &block)
         if evaluator && block
-          raise ArgumentError.new 'Only evaluator or block can be provided, not both.'
+          raise ArgumentError.new "Only evaluator or block can be provided, not both."
         end
         @provider = Bogo::Utility.snake(provider).to_sym
         @search_expression = expr
@@ -46,7 +46,7 @@ module Sfn
       # @note override this method when subclassing
       def run(result, template)
         unless evaluator
-          raise NotImplementedError.new 'No evaluator has been defined for this definition!'
+          raise NotImplementedError.new "No evaluator has been defined for this definition!"
         end
         evaluator.call(result, template)
       end

data/lib/sfn/lint/rule.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   module Lint
@@ -40,7 +40,7 @@ module Sfn
             f_item
           end.flatten.compact.map(&:to_s)
           unless failed_items.empty?
-            msg = "#{msg} (failures: `#{failed_items.join('`, `')}`)"
+            msg = "#{msg} (failures: `#{failed_items.join("`, `")}`)"
           end
         end
         msg
@@ -109,7 +109,7 @@ module Sfn
         end
         unless non_match.empty?
           raise ArgumentError.new "Rule defines `#{provider}` as provider but includes definitions for " \
-                                  "non matching providers. (#{non_match.map(&:provider).map(&:to_s).uniq.sort.join(', ')})"
+                                  "non matching providers. (#{non_match.map(&:provider).map(&:to_s).uniq.sort.join(", ")})"
         end
       end
     end

data/lib/sfn/lint/rule_set.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   module Lint
@@ -160,7 +160,7 @@ module Sfn
         end
         unless non_match.empty?
           raise ArgumentError.new "Rule set defines `#{provider}` as provider but includes rules for " \
-                                  "non matching providers. (#{non_match.map(&:provider).map(&:to_s).uniq.sort.join(', ')})"
+                                  "non matching providers. (#{non_match.map(&:provider).map(&:to_s).uniq.sort.join(", ")})"
         end
       end
     end

data/lib/sfn/monkey_patch.rb

@@ -1,8 +1,8 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   # Container for monkey patches
   module MonkeyPatch
-    autoload :Stack, 'sfn/monkey_patch/stack'
+    autoload :Stack, "sfn/monkey_patch/stack"
   end
 end

data/lib/sfn/monkey_patch/stack.rb

@@ -1,13 +1,13 @@
-require 'base64'
-require 'sfn'
+require "base64"
+require "sfn"
 
 module Sfn
   module MonkeyPatch
 
     # Expand stack model functionality
     module Stack
-      autoload :Azure, 'sfn/monkey_patch/stack/azure'
-      autoload :Google, 'sfn/monkey_patch/stack/google'
+      autoload :Azure, "sfn/monkey_patch/stack/azure"
+      autoload :Google, "sfn/monkey_patch/stack/google"
 
       include Bogo::AnimalStrings
       include Azure
@@ -92,7 +92,7 @@ module Sfn
       # @return [String] action currently being performed
       def performing
         if in_progress?
-          status.to_s.downcase.split('_').first.to_sym
+          status.to_s.downcase.split("_").first.to_sym
         end
       end
 
@@ -143,9 +143,9 @@ module Sfn
           self.send("percent_complete_#{api.provider}", min)
         else
           if in_progress?
-            total_resources = template.fetch('Resources', []).size
+            total_resources = template.fetch("Resources", []).size
             total_complete = resources.all.find_all do |resource|
-              resource.status.downcase.end_with?('complete')
+              resource.status.downcase.end_with?("complete")
             end.size
             result = ((total_complete.to_f / total_resources) * 100).to_i
             result > min.to_i ? result : min
@@ -176,20 +176,20 @@ module Sfn
             stack_parameters = template[opts[:parameter_key]]
             default_key = opts.fetch(
               :default_key,
-              opts[:parameter_key].to_s[0, 1].match(/[a-z]/) ? 'default' : 'Default'
+              opts[:parameter_key].to_s[0, 1].match(/[a-z]/) ? "default" : "Default"
             )
           else
-            if template['Parameters']
-              default_key = 'Default'
-              stack_parameters = template['Parameters']
+            if template["Parameters"]
+              default_key = "Default"
+              stack_parameters = template["Parameters"]
             else
-              default_key = 'default'
-              stack_parameters = template['parameters']
+              default_key = "default"
+              stack_parameters = template["parameters"]
             end
           end
           if stack_parameters
             valid_parameters = stack_parameters.find_all do |key, val|
-              !val['DisableApply'] && !val['disable_apply']
+              !val["DisableApply"] && !val["disable_apply"]
             end.map(&:first)
             if ignore_params
               valid_parameters.reject! do |key|
@@ -197,17 +197,17 @@ module Sfn
               end
             end
             remote_stack.outputs.each do |output|
-              o_key = output.key.downcase.tr('_', '')
+              o_key = output.key.downcase.tr("_", "")
               p_key = valid_parameters.detect do |v_param|
-                v_param.downcase.tr('_', '') == o_key
+                v_param.downcase.tr("_", "") == o_key
               end
               unless p_key
                 map_key = opts[:mapping].keys.detect do |map_key|
-                  map_key.downcase.tr('_', '') == o_key
+                  map_key.downcase.tr("_", "") == o_key
                 end
                 if map_key
                   p_key = valid_parameters.detect do |v_param|
-                    v_param.downcase.tr('_', '') == opts[:mapping][map_key].downcase.tr('_', '')
+                    v_param.downcase.tr("_", "") == opts[:mapping][map_key].downcase.tr("_", "")
                   end
                 end
               end
@@ -231,8 +231,8 @@ module Sfn
           resources.reload.all.map do |resource|
             if api.data.fetch(:stack_types, []).include?(resource.type)
               # Custom remote load support
-              if resource.type == 'Custom::JackalStack'
-                location, stack_id = resource.id.to_s.split('-', 2)
+              if resource.type == "Custom::JackalStack"
+                location, stack_id = resource.id.to_s.split("-", 2)
                 if l_conf = api.data[:locations][location]
                   n_stack = Miasma.api(
                     :type => :orchestration,
@@ -279,13 +279,13 @@ module Sfn
           if (self.api.provider == :aws) # cause this is the only one
             begin
               result = self.api.request(
-                :path => '/',
+                :path => "/",
                 :form => Smash.new(
-                  'Action' => 'GetStackPolicy',
-                  'StackName' => self.id,
+                  "Action" => "GetStackPolicy",
+                  "StackName" => self.id,
                 ),
               )
-              serialized_policy = result.get(:body, 'GetStackPolicyResult', 'StackPolicyBody')
+              serialized_policy = result.get(:body, "GetStackPolicyResult", "StackPolicyBody")
               MultiJson.load(serialized_policy).to_smash
             rescue Miasma::Error::ApiError::RequestError => e
               if e.response.code == 404
@@ -310,10 +310,10 @@ module Sfn
           self.send("nesting_style_#{api.provider}")
         else
           if nested?
-            self.template['Resources'].find_all do |t_resource|
-              t_resource['Type'] == self.api.class.const_get(:RESOURCE_MAPPING).key(self.class)
+            self.template["Resources"].find_all do |t_resource|
+              t_resource["Type"] == self.api.class.const_get(:RESOURCE_MAPPING).key(self.class)
             end.detect do |t_resource|
-              t_resource['Properties'].fetch('Parameters', {}).values.detect do |t_value|
+              t_resource["Properties"].fetch("Parameters", {}).values.detect do |t_value|
                 !t_value.is_a?(Hash)
               end
             end ? :deep : :shallow