stack_master 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77c6c6c758e05af556c50439bfdf5dce99720a8deb44f485f0e17bcbd82890a6
-  data.tar.gz: 8f467f0f94b7e963afac93400d4f2c4152a3cbc6e12dc0949ed8fcfc857f5d9d
+  metadata.gz: a80f3544c2f5a4920fcc6bfb3ff09a524549f028cba7a6736b0e761560599d73
+  data.tar.gz: 2bee13731638f892921863c688c88e59fd4213e906c73afc1cc2434b3b36b4f7
 SHA512:
-  metadata.gz: f32beb39936cbe533bf08949f2a9657f69dc353dda6bf12f9d98d4736a00060d3745baec090d02fb02288d7abf739a923c0d21af6f7d77f27d2540b67971535d
-  data.tar.gz: 467c51b8edc25e774f20ab3a804b8d44f3559bbde1e9c7817f67935d8a1a4a577d7d4f3181650c48bfa708b11a314213c1ae40e44a546dd03ba882ef225608a1
+  metadata.gz: b8b64ef00d94df9456194077d70386143a9722ffd52b04177c38eacd76805bd377a1116f5c29e70d346b730a758c57628404f4ad416210a4d224fc2590e72719
+  data.tar.gz: fb8a380e0ac314af64e62e5395ec43a8550e1590080aa698ff150cc4ee6c90b508e521a1a9086e8837e4c3f000cf0d1a9d01e2e582c4a8d365077e8e38fa8b0d

data/README.md

@@ -467,6 +467,30 @@ stacks:
       template: my-stack.rb
 ```
 
+### Loading SparklePacks
+
+[SparklePacks](http://www.sparkleformation.io/docs/sparkle_formation/sparkle-packs.html) can be pre-loaded using compiler options. This requires the name of a rubygem to `require` followed by the name of the SparklePack, which is usually the same name as the Gem.
+
+```yaml
+stacks:
+  us-east-1
+    my-stack:
+      template: my-stack-with-dynamic.rb
+      compiler_options:
+        sparkle_packs:
+          - vpc-sparkle-pack
+```
+
+The template can then simply load a dynamic from the sparkle pack like so:
+
+```ruby
+SparkleFormation.new(:my_stack_with_dynamic) do
+   dynamic!(:sparkle_pack_dynamic)
+end
+```
+
+Note though that if a dynamic with the same name exists in your `templates/dynamics/` directory it will get loaded since it has higher precedence.
+
 ## Commands
 
 ```bash

data/lib/stack_master/stack.rb

@@ -65,7 +65,7 @@ module StackMaster
       parameter_hash = ParameterLoader.load(stack_definition.parameter_files)
       template_parameters = ParameterResolver.resolve(config, stack_definition, parameter_hash[:template_parameters])
       compile_time_parameters = ParameterResolver.resolve(config, stack_definition, parameter_hash[:compile_time_parameters])
-      template_body = TemplateCompiler.compile(config, stack_definition.template_file_path, compile_time_parameters,stack_definition.compiler_options)
+      template_body = TemplateCompiler.compile(config, stack_definition.template_file_path, compile_time_parameters, stack_definition.compiler_options)
       template_format = TemplateUtils.identify_template_format(template_body)
       stack_policy_body = if stack_definition.stack_policy_file_path
                             File.read(stack_definition.stack_policy_file_path)

data/lib/stack_master/template_compilers/sparkle_formation.rb

@@ -13,12 +13,7 @@ module StackMaster::TemplateCompilers
     end
 
     def self.compile(template_file_path, compile_time_parameters, compiler_options = {})
-      if compiler_options['sparkle_path']
-        ::SparkleFormation.sparkle_path = File.expand_path(compiler_options['sparkle_path'])
-      else
-        ::SparkleFormation.sparkle_path = File.dirname(template_file_path)
-      end
-      sparkle_template = ::SparkleFormation.compile(template_file_path, :sparkle)
+      sparkle_template = compile_sparkle_template(template_file_path, compiler_options)
       definitions = sparkle_template.parameters
       validate_definitions(definitions)
       validate_parameters(definitions, compile_time_parameters)
@@ -32,6 +27,33 @@ module StackMaster::TemplateCompilers
 
     private
 
+    def self.compile_sparkle_template(template_file_path, compiler_options)
+      sparkle_path = compiler_options['sparkle_path'] ?
+                        File.expand_path(compiler_options['sparkle_path']) : File.dirname(template_file_path)
+
+      collection = ::SparkleFormation::SparkleCollection.new
+      root_pack = ::SparkleFormation::Sparkle.new(
+        :root => sparkle_path,
+      )
+      collection.set_root(root_pack)
+      if compiler_options['sparkle_packs']
+        compiler_options['sparkle_packs'].each do |pack_name|
+          require pack_name
+          pack = ::SparkleFormation::SparklePack.new(:name => pack_name)
+          collection.add_sparkle(pack)
+        end
+      end
+
+      sparkle_template = compile_template_with_sparkle_path(template_file_path, sparkle_path)
+      sparkle_template.sparkle.apply(collection)
+      sparkle_template
+    end
+
+    def self.compile_template_with_sparkle_path(template_path, sparkle_path)
+      ::SparkleFormation.sparkle_path = sparkle_path
+      ::SparkleFormation.compile(template_path, :sparkle)
+    end
+
     def self.validate_definitions(definitions)
       CompileTime::DefinitionsValidator.new(definitions).validate
     end

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/spec/fixtures/sparkle_pack_integration/my_sparkle_pack/lib/my_sparkle_pack.rb

@@ -0,0 +1 @@
+::SparkleFormation::SparklePack.register!

data/spec/fixtures/sparkle_pack_integration/my_sparkle_pack/lib/sparkleformation/dynamics/my_dynamic.rb

@@ -0,0 +1,5 @@
+SparkleFormation.dynamic(:my_dynamic) do
+  outputs.foo do
+    value "bar"
+  end
+end

data/spec/fixtures/sparkle_pack_integration/templates/dynamics/local_dynamic.rb

@@ -0,0 +1,5 @@
+SparkleFormation.dynamic(:local_dynamic) do
+  outputs.bar do
+    value "local_dynamic"
+  end
+end

data/spec/fixtures/sparkle_pack_integration/templates/template_with_dynamic.rb

@@ -0,0 +1,3 @@
+SparkleFormation.new(:template_with_dynamic) do
+  dynamic!(:local_dynamic)
+end

data/spec/fixtures/sparkle_pack_integration/templates/template_with_dynamic_from_pack.rb

@@ -0,0 +1,3 @@
+SparkleFormation.new(:template_with_dynamic_from_pack) do
+  dynamic!(:my_dynamic)
+end

data/spec/stack_master/template_compilers/sparkle_formation_spec.rb

@@ -15,13 +15,20 @@ RSpec.describe StackMaster::TemplateCompilers::SparkleFormation do
     let(:parameters_validator) { instance_double(StackMaster::SparkleFormation::CompileTime::ParametersValidator) }
     let(:state_builder) { instance_double(StackMaster::SparkleFormation::CompileTime::StateBuilder) }
 
+    let(:sparkle_double) { instance_double(::SparkleFormation::SparkleCollection) }
+
     before do
       allow(::SparkleFormation).to receive(:compile).with(template_file_path, :sparkle).and_return(sparkle_template)
+      allow(::SparkleFormation::Sparkle).to receive(:new)
       allow(StackMaster::SparkleFormation::CompileTime::DefinitionsValidator).to receive(:new).and_return(definitions_validator)
       allow(StackMaster::SparkleFormation::CompileTime::ParametersValidator).to receive(:new).and_return(parameters_validator)
       allow(StackMaster::SparkleFormation::CompileTime::StateBuilder).to receive(:new).and_return(state_builder)
+      allow(::SparkleFormation::SparkleCollection).to receive(:new).and_return(sparkle_double)
 
       allow(sparkle_template).to receive(:parameters).and_return(compile_time_parameter_definitions)
+      allow(sparkle_template).to receive(:sparkle).and_return(sparkle_double)
+      allow(sparkle_double).to receive(:apply)
+      allow(sparkle_double).to receive(:set_root)
       allow(definitions_validator).to receive(:validate)
       allow(parameters_validator).to receive(:validate)
       allow(state_builder).to receive(:build).and_return({})
@@ -78,4 +85,32 @@ RSpec.describe StackMaster::TemplateCompilers::SparkleFormation do
 
   end
 
+  describe '.compile with sparkle packs' do
+    let(:compile_time_parameters) { {} }
+    subject(:compile) { described_class.compile(template_file_path, compile_time_parameters, compiler_options)}
+
+    context 'with a sparkle_pack loaded' do
+      let(:template_file_path) { File.join(File.dirname(__FILE__), "..", "..", "fixtures", "sparkle_pack_integration", "templates", "template_with_dynamic_from_pack.rb")}
+      let(:compiler_options) { {"sparkle_packs" => ["my_sparkle_pack"]} }
+
+      before do
+        lib =  File.join(File.dirname(__FILE__), "..", "..", "fixtures", "sparkle_pack_integration", "my_sparkle_pack", "lib")
+        puts "Loading from #{lib}"
+        $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+      end
+
+      it 'pulls the dynamic from the sparkle pack' do
+        expect(compile).to eq(%Q({\n  \"Outputs\": {\n    \"Foo\": {\n      \"Value\": \"bar\"\n    }\n  }\n}))
+      end
+    end
+
+    context 'without a sparkle_pack loaded' do
+      let(:template_file_path) { File.join(File.dirname(__FILE__), "..", "..", "fixtures", "sparkle_pack_integration", "templates", "template_with_dynamic.rb")}
+      let(:compiler_options) { {} }
+
+      it 'pulls the dynamic from the local path' do
+        expect(compile).to eq(%Q({\n  \"Outputs\": {\n    \"Bar\": {\n      \"Value\": \"local_dynamic\"\n    }\n  }\n}))
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -396,6 +396,11 @@ files:
 - script/buildkite_rspec.sh
 - spec/fixtures/parameters/myapp_vpc.yml
 - spec/fixtures/parameters/myapp_vpc_with_secrets.yml
+- spec/fixtures/sparkle_pack_integration/my_sparkle_pack/lib/my_sparkle_pack.rb
+- spec/fixtures/sparkle_pack_integration/my_sparkle_pack/lib/sparkleformation/dynamics/my_dynamic.rb
+- spec/fixtures/sparkle_pack_integration/templates/dynamics/local_dynamic.rb
+- spec/fixtures/sparkle_pack_integration/templates/template_with_dynamic.rb
+- spec/fixtures/sparkle_pack_integration/templates/template_with_dynamic_from_pack.rb
 - spec/fixtures/stack_master.yml
 - spec/fixtures/templates/json/valid_myapp_vpc.json
 - spec/fixtures/templates/myapp_vpc.json
@@ -515,6 +520,11 @@ test_files:
 - features/validate.feature
 - spec/fixtures/parameters/myapp_vpc.yml
 - spec/fixtures/parameters/myapp_vpc_with_secrets.yml
+- spec/fixtures/sparkle_pack_integration/my_sparkle_pack/lib/my_sparkle_pack.rb
+- spec/fixtures/sparkle_pack_integration/my_sparkle_pack/lib/sparkleformation/dynamics/my_dynamic.rb
+- spec/fixtures/sparkle_pack_integration/templates/dynamics/local_dynamic.rb
+- spec/fixtures/sparkle_pack_integration/templates/template_with_dynamic.rb
+- spec/fixtures/sparkle_pack_integration/templates/template_with_dynamic_from_pack.rb
 - spec/fixtures/stack_master.yml
 - spec/fixtures/templates/json/valid_myapp_vpc.json
 - spec/fixtures/templates/myapp_vpc.json