stack_master 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c7bca8cc5ad9464ac48f4584a1d85cd14bb8e0b
-  data.tar.gz: c39f36d3f6455097c66a0e1284eab2c5d7402b64
+  metadata.gz: eb2d6fdde6c2c8a5c212ceaedc25d27c25fbc825
+  data.tar.gz: ceb28eba091a63fb75505bc39d4409280145618c
 SHA512:
-  metadata.gz: cf9a371a2ed906ce11a8fc77b307786ba0156fb96042d18c49a73747c52399fdfb774e0b6177df376566dec989abf32b162697675c80a14915a8db754eee368d
-  data.tar.gz: 740933a0d714f31265014462db257c930c65c3bfdf9e9b8dcfdf63b6379f7e362b55d2c121de2d0babd031cd8c2cffb1634a63bce426d0065b567d84f672f275
+  metadata.gz: 9ee79f7e351f949f06afc53253f8e6e6760abec82d83dee94071c3d2a9d003030978a9d71dc7a4da4c89f307380fab15151cd1c1d6eed8a3cc42014bd09998c0
+  data.tar.gz: 06276a434b95691c632bd99688b18f83b14d3dc0e8f389da6593740809cd164c5737ad16197577a65453029d8c22d0ed1fbb275fc6ddc38283c4196a07ee2c8f

data/lib/stack_master/cli.rb

@@ -41,6 +41,7 @@ module StackMaster
         c.summary = 'Creates or updates a stack'
         c.description = "Creates or updates a stack. Shows a diff of the proposed stack's template and parameters. Tails stack events until CloudFormation has completed."
         c.example 'update a stack named myapp-vpc in us-east-1', 'stack_master apply us-east-1 myapp-vpc'
+        c.option '--on-failure ACTION', String, 'Action to take on CREATE_FAILURE. Valid Values: [ DO_NOTHING | ROLLBACK | DELETE ]. Default: ROLLBACK'
         c.action do |args, options|
           options.defaults config: default_config_file
           execute_stacks_command(StackMaster::Commands::Apply, args, options)

data/lib/stack_master/commands/apply.rb

@@ -6,11 +6,13 @@ module StackMaster
       include StackMaster::Prompter
       TEMPLATE_TOO_LARGE_ERROR_MESSAGE = 'The (space compressed) stack is larger than the limit set by AWS. See http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html'.freeze
 
-      def initialize(config, stack_definition, options = {})
+      def initialize(config, stack_definition, options = Commander::Command::Options.new)
         @config = config
         @s3_config = stack_definition.s3
         @stack_definition = stack_definition
         @from_time = Time.now
+        @options = options
+        @options.on_failure ||= "ROLLBACK"
       end
 
       def perform
@@ -64,7 +66,8 @@ module StackMaster
           failed!("Stack creation aborted")
         end
         upload_files
-        cf.create_stack(stack_options.merge(tags: proposed_stack.aws_tags))
+        on_failure = @config.stack_defaults['on_failure'] || @options.on_failure
+        cf.create_stack(stack_options.merge({tags: proposed_stack.aws_tags, on_failure: on_failure}))
       end
 
       def ask_to_cancel_stack_update

data/lib/stack_master/parameter_resolver.rb

@@ -30,7 +30,11 @@ module StackMaster
     def require_parameter_resolver(file_name)
       require "stack_master/parameter_resolvers/#{file_name}"
     rescue LoadError
-      raise ResolverNotFound.new(file_name)
+      if file_name == file_name.singularize
+        raise ResolverNotFound.new(file_name)
+      else
+        require_parameter_resolver(file_name.singularize)
+      end
     end
 
     def load_parameter_resolver(class_name)
@@ -53,6 +57,8 @@ module StackMaster
       value = parameter_value.values.first
       resolver_class_name = resolver_name.camelize
       call_resolver(resolver_class_name, value)
+    rescue Aws::CloudFormation::Errors::ValidationError
+      raise InvalidParameter, $!.message
     end
 
     def call_resolver(class_name, value)

data/lib/stack_master/stack.rb

@@ -9,6 +9,7 @@ module StackMaster
                 :stack_status,
                 :parameters,
                 :template_body,
+                :template_format,
                 :notification_arns,
                 :outputs,
                 :stack_policy_body,
@@ -18,17 +19,20 @@ module StackMaster
     include Utils::Initializable
 
     def template_hash
-      if template_body
-        @template_hash ||= JSON.parse(template_body)
-      end
+      return unless template_body
+      @template_hash ||= case template_format
+                         when :json
+                           JSON.parse(template_body)
+                         when :yaml
+                           YAML.load(template_body)
+                         end
     end
 
     def maybe_compressed_template_body
-      if template_body.size > MAX_TEMPLATE_SIZE
-        @compressed_template_body ||= JSON.dump(template_hash)
-      else
-        template_body
-      end
+      # Do not compress the template if it's not JSON because parsing YAML as a hash ignores
+      # CloudFormation-specific tags such as !Ref
+      return template_body if template_body.size <= MAX_TEMPLATE_SIZE || template_format != :json
+      @compressed_template_body ||= JSON.dump(template_hash)
     end
 
     def template_default_parameters
@@ -57,6 +61,7 @@ module StackMaster
         params_hash
       end
       template_body ||= cf.get_template(stack_name: stack_name).template_body
+      template_format = identify_template_format(template_body)
       stack_policy_body ||= cf.get_stack_policy(stack_name: stack_name).stack_policy_body
       outputs = cf_stack.outputs
 
@@ -65,6 +70,7 @@ module StackMaster
           stack_id: cf_stack.stack_id,
           parameters: parameters,
           template_body: template_body,
+          template_format: template_format,
           outputs: outputs,
           notification_arns: cf_stack.notification_arns,
           stack_policy_body: stack_policy_body,
@@ -76,6 +82,7 @@ module StackMaster
     def self.generate(stack_definition, config)
       parameter_hash = ParameterLoader.load(stack_definition.parameter_files)
       template_body = TemplateCompiler.compile(config, stack_definition.template_file_path)
+      template_format = identify_template_format(template_body)
       parameters = ParameterResolver.resolve(config, stack_definition, parameter_hash)
       stack_policy_body = if stack_definition.stack_policy_file_path
                             File.read(stack_definition.stack_policy_file_path)
@@ -85,10 +92,17 @@ module StackMaster
           tags: stack_definition.tags,
           parameters: parameters,
           template_body: template_body,
+          template_format: template_format,
           notification_arns: stack_definition.notification_arns,
           stack_policy_body: stack_policy_body)
     end
 
+    def self.identify_template_format(template_body)
+      return :json if template_body =~ /^{/x # ignore leading whitespaces
+      :yaml
+    end
+    private_class_method :identify_template_format
+
     def max_template_size(use_s3)
       return MAX_S3_TEMPLATE_SIZE if use_s3
       MAX_TEMPLATE_SIZE

data/lib/stack_master/stack_definition.rb

@@ -60,6 +60,7 @@ module StackMaster
     end
 
     def s3_template_file_name
+      return template if ['.json', '.yaml', '.yml'].include?(File.extname(template))
       Utils.change_extension(template, 'json')
     end
 

data/lib/stack_master/stack_differ.rb

@@ -8,15 +8,14 @@ module StackMaster
     end
 
     def proposed_template
+      return @proposed_stack.template_body unless @proposed_stack.template_format == :json
       JSON.pretty_generate(JSON.parse(@proposed_stack.template_body))
     end
 
     def current_template
-      if @current_stack
-        JSON.pretty_generate(@current_stack.template_hash)
-      else
-        ''
-      end
+      return '' unless @current_stack
+      return @current_stack.template_body unless @current_stack.template_format == :json
+      JSON.pretty_generate(@current_stack.template_hash)
     end
 
     def current_parameters

data/lib/stack_master/template_compilers/yaml.rb

@@ -6,10 +6,9 @@ module StackMaster::TemplateCompilers
     end
 
     def self.compile(template_file_path)
-      template_body = File.read(template_file_path)
-      JSON.dump(YAML.load(template_body))
+      File.read(template_file_path)
     end
 
     StackMaster::TemplateCompiler.register(:yaml, self)
   end
-end
+end

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "0.7.2"
+  VERSION = "0.8.0"
 end

data/spec/stack_master/commands/apply_spec.rb

@@ -7,8 +7,9 @@ RSpec.describe StackMaster::Commands::Apply do
   let(:notification_arn) { 'test_arn' }
   let(:stack_definition) { StackMaster::StackDefinition.new(base_dir: '/base_dir', region: region, stack_name: stack_name) }
   let(:template_body) { '{}' }
+  let(:template_format) { :json }
   let(:parameters) { { 'param_1' => 'hello' } }
-  let(:proposed_stack) { StackMaster::Stack.new(template_body: template_body, tags: { 'environment' => 'production' } , parameters: parameters, notification_arns: [notification_arn], stack_policy_body: stack_policy_body ) }
+  let(:proposed_stack) { StackMaster::Stack.new(template_body: template_body, template_format: template_format, tags: { 'environment' => 'production' } , parameters: parameters, notification_arns: [notification_arn], stack_policy_body: stack_policy_body ) }
   let(:stack_policy_body) { '{}' }
 
   before do
@@ -134,7 +135,8 @@ RSpec.describe StackMaster::Commands::Apply do
           }],
         capabilities: ['CAPABILITY_IAM'],
         notification_arns: [notification_arn],
-        stack_policy_body: stack_policy_body
+        stack_policy_body: stack_policy_body,
+        on_failure: 'ROLLBACK'
       )
     end
 
@@ -155,6 +157,23 @@ RSpec.describe StackMaster::Commands::Apply do
         expect(StackMaster::StackEvents::Streamer).to have_received(:stream).with(stack_name, region, io: STDOUT, from: Time.now)
       end
     end
+
+    it 'on_failure can be set to a custom value' do
+      config.stack_defaults['on_failure'] = 'DELETE'
+      apply
+      expect(cf).to have_received(:create_stack).with(
+        hash_including(on_failure: 'DELETE')
+      )
+    end
+
+    it 'on_failure can be passed in options' do
+      options = Commander::Command::Options.new
+      options.on_failure = 'DELETE'
+      StackMaster::Commands::Apply.perform(config, stack_definition, options)
+      expect(cf).to have_received(:create_stack).with(
+        hash_including(on_failure: 'DELETE')
+      )
+    end
   end
 
   context 'one or more parameters are empty' do

data/spec/stack_master/commands/status_spec.rb

@@ -17,10 +17,10 @@ RSpec.describe StackMaster::Commands::Status do
     end
 
     context "some parameters are different" do
-      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}) }
+      let(:stack1) { double(:stack1, template_hash: {}, template_format: :json, parameters_with_defaults: {a: 1}, stack_status: 'UPDATE_COMPLETE') }
+      let(:stack2) { double(:stack2, template_hash: {}, template_format: :json, parameters_with_defaults: {a: 2}, stack_status: 'CREATE_COMPLETE') }
+      let(:proposed_stack1) { double(:proposed_stack1, template_body: "{}", template_format: :json, parameters_with_defaults: {a: 1}) }
+      let(:proposed_stack2) { double(:proposed_stack2, template_body: "{}", template_format: :json, parameters_with_defaults: {a: 1}) }
 
       it "returns the status of call stacks" do
         out = "REGION    | STACK_NAME | STACK_STATUS    | DIFFERENT\n----------|------------|-----------------|----------\nus-east-1 | stack1     | UPDATE_COMPLETE | No       \nus-east-1 | stack2     | CREATE_COMPLETE | Yes      \n * No echo parameters can't be diffed\n"
@@ -29,10 +29,10 @@ RSpec.describe StackMaster::Commands::Status do
     end
 
     context "some templates are different" do
-      let(:stack1) { double(:stack1, template_hash: {foo: 'bar'}, parameters_with_defaults: {a: 1}, stack_status: 'UPDATE_COMPLETE') }
-      let(:stack2) { double(:stack2, template_hash: {}, parameters_with_defaults: {a: 1}, 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}) }
+      let(:stack1) { double(:stack1, template_hash: {foo: 'bar'}, template_format: :json, parameters_with_defaults: {a: 1}, stack_status: 'UPDATE_COMPLETE') }
+      let(:stack2) { double(:stack2, template_hash: {}, template_format: :json, parameters_with_defaults: {a: 1}, stack_status: 'CREATE_COMPLETE') }
+      let(:proposed_stack1) { double(:proposed_stack1, template_body: "{}", template_format: :json, parameters_with_defaults: {a: 1}) }
+      let(:proposed_stack2) { double(:proposed_stack2, template_body: "{}", template_format: :json, parameters_with_defaults: {a: 1}) }
 
       it "returns the status of call stacks" do
         out = "REGION    | STACK_NAME | STACK_STATUS    | DIFFERENT\n----------|------------|-----------------|----------\nus-east-1 | stack1     | UPDATE_COMPLETE | Yes      \nus-east-1 | stack2     | CREATE_COMPLETE | No       \n * No echo parameters can't be diffed\n"

data/spec/stack_master/parameter_resolver_spec.rb

@@ -17,9 +17,20 @@ RSpec.describe StackMaster::ParameterResolver do
       end
     end
   }
+  let(:bad_resolver) {
+    Class.new do
+      def initialize(config, region)
+      end
+
+      def resolve(value)
+        raise Aws::CloudFormation::Errors::ValidationError.new(nil, "Can't find stack")
+      end
+    end
+  }
 
   before do
     stub_const('StackMaster::ParameterResolvers::MyResolver', my_resolver)
+    stub_const('StackMaster::ParameterResolvers::BadResolver', bad_resolver)
   end
 
   def resolve(params)
@@ -69,6 +80,14 @@ RSpec.describe StackMaster::ParameterResolver do
     end
   end
 
+  context 'when the resolver throws a ValidationError' do
+    it 'throws a invalid parameter error' do
+      expect {
+        resolve(param: { bad_resolver: 2 })
+      }.to raise_error StackMaster::ParameterResolver::InvalidParameter
+    end
+  end
+
   context 'resolver class caching' do
     it "uses the same instance of the resolver for the duration of the resolve run" do
       expect(my_resolver).to receive(:new).once.and_call_original
@@ -99,5 +118,21 @@ RSpec.describe StackMaster::ParameterResolver do
 
       parameter_resolver.resolve
     end
+
+    context "using an array resolver" do
+      let(:params) do
+        {
+          param: { other_dummy_resolvers: [1, 2] }
+        }
+      end
+
+      it "tries to load the plural and singular forms" do
+        expect(parameter_resolver).to receive(:require_parameter_resolver).with("other_dummy_resolvers").once.and_call_original.ordered
+        expect(parameter_resolver).to receive(:require_parameter_resolver).with("other_dummy_resolver").once.ordered
+        expect(parameter_resolver).to receive(:call_resolver).and_return nil
+
+        parameter_resolver.resolve
+      end
+    end
   end
 end

data/spec/stack_master/stack_differ_spec.rb

@@ -6,11 +6,13 @@ RSpec.describe StackMaster::StackDiffer do
                                        region: region,
                                        stack_id: 123,
                                        template_body: '{}',
+                                       template_format: :json,
                                        parameters: current_params) }
   let(:proposed_stack) { StackMaster::Stack.new(stack_name: stack_name,
                                                 region: region,
                                                 parameters: proposed_params,
-                                                template_body: "{\"a\": 1}") }
+                                                template_body: "{\"a\": 1}",
+                                                template_format: :json) }
   let(:stack_name) { 'myapp-vpc' }
   let(:region) { 'us-east-1' }
 

data/spec/stack_master/stack_spec.rb

@@ -77,6 +77,7 @@ RSpec.describe StackMaster::Stack do
     let(:resolved_parameters) { { 'DbPassword' => 'sdfgjkdhlfjkghdflkjghdflkjg', 'InstanceType' => 't2.medium' } }
     let(:template_file_name) { 'template.rb' }
     let(:template_body) { '{"Parameters": { "VpcId": { "Description": "VPC ID" }, "InstanceType": { "Description": "Instance Type", "Default": "t2.micro" }} }' }
+    let(:template_format) { :json }
     let(:stack_policy_body) { '{}' }
 
     before do
@@ -136,7 +137,7 @@ RSpec.describe StackMaster::Stack do
     end
 
     context "oversized json" do
-      let(:stack) { described_class.new(template_body: "{#{' ' * 60000}}" ) }
+      let(:stack) { described_class.new(template_body: "{#{' ' * 60000}}", template_format: :json) }
       it "compresses the json when it's overly bulbous" do
         expect(maybe_compressed_template_body).to eq('{}')
       end
@@ -176,7 +177,7 @@ RSpec.describe StackMaster::Stack do
   describe '#missing_parameters?' do
     subject { stack.missing_parameters? }
 
-    let(:stack) { StackMaster::Stack.new(parameters: parameters, template_body: '{}') }
+    let(:stack) { StackMaster::Stack.new(parameters: parameters, template_body: '{}', template_format: :json) }
 
     context 'when a parameter has a nil value' do
       let(:parameters) { { 'my_param' => nil } }

data/spec/stack_master/template_compilers/yaml_spec.rb

@@ -7,12 +7,11 @@ RSpec.describe StackMaster::TemplateCompilers::Yaml do
     context 'valid YAML template' do
       let(:template_file_path) { 'spec/fixtures/templates/yml/valid_myapp_vpc.yml' }
 
-      it 'produces valid JSON' do
-        valid_myapp_vpc_as_json = File.read('spec/fixtures/templates/json/valid_myapp_vpc.json')
-        valid_myapp_vpc_as_hash = JSON.parse(valid_myapp_vpc_as_json)
+      it 'produces valid YAML' do
+        valid_myapp_vpc_yaml = File.read('spec/fixtures/templates/yml/valid_myapp_vpc.yml')
 
-        expect(JSON.parse(compile)).to eq(valid_myapp_vpc_as_hash)
+        expect(compile).to eq(valid_myapp_vpc_yaml)
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler