sparkle_formation 0.1.6 → 0.2.0

data/lib/sparkle_formation/utils.rb

@@ -17,14 +17,24 @@
 #
 
 class SparkleFormation
+
+  # Helper utilities
   module Utils
 
+    # Animal stylings on strins
     module AnimalStrings
 
+      # Camel case string
+      # @param string [String]
+      # @return [String]
       def camel(string)
         string.to_s.split('_').map{|k| "#{k.slice(0,1).upcase}#{k.slice(1,k.length)}"}.join
       end
 
+      # Snake case (underscore) string
+      #
+      # @param string [String]
+      # @return [String]
       def snake(string)
         string.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.to_sym
       end
@@ -33,19 +43,32 @@ class SparkleFormation
 
   end
 
+  # Registry helper
   class Registry
 
     class << self
 
+      # Initialize registry
+      #
+      # @return [self]
       def init!
         @register = AttributeStruct.hashish.new
         self
       end
 
+      # Register block
+      #
+      # @param name [String, Symbol] name of item
+      # @yield block to register
       def register(name, &block)
         @register[name] = block
       end
 
+      # Insert registry item into context
+      #
+      # @param name [String, Symbol] name of item
+      # @param location [AttributeStruct] context to apply block
+      # @param args [Object] argument list for block
       def insert(name, location, *args)
         if(block = @register[name])
           location.instance_exec(*args, &block)
@@ -58,23 +81,37 @@ class SparkleFormation
 
   end
 
+  # Cache helper
   class Cache
     class << self
 
+      # Get value
+      #
+      # @param k [Object]
+      # @return [Object]
       def [](k)
         init!
         Thread.current[:sparkle_cache][k]
       end
 
+      # Set value
+      #
+      # @param k [Object] key
+      # @param v [Object] value
+      # @return [Object] v
       def []=(k,v)
         init!
         Thread.current[:sparkle_cache][k] = v
       end
 
+      # Initialize cache within thread
+      #
+      # @return [self]
       def init!
         unless(Thread.current[:sparkle_cache])
           Thread.current[:sparkle_cache] = {}
         end
+        self
       end
 
     end

data/lib/sparkle_formation/version.rb

@@ -19,5 +19,5 @@
 class SparkleFormation
   class Version < Gem::Version
   end
-  VERSION = Version.new('0.1.6')
+  VERSION = Version.new('0.2.0')
 end

data/sparkle_formation.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.description = 'Cloud Formation builder'
   s.license = 'Apache-2.0'
   s.require_path = 'lib'
-  s.add_dependency 'attribute_struct', '~> 0.1.8'
+  s.add_dependency 'attribute_struct', '~> 0.2.2'
   s.add_dependency 'multi_json'
   s.files = Dir['**/*']
 end

data/test/spec.rb

@@ -0,0 +1,6 @@
+require 'sparkle_formation'
+require 'minitest/autorun'
+
+Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), 'specs/*.rb')).each do |path|
+  require path
+end

data/test/specs/attribute.rb

@@ -0,0 +1,72 @@
+describe SparkleFormation::SparkleAttribute do
+
+  before do
+    @attr = Object.new
+    @attr.extend(SparkleFormation::SparkleAttribute)
+  end
+
+  it 'should generate Fn::Join' do
+    @attr.join!('a', 'b', 'c').must_equal 'Fn::Join' => ['', ['a', 'b', 'c']]
+  end
+
+  it 'should generate Fn::Join with custom delimiter' do
+    @attr.join!('a', 'b', 'c', :options => {:delimiter => '-'}).
+      must_equal 'Fn::Join' => ['-', ['a', 'b', 'c']]
+  end
+
+  it 'should generate Ref' do
+    @attr.ref!('Item').must_equal 'Ref' => 'Item'
+  end
+
+  it 'should process symbol when generating Ref' do
+    SparkleFormation.new(:dummy) do
+      thing ref!(:item)
+    end.dump.must_equal 'Thing' => {'Ref' => 'Item'}
+  end
+
+  it 'should generate Fn::FindInMap' do
+    SparkleFormation.new(:dummy) do
+      thing find_in_map!('MyMap', 'MyKey', 'SubKey')
+    end.dump.
+      must_equal 'Thing' => {'Fn::FindInMap' => ['MyMap', {'Ref' => 'MyKey'}, 'SubKey']}
+  end
+
+  it 'should generate Fn::GetAtt' do
+    SparkleFormation.new(:dummy) do
+      thing attr!(:resource, 'my_instance', :ip_address)
+    end.dump.
+      must_equal 'Thing' => {'Fn::GetAtt' => ['Resource', 'my_instance', 'IpAddress']}
+  end
+
+  it 'should generate Fn::Base64' do
+    @attr.base64!('my string!').must_equal 'Fn::Base64' => 'my string!'
+  end
+
+  it 'should generate Fn::GetAZs' do
+    @attr.azs!.must_equal 'Fn::GetAZs' => ''
+  end
+
+  it 'should generate Fn::GetAZs with argument' do
+    @attr.azs!('fubar').must_equal 'Fn::GetAZs' => 'fubar'
+  end
+
+  it 'should generate Fn::GetAZs with Ref when provided symbol' do
+    SparkleFormation.new(:dummy) do
+      thing azs!(:item)
+    end.dump.
+      must_equal 'Thing' => {'Fn::GetAZs' => {'Ref' => 'Item'}}
+  end
+
+  it 'should generate Fn::Select' do
+    @attr.select!(1, 'fubar').must_equal 'Fn::Select' => [1, 'fubar']
+    @attr.select!('1', 'fubar').must_equal 'Fn::Select' => ['1', 'fubar']
+  end
+
+  it 'should generate Fn::Select with Ref when provided symbol' do
+    SparkleFormation.new(:dummy) do
+      thing select!(:param, :fubar)
+    end.dump.
+      must_equal 'Thing' => {'Fn::Select' => [{'Ref' => 'Param'}, {'Ref' => 'Fubar'}]}
+  end
+
+end

data/test/specs/basic.rb

@@ -0,0 +1,76 @@
+describe SparkleFormation do
+
+  before do
+    SparkleFormation.sparkle_path = File.join(
+      File.dirname(__FILE__), 'cloudformation'
+    )
+  end
+
+  describe 'Basic Usage' do
+
+    it 'should dump hashes' do
+      SparkleFormation.new(:dummy) do
+        test true
+      end.dump.must_equal 'Test' => true
+    end
+
+    it 'should include components' do
+      SparkleFormation.new(:dummy).load(:ami).
+        dump.keys.must_include 'Mappings'
+    end
+
+    it 'should process overrides' do
+      SparkleFormation.new(:dummy).overrides do
+        test true
+      end.dump.must_equal 'Test' => true
+    end
+
+    it 'should apply components on top of initial block' do
+      result = SparkleFormation.new(:dummy) do
+        mappings true
+      end.load(:ami).dump
+      result['Mappings'].must_be :is_a?, Hash
+    end
+
+    it 'should apply overrides on top of initial block and components' do
+      SparkleFormation.new(:dummy) do
+        mappings true
+      end.load(:ami).overrides do
+        mappings true
+      end.dump.must_equal 'Mappings' => true
+    end
+
+    it 'should should build component hash' do
+      component = MultiJson.load(File.read(File.join(File.dirname(__FILE__), 'results', 'component.json')))
+      SparkleFormation.new(:dummy).load(:ami).dump.must_equal component
+    end
+
+    it 'should build full stack' do
+      full_stack = MultiJson.load(File.read(File.join(File.dirname(__FILE__), 'results', 'base.json')))
+      SparkleFormation.new(:dummy).load(:ami).overrides do
+        dynamic!(:node, :my)
+      end.dump.must_equal full_stack
+    end
+
+    it 'should allow dynamic customization' do
+      full_stack = MultiJson.load(File.read(File.join(File.dirname(__FILE__), 'results', 'base_with_map.json')))
+      SparkleFormation.new(:dummy).load(:ami).overrides do
+        dynamic!(:node, :my) do
+          properties do
+            image_id map!(:region_map, 'AWS::Region', :ami)
+          end
+        end
+      end.dump.must_equal full_stack
+    end
+
+    it 'should allow customization of defined items' do
+      full_stack = MultiJson.load(File.read(File.join(File.dirname(__FILE__), 'results', 'base_with_map.json')))
+      SparkleFormation.new(:dummy).load(:ami).overrides do
+        dynamic!(:node, :my)
+        resources.my_ec2_instance.properties.image_id map!(:region_map, 'AWS::Region', :ami)
+      end.dump.must_equal full_stack
+    end
+
+  end
+
+end

data/test/specs/cloudformation/components/ami.rb

@@ -0,0 +1,14 @@
+SparkleFormation.build do
+
+  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')
+  end
+
+end

data/test/specs/cloudformation/dynamics/node.rb

@@ -0,0 +1,16 @@
+SparkleFormation.dynamic(:node) do |_name, _config|
+
+  parameters do
+    key_name do
+      description 'Name of an existing EC2 KeyPair to enable SSH access to the instance'
+      type 'String'
+    end
+  end
+
+  dynamic!(:ec2_instance, _name) do
+    properties do
+      key_name ref!(:key_name)
+    end
+  end
+
+end

data/test/specs/results/base.json

@@ -0,0 +1,43 @@
+{
+  "Parameters": {
+    "KeyName": {
+      "Description": "Name of an existing EC2 KeyPair to enable SSH access to the instance",
+      "Type": "String"
+    }
+  },
+  "Mappings": {
+    "RegionMap": {
+      "Us-east-1": {
+        "Ami": "ami-7f418316"
+      },
+      "Us-west-1": {
+        "Ami": "ami-951945d0"
+      },
+      "Us-west-2": {
+        "Ami": "ami-16fd7026"
+      },
+      "Eu-west-1": {
+        "Ami": "ami-24506250"
+      },
+      "Sa-east-1": {
+        "Ami": "ami-3e3be423"
+      },
+      "Ap-southeast-1": {
+        "Ami": "ami-74dda626"
+      },
+      "Ap-northeast-1": {
+        "Ami": "ami-dcfa4edd"
+      }
+    }
+  },
+  "Resources": {
+    "MyEc2Instance": {
+      "Type": "AWS::EC2::Instance",
+      "Properties": {
+        "KeyName": {
+          "Ref": "KeyName"
+        }
+      }
+    }
+  }
+}

data/test/specs/results/base_with_map.json

@@ -0,0 +1,50 @@
+{
+  "Parameters": {
+    "KeyName": {
+      "Description": "Name of an existing EC2 KeyPair to enable SSH access to the instance",
+      "Type": "String"
+    }
+  },
+  "Mappings": {
+    "RegionMap": {
+      "Us-east-1": {
+        "Ami": "ami-7f418316"
+      },
+      "Us-west-1": {
+        "Ami": "ami-951945d0"
+      },
+      "Us-west-2": {
+        "Ami": "ami-16fd7026"
+      },
+      "Eu-west-1": {
+        "Ami": "ami-24506250"
+      },
+      "Sa-east-1": {
+        "Ami": "ami-3e3be423"
+      },
+      "Ap-southeast-1": {
+        "Ami": "ami-74dda626"
+      },
+      "Ap-northeast-1": {
+        "Ami": "ami-dcfa4edd"
+      }
+    }
+  },
+  "Resources": {
+    "MyEc2Instance": {
+      "Type": "AWS::EC2::Instance",
+      "Properties": {
+        "KeyName": {
+          "Ref": "KeyName"
+        },
+        "ImageId": {
+          "Fn::FindInMap": [
+            "RegionMap",
+            {"Ref": "AWS::Region"},
+            "Ami"
+          ]
+        }
+      }
+    }
+  }
+}

data/test/specs/results/component.json

@@ -0,0 +1,27 @@
+{
+  "Mappings": {
+    "RegionMap": {
+      "Us-east-1": {
+        "Ami": "ami-7f418316"
+      },
+      "Us-west-1": {
+        "Ami": "ami-951945d0"
+      },
+      "Us-west-2": {
+        "Ami": "ami-16fd7026"
+      },
+      "Eu-west-1": {
+        "Ami": "ami-24506250"
+      },
+      "Sa-east-1": {
+        "Ami": "ami-3e3be423"
+      },
+      "Ap-southeast-1": {
+        "Ami": "ami-74dda626"
+      },
+      "Ap-northeast-1": {
+        "Ami": "ami-dcfa4edd"
+      }
+    }
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sparkle_formation
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attribute_struct
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -60,7 +60,14 @@ files:
 - lib/sparkle_formation/translation.rb
 - lib/sparkle_formation/utils.rb
 - lib/sparkle_formation.rb
-- sparkle_formation-0.2.0.gem
+- test/spec.rb
+- test/specs/attribute.rb
+- test/specs/results/component.json
+- test/specs/results/base.json
+- test/specs/results/base_with_map.json
+- test/specs/basic.rb
+- test/specs/cloudformation/components/ami.rb
+- test/specs/cloudformation/dynamics/node.rb
 - examples/allinone/parse.rb
 - examples/allinone/cloudformation/ec2_example.rb
 - examples/ami_component/parse.rb
@@ -73,6 +80,7 @@ files:
 - bin/heat_resources
 - bin/aws_resources
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile.lock
 homepage: http://github.com/heavywater/sparkle_formation
 licenses: