convection 0.0.1 → 0.2.1

data/test/convection/model/test_loggroups.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+require 'json'
+require 'pp'
+
+class TestLogGroups < Minitest::Test
+  def setup
+    @template = ::Convection.template do
+      description 'Logroups Test Template'
+
+      resource 'testgroup' do
+        type 'AWS::Logs::LogGroup'
+        property 'RetentionInDays', 365
+      end
+    end
+  end
+
+  def from_json
+    JSON.parse(@template.to_json)
+  end
+
+  def test_log_groups
+    refute_empty(from_json['Resources'])
+    assert_includes(from_json['Resources'], 'testgroup')
+  end
+end

data/test/convection/model/test_rds.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+require 'json'
+require 'pp'
+
+class TestRDS < Minitest::Test
+  def setup
+    # Inspired by http://www.unixdaemon.net/cloud/intro-to-cloudformations-conditionals.html
+    @template = ::Convection.template do
+      description 'RDS Test Template'
+
+      rds_security_group 'MyRDSSecGroup' do
+        description 'Pulls in EC2 SGs'
+        ec2_security_group 'MyEC2SecGroup', '123456789012'
+        cidr_ip 'my_cidr_value'
+      end
+
+      rds_instance 'MyRDSInstance' do
+        engine 'MySQL'
+        instance_class 'db.m1.medium'
+        allocated_storage 5
+        backup_retention_period 7
+        multi_az false
+
+        master_username 'root'
+        master_password 'secret'
+
+        security_group [fn_ref('MyRDSSecGroup')]
+      end
+    end
+  end
+
+  def from_json
+    JSON.parse(@template.to_json)
+  end
+
+  def test_rds_instance
+    # Expected JSON:
+    json = from_json['Resources']['MyRDSInstance']
+    db_secgroups = json['Properties']['DBSecurityGroups']
+
+    assert db_secgroups.is_a? Array
+    assert_equal 1, db_secgroups.size
+
+    perform_parameter_ref_comparison db_secgroups, 'MyRDSSecGroup', nil
+  end
+
+  def test_rds_secgroup
+    # Expected JSON:
+    json = from_json['Resources']['MyRDSSecGroup']
+    ingress_rules = json['Properties']['DBSecurityGroupIngress']
+
+    assert ingress_rules.is_a? Array
+    assert_equal 2, ingress_rules.size
+
+    ingress_rules.each do |rule|
+      if rule.key? 'CIDRIP'
+        assert rule.value? 'my_cidr_value'
+      else
+        assert rule['EC2SecurityGroupName'] == 'MyEC2SecGroup'
+        assert rule['EC2SecurityGroupOwnerId'] == '123456789012'
+      end
+    end
+  end
+
+  private
+
+  def perform_parameter_ref_comparison(comparison_array, parameter_name, expected_value)
+    parameter_ref = comparison_array[0]
+    assert parameter_ref.is_a? Hash
+    assert_equal 1, parameter_ref.size
+    assert parameter_ref.key? 'Ref'
+    assert parameter_ref.value? parameter_name
+
+    assert_equal expected_value, comparison_array[1]
+  end
+end

data/test/convection/model/test_template.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+require 'json'
+require 'pp'
+
+class TestTemplate < Minitest::Test
+  def setup
+    @template = Convection.template do
+      description 'Test Template'
+
+      ec2_instance 'TestInstance1' do
+        availability_zone 'us-east-1'
+        image_id 'ami-asdf83'
+      end
+
+      ec2_instance 'TestInstance2' do
+        availability_zone 'us-west-1'
+        image_id 'ami-lda34f'
+        depends_on 'TestInstance1'
+      end
+    end
+  end
+
+  def from_json
+    JSON.parse(@template.to_json)
+  end
+
+  def test_template_class
+    assert_kind_of Convection::Model::Template, @template
+  end
+
+  def test_template_format_version
+    assert_equal '2010-09-09', from_json['AWSTemplateFormatVersion']
+  end
+
+  def test_template_description
+    assert_equal 'Test Template', from_json['Description']
+  end
+
+  %w(Parameters Mappings Conditions Resources).each do |section|
+    define_method("test_template_#{section.downcase}") do
+      assert_respond_to from_json[section], :key?, "#{section} expected to respond to :key? method"
+    end
+  end
+
+  def test_template_resources
+    assert_includes from_json['Resources'], 'TestInstance1'
+  end
+
+  def instance1
+    from_json['Resources']['TestInstance1']
+  end
+
+  def test_template_instance_has_properties
+    assert_includes instance1, 'Properties'
+  end
+
+  def test_template_instance_type
+    assert_equal 'AWS::EC2::Instance', instance1['Type']
+  end
+
+  def test_template_depends_on
+    assert_includes from_json['Resources']['TestInstance2']['DependsOn'], 'TestInstance1'
+  end
+end

data/test/convection/model/test_validation.rb

@@ -0,0 +1,216 @@
+require 'test_helper'
+require 'json'
+require 'pp'
+
+class TestValidations < Minitest::Test
+  def test_within_limits
+    @within_limits = ::Convection.template do
+      description 'Validations Test Template - Within Limits'
+      10.times do |count|
+        resource "EC2_INSTANCE_#{count}" do
+          type 'AWS::EC2::Instance'
+          property 'AvailabilityZone', 'us-east-1a'
+          property 'ImageId', 'ami-76e27e1e'
+          property 'KeyName', 'test'
+          property 'SecurityGroupIds', ['sg-dd733c41', 'sg-dd738df3']
+        end
+        mapping "Mapping_#{count}" do
+          item 'one', 'two', 'three'
+          item '1', '2', '3'
+        end
+        output "Output_#{count}" do
+          description 'An Important Attribute'
+          value get_att('Resource', 'Attribute')
+        end
+        parameter "Parameter_#{count}" do
+          type 'String'
+          description 'Example Parameter'
+          default 'm3.medium'
+        end
+      end
+    end
+
+    assert_nothing_raised(StandardError) do
+      @within_limits.to_json
+    end
+  end
+
+  def test_bytesize
+    @excessive_bytesize = ::Convection.template do
+      description 'Validations Test Template - Excessive Bytesize'
+      200.times do |count|
+        resource "EC2_INSTANCE_#{count}" do
+          type 'AWS::EC2::Instance'
+          property 'AvailabilityZone', 'us-east-1a'
+          property 'ImageId', 'ami-76e27e1e'
+          property 'KeyName', 'test'
+          property 'SecurityGroupIds', ['sg-dd733c41', 'sg-dd738df3']
+          property 'Tags', [{
+            'Key' => 'Name',
+            'Value' => 'test-1'
+          }]
+        end
+      end
+      80.times do |count|
+        mapping "Mapping_#{count}" do
+          item 'us-east-1', 'test', 'cf-test-keys'
+          item 'us-west-1', 'test', 'cf-test-keys'
+        end
+      end
+    end
+    assert_raises(ExcessiveTemplateSizeError) do
+      JSON.generate(@excessive_bytesize.to_json).bytesize
+    end
+  end
+
+  def test_resources
+    @excessive_resources = ::Convection.template do
+      description 'Validations Test Template - Too Many Resources'
+      201.times do |count|
+        logs_log_group "Log_Group_#{count}" do
+          retention_in_days 365
+        end
+      end
+    end
+    @excessive_resource_name = ::Convection.template do
+      description 'Validations Test Template - Excessive Resource Name'
+      logs_log_group '0' * 256 do
+        retention_in_days 365
+      end
+    end
+
+    assert_raises(ExcessiveResourcesError) do
+      @excessive_resources.to_json
+    end
+    assert_raises(ExcessiveResourceNameError) do
+      @excessive_resource_name.to_json
+    end
+  end
+
+  def test_mappings
+    @excessive_mappings = ::Convection.template do
+      description 'Validations Test Template - Too Many Mappings'
+      101.times do |count|
+        mapping "Mapping_#{count}" do
+          item 'us-east-1', 'test', 'cf-test-keys'
+          item 'us-west-1', 'test', 'cf-test-keys'
+        end
+      end
+    end
+    @excessive_mapping_name = ::Convection.template do
+      description 'Validations Test Template - Excessive Mapping Name'
+      mapping '0' * 256 do
+        item '1', '2', '3'
+      end
+    end
+
+    assert_raises(ExcessiveMappingsError) do
+      @excessive_mappings.to_json
+    end
+    assert_raises(ExcessiveMappingNameError) do
+      @excessive_mapping_name.to_json
+    end
+  end
+
+  def test_mapping_attributes
+    @excessive_mapping_attributes = ::Convection.template do
+      description 'Validations Test Template - Too Many Mapping Attributes'
+      mapping 'Mapping_Example' do
+        31.times do |count|
+          item "#{count}_1", "#{count}_2", "#{count}_3"
+        end
+      end
+    end
+    @excessive_mapping_attribute_names = ::Convection.template do
+      description 'Validations Test Template - Excessive Mapping Attribute Name'
+      mapping 'Mapping_1' do
+        item '0' * 256, 'value', 'value'
+      end
+    end
+
+    assert_raises(ExcessiveMappingAttributesError)do
+      @excessive_mapping_attributes.to_json
+    end
+    assert_raises(ExcessiveMappingAttributeNameError) do
+      @excessive_mapping_attribute_names.to_json
+    end
+  end
+
+  def test_outputs
+    @excessive_outputs = ::Convection.template do
+      description 'Validations Test Template - Too Many Outputs'
+      61.times do |count|
+        output "Output_#{count}" do
+          description 'An Important Attribute'
+          value get_att('Resource', 'Attribute')
+        end
+      end
+    end
+    @excessive_output_name = ::Convection.template do
+      description 'Validations Test Template - Excessive Output Name'
+      output '0' * 256 do
+        description 'An Important Attribute'
+        value get_att('Resource', 'Attribute')
+      end
+    end
+
+    assert_raises(ExcessiveOutputsError) do
+      @excessive_outputs.to_json
+    end
+    assert_raises(ExcessiveOutputNameError) do
+      @excessive_output_name.to_json
+    end
+  end
+
+  def test_parameters
+    @excessive_parameters = ::Convection.template do
+      description 'Validations Test Template - Too Many Parameters'
+      61.times do |count|
+        parameter "Parameter_#{count}" do
+          type 'String'
+          description 'Example Parameter'
+          default 'm3.medium'
+        end
+      end
+    end
+    @excessive_parameter_name = ::Convection.template do
+      description 'Validations Test Template - Excessive Parameter Name'
+      parameter '0' * 256 do
+        type 'String'
+        description 'Example Parameter'
+        default 'm3.medium'
+      end
+    end
+
+    assert_raises(ExcessiveParametersError) do
+      @excessive_parameters.to_json
+    end
+    assert_raises(ExcessiveParameterNameError) do
+      @excessive_parameter_name.to_json
+    end
+  end
+
+  def test_parameter_bytesize
+    @excessive_parameter_value_bytesize = ::Convection.template do
+      description 'Validations Test Template - Excessive Parameter Value Bytesize'
+      parameter 'Excessive_Parameter' do
+        type 'String' * 150
+        description 'Example Parameter' * 150
+        default 'm3.medium' * 150
+      end
+    end
+
+    assert_raises(ExcessiveParameterBytesizeError) do
+      @excessive_parameter_value_bytesize.to_json
+    end
+  end
+
+  def test_description
+    @excessive_description = ::Convection.template do
+      description '0' * 1_025
+    end
+    assert_raises(ExcessiveDescriptionError) do
+      @excessive_description.to_json
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+SimpleCov.start do
+  add_group 'Control', 'lib/convection/control'
+  add_group 'Model', 'lib/convection/model'
+  add_group 'DSL', 'lib/convection/dsl'
+end
+
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+require_relative '../lib/convection'
+
+module Minitest::Assertions
+  def assert_nothing_raised(*)
+    yield
+  end
+end

metadata

@@ -1,87 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: convection
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.1
 platform: ruby
 authors:
 - John Manero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: thor-scmversion
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :development
+        version: '0.13'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: netaddr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: netaddr
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0.19'
 description: |
-  # Convection
+  # Convection [![Build Status](https://travis-ci.org/rapid7/convection.svg)](https://travis-ci.org/rapid7/convection)
   _A fully generic, modular DSL for AWS CloudFormation_
 
   This gem aims to provide a reusable model for AWS CloudFormation in Ruby. It exposes a DSL for template definition, and a simple, decoupled abstraction of a CloudFormation Stack to compile and apply templates.
@@ -190,7 +176,18 @@ description: |
   ### Conditions
   http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html
 
-  Not implemented yet.
+  ```ruby
+  condition 'ThisCondition' do
+    fn_equals( fn_ref('SomeParameter'), 'value_x' )
+  end
+
+  condition 'ThatCondition' do
+    fn_or(
+      fn_equals( fn_ref('SomeParameter'), 'value_y' ),
+      fn_equals( fn_ref('SomeParameter'), 'value_z' )
+    )
+  end
+  ```
 
   ### Resources
   http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html
@@ -210,6 +207,17 @@ description: |
   end
   ```
 
+  Using a condition to set a resource property:
+
+  ```ruby
+  resource 'MySQL' do
+    type 'AWS::RDS::DBInstance'
+    ...
+    property 'Iops', fn_if('ThisCondition', '1000', fn_ref('AWS::NoValue'))
+    ...
+  end
+  ```
+
   ### Outputs
   http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html
 
@@ -278,6 +286,9 @@ description: |
   * `#delete` - Delete CloudFormation Stack
   * `#availability_zones(&block)` - Return an array of strings representing the region's availability zones. Provided codeblock will be called for each AZ.
 
+  ## Futures
+  *
+
   ## License
   _Copyright (c) 2015 John Manero, Rapid7 LLC._
 
@@ -307,48 +318,111 @@ description: |
   ```
 email:
 - jmanero@rapid7.com
-executables: []
+executables:
+- convection
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - Thorfile
+- bin/convection
 - convection.gemspec
-- example/iam_role.rb
-- example/s3.rb
+- example/.ruby-version
+- example/Cloudfile
+- example/deprecated/elb.rb
+- example/deprecated/iam_access_key.rb
+- example/deprecated/iam_group.rb
+- example/deprecated/iam_role.rb
+- example/deprecated/iam_user.rb
+- example/deprecated/rds.rb
+- example/deprecated/s3.rb
+- example/deprecated/sqs.rb
+- example/deprecated/vpc.rb
+- example/foobar.rb
+- example/output/vpc.json
+- example/security-groups.rb
+- example/trust_cloudtrail.rb
 - example/vpc.rb
+- ext/resource_generator.sh
 - lib/convection.rb
+- lib/convection/control/cloud.rb
 - lib/convection/control/stack.rb
 - lib/convection/dsl/helpers.rb
 - lib/convection/dsl/intrinsic_functions.rb
+- lib/convection/model/attributes.rb
+- lib/convection/model/cloudfile.rb
+- lib/convection/model/diff.rb
+- lib/convection/model/event.rb
+- lib/convection/model/exceptions.rb
 - lib/convection/model/mixin/cidr_block.rb
+- lib/convection/model/mixin/colorize.rb
 - lib/convection/model/mixin/conditional.rb
+- lib/convection/model/mixin/policy.rb
+- lib/convection/model/mixin/protocol.rb
 - lib/convection/model/mixin/taggable.rb
 - lib/convection/model/template.rb
+- lib/convection/model/template/condition.rb
 - lib/convection/model/template/mapping.rb
 - lib/convection/model/template/output.rb
 - lib/convection/model/template/parameter.rb
 - lib/convection/model/template/resource.rb
+- lib/convection/model/template/resource/aws_auto_scaling_auto_scaling_group.rb
+- lib/convection/model/template/resource/aws_auto_scaling_launch_configuration.rb
+- lib/convection/model/template/resource/aws_auto_scaling_scaling_policy.rb
+- lib/convection/model/template/resource/aws_cloud_watch_alarm.rb
 - lib/convection/model/template/resource/aws_ec2_instance.rb
 - lib/convection/model/template/resource/aws_ec2_internet_gateway.rb
+- lib/convection/model/template/resource/aws_ec2_network_acl.rb
+- lib/convection/model/template/resource/aws_ec2_network_acl_entry.rb
 - lib/convection/model/template/resource/aws_ec2_route.rb
 - lib/convection/model/template/resource/aws_ec2_route_table.rb
 - lib/convection/model/template/resource/aws_ec2_security_group.rb
+- lib/convection/model/template/resource/aws_ec2_security_group_ingres.rb
 - lib/convection/model/template/resource/aws_ec2_subnet.rb
+- lib/convection/model/template/resource/aws_ec2_subnet_network_acl_association.rb
 - lib/convection/model/template/resource/aws_ec2_subnet_route_table_association.rb
 - lib/convection/model/template/resource/aws_ec2_vpc.rb
 - lib/convection/model/template/resource/aws_ec2_vpc_gateway_attachment.rb
+- lib/convection/model/template/resource/aws_elasticache_cluster.rb
+- lib/convection/model/template/resource/aws_elasticache_parameter_group.rb
+- lib/convection/model/template/resource/aws_elasticache_security_group.rb
+- lib/convection/model/template/resource/aws_elasticache_security_group_ingress.rb
+- lib/convection/model/template/resource/aws_elb.rb
+- lib/convection/model/template/resource/aws_iam_access_key.rb
+- lib/convection/model/template/resource/aws_iam_group.rb
+- lib/convection/model/template/resource/aws_iam_instance_profile.rb
 - lib/convection/model/template/resource/aws_iam_policy.rb
 - lib/convection/model/template/resource/aws_iam_role.rb
+- lib/convection/model/template/resource/aws_iam_user.rb
+- lib/convection/model/template/resource/aws_logs_loggroup.rb
+- lib/convection/model/template/resource/aws_rds_db_instance.rb
+- lib/convection/model/template/resource/aws_rds_db_parameter_group.rb
+- lib/convection/model/template/resource/aws_rds_db_security_group.rb
+- lib/convection/model/template/resource/aws_rds_db_subnet_group.rb
+- lib/convection/model/template/resource/aws_route53_health_check.rb
+- lib/convection/model/template/resource/aws_route53_recordset.rb
 - lib/convection/model/template/resource/aws_s3_bucket.rb
 - lib/convection/model/template/resource/aws_s3_bucket_policy.rb
+- lib/convection/model/template/resource/aws_sns_topic.rb
+- lib/convection/model/template/resource/aws_sqs_queue.rb
+- lib/convection/model/template/resource/aws_sqs_queue_policy.rb
 - lib/convection/version.rb
-homepage: ''
+- test/convection/model/test_conditions.rb
+- test/convection/model/test_elasticache.rb
+- test/convection/model/test_loggroups.rb
+- test/convection/model/test_rds.rb
+- test/convection/model/test_template.rb
+- test/convection/model/test_validation.rb
+- test/test_helper.rb
+homepage: https://github.com/rapid7/convection
 licenses:
 - MIT
 metadata: {}
@@ -358,18 +432,25 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A fully generic, modular DSL for AWS CloudFormation
-test_files: []
+test_files:
+- test/convection/model/test_conditions.rb
+- test/convection/model/test_elasticache.rb
+- test/convection/model/test_loggroups.rb
+- test/convection/model/test_rds.rb
+- test/convection/model/test_template.rb
+- test/convection/model/test_validation.rb
+- test/test_helper.rb