stack_master 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: decf1cea6cb689ff5f5df562e7393715a97c9a59
-  data.tar.gz: 6b2b11e73212a5e154f50a7350618b1e5f3a31a0
+  metadata.gz: 8693e4d791f64b4704d3e5b068d0e3a77fa8c6a6
+  data.tar.gz: 69c0fcb456e40b8dc933ea73697bc194b65e20ea
 SHA512:
-  metadata.gz: 663b7860af6120f09ebed47d50374a51b09d4b4f9f3981b7753f1876fbcefa082b62d5dc99a7ebdeee78a2b85c0f23bcb088a5619e4a69284b08a2574547d537
-  data.tar.gz: 65f77fc48be1584005cfc7292f07815a7f575b5b63cda9c6334572668bedfa9097f50ec5386c4aa25b642acd3e244b56a793bfc3e45ec675a1cf6a749457ed61
+  metadata.gz: 6805b7c93f992d0d83f6728732bf58001e5ebdda5bc2cb59d4438ede7e8ef725feb29f77512b5e3d673210405f7e869d197443b77545c602564f0704efe515ed
+  data.tar.gz: 42bc841676942028c0f8cc59206e5d7ca3dfb8c38301aa52e543c921eff25bd3afd97f0ba2e1a02bbf386e4d81d34684aa3c71e9e32390e69fa8cc35abb00bbd

data/README.md

@@ -168,11 +168,20 @@ region/account, even though the resolved values will be different.
 ### Stack Output
 
 The stack output parameter resolver looks up outputs from other stacks in the
-same region. The expected format is `[stack-name]/[OutputName]`.
+same or different region. The expected format is `[(region|region-alias):]stack-name/(OutputName|output_name)`.
 
 ```yaml
 vpc_id:
+  # Output from a stack in the same region
   stack_output: my-vpc-stack/VpcId
+
+bucket_name:
+  # Output from a stack in a different region
+  stack_output: us-east-1:init-bucket/bucket_name
+
+zone_name:
+  # Output from a stack in a different region using its alias
+  stack_output: global:hosted-zone/ZoneName
 ```
 
 This is the most used parameter resolver because it enables stacks to be split
@@ -307,7 +316,7 @@ vpc_id:
 
 Most resolvers support taking an array of values that will each be resolved.
 Unless stated otherwise in the documentation, the array version of the
-resolver will be named with the [pluralized](http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-pluralize) 
+resolver will be named with the [pluralized](http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-pluralize)
 name of the original resolver.
 
 When creating a new resolver, one can automatically create the array resolver by adding a `array_resolver` statement

data/lib/stack_master/aws_driver/cloud_formation.rb

@@ -3,9 +3,15 @@ module StackMaster
     class CloudFormation
       extend Forwardable
 
-      def set_region(region)
-        @region = region
-        @cf = nil
+      def region
+        @region ||= ENV['AWS_REGION'] || Aws.config[:region] || Aws.shared_config.region
+      end
+
+      def set_region(value)
+        if region != value
+          @region = value
+          @cf = nil
+        end
       end
 
       def_delegators :cf, :create_change_set,
@@ -19,42 +25,16 @@ module StackMaster
                           :get_stack_policy,
                           :describe_stack_events,
                           :update_stack,
-                          :create_stack
-
-      def describe_stacks(options)
-        retry_with_backoff do
-          cf.describe_stacks(options)
-        end
-      end
-
-      def validate_template(options)
-        retry_with_backoff do
-          cf.validate_template(options)
-        end
-      end
+                          :create_stack,
+                          :validate_template,
+                          :describe_stacks
 
       private
 
       def cf
-        @cf ||= Aws::CloudFormation::Client.new(region: @region)
+        @cf ||= Aws::CloudFormation::Client.new(region: region, retry_limit: 10)
       end
 
-      def retry_with_backoff
-        delay       = 1
-        max_delay   = 30
-        begin
-          yield
-        rescue Aws::CloudFormation::Errors::Throttling => e
-          if e.message =~ /Rate exceeded/
-            sleep delay
-            delay *= 2
-            if delay > max_delay
-              delay = max_delay
-            end
-            retry
-          end
-        end
-      end
     end
   end
 end

data/lib/stack_master/parameter_resolvers/stack_output.rb

@@ -10,14 +10,15 @@ module StackMaster
         @config = config
         @stack_definition = stack_definition
         @stacks = {}
+        @cf_drivers = {}
+        @output_regex = %r{(?:(?<region>[^:]+):)?(?<stack_name>[^:/]+)/(?<output_name>.+)}
       end
 
       def resolve(value)
-        validate_value!(value)
-        stack_name, output_name = value.split('/')
-        stack = find_stack(stack_name)
+        region, stack_name, output_name = parse!(value)
+        stack = find_stack(stack_name, region)
         if stack
-          output = stack.outputs.find { |output| output.output_key == output_name.camelize }
+          output = stack.outputs.find { |stack_output| stack_output.output_key == output_name.camelize }
           if output
             output.output_value
           else
@@ -34,21 +35,41 @@ module StackMaster
         @cf ||= StackMaster.cloud_formation_driver
       end
 
-      def validate_value!(value)
-        if !value.is_a?(String) || !value.include?('/')
-          raise ArgumentError, 'Stack output values must be in the form of stack-name/output-name'
+      def parse!(value)
+        if !value.is_a?(String) || !(match = @output_regex.match(value))
+          raise ArgumentError, 'Stack output values must be in the form of [region:]stack-name/output_name'
         end
+
+        [
+          match[:region] || cf.region,
+          match[:stack_name],
+          match[:output_name]
+        ]
       end
 
-      def find_stack(stack_name)
-        @stacks.fetch(stack_name) do
-          cf_stack = cf.describe_stacks(stack_name: stack_name).stacks.first
-          @stacks[stack_name] = cf_stack
+      def find_stack(stack_name, region)
+        unaliased_region = @config.unalias_region(region)
+        stack_key = stack_key(stack_name, unaliased_region)
+
+        @stacks.fetch(stack_key) do
+          regional_cf = cf_for_region(unaliased_region)
+          cf_stack = regional_cf.describe_stacks(stack_name: stack_name).stacks.first
+          @stacks[stack_key] = cf_stack
         end
       end
 
-      def cf
-        @cf ||= StackMaster.cloud_formation_driver
+      def stack_key(stack_name, region)
+        "#{region}:#{stack_name}"
+      end
+
+      def cf_for_region(region)
+        return cf if cf.region == region
+
+        @cf_drivers.fetch(region) do
+          cloud_formation_driver = cf.class.new
+          cloud_formation_driver.set_region(region)
+          @cf_drivers[region] = cloud_formation_driver
+        end
       end
     end
   end

data/lib/stack_master/test_driver/cloud_formation.rb

@@ -65,6 +65,10 @@ module StackMaster
         reset
       end
 
+      def region
+        @region ||= ENV['AWS_REGION'] || Aws.config[:region] || Aws.shared_config.region
+      end
+
       def set_region(region)
         @region = region
       end

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/spec/stack_master/commands/delete_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe StackMaster::Commands::Delete do
 
   before do
     StackMaster.cloud_formation_driver.set_region(region)
-    allow(Aws::CloudFormation::Client).to receive(:new).with(region: region).and_return(cf)
+    allow(Aws::CloudFormation::Client).to receive(:new).with(region: region, retry_limit: 10).and_return(cf)
     allow(delete).to receive(:ask?).and_return('y')
     allow(StackMaster::StackEvents::Streamer).to receive(:stream)
   end

data/spec/stack_master/commands/status_spec.rb

@@ -41,23 +41,4 @@ RSpec.describe StackMaster::Commands::Status do
     end
   end
 
-  context "handles AWS throttling" do
-    let(:throttle_exception)  { Aws::CloudFormation::Errors::Throttling.new(double(), "Rate exceeded.") }
-    let(:stack1) { double(:stack1, template_hash: {}, parameters_with_defaults: {a: 1}, stack_status: 'UPDATE_COMPLETE') }
-    let(:stack2) { double(:stack2, template_hash: {}, parameters_with_defaults: {a: 2}, stack_status: 'CREATE_COMPLETE') }
-    let(:proposed_stack1) { double(:proposed_stack1, template_body: "{}", parameters_with_defaults: {a: 1}) }
-    let(:proposed_stack2) { double(:proposed_stack2, template_body: "{}", parameters_with_defaults: {a: 1}) }
-
-    it "doubles the sleep time across calls" do
-      call_count = 0
-      expect(cf).to receive(:describe_stacks).at_least(1).times do 
-        call_count += 1
-        call_count <= 3 ? raise(throttle_exception) : double(stacks: double(first: nil))
-      end
-      expect(StackMaster.cloud_formation_driver).to receive(:sleep).with(1).ordered
-      expect(StackMaster.cloud_formation_driver).to receive(:sleep).with(2).ordered
-      expect(StackMaster.cloud_formation_driver).to receive(:sleep).with(4).ordered
-      expect { status.perform }.to_not raise_exception
-    end
-  end
 end

data/spec/stack_master/parameter_resolvers/stack_output_spec.rb

@@ -1,9 +1,9 @@
 RSpec.describe StackMaster::ParameterResolvers::StackOutput do
   let(:region) { 'us-east-1' }
   let(:stack_name) { 'my-stack' }
-  let(:config) { double }
   let(:resolver) { described_class.new(config, double(region: 'us-east-1')) }
   let(:cf) { Aws::CloudFormation::Client.new }
+  let(:config) { double(:unalias_region => region) }
 
   def resolve(value)
     resolver.resolve(value)
@@ -74,4 +74,54 @@ RSpec.describe StackMaster::ParameterResolvers::StackOutput do
       end
     end
   end
+
+  context 'when given a valid string value including region' do
+    let(:value) { 'us-east-1:my-stack/MyOutput' }
+    let(:stacks) { [{ stack_name: 'my-stack', creation_time: Time.now, stack_status: 'CREATE_COMPLETE', outputs: outputs}] }
+    let(:outputs) { [] }
+
+    before do
+      allow(Aws::CloudFormation::Client).to receive(:new).and_return(cf)
+      cf.stub_responses(:describe_stacks, stacks: stacks)
+    end
+
+    context 'the stack and output exist' do
+      let(:outputs) { [{output_key: 'MyOutput', output_value: 'myresolvedvalue'}] }
+
+      it 'resolves the value' do
+        expect(resolved_value).to eq 'myresolvedvalue'
+      end
+
+      context 'the stack and output exist in a different region with the same name' do
+        let(:value_in_region_alias) { 'global:my-stack/MyOutput' }
+        let(:value_in_region_2) { 'ap-southeast-2:my-stack/MyOutput' }
+        let(:outputs_in_region_2) { [{output_key: 'MyOutput', output_value: 'myresolvedvalue2'}] }
+        let(:stacks_in_region_2) { [{ stack_name: 'my-stack', creation_time: Time.now, stack_status: 'CREATE_COMPLETE', outputs: outputs_in_region_2}] }
+
+        before do
+          cf.stub_responses(
+            :describe_stacks,
+            { stacks: stacks },
+            { stacks: stacks_in_region_2 }
+          )
+          allow(config).to receive(:unalias_region) do |aliased_region|
+            if aliased_region == 'global'
+              'us-east-1'
+            else
+              aliased_region
+            end
+          end
+        end
+
+        it 'resolves the value to the right region' do
+          resolver.resolve(value)
+          expect(resolver.resolve(value_in_region_2)).to eq 'myresolvedvalue2'
+        end
+
+        it 'resolves to the same region if it is an alias' do
+          expect(resolver.resolve(value_in_region_alias)).to eq 'myresolvedvalue'
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler