sparkle_formation 3.0.10 → 3.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 941277da18060a1b6e4e560d6857e9a1ca17c551
-  data.tar.gz: 4c7d9ff4d75abc560d999a07dbe730b85e535b3e
+  metadata.gz: c2b28c5665d40741d8d5b93f3c2e3386cf5045f5
+  data.tar.gz: fe9953246e87f0330981402c8f24017e0ce772d2
 SHA512:
-  metadata.gz: 0fe3d50ad9892bb61ea89a4b266266c65ef2d98ec6cd797d26b3feb284a6adf48bef6203d2e90680d51006fa24030c320a979e981b06816049b5c0259d0c5325
-  data.tar.gz: 9a30aeb77cde80d7257b0b1fe5d0c301ccc59fd5a25cb0690f72e28102fe1f6d076c57da22407c5ca987775c7a2e8ecfa3c9a7bf5e6b7a5b5385d635d7ee89bb
+  metadata.gz: 221fa63f32b1b58ff7b06315ef97b7ca9f92f804dc1162a38ef8676a4f1baf9cc7932a2869df3d56cb59b9aed5b58e65ca674c1cad3ebef08145da421ac8d214
+  data.tar.gz: 86458dcb43d3e07c087d271bcdc0434ba1ae5c76604294e16569357bd59b993528ad5a6a80d9ad24ef80a497103c1877119194b68c0dfeec19cc02e9bce19bb2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v3.0.12
+* Prevent parameter mappings applying to root template
+* Add #import_value! helper for AWS templates (#193)
+* Add #split! helper for AWS templates
+* Add provider support for Terraform (#201)
+
 # v3.0.10
 * Extract pack name using previously extract path (#180)
 

data/LICENSE

@@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work.
    same "printed page" as the copyright notice for easier
    identification within third-party archives.
 
-Copyright 2015 Chris Roberts
+Copyright 2017 Chris Roberts
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/docs/sparkle-packs.md

@@ -12,7 +12,7 @@ anchors:
   - title: "Usage"
     url: "#usage"
   - title: "Distribution"
-    url: "#distribution
+    url: "#distribution"
 ---
 
 ## SparklePacks

data/lib/sparkle_formation/function_struct.rb

@@ -83,7 +83,8 @@ class SparkleFormation
           if(arg.respond_to?(:_dump))
             arg._dump
           elsif(arg.is_a?(::Symbol))
-            "'#{::Bogo::Utility.camel(arg.to_s, false)}'"
+            quote = __single_quote_strings ? "'" : '"'
+            "#{quote}#{::Bogo::Utility.camel(arg.to_s, false)}#{quote}"
           elsif(arg.is_a?(::String) && __single_quote_strings)
             "'#{arg}'"
           else
@@ -99,7 +100,14 @@ class SparkleFormation
             suffix
           ].compact
         )
-        root? ? "#{__anchor_start}#{internal}#{__anchor_stop}" : internal
+        if(root? || (!__single_anchor? && function_name))
+          if(!root? && __quote_nested_funcs?)
+            quote = __single_quote_strings ? "'" : '"'
+          end
+          "#{quote}#{__anchor_start}#{internal}#{__anchor_stop}#{quote}"
+        else
+          internal
+        end
       else
         suffix
       end
@@ -121,6 +129,15 @@ class SparkleFormation
       end
     end
 
+    def __quote_nested_funcs?
+      false
+    end
+
+    # @return [TrueClass] wrap in single anchor
+    def __single_anchor?
+      true
+    end
+
     # @return [Class]
     def _klass
       ::SparkleFormation::FunctionStruct
@@ -161,8 +178,6 @@ class SparkleFormation
   # FunctionStruct for jinja expressions
   class JinjaExpressionStruct < FunctionStruct
 
-    SINGLE_QUOTE_STRINGS = false
-
     # @return [String] start character(s) used to anchor function call
     def __anchor_start
       '{{ '
@@ -193,8 +208,6 @@ class SparkleFormation
   # FunctionStruct for jinja statements
   class JinjaStatementStruct < FunctionStruct
 
-    SINGLE_QUOTE_STRINGS = false
-
     # @return [String] start character(s) used to anchor function call
     def __anchor_start
       '{% '
@@ -251,4 +264,45 @@ class SparkleFormation
     end
 
   end
+
+  # FunctionStruct for customized terraform functions
+  class TerraformStruct < FunctionStruct
+
+    SINGLE_ANCHOR = true
+
+    # @return [String] start character(s) used to anchor function call
+    def __anchor_start
+      '${'
+    end
+
+    # @return [String] stop character(s) used to anchor function call
+    def __anchor_stop
+      '}'
+    end
+
+    # @return [String] value to use when argument list is empty
+    def __empty_argument_list
+      ''
+    end
+
+    # @return [FalseClass] disable single quote string generation
+    def __single_quote_strings
+      false
+    end
+
+    # @return [FalseClass] wrap every structure in anchors
+    def __single_anchor?
+      true
+    end
+
+    def __quote_nested_funcs?
+      false
+    end
+
+    # @return [Class]
+    def _klass
+      ::SparkleFormation::TerraformStruct
+    end
+
+  end
 end

data/lib/sparkle_formation/provider/aws.rb

@@ -54,11 +54,16 @@ class SparkleFormation
           unless(stack.nested_stacks.empty?)
             stack.apply_deep_nesting(*args)
           end
-          stack.compile.parameters.keys!.each do |parameter_name|
-            if(output_name = output_matched?(parameter_name, outputs.keys))
-              next if outputs[output_name] == stack
-              stack_output = stack.make_output_available(output_name, outputs)
-              resource.properties.parameters.set!(parameter_name, stack_output)
+          unless(stack.root?)
+            stack.compile.parameters.keys!.each do |parameter_name|
+              next if stack.compile.parameters.set!(parameter_name).stack_unique == true
+              if(!stack.parent.compile.parameters.set!(parameter_name).nil?)
+                resource.properties.parameters.set!(parameter_name, resource.ref!(parameter_name))
+              elsif(output_name = output_matched?(parameter_name, outputs.keys))
+                next if outputs[output_name] == stack
+                stack_output = stack.make_output_available(output_name, outputs)
+                resource.properties.parameters.set!(parameter_name, stack_output)
+              end
             end
           end
         end
@@ -155,7 +160,7 @@ class SparkleFormation
       # @param stack_resource [Hash] duplicate of stack resource contents
       # @param output_map [Hash] mapping of output names to required stack output access
       # @return [TrueClass]
-      # @note if parameter has includes `StackUnique` a new parameter will
+      # @note if parameter includes `StackUnique` a new parameter will
       #   be added to container stack and it will not use outputs
       def remap_nested_parameters(template, parameters, stack_name, stack_resource, output_map)
         stack_parameters = stack_resource.properties.stack.compile.parameters

data/lib/sparkle_formation/provider/terraform.rb

@@ -0,0 +1,146 @@
+require 'sparkle_formation'
+
+class SparkleFormation
+  module Provider
+    # Terraform specific implementation
+    module Terraform
+
+      # Customized dump to break out templates into consumable structures for
+      # passing to the deployment manager API
+      #
+      # @return [Hash]
+      def terraform_dump
+        result = non_terraform_dump.to_smash
+        Smash.new(
+          :parameters => :variable,
+          :resources => :resource,
+          :outputs => :output
+        ).each do |original, updated|
+          if(val = result.delete(original))
+            result[updated] = val
+          end
+        end
+        if(resources = result.delete(:resource))
+          result[:resource] = Smash.new
+          resources.each do |r_name, r_info|
+            result.set(:resource, r_info[:type], r_name, r_info[:properties])
+          end
+        end
+        result
+      end
+
+      # Properly remap dumping methods
+      def self.included(klass)
+        klass.class_eval do
+          alias_method :non_terraform_dump, :dump
+          alias_method :dump, :terraform_dump
+        end
+      end
+
+      # Properly remap dumping methods
+      def self.extended(klass)
+        klass.instance_eval do
+          alias :non_terraform_dump :dump
+          alias :dump :terraform_dump
+        end
+      end
+
+      # @return [String] Type string for terraform stack resource
+      # @note Nested templates aren't defined as a specific type thus no "real"
+      #   type exists. So we'll create a custom one!
+      def stack_resource_type
+        'module'
+      end
+
+      # Generate policy for stack
+      #
+      # @return [Hash]
+      def generate_policy
+        {}
+      end
+
+      # Apply deeply nested stacks. This is the new nesting approach and
+      # does not bubble parameters up to the root stack. Parameters are
+      # isolated to the stack resource itself and output mapping is
+      # automatically applied.
+      #
+      # @yieldparam stack [SparkleFormation] stack instance
+      # @yieldparam resource [AttributeStruct] the stack resource
+      # @yieldparam s_name [String] stack resource name
+      # @yieldreturn [Hash] key/values to be merged into resource properties
+      # @return [SparkleFormation::SparkleStruct] compiled structure
+      def apply_deep_nesting(*args, &block)
+        outputs = collect_outputs
+        nested_stacks(:with_resource).each do |stack, resource|
+          unless(stack.nested_stacks.empty?)
+            stack.apply_deep_nesting(*args)
+          end
+          stack.compile.parameters.keys!.each do |parameter_name|
+            if(output_name = output_matched?(parameter_name, outputs.keys))
+              next if outputs[output_name] == stack
+              stack_output = stack.make_output_available(output_name, outputs, self)
+              # NOTE: Only set value if not already explicitly set
+              if(resource.properties.parameters._set(parameter_name).nil?)
+                resource.properties.parameters._set(parameter_name, stack_output)
+              end
+            end
+          end
+        end
+        if(block_given?)
+          extract_templates(&block)
+        end
+        self
+      end
+
+      # Forcibly disable shallow nesting
+      def apply_shallow_nesting(*args, &block)
+        raise NotImplementedError.new 'Shallow nesting is not supported for this provider!'
+      end
+
+      # Extract output to make available for stack parameter usage at the
+      # current depth
+      #
+      # @param output_name [String] name of output
+      # @param outputs [Hash] listing of outputs
+      # @param source_stack [SparkleFormation] requesting stack
+      # @reutrn [Hash] reference to output value (used for setting parameter)
+      def make_output_available(output_name, outputs, source_stack)
+        bubble_path = outputs[output_name].root_path - root_path
+        drip_path = root_path - outputs[output_name].root_path
+        bubble_path.each_slice(2) do |base_sparkle, ref_sparkle|
+          next unless ref_sparkle
+          base_sparkle.compile.outputs._set(output_name)._set(
+            :value, base_sparkle.compile._stack_output(
+              ref_sparkle.name, output_name
+            )
+          )
+        end
+        if(bubble_path.empty?)
+          if(drip_path.size == 1)
+            parent = drip_path.first.parent
+            if(parent && !parent.compile.parameters._set(output_name).nil?)
+              return compile.parameter!(output_name)
+            end
+          end
+          raise ArgumentError.new "Failed to detect available bubbling path for output `#{output_name}`. " <<
+            'This may be due to a circular dependency! ' <<
+            "(Output Path: #{outputs[output_name].root_path.map(&:name).join(' > ')} " <<
+            "Requester Path: #{root_path.map(&:name).join(' > ')})"
+        end
+        result = source_stack.compile._stack_output(bubble_path.first.name, output_name)
+        if(drip_path.size > 1)
+          parent = drip_path.first.parent
+          drip_path.unshift(parent) if parent
+          drip_path.each_slice(2) do |base_sparkle, ref_sparkle|
+            next unless ref_sparkle
+            base_sparkle.compile.resources[ref_sparkle.name].properties.parameters.value._set(output_name, result)
+            ref_sparkle.compile.parameters._set(output_name).type 'string' # TODO: <<<<------ type check and prop
+            result = compile._parameter(output_name)
+          end
+        end
+        result
+      end
+
+    end
+  end
+end

data/lib/sparkle_formation/provider.rb

@@ -8,6 +8,7 @@ class SparkleFormation
     autoload :Azure, 'sparkle_formation/provider/azure'
     autoload :Google, 'sparkle_formation/provider/google'
     autoload :Heat, 'sparkle_formation/provider/heat'
+    autoload :Terraform, 'sparkle_formation/provider/terraform'
 
   end
 end