stack_master 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 912d6ca4f6983f7596e2f19064a3a095b766dcea
-  data.tar.gz: 2d10bee6f5db987640f7ae0bdf53749f7baa7030
+  metadata.gz: dac9ea54e5fb5f551c15e0d077816eb62b79cb7a
+  data.tar.gz: f9e58ade11de8c75902ffc8ed83a03d623b02a83
 SHA512:
-  metadata.gz: 290c0443cc24477a349f8c1256ff915652ab99b233b7013d08316656eab94df4b8e87f8299133ff9e1b804c46f1b1a21f56ead4223678d81f1686614302400b0
-  data.tar.gz: 4105297fb4bd6c6535bb0cb143709406dec991b3dc9ebf7fc20d6e332b8f568178db5ce36932f756235947f024c5518e8319f896b4b64f28a3df600c74250c70
+  metadata.gz: 18f4ad8e75146c81a63b33aade1e97ac14d133863def43e62f78e969120122eeba7ec33f90253d7582904443d9cedcab444d54c57e43637e5800981ff0a4000d
+  data.tar.gz: 311a35d9e1976033c4ab45a588199596b8be674af0669abd0dc27c77ec7f17f9a28b09d050ab0586b72fc578c02afab99aec9acf5112f6ac57fdbe9df988e574

data/lib/stack_master.rb

@@ -24,6 +24,7 @@ module StackMaster
   autoload :ResolverArray, 'stack_master/resolver_array'
   autoload :Resolver, 'stack_master/resolver_array'
   autoload :Utils, 'stack_master/utils'
+  autoload :TemplateUtils, 'stack_master/template_utils'
   autoload :Config, 'stack_master/config'
   autoload :PagedResponseAccumulator, 'stack_master/paged_response_accumulator'
   autoload :StackDefinition, 'stack_master/stack_definition'

data/lib/stack_master/commands/apply.rb

@@ -103,7 +103,7 @@ module StackMaster
         if use_s3?
           s3.url(bucket: @s3_config['bucket'], prefix: @s3_config['prefix'], region: @s3_config['region'], template: @stack_definition.s3_template_file_name)
         else
-          proposed_stack.maybe_compressed_template_body
+          proposed_stack.template
         end
       end
 
@@ -112,7 +112,7 @@ module StackMaster
         @stack_definition.s3_files.tap do |files|
           files[@stack_definition.s3_template_file_name] = {
             path: @stack_definition.template_file_path,
-            body: proposed_stack.maybe_compressed_template_body
+            body: proposed_stack.template
           }
         end
       end

data/lib/stack_master/stack.rb

@@ -1,8 +1,5 @@
 module StackMaster
   class Stack
-    MAX_TEMPLATE_SIZE = 51200
-    MAX_S3_TEMPLATE_SIZE = 460800
-
     attr_reader :stack_name,
                 :region,
                 :stack_id,
@@ -18,25 +15,8 @@ module StackMaster
 
     include Utils::Initializable
 
-    def template_hash
-      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
-      # 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
-      template_hash.fetch('Parameters', {}).inject({}) do |result, (parameter_name, description)|
+      TemplateUtils.template_hash(template).fetch('Parameters', {}).inject({}) do |result, (parameter_name, description)|
         result[parameter_name] = description['Default']
         result
       end
@@ -61,7 +41,7 @@ module StackMaster
         params_hash
       end
       template_body ||= cf.get_template(stack_name: stack_name).template_body
-      template_format = identify_template_format(template_body)
+      template_format = TemplateUtils.identify_template_format(template_body)
       stack_policy_body ||= cf.get_stack_policy(stack_name: stack_name).stack_policy_body
       outputs = cf_stack.outputs
 
@@ -82,7 +62,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)
+      template_format = TemplateUtils.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)
@@ -97,19 +77,13 @@ module StackMaster
           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
+      return TemplateUtils::MAX_S3_TEMPLATE_SIZE if use_s3
+      TemplateUtils::MAX_TEMPLATE_SIZE
     end
 
     def too_big?(use_s3 = false)
-      maybe_compressed_template_body.size > max_template_size(use_s3)
+      template.size > max_template_size(use_s3)
     end
 
     def aws_parameters
@@ -119,5 +93,9 @@ module StackMaster
     def aws_tags
       Utils.hash_to_aws_tags(tags)
     end
+
+    def template
+      @template ||= TemplateUtils.maybe_compressed_template_body(template_body)
+    end
   end
 end

data/lib/stack_master/stack_differ.rb

@@ -15,7 +15,7 @@ module StackMaster
     def current_template
       return '' unless @current_stack
       return @current_stack.template_body unless @current_stack.template_format == :json
-      JSON.pretty_generate(@current_stack.template_hash)
+      JSON.pretty_generate(TemplateUtils.template_hash(@current_stack.template_body))
     end
 
     def current_parameters

data/lib/stack_master/template_utils.rb

@@ -0,0 +1,31 @@
+module StackMaster
+  module TemplateUtils
+    MAX_TEMPLATE_SIZE = 51200
+    MAX_S3_TEMPLATE_SIZE = 460800
+
+    extend self
+
+    def identify_template_format(template_body)
+      return :json if template_body =~ /^{/x # ignore leading whitespaces
+      :yaml
+    end
+
+    def template_hash(template_body=nil)
+      return unless template_body
+      template_format = identify_template_format(template_body)
+      case template_format
+      when :json
+        JSON.parse(template_body)
+      when :yaml
+        YAML.load(template_body)
+      end
+    end
+
+    def maybe_compressed_template_body(template_body)
+      # 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 || identify_template_format(template_body) != :json
+      JSON.dump(template_hash(template_body))
+    end
+  end
+end

data/lib/stack_master/validator.rb

@@ -11,8 +11,8 @@ module StackMaster
 
     def perform
       StackMaster.stdout.print "#{@stack_definition.stack_name}: "
-      template_body = Stack.generate(@stack_definition, @config).maybe_compressed_template_body
-      cf.validate_template(template_body: template_body)
+      template_body = TemplateCompiler.compile(@config, @stack_definition.template_file_path)
+      cf.validate_template(template_body: TemplateUtils.maybe_compressed_template_body(template_body))
       StackMaster.stdout.puts "valid"
       true
     rescue Aws::CloudFormation::Errors::ValidationError => e

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "0.10.1"
+  VERSION = "0.10.2"
 end

data/spec/fixtures/parameters/myapp_vpc_with_secrets.yml

@@ -0,0 +1,3 @@
+param_1: 'hello'
+param_2:
+  secret: world

data/spec/fixtures/stack_master.yml

@@ -32,6 +32,8 @@ stacks:
         - test_arn_2
     myapp_web:
       template: myapp_web.rb
+    myapp_vpc_with_secrets:
+      template: myapp_vpc.json
   ap-southeast-2:
     myapp_vpc:
       template: myapp_vpc.rb

data/spec/stack_master/commands/status_spec.rb

@@ -17,8 +17,8 @@ RSpec.describe StackMaster::Commands::Status do
     end
 
     context "some parameters are different" do
-      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(:stack1) { double(:stack1, template_body: '{}', template_hash: {}, template_format: :json, parameters_with_defaults: {a: 1}, stack_status: 'UPDATE_COMPLETE') }
+      let(:stack2) { double(:stack2, template_body: '{}', 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}) }
 
@@ -29,8 +29,8 @@ RSpec.describe StackMaster::Commands::Status do
     end
 
     context "some templates are different" do
-      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(:stack1) { double(:stack1, template_body: '{"foo": "bar"}', template_hash: {foo: 'bar'}, template_format: :json, parameters_with_defaults: {a: 1}, stack_status: 'UPDATE_COMPLETE') }
+      let(:stack2) { double(:stack2, template_body: '{}', 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}) }
 

data/spec/stack_master/config_spec.rb

@@ -53,12 +53,12 @@ RSpec.describe StackMaster::Config do
 
     it 'can filter by region only' do
       stacks = loaded_config.filter('us-east-1')
-      expect(stacks.size).to eq 2
+      expect(stacks.size).to eq 3
     end
 
     it 'can return all stack definitions with no filters' do
       stacks = loaded_config.filter
-      expect(stacks.size).to eq 4
+      expect(stacks.size).to eq 5
     end
   end
 

data/spec/stack_master/stack_spec.rb

@@ -124,26 +124,6 @@ RSpec.describe StackMaster::Stack do
     end
   end
 
-  describe "#maybe_compressed_template_body" do
-    subject(:maybe_compressed_template_body) do
-      stack.maybe_compressed_template_body
-    end
-    context "undersized json" do
-      let(:stack) { described_class.new(template_body: '{     }' ) }
-
-      it "leaves the json alone if it's not too large" do
-        expect(maybe_compressed_template_body).to eq('{     }')
-      end
-    end
-
-    context "oversized json" do
-      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
-    end
-  end
-
   describe '#too_big?' do
     let(:big_stack) { described_class.new(template_body: "{\"a\":\"#{'x' * 500000}\"}") }
     let(:medium_stack) { described_class.new(template_body: "{\"a\":\"#{'x' * 60000}\"}") }

data/spec/stack_master/template_utils_spec.rb

@@ -0,0 +1,21 @@
+RSpec.describe StackMaster::TemplateUtils do
+  describe "#maybe_compressed_template_body" do
+    subject(:maybe_compressed_template_body) do
+      described_class.maybe_compressed_template_body(template_body)
+    end
+    context "undersized json" do
+      let(:template_body) { '{     }' }
+
+      it "leaves the json alone if it's not too large" do
+        expect(maybe_compressed_template_body).to eq('{     }')
+      end
+    end
+
+    context "oversized json" do
+      let(:template_body) { "{#{' ' * 60000}}" }
+      it "compresses the json when it's overly bulbous" do
+        expect(maybe_compressed_template_body).to eq('{}')
+      end
+    end
+  end
+end

data/spec/stack_master/validator_spec.rb

@@ -2,10 +2,11 @@ RSpec.describe StackMaster::Validator do
 
   subject(:validator) { described_class.new(stack_definition, config) }
   let(:config) { StackMaster::Config.new({'stacks' => {}}, '/base_dir') }
+  let(:stack_name) { 'myapp_vpc' }
   let(:stack_definition) do
     StackMaster::StackDefinition.new(
       region: 'us-east-1',
-      stack_name: 'myapp_vpc',
+      stack_name: stack_name,
       template: 'myapp_vpc.json',
       tags: { 'environment' => 'production' },
       base_dir: File.expand_path('spec/fixtures'),
@@ -34,6 +35,18 @@ RSpec.describe StackMaster::Validator do
         expect { validator.perform }.to output(/myapp_vpc: invalid/).to_stdout
       end
     end
+
+    context "validate is called from from a continuous integration system with no access to secrets" do
+      let(:stack_name) { 'myapp_vpc_with_secrets' }
+      let(:secret) { instance_double(StackMaster::ParameterResolvers::Secret) }
+      before do
+        allow(StackMaster::ParameterResolvers::Secret).to receive(:new).and_return(secret)
+      end
+      it "does not prompt for the secret key" do
+        expect(secret).not_to receive(:resolve)
+        validator.perform
+      end
+    end
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-23 00:00:00.000000000 Z
+date: 2016-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -362,6 +362,7 @@ files:
 - lib/stack_master/template_compilers/json.rb
 - lib/stack_master/template_compilers/sparkle_formation.rb
 - lib/stack_master/template_compilers/yaml.rb
+- lib/stack_master/template_utils.rb
 - lib/stack_master/test_driver/cloud_formation.rb
 - lib/stack_master/test_driver/s3.rb
 - lib/stack_master/testing.rb
@@ -373,6 +374,7 @@ files:
 - script/buildkite/clean.sh
 - script/buildkite_rspec.sh
 - spec/fixtures/parameters/myapp_vpc.yml
+- spec/fixtures/parameters/myapp_vpc_with_secrets.yml
 - spec/fixtures/stack_master.yml
 - spec/fixtures/templates/json/valid_myapp_vpc.json
 - spec/fixtures/templates/myapp_vpc.json
@@ -417,6 +419,7 @@ files:
 - spec/stack_master/template_compilers/json_spec.rb
 - spec/stack_master/template_compilers/sparkle_formation_spec.rb
 - spec/stack_master/template_compilers/yaml_spec.rb
+- spec/stack_master/template_utils_spec.rb
 - spec/stack_master/test_driver/cloud_formation_spec.rb
 - spec/stack_master/test_driver/s3_spec.rb
 - spec/stack_master/utils_spec.rb
@@ -468,6 +471,7 @@ test_files:
 - features/support/env.rb
 - features/validate.feature
 - spec/fixtures/parameters/myapp_vpc.yml
+- spec/fixtures/parameters/myapp_vpc_with_secrets.yml
 - spec/fixtures/stack_master.yml
 - spec/fixtures/templates/json/valid_myapp_vpc.json
 - spec/fixtures/templates/myapp_vpc.json
@@ -512,6 +516,7 @@ test_files:
 - spec/stack_master/template_compilers/json_spec.rb
 - spec/stack_master/template_compilers/sparkle_formation_spec.rb
 - spec/stack_master/template_compilers/yaml_spec.rb
+- spec/stack_master/template_utils_spec.rb
 - spec/stack_master/test_driver/cloud_formation_spec.rb
 - spec/stack_master/test_driver/s3_spec.rb
 - spec/stack_master/utils_spec.rb