sparkle_formation 0.2.2 → 0.2.4

data/docs/resource-reference.md

@@ -1,49 +0,0 @@
-## Resource Reference
-
-This is a best-effort list of commonly used cloudformation resources and their
-availability/feature set in supported cloud providers. This list does
-not cover everything that may be offered by a specific provider, and
-is not intended as a comparison of cloud providers.
-
-#### Auto Scaling Groups
-
-|Provider    |Available |Caveats & Limitations                                                        |
-|------------|----------|-----------------------------------------------------------------------------|
-|AWS         |Yes       |EC2 Classic and VPC use mutually exclusive properties.                       |
-|Rackspace   |Yes       |Autoscaling will not replace lost instances, only does policy based scaling. |
-
-#### Compute Instances
-
-|Provider    |Available |Caveats & Limitations                                                        |
-|------------|----------|-----------------------------------------------------------------------------|
-|AWS         |Yes       |                                                                             |
-|Rackspace   |Yes       |                                                                             |
-
-#### Load Balancers
-
-|Provider    |Available |Caveats & Limitations                                                        |
-|------------|----------|-----------------------------------------------------------------------------|
-|AWS         |Yes       |Security Group Ingress is not automatic. Must be defined separately.         |
-|Rackspace   |Yes       |Multiple ports generates new template resources.                             |
-
-#### Security Groups
-
-|Provider    |Available |Caveats & Limitations                                                        |
-|------------|----------|-----------------------------------------------------------------------------|
-|AWS         |Yes       |                                                                             |
-|Rackspace   |No        |                                                                             |
-
-#### Storage
-
-|Provider    |Available |Caveats & Limitations                                                        |
-|------------|----------|-----------------------------------------------------------------------------|
-|AWS         |Yes       |                                                                             |
-|Rackspace   |No        |                                                                             |
-
-
-#### Stack Users
-
-|Provider    |Available |Caveats & Limitations                                                        |
-|------------|----------|-----------------------------------------------------------------------------|
-|AWS         |Yes       |                                                                             |
-|Rackspace   |No        |                                                                             |

data/examples/allinone/cloudformation/ec2_example.rb

@@ -1,59 +0,0 @@
-SparkleFormation.new('ec2_example') do
-  description "AWS CloudFormation Sample Template EC2InstanceSample..."
-
-  parameters do
-    key_name do
-      description 'Name of an existing EC2 KeyPair to enable SSH access to the instance'
-      type 'String'
-    end
-  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')
-  end
-
-  resources do
-    my_instance do
-      type 'AWS::EC2::Instance'
-      properties do
-        key_name _cf_ref(:key_name)
-        image_id _cf_map(:region_map, 'AWS::Region', :ami)
-        user_data _cf_base64('80')
-      end
-    end
-  end
-
-  outputs do
-    instance_id do
-      description 'InstanceId of the newly created EC2 instance'
-      value _cf_ref(:my_instance)
-    end
-    az do
-      description 'Availability Zone of the newly created EC2 instance'
-      value _cf_attr(:my_instance, :availability_zone)
-    end
-    public_ip do
-      description 'Public IP address of the newly created EC2 instance'
-      value _cf_attr(:my_instance, :public_ip)
-    end
-    private_ip do
-      description 'Private IP address of the newly created EC2 instance'
-      value _cf_attr(:my_instance, :private_ip)
-    end
-    public_dns do
-      description 'Public DNSName of the newly created EC2 instance'
-      value _cf_attr(:my_instance, :public_dns_name)
-    end
-    private_dns do
-      description 'Private DNSName of the newly created EC2 instance'
-      value _cf_attr(:my_instance, :private_dns_name)
-    end
-  end
-end

data/examples/allinone/parse.rb

@@ -1,14 +0,0 @@
-require 'sparkle_formation'
-require 'pp'
-require 'json'
-
-SparkleFormation.sparkle_path = File.join(File.dirname(__FILE__), 'cloudformation')
-
-puts JSON.pretty_generate(
-  SparkleFormation.compile(
-    File.join(
-      File.dirname(__FILE__),
-      'cloudformation/ec2_example.rb'
-    )
-  )
-)

data/examples/ami_component/cloudformation/components/ami.rb

@@ -1,21 +0,0 @@
-SparkleFormation.build do
-
-  parameters do
-    key_name do
-      description 'Name of an existing EC2 KeyPair to enable SSH access to the instance'
-      type 'String'
-    end
-  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')
-  end
-
-end

data/examples/ami_component/cloudformation/ec2_example.rb

@@ -1,39 +0,0 @@
-SparkleFormation.new('ec2_example').load(:ami).overrides do
-
-  description "AWS CloudFormation Sample Template EC2InstanceSample..."
-
-  dynamic!(:ec2_instance, :my) do
-    properties do
-      key_name ref!(:key_name)
-      image_id map!(:region_map, 'AWS::Region', :ami)
-      user_data base64!('80')
-    end
-  end
-
-  outputs do
-    instance_id do
-      description 'InstanceId of the newly created EC2 instance'
-      value ref!(:my_ec2_instance)
-    end
-    az do
-      description 'Availability Zone of the newly created EC2 instance'
-      value attr!(:my_ec2_instance, :availability_zone)
-    end
-    public_ip do
-      description 'Public IP address of the newly created EC2 instance'
-      value attr!(:my_ec2_instance, :public_ip)
-    end
-    private_ip do
-      description 'Private IP address of the newly created EC2 instance'
-      value attr!(:my_ec2_instance, :private_ip)
-    end
-    public_dns do
-      description 'Public DNSName of the newly created EC2 instance'
-      value attr!(:my_ec2_instance, :public_dns_name)
-    end
-    private_dns do
-      description 'Private DNSName of the newly created EC2 instance'
-      value attr!(:my_ec2_instance, :private_dns_name)
-    end
-  end
-end

data/examples/ami_component/parse.rb

@@ -1,14 +0,0 @@
-require 'sparkle_formation'
-require 'pp'
-require 'json'
-
-SparkleFormation.sparkle_path = File.join(File.dirname(__FILE__), 'cloudformation')
-
-puts JSON.pretty_generate(
-  SparkleFormation.compile(
-    File.join(
-      File.dirname(__FILE__),
-      'cloudformation/ec2_example.rb'
-    )
-  )
-)

data/test/spec.rb

@@ -1,6 +0,0 @@
-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

@@ -1,72 +0,0 @@
-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

@@ -1,76 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

@@ -1,43 +0,0 @@
-{
-  "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

@@ -1,50 +0,0 @@
-{
-  "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

@@ -1,27 +0,0 @@
-{
-  "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"
-      }
-    }
-  }
-}