RubyGems - sparkle_formation - Versions diffs - 0.2.4 → 0.2.6 - Mend

sparkle_formation 0.2.4 → 0.2.6

Files changed (8) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +4 -0
data/README.md +8 -9
data/bin/generate_sparkle_docs +14 -8
data/lib/sparkle_formation/sparkle_attribute.rb +19 -1
data/lib/sparkle_formation/sparkle_formation.rb +155 -8
data/lib/sparkle_formation/version.rb +1 -1
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f49e3aceb2896698cfb226e53c06f02ed9607d7
-  data.tar.gz: 4db5fff53aff957f05f6e933a22a273d52548457
+  metadata.gz: 629f237b850e9be0623bc58499ee7576018730a4
+  data.tar.gz: 9b602ddb998707e16a1c45ff08e12b5a175a485c
 SHA512:
-  metadata.gz: b5a8aea5a9c132d0f7bddf6fa537c37f2d03e7b4e4d93a58690a29c65dc441ab26e6cec640ac7965b4281f68bced0954078762f10b86c84a5e68d7af92190c58
-  data.tar.gz: db9da97bd24fe89858a8b822ed4ebb7ec328e24c2dc3d1646d8582236aa6f41ce8d2942a64916a8d5b4d925c9294db668916c8249afd647ee342913e117a59bc
+  metadata.gz: d527b10cca86fb282187e4e9c6672dd89957b00b8ffa6b8c7ace56b6ab3c67e639f425a89cd9091798c0073d9a1495ed4d75b17bed50026ec78c2f9298df14ae
+  data.tar.gz: d4c775dcd1114e10d3c707ce863c836125ee035bc4bfbd2122261340c330844fec335ba6ca8b28b7e497b25ae914d2bb7e7b0f4b298c6a771b2130d250f90c28

data/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,7 @@
+## v0.2.6
+* Add initial nested stack implementation
+* Update user docs generation
 ## v0.2.4
 * Update builtin registry lookup to better handle all caps types
 * Add helper methods for conditionals

data/README.md CHANGED Viewed

@@ -32,14 +32,13 @@ SparkleFormation.new('ec2_example') do
   end
   mappings.region_map do
-    set!('us-east-1', :ami => 'ami-7f418316')
-    set!('us-east-1', :ami => 'ami-7f418316')
-    set!('us-west-1', :ami => 'ami-951945d0')
-    set!('us-west-2', :ami => 'ami-16fd7026')
-    set!('eu-west-1', :ami => 'ami-24506250')
-    set!('sa-east-1', :ami => 'ami-3e3be423')
-    set!('ap-southeast-1', :ami => 'ami-74dda626')
-    set!('ap-northeast-1', :ami => 'ami-dcfa4edd')
+    set!('us-east-1'._no_hump, :ami => 'ami-7f418316')
+    set!('us-west-1'._no_hump, :ami => 'ami-951945d0')
+    set!('us-west-2'._no_hump, :ami => 'ami-16fd7026')
+    set!('eu-west-1'._no_hump, :ami => 'ami-24506250')
+    set!('sa-east-1'._no_hump, :ami => 'ami-3e3be423')
+    set!('ap-southeast-1'._no_hump, :ami => 'ami-74dda626')
+    set!('ap-northeast-1'._no_hump, :ami => 'ami-dcfa4edd')
   end
   dynamic!(:ec2_instance, :foobar) do
@@ -109,7 +108,7 @@ templates.
 First, create the component (components/ami.rb):
 ```ruby
-SparkleFormation.build(:ami) do
+SparkleFormation.build do
   mappings.region_map do
     set!('us-east-1', :ami => 'ami-7f418316')

data/bin/generate_sparkle_docs CHANGED Viewed

@@ -11,15 +11,21 @@ FileUtils.mkdir_p('doc/UserDocs')
 Dir.glob('docs/**/*').each do |path|
   next unless File.file?(path)
   content = File.read(path)
-  new_path = File.join('doc/UserDocs', path.sub(/.*?docs\//, ''))
+  rel_path = path.sub(/.*?docs\//, '')
+  new_path = File.join('doc/UserDocs', rel_path)
+  user_doc_root = (['..'] * rel_path.scan('/').size).join('/')
+  unless(user_doc_root.to_s.empty?)
+    user_doc_root << '/'
+  end
   FileUtils.mkdir_p(File.dirname(new_path))
-  File.open(new_path.sub('.md', '.html'), 'w') do |file|
-    if(path.end_with?('.md'))
-      file.puts '<!DOCTYPE html><html><title>SparkleFormation User Documentation</title><xmp theme="simplex" style="display:none;">'
-      file.puts content.gsub('.md', '.html')
-      file.puts '</xmp><script src="http://strapdownjs.com/v/0.2/strapdown.js"></script></html>'
-    else
-      file.puts content
+  File.open(new_path, 'w') do |file|
+    file.puts content
+  end
+  if(new_path.end_with?('.md'))
+    File.open(new_path.sub('.md', '.html'), 'w') do |file|
+      file.print "<!DOCTYPE html><html><head><title>SparkleFormation User Documentation</title><script src=\"#{user_doc_root}v/0.3.2/marked.js\"></script><script src=\"#{user_doc_root}v/jquery-2.1.3.min.js\"></script><script src=\"#{user_doc_root}v/loader.js\"></script><script src=\"#{user_doc_root}v/highlight.min.js\"></script><link rel=\"stylesheet\" href=\"#{user_doc_root}v/bootstrap.min.css\"></link><link rel=\"stylesheet\" href=\"#{user_doc_root}v/highlight.min.css\"></link><link rel=\"stylesheet\" href=\"#{user_doc_root}v/finalizer.css\"></link>"
+      file.print "</head><body><div class=\"markdown-body\"><div class=\"navbar navbar-top\"><div class=\"navbar-inner\"><div class=\"container\"><div class=\"navbar-brand\"><a href=\"#{user_doc_root}README.html\">SparkleFormation - User documentation</a></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-body\" id=\"content\"></div></div></div>"
+      file.print "</body></html>"
     end
   end
 end

data/lib/sparkle_formation/sparkle_attribute.rb CHANGED Viewed

@@ -170,7 +170,7 @@ class SparkleFormation
     def _and(*args)
       {
         'Fn::And' => _array(
-          args.map{|v|
+          *args.map{|v|
             if(v.is_a?(Symbol) || v.is_a?(String))
               _condition(v)
             else
@@ -226,6 +226,15 @@ class SparkleFormation
     end
     alias_method :or!, :_or
+    # Execute system command
+    #
+    # @param command [String]
+    # @return [String] result
+    def _system(command)
+      ::Kernel.send('`', command)
+    end
+    alias_method :system!, :_system
     # @return [TrueClass, FalseClass]
     def rhel?
       !!@platform[:rhel]
@@ -264,5 +273,14 @@ class SparkleFormation
       SfnRegistry.insert(name, self, *args)
     end
+    # Stack nesting helper method
+    #
+    # @param template [String, Symbol] template to nest
+    # @param args [String, Symbol] stringified and underscore joined for name
+    # @return [self]
+    def nest!(template, *args, &block)
+      SparkleFormation.nest(template, self, *args, &block)
+    end
   end
 end

data/lib/sparkle_formation/sparkle_formation.rb CHANGED Viewed

@@ -28,6 +28,13 @@ class SparkleFormation
   extend SparkleFormation::Utils::AnimalStrings
   # @!parse extend SparkleFormation::Utils::AnimalStrings
+  # @return [Array<String>] directory names to ignore
+  IGNORE_DIRECTORIES = [
+    'components',
+    'dynamics',
+    'registry'
+  ]
   class << self
     # @return [Hashish] loaded dynamics
@@ -204,6 +211,36 @@ class SparkleFormation
       result
     end
+    # Nest a template into a context
+    #
+    # @param template [String, Symbol] template to nest
+    # @param struct [SparkleStruct] context for nesting
+    # @param args [String, Symbol] stringified and underscore joined for name
+    # @return [SparkleStruct]
+    # @note if symbol is provided for template, double underscores
+    #   will be used for directory separator and dashes will match underscores
+    def nest(template, struct, *args, &block)
+      spath = SparkleFormation.new('stub').sparkle_path
+      resource_name = [template.to_s.gsub(/(\/|__|-)/, '_'), *args].compact.join('_').to_sym
+      path = template.is_a?(Symbol) ? template.to_s.gsub('__', '/') : template.to_s
+      file = Dir.glob(File.join(spath, '**', '**', '*.rb')).detect do |local_path|
+        strip_path = local_path.sub(spath, '').sub(/^\//, '').tr('-', '_').sub('.rb', '')
+        strip_path == path
+      end
+      unless(file)
+        raise ArgumentError.new("Failed to locate nested stack file! (#{template.inspect} -> #{path.inspect})")
+      end
+      instance = self.instance_eval(IO.read(file), file, 1)
+      struct.resources.set!(resource_name) do
+        type 'AWS::CloudFormation::Stack'
+      end
+      struct.resources.__send__(resource_name).properties.stack instance.compile
+      if(block_given?)
+        struct.resources.__send__(resource_name).instance_exec(&block)
+      end
+      struct.resources.__send__(resource_name)
+    end
     # Insert a builtin dynamic into a context
     #
     # @param dynamic_name [String, Symbol] dynamic name
@@ -300,6 +337,7 @@ class SparkleFormation
     if(block)
       load_block(block)
     end
+    @compiled = nil
   end
   # Add block to load order
@@ -344,17 +382,126 @@ class SparkleFormation
   #
   # @return [SparkleStruct]
   def compile
-    compiled = SparkleStruct.new
-    @load_order.each do |key|
-      compiled._merge!(components[key])
+    unless(@compiled)
+      compiled = SparkleStruct.new
+      @load_order.each do |key|
+        compiled._merge!(components[key])
+      end
+      @overrides.each do |override|
+        if(override[:args] && !override[:args].empty?)
+          compiled._set_state(override[:args])
+        end
+        self.class.build(compiled, &override[:block])
+      end
+      @compiled = compiled
+    end
+    @compiled
+  end
+  # Clear compiled stack if cached and perform compilation again
+  #
+  # @return [SparkleStruct]
+  def recompile
+    @compiled = nil
+    compile
+  end
+  # @return [TrueClass, FalseClass] includes nested stacks
+  def nested?
+    !!compile.dump!['Resources'].detect do |r_name, resource|
+      resource['Type'] == 'AWS::CloudFormation::Stack'
     end
-    @overrides.each do |override|
-      if(override[:args] && !override[:args].empty?)
-        compiled._set_state(override[:args])
+  end
+  # @return [TrueClass, FalseClass] includes _only_ nested stacks
+  def isolated_nests?
+    hash = compile.dump!
+    (hash.keys == ['Resources'] || hash.keys == ['Resources', 'AWSTemplateFormatVersion']) &&
+      !hash['Resources'].detect{|_, r| r['Type'] != 'AWS::CloudFormation::Stack'}
+  end
+  # Apply stack nesting logic. Will extract unique parameters from
+  # nested stacks, update refs to use sibling stack outputs where
+  # required and extract nested stack templates for remote persistence
+  #
+  # @yieldparam template_name [String] nested stack resource name
+  # @yieldparam template [Hash] nested stack template
+  # @yieldreturn [String] remote URL
+  # @return [Hash] dumped template hash
+  def apply_nesting
+    hash = compile.dump!
+    stacks = Hash[
+      hash['Resources'].find_all do |r_name, resource|
+        [r_name, MultiJson.load(MultiJson.dump(resource))]
+      end
+    ]
+    parameters = hash.fetch('Parameters', {})
+    output_map = {}
+    stacks.each do |stack_name, stack_resource|
+      remap_nested_parameters(hash, parameters, stack_name, stack_resource, output_map)
+    end
+    hash['Parameters'] = parameters
+    hash['Resources'].each do |resource_name, resource|
+      if(resource['Type'] == 'AWS::CloudFormation::Stack')
+        stack = resource['Properties'].delete('Stack')
+        resource['Properties']['TemplateURL'] = yield(resource_name, stack)
       end
-      self.class.build(compiled, &override[:block])
     end
-    compiled
+    hash
+  end
+  # Extract parameters from nested stacks. Check for previous nested
+  # stack outputs that match parameter. If match, set parameter to use
+  # output. If no match, check container stack parameters for match.
+  # If match, set to use ref. If no match, add parameter to container
+  # stack parameters and set to use ref.
+  #
+  # @param template [Hash] template being processed
+  # @param parameters [Hash] top level parameter set being built
+  # @param stack_name [String] name of stack resource
+  # @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
+  #   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']['Parameters']
+    if(stack_parameters)
+      template['Resources'][stack_name]['Properties']['Parameters'] ||= {}
+      stack_parameters.each do |pname, pval|
+        if(pval['StackUnique'])
+          check_name = [stack_name, pname].join
+        else
+          check_name = pname
+        end
+        if(parameters.keys.include?(check_name))
+          if(parameters[check_name]['Type'] == 'CommaDelimitedList')
+            new_val = {'Fn::Join' => [',', {'Ref' => check_name}]}
+          else
+            new_val = {'Ref' => check_name}
+          end
+          template['Resources'][stack_name]['Properties']['Parameters'][pname] = new_val
+        elsif(output_map[check_name])
+          template['Resources'][stack_name]['Properties']['Parameters'][pname] = {
+            'Fn::GetAtt' => output_map[check_name]
+          }
+        else
+          if(pval['Type'] == 'CommaDelimitedList')
+            new_val = {'Fn::Join' => [',', {'Ref' => check_name}]}
+          else
+            new_val = {'Ref' => check_name}
+          end
+          template['Resources'][stack_name]['Properties']['Parameters'][pname] = new_val
+          parameters[check_name] = pval
+        end
+      end
+    end
+    if(stack_resource['Properties']['Stack']['Outputs'])
+      stack_resource['Properties']['Stack']['Outputs'].keys.each do |oname|
+        output_map[oname] = [stack_name, "Outputs.#{oname}"]
+      end
+    end
+    true
   end
   # @return [Hash] dumped hash

data/lib/sparkle_formation/version.rb CHANGED Viewed

@@ -18,5 +18,5 @@
 class SparkleFormation
   # Current library version
-  VERSION = Gem::Version.new('0.2.4')
+  VERSION = Gem::Version.new('0.2.6')
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkle_formation
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Chris Roberts
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2014-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attribute_struct