convection 0.0.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0e40b87f41fe55c9ae72164fb2f4bfd6a65b7e6
-  data.tar.gz: 6c2136c2a50025cbc8ab781362717afbd919bde4
+  metadata.gz: 075a28b9e49edf4315587f8de99945362fd9e837
+  data.tar.gz: 97a5572cf09f71edca02765fda206d77483bbfc0
 SHA512:
-  metadata.gz: 73e16b10a0ff8accc52f4f50840ce91638d28e83df66b258b6b577f7955733aa471c621054eabd272ac2d62f3dfee6d9c28f4e2494f3cdc948341f7d31f02cf1
-  data.tar.gz: 6170446d0c4ccd1cc348b596529c11917017323df2c25f8983f2ea598f3ccc05fed5c37797c4bb1db90bb457096a43bd46b3008de09ef0fb588d88b21d032c46
+  metadata.gz: 7c0a82cfe5c746882ca8d48c45929ed0a136d27def8f98bd59a5a3394c4ea00ce5ecf4c19ddd30dd17dff84c9f2612ca6b9a9ebe14d103fd0d0ef29acc1f4f13
+  data.tar.gz: c2dbf7220245c5c4b4274a40c1db694f5ac3c68b0a954a88418bd4da0270d8359d60f0a63644d93905ace121a226e70f1aad2ca4fdeca5a9988776b570f45844

data/.gitignore

@@ -11,6 +11,7 @@
 *.so
 *.o
 *.a
+.DS_Store
 mkmf.log
 
 keys

data/.rubocop.yml

@@ -1,16 +1,34 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
- Exclude:
-   - libraries/**/*
-   - spec/**/*
-   - metadata.rb
+  Include:
+    - lib/**/*
+    - bin/**/*
+    - test/**/*
+    - Gemfile
+    - Rakefile
+    - Thorfile
+  Exclude:
+    - example/**/*
 
 Encoding:
  Enabled: false
-LineLength:
+RescueModifier:
  Enabled: false
 HashSyntax:
  Enabled: false
-RescueModifier:
+SpaceInsideStringInterpolation:
   Enabled: false
-MethodLength:
-  Max: 24
+
+# AbcSize:
+#   Max: 24
+# ClassLength:
+#   Max: 256
+# CyclomaticComplexity:
+#   Max: 12
+# LineLength:
+#   Max: 120
+# MethodLength:
+#   Max: 32
+# PerceivedComplexity:
+#   Max: 12

data/.rubocop_todo.yml

@@ -0,0 +1,77 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-09-14 17:06:32 -0400 using RuboCop version 0.34.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/convection/control/stack.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/convection/model/template.rb'
+
+# Offense count: 9
+Metrics/AbcSize:
+  Max: 57
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 267
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 9
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 151
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 35
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Offense count: 2
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/convection/control/stack.rb'
+
+# Offense count: 3
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/convection/model/template.rb'
+    - 'test/test_helper.rb'
+
+# Offense count: 11
+Style/Documentation:
+  Exclude:
+    - 'lib/convection/model/attributes.rb'
+    - 'lib/convection/model/mixin/colorize.rb'
+    - 'lib/convection/model/template/condition.rb'
+    - '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'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/FirstParameterIndentation:
+  Exclude:
+    - 'lib/convection/model/mixin/taggable.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.3 
+  - 2.1.5
+  - 2.1.6
+  - 2.2.0
+  - 2.2.1
+  - 2.2.2
+sudo: false

data/Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in convection.gemspec
 gemspec
+
+group :development do
+  gem 'bundler', '~> 1.7'
+  gem 'minitest'
+  gem 'rake', '~> 10.0'
+  gem 'rubocop', '~> 0.34'
+  gem 'simplecov'
+  gem 'thor-scmversion', '= 1.7.0'
+end

data/README.md

@@ -1,4 +1,4 @@
-# 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.
@@ -107,7 +107,18 @@ end
 ### 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
@@ -127,6 +138,17 @@ resource 'AnInstance' do
 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
 
@@ -195,6 +217,9 @@ The `Stack` class provides a state wrapper for CloudFormation Stacks. It tracks
 * `#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._
 

data/Rakefile

@@ -1,2 +1,12 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rake/testtask'
 
+RuboCop::RakeTask.new
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+end
+
+task :default => [:test, :rubocop]

data/bin/convection

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+require 'thor'
+require_relative '../lib/convection/control/cloud'
+
+module Convection
+  ##
+  # Convection CLI
+  ##
+  class CLI < Thor
+    class_option :cloudfile, :type => :string, :default => 'Cloudfile'
+    def initialize(*args)
+      super
+      @cloud = Control::Cloud.new
+      @cwd = Dir.getwd
+    end
+
+    desc 'converge STACK', 'Converge your cloud'
+    def converge(stack = nil)
+      @cloud.configure(File.absolute_path(options['cloudfile'], @cwd))
+      @cloud.converge(stack) do |event, errors|
+        say_status(*event.to_thor)
+        errors.each do |error|
+          say "* #{ error.message }"
+          error.backtrace.each { |b| say "    #{ b }" }
+        end unless errors.nil?
+      end
+    end
+
+    desc 'diff', 'Show changes that will be applied by converge'
+    def diff
+      @cloud.configure(File.absolute_path(options['cloudfile'], @cwd))
+      @cloud.diff { |d| say_status(*d.to_thor) }
+    end
+
+    desc 'print STACK', 'Print the rendered template for STACK'
+    def print(stack)
+      @cloud.configure(File.absolute_path(options['cloudfile'], @cwd))
+      puts @cloud.stacks[stack].to_json(true)
+    end
+
+    desc 'validate STACK', 'Validate the rendered template for STACK'
+    def validate(stack)
+      @cloud.configure(File.absolute_path(options['cloudfile'], @cwd))
+      @cloud.stacks[stack].validate
+    end
+  end
+end
+
+Convection::CLI.start(ARGV)

data/convection.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['jmanero@rapid7.com']
   spec.summary       = Convection::SUMMARY
   spec.description   = Convection::DESCRIPTION
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/rapid7/convection'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,10 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'thor-scmversion', '= 1.7.0'
-
-  spec.add_runtime_dependency 'aws-sdk', '< 2'
-  spec.add_runtime_dependency 'netaddr', '~> 1.5.0'
+  spec.add_runtime_dependency 'aws-sdk', '>= 2'
+  spec.add_runtime_dependency 'httparty', '~> 0.13'
+  spec.add_runtime_dependency 'netaddr', '~> 1.5'
+  spec.add_runtime_dependency 'thor', '~> 0.19'
 end

data/example/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/example/Cloudfile

@@ -0,0 +1,13 @@
+require_relative '../lib/convection'
+require_relative './vpc'
+require_relative './security-groups'
+require_relative './foobar'
+
+name 'convection-test'
+region 'us-east-1'
+
+attribute 'vpc', 'subnet', '10.255.0.0/16'
+
+stack 'vpc', Convection::Demo::VPC
+stack 'security-groups', Convection::Demo::SECURITY_GROUPS
+stack 'foobar', Convection::Demo::FOOBAR

data/example/deprecated/elb.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'convection'
+
+region = 'us-west-1'
+
+elb_template = Convection.template do
+  description 'Example ELB via Convection '
+
+  elb 'TestELB' do
+    availability_zones(
+      {
+        "Fn::GetAZs"=>""
+      }
+    )
+    load_balancer_name('ExampleELB')
+    listeners(
+      {
+         'InstancePort' => '80',
+         'LoadBalancerPort' => '80',
+         'Protocol' => 'HTTP'
+      }
+    )
+  end
+end
+
+puts elb_template.to_json
+#puts Convection.stack('ELBTestStack', elb_template, :region => region).apply

data/example/deprecated/iam_access_key.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'convection'
+
+test_iam_access_key_template = Convection.template do
+  description 'This example creates a user an access keys for that user.'
+
+  iam_user 'NewUser' do
+    path 'new_user'
+  end
+
+  iam_access_key 'NewUserKey' do
+    status 'Active'
+    user_name fn_ref(:NewUser)
+  end
+end
+
+puts test_iam_access_key_template.to_json
+# puts Convection.stack('IAMTestStack', test_iam_access_key_template, :region => 'us-west-1').apply

data/example/deprecated/iam_group.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'convection'
+
+test_iam_group_template = Convection.template do
+  description 'This is an example of a stack representing IAM Groups and Policies.'
+
+  parameter 'Path' do
+    type 'String'
+    default '/'
+  end
+
+  iam_policy 'GroupPolicy' do
+    policy_name 'NewPolicy'
+    group fn_ref(:NewGroup)
+
+    policy(
+      :Statement => [{
+        :Effect => 'Allow',
+        :Action => ['s3:GetObject'],
+        :Resource => ['arn:aws:s3:::some.bucket.name.here/*']
+      }]
+    )
+  end
+
+  iam_group 'NewGroup' do
+    path fn_ref(:Path)
+  end
+end
+
+puts test_iam_group_template.to_json
+# puts Convection.stack('IAMTestStack', test_iam_group_template, :region => 'us-west-1').apply

data/example/{iam_role.rb → deprecated/iam_role.rb}

@@ -20,43 +20,32 @@ test_iam_role_template = Convection.template do
   end
 
   iam_policy 'RolePolicy' do
-    role fn_ref('NewRole')
-    # You can choose between multiple 'role' attributes
-    # or build out an array with multiple values.
-    name 'NewPolicy'
-    # Note the move to fat colons below:
-    policy_document({
-    "Statement"=> [
-        {
-          "Effect"=> "Allow",
-          "Action"=> [
-              "s3:GetObject"
-          ],
-          "Resource"=> [
-              "arn:aws:s3:::some.bucket.name.here/*"
-          ]
-        }
-      ]
-    })
+    policy_name 'NewPolicy'
+    role fn_ref(:NewRole)
+
+    policy(
+      :Statement => [{
+        :Effect => 'Allow',
+        :Action => ['s3:GetObject'],
+        :Resource => ['arn:aws:s3:::some.bucket.name.here/*']
+      }]
+    )
   end
 
   iam_role 'NewRole' do
-    path fn_ref('Path')
-    # This is a contrived example of an instance role for aws.
-    assume_role_policy_document({
-      "Statement" => [
-      {
-        "Sid" => "",
-        "Effect" => "Allow",
-        "Principal" => {
-          "Service" => "ec2.amazonaws.com"
+    path fn_ref(:Path)
+
+    # EC2 Instance Role
+    trust_relationship(
+      :Statement => [{
+        :Effect => 'Allow',
+        :Principal => {
+          :Service => 'ec2.amazonaws.com'
         },
-        "Action" => "sts:AssumeRole"
-      }
-     ]
-   })
+        :Action => 'sts:AssumeRole'
+      }]
+    )
   end
-
 end
 
 puts test_iam_role_template.to_json