stackup 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b00856895bb8013972d2861813cf8260203808afb4ee4a4a9e3e861adcf7c33
-  data.tar.gz: 3c4abaa4fdceb95ffee76134d2b1dd189149fdc5750b3ddd2a64dd16ca44567c
+  metadata.gz: 01e367ca4b2044872b8bffc12075970ad962f5542e143a3d8f47cc6cd9ec6773
+  data.tar.gz: a3b4dd683a84e01885ffdc60ec306e18d212e24fefddec660cd451b8ca8c5d23
 SHA512:
-  metadata.gz: eacb2f2acc276c29507ab0fc221a0205498baed30244b6c0e0480f86f2788d2c3fb0a63e937d8e7add1aee23dd25d36dbfb182e2cae34b2a88841055d393d62d
-  data.tar.gz: 9454cc5bbfeac0f94ab398b8a2bc48e3d0fa2a4555fab3ebdfd9e3235b51776edf915a886b42652ee7f72d24d5e8f912230cb37c061023c07d90e0d66d76b60d
+  metadata.gz: 1fc1090d8365094a4ec26df52d8f4ba745d5ff9dc275001630d4ebb013a7673105d658749ee0d3214da89c1559c0acbaa3a5f9ee1cb17ab8e643ab16436d0ac0
+  data.tar.gz: 578e511731086edfe83a22245bde31c50ec8c194504772f6f4ae3cd2ac56fe5819e2adfc2c11e34b576e07071207f70b2f3f2c38f61d16a0ca74f639e1668333

data/CHANGES.md

@@ -1,5 +1,10 @@
 # CHANGES
 
+## 1.4.3 (2019-09-05)
+
+* Add support for CloudFormation capabilities via CLI and Rake
+* Fix: Prevent failure when creating a stack with change sets
+
 ## 1.4.2 (2019-01-21)
 
 * Fix #64: Create and Update functions should not mutate the options parameter

data/bin/stackup

@@ -26,6 +26,7 @@ Clamp do
 
   option ["--region"], "REGION", "set region" do |arg|
     raise ArgumentError, "#{arg.inspect} doesn't look like a region" unless arg =~ /^[a-z]{2}-[a-z]+-\d$/
+
     arg
   end
 
@@ -84,6 +85,7 @@ Clamp do
 
   def role_arn=(arg)
     raise ArgumentError, "#{arg.inspect} doesn't look like a role ARN" unless arg =~ %r{^arn:aws:iam::\d+:role/}
+
     @role_arn = arg
   end
 
@@ -102,6 +104,7 @@ Clamp do
 
   def aws_config
     return base_aws_config unless role_arn
+
     assumed_credentials = Aws::AssumeRoleCredentials.new(
       :client => Aws::STS::Client.new(base_aws_config),
       :role_arn => role_arn,
@@ -190,6 +193,7 @@ Clamp do
 
     option "--service-role-arn", "SERVICE_ROLE_ARN", "cloudformation service role ARN" do |arg|
       raise ArgumentError, "#{arg.inspect} doesn't look like a role ARN" unless arg =~ %r{^arn:aws:iam::\d+:role/}
+
       arg
     end
 
@@ -197,6 +201,9 @@ Clamp do
            "when stack creation fails: DO_NOTHING, ROLLBACK, or DELETE",
            :default => "ROLLBACK"
 
+    option "--capability", "CAPABILITY", "cloudformation capability",
+           :multivalued => true, :default => ["CAPABILITY_NAMED_IAM"]
+
     def execute
       unless template_source || use_previous_template?
         signal_usage_error "Specify either --template or --use-previous-template"
@@ -221,6 +228,7 @@ Clamp do
       end
       options[:role_arn] = service_role_arn if service_role_arn
       options[:use_previous_template] = use_previous_template?
+      options[:capabilities] = capability_list
       report_change do
         stack.create_or_update(options)
       end
@@ -275,6 +283,9 @@ Clamp do
              :attribute_name => :tag_source,
              &Stackup::Source.method(:new)
 
+      option "--capability", "CAPABILITY", "cloudformation capability",
+             :multivalued => true, :default => ["CAPABILITY_NAMED_IAM"]
+
       def execute
         unless template_source || use_previous_template?
           signal_usage_error "Specify either --template or --use-previous-template"
@@ -292,6 +303,7 @@ Clamp do
         options[:tags] = tag_source.data if tag_source
         options[:use_previous_template] = use_previous_template?
         options[:force] = force?
+        options[:capabilities] = capability_list
         report_change do
           change_set.create(options)
         end
@@ -434,6 +446,7 @@ Clamp do
             display_event(event)
           end
           break unless follow?
+
           sleep 5
         end
       end

data/lib/stackup/change_set.rb

@@ -87,7 +87,7 @@ module Stackup
     # @raise [Stackup::StackUpdateError] if operation fails
     #
     def execute
-      modify_stack("UPDATE_COMPLETE", "update failed") do
+      modify_stack(/(CREATE|UPDATE)_COMPLETE/, "update failed") do
         cf_client.execute_change_set(:stack_name => stack.name, :change_set_name => name)
       end
     end

data/lib/stackup/differ.rb

@@ -20,7 +20,7 @@ module Stackup
     def diff(existing_data, pending_data, context_lines = nil)
       existing = format(normalize_data(existing_data)) + "\n"
       pending = format(normalize_data(pending_data)) + "\n"
-      diff = Diffy::Diff.new(existing, pending, context: context_lines).to_s(diff_style)
+      diff = Diffy::Diff.new(existing, pending, :context => context_lines).to_s(diff_style)
       diff unless diff =~ /\A\s*\Z/
     end
 

data/lib/stackup/parameters.rb

@@ -58,6 +58,7 @@ module Stackup
         name = name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase if name.respond_to?(:gsub)
         writer = "#{name}="
         raise(ArgumentError, "invalid attribute: #{name.inspect}") unless respond_to?(writer)
+
         public_send(writer, value)
       end
     end

data/lib/stackup/rake_tasks.rb

@@ -1,6 +1,7 @@
 require "rake/tasklib"
 require "tempfile"
 require "yaml"
+require "Pathname"
 
 module Stackup
 
@@ -13,6 +14,7 @@ module Stackup
     attr_accessor :template
     attr_accessor :parameters
     attr_accessor :tags
+    attr_accessor :capabilities
 
     alias namespace= name=
 
@@ -23,6 +25,7 @@ module Stackup
       yield self if block_given?
       raise ArgumentError, "no name provided" unless @name
       raise ArgumentError, "no template provided" unless @template
+
       define
     end
 
@@ -36,14 +39,15 @@ module Stackup
     def define
       namespace(name) do
 
-        data_options = DataOptions.new
-        data_options["--template"] = template
-        data_options["--parameters"] = parameters if parameters
-        data_options["--tags"] = tags if tags
+        data_options = []
+        data_options << DataOption.for("--template", template)
+        data_options << DataOption.for("--parameters", parameters) if parameters
+        data_options << DataOption.for("--tags", tags) if tag
 
         desc "Update #{stack} stack"
-        task "up" => data_options.files do
-          stackup "up", *data_options.to_a
+        task "up" => data_options.grep(DataOptionFile).map(&:argument) do
+          data_options << DataOption.for("--capability", capabilities) if capabilities
+          stackup "up", *data_options.map(&:to_a).flatten
         end
 
         desc "Cancel update of #{stack} stack"
@@ -52,8 +56,8 @@ module Stackup
         end
 
         desc "Show pending changes to #{stack} stack"
-        task "diff" => data_options.files do
-          stackup "diff", *data_options.to_a
+        task "diff" => data_options.grep(DataOptionFile).map(&:argument) do
+          stackup "diff", *data_options.map(&:to_a).flatten
         end
 
         desc "Show #{stack} stack outputs and resources"
@@ -74,41 +78,66 @@ module Stackup
       end
     end
 
-    # Options to "stackup up".
-    #
-    class DataOptions
-
-      def initialize
-        @options = {}
-      end
+    # A flag with optional argument that will be passed to stackup
+    class DataOption
 
-      def []=(option, file_or_value)
-        @options[option] = file_or_value
+      def initialize(flag, argument)
+        @flag = flag
+        @argument = argument
       end
 
-      def files
-        @options.values.grep(String)
+      def to_a
+        [@flag, @argument]
       end
 
-      def to_a
-        [].tap do |result|
-          @options.each do |option, file_or_data|
-            result << option
-            result << maybe_tempfile(file_or_data, option[2..-1])
-          end
+      # Factory method for initialising DataOptions based on class
+      def self.for(flag, argument)
+        if argument.is_a?(Hash)
+          DataOptionHash.new(flag, argument)
+        elsif argument.is_a?(Array)
+          DataOptionArray.new(flag, argument)
+        elsif argument.is_a?(String) && File.exist?(argument)
+          DataOptionFile.new(flag, argument)
+        else
+          DataOption.new(flag, argument)
         end
       end
 
-      def maybe_tempfile(file_or_data, type)
-        return file_or_data if file_or_data.is_a?(String)
-        tempfile = Tempfile.new([type, ".yml"])
-        tempfile.write(YAML.dump(file_or_data))
+      attr_reader :flag
+      attr_reader :argument
+
+    end
+
+    # An option with a Hash argument
+    # Hash content is stored in a temporary file upon conversion
+    class DataOptionHash < DataOption
+
+      def as_tempfile(filename, data)
+        tempfile = Tempfile.new([filename, ".yml"])
+        tempfile.write(YAML.dump(data))
         tempfile.close
         tempfile.path.to_s
       end
 
+      def to_a
+        [@flag, as_tempfile(@flag[2..-1], @argument)]
+      end
+
     end
 
+    # An option with an Array argument
+    # Flag is repeated for every Array member upon conversion
+    class DataOptionArray < DataOption
+
+      def to_a
+        @argument.map { |a| [@flag, a] }.flatten
+      end
+
+    end
+
+    # An option with a File argument
+    class DataOptionFile < DataOption; end
+
   end
 
 end

data/lib/stackup/source.rb

@@ -28,7 +28,7 @@ module Stackup
 
     private
 
-    LOOKS_LIKE_JSON = /\A\s*[\{\[]/
+    LOOKS_LIKE_JSON = /\A\s*[\{\[]/.freeze
 
     def uri
       URI(location)

data/lib/stackup/stack.rb

@@ -41,6 +41,7 @@ module Stackup
     def on_event(event_handler = nil, &block)
       event_handler ||= block
       raise ArgumentError, "no event_handler provided" if event_handler.nil?
+
       @event_handler = event_handler
     end
 
@@ -324,6 +325,7 @@ module Stackup
       if wait?
         status = modify_stack_synchronously(&block)
         raise StackUpdateError, failure_message unless target_status === status
+
         status
       else
         modify_stack_asynchronously(&block)
@@ -344,6 +346,7 @@ module Stackup
           status = self.status
           logger.debug("stack_status=#{status}")
           return status if status.nil? || status =~ /_(COMPLETE|FAILED)$/
+
           sleep(wait_poll_interval)
         end
       end

data/lib/stackup/stack_watcher.rb

@@ -22,6 +22,7 @@ module Stackup
       new_events = []
       stack.events.each do |event|
         break if event.id == @last_processed_event_id
+
         new_events.unshift(event)
       end
       new_events.each do |event|

data/lib/stackup/version.rb

@@ -1,5 +1,5 @@
 module Stackup
 
-  VERSION = "1.4.2".freeze
+  VERSION = "1.4.3".freeze
 
 end

data/lib/stackup/yaml.rb

@@ -24,6 +24,7 @@ module Stackup
       def load(yaml, filename = nil)
         tree = ::YAML.parse(yaml, filename)
         return tree unless tree
+
         CloudFormationToRuby.create.accept(tree)
       end
 

data/spec/stackup/stack_spec.rb

@@ -280,6 +280,22 @@ describe Stackup::Stack do
 
       end
 
+      context "with :capabilities as an Array" do
+
+        before do
+          options[:capabilities] = %w[CAPABILITY_IAM CAPABILITY_NAMED_IAM]
+        end
+
+        it "passes them through" do
+          expected_capabilities = %w[CAPABILITY_IAM CAPABILITY_NAMED_IAM]
+          create_or_update
+          expect(cf_client).to have_received(:create_stack) do |options|
+            expect(options[:capabilities]).to eq(expected_capabilities)
+          end
+        end
+
+      end
+
     end
 
     describe "#change_set#create" do
@@ -360,6 +376,53 @@ describe Stackup::Stack do
 
       end
 
+      context "with :capabilities as an Array" do
+
+        before do
+          options[:capabilities] = %w[CAPABILITY_IAM CAPABILITY_NAMED_IAM]
+        end
+
+        it "passes them through" do
+          expected_capabilities = %w[CAPABILITY_IAM CAPABILITY_NAMED_IAM]
+          create_change_set
+          expect(cf_client).to have_received(:create_change_set) do |options|
+            expect(options[:capabilities]).to eq(expected_capabilities)
+          end
+        end
+
+      end
+
+    end
+
+    describe "#change_set#execute" do
+
+      let(:change_set_name) { "create-it" }
+
+      let(:describe_stacks_responses) do
+        [
+          stack_description("CREATE_IN_PROGRESS"),
+          stack_description("CREATE_COMPLETE")
+        ]
+      end
+
+      def execute_change_set
+        stack.change_set(change_set_name).execute
+      end
+
+      it "calls :execute_change_set" do
+        execute_change_set
+        expected_args = {
+          :stack_name => stack_name,
+          :change_set_name => change_set_name
+        }
+        expect(cf_client).to have_received(:execute_change_set)
+          .with(hash_including(expected_args))
+      end
+
+      it "returns status" do
+        expect(execute_change_set).to eq("CREATE_COMPLETE")
+      end
+
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stackup
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Mike Williams
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-21 00:00:00.000000000 Z
+date: 2019-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -134,8 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Manage CloudFormation stacks