cloudformation-ruby-dsl 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57fff8ca0d99312692f6c33807de5aa47a6985c0
-  data.tar.gz: c8b847f425907f314e78696a856ffd1179e7f715
+  metadata.gz: 1fc27537e778d1d9bf9b8886047e87f578e93f3a
+  data.tar.gz: ba288ca3b0e250854b5f7c45485d963a4cd27a37
 SHA512:
-  metadata.gz: d4caeec967852e730b440ceb33975a8c863fabed84e92907aea1b8c158490cdf0a7b485f42a1e23cb2e1586ff70dd6026b80997791fe6693b0065e2946c2885d
-  data.tar.gz: f906f46d8980cc727d1db1c21c7a8468c8ee37f324e833783ed3807fc108ed48d759c80f9171f092f994ca4e00b1966a87b32a4fe8eefa7b0dd00959a133fddc
+  metadata.gz: 7179312a3f4a3462c7de36b9e0ec77f42d1c2bca68e8d52e0cfe9cb3a19d9c97abcf3d04aaa92a3e844aa0a5dc27d67757e0777d5d6e9ac6cd55d6c597ff09ab
+  data.tar.gz: b6f097b17b653d267a0f07a946fbeab1996b82604bf9386b749c3bc88337f82de741adc3fe02bc697c0f260f1f2ffef975c1e7d26319351e55268218ed331e5e

data/examples/simple_template.rb

@@ -2,8 +2,9 @@
 require 'bundler/setup'
 require 'cloudformation-ruby-dsl/cfntemplate'
 
-template = template do
+tmpl = template do
+  @stack_name = "hello-bucket-example"
   resource "HelloBucket", :Type => "AWS::S3::Bucket"
 end
 
-template.exec!
+tmpl.exec!

data/lib/cloudformation-ruby-dsl/cfntemplate.rb

@@ -91,9 +91,10 @@ def parse_args
     when '--stack-name'
       args[:stack_name] = value
     when '--parameters'
-      args[:parameters] = Hash[value.split(/;\s*/).map { |pair| pair.split(/=/, 2) }]  #/# fix for syntax highlighting
+      args[:parameters] = Hash[value.split(/;/).map { |pair| parts = pair.split(/=/, 2); [ parts[0], Parameter.new(parts[1]) ] }]  #/# fix for syntax highlighting
     when '--interactive'
       args[:interactive] = true
+default and previous values of a parameter. Updated excise_parameter_attributes! to support multiple parameters.
     when '--region'
       args[:region] = value
     when '--profile'
@@ -155,9 +156,9 @@ def cfn(template)
 
   action = validate_action( ARGV[0] )
 
-  # Find parameters where extension attribute :Immutable is true then remove it from the
+  # Find parameters where extension attributes are true then remove them from the
   # cfn template since we can't pass it to CloudFormation.
-  immutable_parameters = template.excise_parameter_attribute!(:Immutable)
+  excised_parameters = template.excise_parameter_attributes!([:Immutable, :UsePreviousValue])
 
   # Tag CloudFormation stacks based on :Tags defined in the template.
   # Remove them from the template as well, so that the template is valid.
@@ -231,15 +232,15 @@ def cfn(template)
     # there is only ever one stack, since stack names are unique
     old_attributes = cfn_client.describe_stacks({stack_name: stack_name}).stacks[0]
     old_tags       = old_attributes.tags
-    old_parameters = old_attributes.parameters
+    old_parameters = Hash[old_attributes.parameters.map { |p| [p.parameter_key, p.parameter_value]}]
 
     # Sort the tag strings alphabetically to make them easily comparable
     old_tags_string = old_tags.map { |tag| %Q(TAG "#{tag.key}=#{tag.value}"\n) }.sort.join
     tags_string     = cfn_tags.map { |k, v| %Q(TAG "#{k.to_s}=#{v}"\n) }.sort.join
 
     # Sort the parameter strings alphabetically to make them easily comparable
-    old_parameters_string = old_parameters.sort! {|pCurrent, pNext| pCurrent.parameter_key <=> pNext.parameter_key }.map { |param| %Q(PARAMETER "#{param.parameter_key}=#{param.parameter_value}"\n) }.join
-    parameters_string     = template.parameters.sort.map { |key, value| "PARAMETER \"#{key}=#{value}\"\n" }.join
+    old_parameters_string = old_parameters.sort.map { |key, value| %Q(PARAMETER "#{key}=#{value}"\n) }.join
+    parameters_string     = template.parameters.sort.map { |key, value| "PARAMETER \"#{key}=#{!(value.empty? && value.use_previous_value) ? value : old_parameters[key]}\"\n" }.join
 
     # set default diff options
     Diffy::Diff.default_options.merge!(
@@ -294,6 +295,9 @@ def cfn(template)
   when 'create'
     begin
 
+      # Apply any default parameter values
+      apply_parameter_defaults(template.parameters)
+
       # default options (not overridable)
       create_stack_opts = {
           stack_name: stack_name,
@@ -435,16 +439,30 @@ def cfn(template)
     end
 
     # If updating a stack and some parameters or tags are marked as immutable, set the variable to true.
-    immutables_exist = nil 
-
-    if not immutable_parameters.empty?
-      old_parameters = Hash[old_stack.parameters.map { |p| [p.parameter_key, p.parameter_value]}]
-      new_parameters = template.parameters
-      immutable_parameters.sort.each do |param|
-        if old_parameters[param].to_s != new_parameters[param].to_s && old_parameters.key?(param)
-          $stderr.puts "Error: unable to update immutable parameter " +
-                           "'#{param}=#{old_parameters[param]}' to '#{param}=#{new_parameters[param]}'."
-          immutables_exist = true
+    immutables_exist = nil
+
+    old_parameters = Hash[old_stack.parameters.map { |p| [p.parameter_key, p.parameter_value]}]
+    new_parameters = template.parameters
+    excised_parameters.each do |extension_attribute, parameters|
+      if !parameters.empty?
+        parameters.sort.each do |param|
+          if old_parameters[param] != new_parameters[param] && old_parameters.key?(param)
+            case extension_attribute
+            when :Immutable
+              if !excised_parameters[:UsePreviousValue].include?(param)
+                $stderr.puts "Error: unable to update immutable parameter " +
+                                 "'#{param}=#{old_parameters[param]}' to '#{param}=#{new_parameters[param]}'."
+                immutables_exist = true
+              end
+            when :UsePreviousValue
+              if !immutables_exist && new_parameters[param].empty?
+                $stderr.puts "Using previous parameter " +
+                                 "'#{param}=#{old_parameters[param]}'."
+                new_parameters[param] = Parameter.new(old_parameters[param])
+                new_parameters[param].use_previous_value = true
+              end
+            end
+          end
         end
       end
     end
@@ -466,6 +484,9 @@ def cfn(template)
       exit(false)
     end
 
+    # Apply any default parameter values
+    apply_parameter_defaults(template.parameters)
+
     # Compare the sorted arrays of parameters for an exact match and print difference.
     old_parameters = old_stack.parameters.map { |p| [p.parameter_key, p.parameter_value]}.sort
     new_parameters = template.parameters.sort
@@ -493,7 +514,7 @@ def cfn(template)
       update_stack_opts = {
           stack_name: stack_name,
           template_body: template_string,
-          parameters: template.parameters.map { |k,v| {parameter_key: k, parameter_value: v}}.to_a,
+          parameters: template.parameters.map { |k,v| (v.use_previous_value && old_parameters[0].include?(k)) ? {parameter_key: k, use_previous_value: v.use_previous_value.to_s} : {parameter_key: k, parameter_value: v}}.to_a,
           tags: cfn_tags.map { |k,v| {"key" => k.to_s, "value" => v.to_s} }.to_a,
           capabilities: ["CAPABILITY_NAMED_IAM"],
       }
@@ -569,6 +590,17 @@ def parse_arg_array_as_hash(options)
   result
 end
 
+# Apply the default value for any parameter not assigned by the user
+def apply_parameter_defaults(parameters)
+  parameters.each do |k, v|
+    if v.empty?
+      parameters[k] = Parameter.new(v.default)
+      $stderr.puts "Using default parameter value " +
+                       "'#{k}=#{parameters[k]}'."
+    end
+  end
+end
+
 ##################################### Additional dsl logic
 # Core interpreter for the DSL
 class TemplateDSL < JsonObjectDSL

data/lib/cloudformation-ruby-dsl/dsl.rb

@@ -52,6 +52,14 @@ def default_region
   ENV['EC2_REGION'] || ENV['AWS_DEFAULT_REGION'] || 'us-east-1'
 end
 
+class Parameter < String
+  attr_accessor :default, :use_previous_value
+
+  def initialize string
+    super string.to_s
+  end
+end
+
 # Core interpreter for the DSL
 class TemplateDSL < JsonObjectDSL
   attr_reader :parameters,
@@ -81,16 +89,21 @@ class TemplateDSL < JsonObjectDSL
     if @interactive
       @parameters[name] ||= _get_parameter_from_cli(name, options)
     else
-      @parameters[name] ||= options[:Default]
+      @parameters[name] ||= Parameter.new('')
+      @parameters[name].default = options[:Default]
+      @parameters[name].use_previous_value = options[:UsePreviousValue]
     end
   end
 
   # Find parameters where the specified attribute is true then remove the attribute from the cfn template.
-  def excise_parameter_attribute!(attribute)
-    marked_parameters = []
+  def excise_parameter_attributes!(attributes)
+    marked_parameters = {}
     @dict.fetch(:Parameters, {}).each do |param, options|
-      if options.delete(attribute.to_sym) or options.delete(attribute.to_s)
-        marked_parameters << param
+      attributes.each do |attribute|
+        marked_parameters[attribute] ||= []
+        if options.delete(attribute.to_sym) or options.delete(attribute.to_s)
+          marked_parameters[attribute] << param
+        end
       end
     end
     marked_parameters

data/lib/cloudformation-ruby-dsl/version.rb

@@ -15,7 +15,7 @@
 module Cfn
   module Ruby
     module Dsl
-      VERSION = "1.3.2"
+      VERSION = "1.4.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-ruby-dsl
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Shawn Smith