cloudformation_rspec 0.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e741127a74f674f19e97e2d5c25dedfb96cab8eb471fe65a4ba8ba5d5e18fd4
+  data.tar.gz: 84004c6abe9054bdd0eccaf8a81996916976c29b45794fb591ef5ba098ffdbe2
+SHA512:
+  metadata.gz: 7b0df6dabb6d58df4bc7bbbdfc70d9ced98dea284522ffc30eabf5fe31f8e15a0f39ba42ed18b293f1944af44a385e5b056370b367f5c4181c5f669b1f79e7a7
+  data.tar.gz: 98b37a583ed876cbd4fcf60ede9f642e7202010ea61ff23936ca319791bacefb70efb6000647d2c4ea2309e0158c3cfd4d0d3bc34365ab9ef7ca7ceba6633d61

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,80 @@
+# CloudFormation RSpec
+
+CloudFormation provides a black-box orchestration model; you feed templates in and infrastructure pops out the other end. This is good in that we design our templates without having to understand how the sausage gets made, but we want a way to test, quickly, what it's actually doing is what we expect.
+
+CloudFormation RSpec enables us to use RSpec matchers test your templates against the actual CloudFormation APIs without creating actual infrastructure. This is a tradeoff to get faster feedback (typically in under 2 minutes) without waiting for CloudFormation stacks to build and is designed to complement but not replace Acceptance Testing.
+
+## Usage
+
+### Testing template Change Set with Parameters
+
+```ruby
+describe 'vpc_template' do
+  let(:template_json) { File.read('fixtures/vpc.json') }
+  let(:stack) {
+    template_body: template_json,
+    parameters: {
+      "VpcCidr" => cidr,
+    }
+  }
+
+  it 'is valid' do
+    expect(template_json).to be_valid
+  end
+
+  context 'with a valid cidr' do
+    let(:cidr) { "10.0.0.0/16" }
+
+    it 'creates a vpc' do
+      expect(stack).to contain_in_change_set("AWS::EC2::VPC", "vpc")
+    end
+  end
+
+  context 'with invalid cidr' do
+    let(:cidr) { "1.1.1.0/16" }
+
+    it 'fails to create a change set' do
+      expect(stack).to have_change_set_failed
+    end
+  end
+end
+```
+
+### Testing SparkleFormation templates
+
+```ruby
+describe 'vpc_template' do
+  let(:stack) {
+    compiler: :sparkleformation,
+    template_file: "templates/vpc.rb",
+    compile_state: {public_subnets: ["10.0.0.0/24", "10.0.1.0/24"], private_subnets: ["10.0.2.0/24", "10.0.3.0/24"]},
+    parameters: {
+      "VpcCidr" => cidr,
+    }
+  }
+
+  it 'is valid' do
+    expect(stack).to be_valid_sparkleformation
+  end
+
+  context 'with a valid cidr' do
+    let(:cidr) { "10.0.0.0/16" }
+
+    it 'creates a vpc' do
+      expect(stack).to contain_in_change_set("AWS::EC2::VPC", "vpc")
+    end
+  end
+
+  context 'with invalid cidr' do
+    let(:cidr) { "1.1.1.0/16" }
+
+    it 'fails to create a change set' do
+      expect(stack).to have_change_set_failed
+    end
+  end
+end
+```
+
+## Limitations
+
+Currently we don't support templates larger than 51,200 bytes, as this requires uploading the template to S3 first.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]

data/cloudformation-rspec.gemspec

@@ -0,0 +1,22 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name    = "cloudformation_rspec"
+  gem.version = "0.0.9"
+
+  gem.authors     = ["Patrick Robinson"]
+  gem.email       = ["patrick.robinson@envato.com"]
+  gem.description = %q{CloudFormation RSpec matchers}
+  gem.summary     = %q{Test your CloudFormation templates}
+  gem.homepage    = "https://github.com/envato/cloudformation_rspec"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rspec', '~> 3'
+  gem.add_dependency 'sparkle_formation', '~> 3'
+  gem.add_dependency 'aws-sdk-cloudformation', '~> 1'
+  gem.add_development_dependency 'rake'
+end

data/lib/cloudformation_rspec.rb

@@ -0,0 +1,7 @@
+module CloudFormationRSpec
+end
+
+require 'cloudformation_rspec/resource_change'
+require 'cloudformation_rspec/change_set'
+require 'cloudformation_rspec/sparkle'
+require 'cloudformation_rspec/matchers'

data/lib/cloudformation_rspec/change_set.rb

@@ -0,0 +1,99 @@
+require 'aws-sdk-cloudformation'
+require 'securerandom'
+require 'digest'
+require 'sparkle_formation'
+
+class CloudFormationRSpec::ChangeSet
+  END_STATES = [
+    'CREATE_COMPLETE',
+    'DELETE_COMPLETE',
+    'FAILED'
+  ]
+  WAIT_DELAY = 3
+
+  ChangeSetNotComplete = Class.new(StandardError)
+
+  @change_set_cache = {}
+
+  attr_reader :changes, :status
+
+  def initialize(template_body:, parameters: {})
+    @template_body = template_body
+    @parameters = parameters ? parameters : {}
+  end
+
+  def self.from_cloudformation_template(template_body:, parameters:)
+    new(template_body: template_body, parameters: parameters).tap { |change_set| change_set.create_change_set }
+  end
+
+  def self.from_sparkleformation_template(template_file:, compile_state:, parameters:)
+    template_body = CloudFormationRSpec::Sparkle.compile_sparkle_template(template_file, compile_state)
+  
+    new(template_body: template_body, parameters: parameters).tap { |change_set| change_set.create_change_set }
+  end
+
+  def create_change_set
+    change_set_hash = generate_change_set_hash
+
+    if change_set = self.class.get_from_cache(change_set_hash)
+      @status = change_set.status
+      @changes = change_set.changes.map { |change| CloudFormationRSpec::ResourceChange.new(change.resource_change.resource_type, change.resource_change.logical_resource_id) }
+      return change_set
+    end
+
+    client = Aws::CloudFormation::Client.new
+    change_set = client.create_change_set(
+      change_set_name: change_set_name,
+      stack_name: change_set_name,
+      change_set_type: 'CREATE',
+      template_body: @template_body,
+      parameters: flat_parameters,
+      capabilities: ['CAPABILITY_IAM', 'CAPABILITY_NAMED_IAM'],
+    )
+    @change_set_id = change_set.id
+    stack_created = wait_change_set_review(client, change_set_name)
+    response = client.describe_change_set(change_set_name: @change_set_id, stack_name: change_set_name)
+    if !END_STATES.include? response.status
+      raise ChangeSetNotComplete.new("Change set did not complete in time. #{response.status}")
+    end
+    @status = response.status
+    @changes = response.changes.map { |change| CloudFormationRSpec::ResourceChange.new(change.resource_change.resource_type, change.resource_change.logical_resource_id) }
+    client.delete_change_set(change_set_name: change_set_name, stack_name: change_set_name)
+    client.delete_stack(stack_name: change_set_name) if stack_created
+    self.class.add_to_cache(change_set_hash, response)
+    response
+  end
+
+  private
+
+  def change_set_name
+    @change_set_name ||= "CloudFormationRSpec-#{SecureRandom.uuid}"
+  end
+
+  def flat_parameters
+    @parameters.map { |k, v| {parameter_key: k, parameter_value: v} }
+  end
+
+  def wait_change_set_review(client, change_set_name)
+    client.wait_until(:stack_exists, {stack_name: change_set_name}, {delay: WAIT_DELAY})
+    client.wait_until(:change_set_create_complete, {change_set_name: change_set_name, stack_name: change_set_name}, {delay: WAIT_DELAY})
+  rescue Aws::Waiters::Errors::WaiterFailed, Aws::Waiters::Errors::TooManyAttemptsError
+    false
+  end
+
+  def generate_change_set_hash
+    Digest::MD5.hexdigest(@template_body + @parameters.to_json)
+  end
+
+  def self.get_from_cache(change_set_hash)
+    @change_set_cache[change_set_hash]
+  end
+
+  def self.add_to_cache(change_set_hash, change_set)
+    @change_set_cache[change_set_hash] = change_set
+  end
+
+  def self.flush_cache
+    @change_set_cache = {}
+  end
+end

data/lib/cloudformation_rspec/matchers.rb

@@ -0,0 +1,7 @@
+module CloudFormationRSpec::Matchers
+end
+
+require 'rspec'
+require 'cloudformation_rspec/matchers/validate'
+require 'cloudformation_rspec/matchers/change_set'
+require 'cloudformation_rspec/matchers/output'

data/lib/cloudformation_rspec/matchers/change_set.rb

@@ -0,0 +1,78 @@
+require 'aws-sdk-cloudformation'
+
+module CloudFormationRSpec::Matchers::ChangeSet
+  def generate_change_set(stack)
+    if stack[:compiler] == :sparkleformation
+      CloudFormationRSpec::ChangeSet.from_sparkleformation_template(
+        template_file: stack[:template_file],
+        compile_state: stack[:compile_state],
+        parameters: stack[:parameters]
+      )
+    else
+      if !stack[:template_body]
+        raise ArgumentError, "You must pass either :template_body or set :compiler and pass in compiler specific options"
+      end
+      CloudFormationRSpec::ChangeSet.from_cloudformation_template(template_body: stack[:template_body], parameters: stack[:parameters])
+    end
+  end
+
+  def resource_ids_with_resource_type(change_set_result, resource_type)
+    change_set_result.changes.select do |change|
+      change.resource_type == resource_type
+    end.map(&:logical_resource_id)
+  end
+end
+
+RSpec::Matchers.define :contain_in_change_set do |resource_type, resource_id|
+  include CloudFormationRSpec::Matchers::ChangeSet
+
+  match do |stack|
+    if !stack.is_a?(Hash)
+      raise ArgumentError, "You must pass a hash to this expectation"
+    end
+
+    change_set_result = generate_change_set(stack)
+
+    if change_set_result.status == 'FAILED'
+      @error = "Change set creation failed: #{change_set_result.status_reason}"
+      return false
+    end
+
+    if !change_set_result.changes.any? { |change| change.resource_type == resource_type }
+      @error = "Change set does not include resource type #{resource_type}"
+      return false
+    end
+
+    if !change_set_result.changes.any? { |change| change.logical_resource_id == resource_id }
+      @error = %Q(
+Change set does not include a resource type #{resource_type} with the id #{resource_id}
+Found the following resources with the same Resource Type:\n#{resource_ids_with_resource_type(change_set_result, resource_type).join("\n")}
+      )
+      return false
+    end
+    true
+  end
+
+  failure_message do
+    @error
+  end
+end
+
+RSpec::Matchers.define :have_change_set_failed do
+  include CloudFormationRSpec::Matchers::ChangeSet
+
+  match do |stack|
+    change_set_result = generate_change_set(stack)
+  
+    if change_set_result.status != 'FAILED'
+      @error = "Change set creation succeeded"
+      return false
+    end
+  
+    true
+  end
+
+  failure_message do
+    @error
+  end
+end

data/lib/cloudformation_rspec/matchers/output.rb

@@ -0,0 +1,47 @@
+require 'json'
+require 'yaml'
+
+RSpec::Matchers.define :have_output_including do |output_name|
+  def json_template?(template_body)
+    template_body =~ /^\s*{/ # ignore leading whitespaces
+  end
+
+  def compile_sparkle_template(stack)
+    stack[:compile_state] ||= {}
+
+    template = CloudFormationRSpec::Sparkle.compile_sparkle_template(stack[:template_file], stack[:compile_state])
+    JSON.load(template)
+  end
+
+  match do |input|
+    if input.is_a?(Hash) && input[:compiler] == :sparkleformation
+      unless input[:template_file]
+        raise ArgumentError, "You must pass a hash to this expectation with at least the :template_file option"
+      end
+
+      decode_function = lambda { |s| compile_sparkle_template(s) }
+    elsif !input.is_a?(String)
+      raise ArgumentError, "You must pass a hash for SparkleFormation templates, or a string for YAML/JSON templates"
+    elsif json_template?(input)
+      decode_function = lambda { |tmpl| JSON.load(tmpl) }
+    else
+      decode_function = lambda { |tmpl| YAML.safe_load(tmpl) }
+    end
+
+    begin
+      template = decode_function.call(input)
+    rescue JSON::ParserError, Psych::SyntaxError, CloudFormationRSpec::Sparkle::InvalidTemplate => error
+      raise SyntaxError, "Unable to parse template: #{error}"
+    end
+    outputs = template["Outputs"].nil? ? [] : template["Outputs"].keys
+
+    @actual = outputs
+    outputs.include?(output_name)
+  end
+
+  diffable
+
+  failure_message do
+    @error
+  end
+end

data/lib/cloudformation_rspec/matchers/validate.rb

@@ -0,0 +1,48 @@
+require 'aws-sdk-cloudformation'
+
+module CloudFormationRSpec::Matchers::Validate
+  def validate_cf_template(template_body)
+    client = Aws::CloudFormation::Client.new
+    begin
+      client.validate_template(template_body: template_body)
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      @error = e.message
+      return false
+    end
+    true
+  end
+end
+
+RSpec::Matchers.define :be_valid do
+  include CloudFormationRSpec::Matchers::Validate
+  match do |cf_template|
+    validate_cf_template(cf_template)
+  end
+
+  failure_message do
+    @error
+  end
+end
+
+RSpec::Matchers.define :be_valid_sparkleformation do
+  include CloudFormationRSpec::Matchers::Validate
+  match do |stack|
+    if !stack.is_a?(Hash) || !stack[:template_file]
+      raise ArgumentError, "You must pass a hash to this expectation with at least the :template_file option"
+    end
+
+    stack[:compile_state] ||= {}
+
+    begin
+      template_body = CloudFormationRSpec::Sparkle.compile_sparkle_template(stack[:template_file], stack[:compile_state])
+    rescue CloudFormationRSpec::Sparkle::InvalidTemplate => error
+      @error = error
+      return false
+    end
+    validate_cf_template(template_body)
+  end
+
+  failure_message do
+    @error
+  end
+end

data/lib/cloudformation_rspec/resource_change.rb

@@ -0,0 +1,12 @@
+class CloudFormationRSpec::ResourceChange
+  attr_reader :resource_type, :logical_resource_id
+
+  def initialize(resource_type, logical_resource_id)
+    @resource_type = resource_type
+    @logical_resource_id = logical_resource_id
+  end
+
+  def ==(expected)
+    expected.is_a?(self.class) && self.resource_type == expected.resource_type && self.logical_resource_id == expected.logical_resource_id
+  end
+end

data/lib/cloudformation_rspec/sparkle.rb

@@ -0,0 +1,20 @@
+class CloudFormationRSpec::Sparkle
+  InvalidTemplate = Class.new(StandardError)
+  InvalidSparkleTemplate = Class.new(InvalidTemplate)
+  InvalidCloudFormationTemplate = Class.new(InvalidTemplate)
+
+  def self.compile_sparkle_template(template_file, compile_state)
+    begin
+      sparkle_template = ::SparkleFormation.compile(template_file, :sparkle)
+    rescue RuntimeError, SyntaxError => error
+      raise InvalidSparkleTemplate.new("Error compiling template into SparkleTemplate #{error.message}")
+    end
+
+    begin
+      sparkle_template.compile_state = compile_state
+      sparkle_template.to_json
+    rescue => error
+      raise InvalidCloudFormationTemplate.new("Error compiling template into CloudFormation #{error.message}")
+    end
+  end
+end

data/spec/change_set_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe CloudFormationRSpec::ChangeSet do
+  let(:template_body) { '{"Description": "Foo"}' }
+  let(:parameters) { {"VpcCidr" => "10.0.0.0/16"} }
+  let(:cf_stub) { instance_double(Aws::CloudFormation::Client) }
+  let(:change_set_mock) { instance_double(Aws::CloudFormation::Types::DescribeChangeSetOutput) }
+  let(:change_set_create_mock) { instance_double(Aws::CloudFormation::Types::CreateChangeSetOutput) }
+  let(:stacks_mock) { instance_double(Aws::CloudFormation::Types::DescribeStacksOutput) }
+  let(:stack_mock) { instance_double(Aws::CloudFormation::Types::Stack) }
+  let(:aws_change_mock) { instance_double(Aws::CloudFormation::Types::Change) }
+  let(:aws_resource_change_mock) { instance_double(Aws::CloudFormation::Types::ResourceChange) }
+  let(:uuid) { "a7ad0965-7395-4660-b607-47b13b1d16c2" }
+
+  before do
+    allow(Aws::CloudFormation::Client).to receive(:new).and_return(cf_stub)
+    allow(cf_stub).to receive(:create_change_set).and_return(change_set_create_mock)
+    allow(change_set_create_mock).to receive(:id).and_return("123")
+    allow(cf_stub).to receive(:delete_stack)
+    allow(cf_stub).to receive(:delete_change_set)
+    allow(cf_stub).to receive(:describe_change_set).and_return(change_set_mock)
+    allow(cf_stub).to receive(:describe_stacks).and_return(stacks_mock)
+    allow(cf_stub).to receive(:wait_until).and_return(true)
+    allow(change_set_mock).to receive(:status).and_return("CREATE_COMPLETE")
+    allow(change_set_mock).to receive(:changes).and_return([aws_change_mock])
+    allow(aws_change_mock).to receive(:resource_change).and_return(aws_resource_change_mock)
+    allow(stacks_mock).to receive(:stacks).and_return([stack_mock])
+    allow(stack_mock).to receive(:stack_status).and_return("REVIEW_IN_PROGRESS")
+    allow(aws_resource_change_mock).to receive(:resource_type).and_return("AWS::EC2::VPC")
+    allow(aws_resource_change_mock).to receive(:logical_resource_id).and_return("Foo")
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+  end
+
+  after do
+    CloudFormationRSpec::ChangeSet.flush_cache
+  end
+
+  context 'a sparkleformation template' do
+    let(:template_file) { File.join("spec", "fixtures", "vpc.rb") }
+    let(:parameters) { {} }
+    let(:compile_state) { {} }
+    subject { described_class.from_sparkleformation_template(template_file: template_file, compile_state: compile_state, parameters: parameters) }
+
+    context 'that does compile' do
+      let(:template_file) { File.join('spec', 'fixtures', 'valid_sparkle_vpc_template.rb') }
+
+      context 'with parameters' do
+        let(:parameters) { {"VpcCidr" => "10.0.0.0/16"} }
+        it 'succeeds' do
+          expect(subject.status).to eq("CREATE_COMPLETE")
+        end
+      end
+
+      context 'with compile state' do
+        let(:compile_state) { {public_subnets: ["10.0.0.0/24", "10.0.1.0/24"], private_subnets: ["10.0.2.0/24", "10.0.3.0/24"]} }
+        it 'succeeds' do
+          expect(subject.status).to eq("CREATE_COMPLETE")
+        end
+      end
+
+      context 'with no parameters or compile state' do
+        it 'succeeds' do
+          expect(subject.status).to eq("CREATE_COMPLETE")
+        end
+      end
+    end
+  end
+
+  context 'a valid change set' do
+    subject(:subject_default) { described_class.new(template_body: template_body, parameters: parameters) }
+    subject(:cached_subject_default) { described_class.new(template_body: template_body, parameters: parameters) }
+    subject(:different_parameters) { described_class.new(template_body: template_body, parameters: {}) }
+    subject(:different_template) { described_class.new(template_body: "{}", parameters: parameters) }
+
+    it 'calls create_change_set with the required parameters' do
+      expect(cf_stub).to receive(:create_change_set).with(
+        change_set_name: "CloudFormationRSpec-#{uuid}",
+        stack_name: "CloudFormationRSpec-#{uuid}",
+        change_set_type: 'CREATE',
+        template_body: template_body,
+        parameters: [
+          {
+            parameter_key:  "VpcCidr",
+            parameter_value: "10.0.0.0/16"
+          }
+        ],
+        capabilities: ['CAPABILITY_IAM', 'CAPABILITY_NAMED_IAM'],
+      )
+      subject_default.create_change_set
+    end
+
+    it 'caches the change set between runs' do
+      expect(cf_stub).to receive(:create_change_set).once
+      subject_default.create_change_set
+      cached_subject_default.create_change_set
+    end
+
+    it 'restores the status from the cached run' do
+      subject_default.create_change_set
+      cached_subject_default.create_change_set
+      expect(cached_subject_default.status).to eq("CREATE_COMPLETE")
+    end
+
+    it 'restores the changes from the cached run' do
+      subject_default.create_change_set
+      cached_subject_default.create_change_set
+      expect(cached_subject_default.changes).to match_array([CloudFormationRSpec::ResourceChange.new("AWS::EC2::VPC", "Foo")])
+    end
+
+    it 'does not cache change sets when parameters are different' do
+      expect(cf_stub).to receive(:create_change_set).twice
+      subject_default.create_change_set
+      different_parameters.create_change_set
+    end
+
+    it 'does not cache change sets when the template is different' do
+      expect(cf_stub).to receive(:create_change_set).twice
+      subject_default.create_change_set
+      different_template.create_change_set
+    end
+
+    it 'deletes the stack and change set' do
+      expect(cf_stub).to receive(:delete_stack)
+      expect(cf_stub).to receive(:delete_change_set)
+      subject_default.create_change_set
+    end
+  end
+
+  context 'an invalid change' do
+    subject { described_class.new(template_body: template_body, parameters: parameters) }
+    before do
+      allow(cf_stub).to receive(:wait_until).and_raise(Aws::Waiters::Errors::WaiterFailed)
+      allow(change_set_mock).to receive(:status).and_return("FAILED")
+    end
+
+    it 'just deletes the change set' do
+      expect(cf_stub).not_to receive(:delete_stack)
+      expect(cf_stub).to receive(:delete_change_set)
+      subject.create_change_set
+    end
+  end
+end

data/spec/fixtures/invalid_sparkle_vpc_template.rb

@@ -0,0 +1,8 @@
+SparkleFormation.new(:vpc) do
+  resources.vpc do
+    type "AWS::EC2::VPC
+    properties do
+      cidr "10.0.0.0/16"
+    end
+  end
+end

data/spec/fixtures/template_with_compile_parameters.rb

@@ -0,0 +1,16 @@
+SparkleFormation.new(:vpc,
+  {
+    compile_time_parameters: {
+      vpc_cidr: {
+        type: :string,
+      }
+    }
+  }
+) do
+  parameters.vpc_cidr do
+    description 'VPC CIDR'
+    type 'String'
+    constraint_description 'CIDR block parameter must be in the form x.x.x.x/16-28'
+    default state!(:vpc_cidr)
+  end
+end

data/spec/fixtures/valid_sparkle_vpc_template.rb

@@ -0,0 +1,20 @@
+SparkleFormation.new(:vpc) do
+  resources.vpc do
+    type "AWS::EC2::VPC"
+    properties do
+      cidr "10.0.0.0/16"
+    end
+  end
+
+  outputs do
+    vpc_id do
+      value ref!(:vpc)
+      description "The VPC ID"
+    end
+
+    vpc_cidr do
+      value "10.0.0.0/16"
+      description "The VPC CIDR"
+    end
+  end
+end

data/spec/fixtures/valid_vpc_template.json

@@ -0,0 +1,20 @@
+{
+  "AWSTemplateFormatVersion" : "2010-09-09",
+  "Resources" : {
+     "myVPC" : {
+        "Type" : "AWS::EC2::VPC",
+        "Properties" : {
+           "CidrBlock" : "10.0.0.0/16",
+         "EnableDnsSupport" : "false",
+         "EnableDnsHostnames" : "false",
+           "InstanceTenancy" : "dedicated",
+           "Tags" : [ {"Key" : "foo", "Value" : "bar"} ]
+        }
+     }
+  },
+  "Outputs" : {
+    "VpcId": {
+      "Value": {"Ref": "myVPC"}
+    }
+  }
+}    

data/spec/fixtures/valid_vpc_template.yml

@@ -0,0 +1,15 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Resources:
+  myVPC:
+    Type: AWS::EC2::VPC
+    Properties:
+      CidrBlock: 10.0.0.0/16
+      EnableDnsSupport: 'false'
+      EnableDnsHostnames: 'false'
+      InstanceTenancy: dedicated
+      Tags:
+      - Key: foo
+        Value: bar
+Outputs:
+  VpcId:
+    Value: !Ref myVPC

data/spec/matchers/change_set_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe 'contain_in_change_set' do
+  let(:change_set_mock) { instance_double(CloudFormationRSpec::ChangeSet) }
+  let(:stack) {{
+    template_body: '{"Parameters": {"VpcCidr": {"Type": "String"}},"Resources": {"Foo": {"Type" : "AWS::EC2::VPC","Properties": {"Cidr" : {"Ref": "VpcCidr"}}}}}',
+    parameters: {
+      "VpcCidr" => "10.0.0.0/16"
+    }
+  }}
+  let(:sparkle_stack) {{
+    compiler: :sparkleformation,
+    template_file: File.join("templates", "vpc.rb"),
+    compile_state: {public_subnets: ["10.0.0.0/24", "10.0.1.0/24"], private_subnets: ["10.0.2.0/24", "10.0.3.0/24"]},
+    parameters: {
+      "VpcCidr" => "10.0.0.0/16",
+    }
+  }}
+  let(:uuid) { "d7ad0965-7395-4660-b607-47b13b1d16c2" }
+  let(:web_server_change_mock) { instance_double(CloudFormationRSpec::ResourceChange) }
+  let(:vpc_change_mock) { instance_double(CloudFormationRSpec::ResourceChange) }
+  before do
+    allow(CloudFormationRSpec::ChangeSet).to receive(:new).and_return(change_set_mock)
+    allow(CloudFormationRSpec::ChangeSet).to receive(:from_sparkleformation_template).and_return(change_set_mock)
+    allow(CloudFormationRSpec::ChangeSet).to receive(:from_cloudformation_template).and_return(change_set_mock)
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+  end
+
+  after do
+    CloudFormationRSpec::ChangeSet.flush_cache
+  end
+
+  context 'a valid cloudformation template' do
+    before do
+      allow(change_set_mock).to receive(:status).and_return("CREATE_COMPLETE")
+      allow(change_set_mock).to receive(:changes).and_return([vpc_change_mock, web_server_change_mock])
+      allow(web_server_change_mock).to receive(:resource_type).and_return("AWS::EC2::Instance")
+      allow(web_server_change_mock).to receive(:logical_resource_id).and_return("WebServer")
+      allow(vpc_change_mock).to receive(:resource_type).and_return("AWS::EC2::VPC")
+      allow(vpc_change_mock).to receive(:logical_resource_id).and_return("vpc")
+    end
+
+    it 'succeeds when there is a matching resource' do
+      expect(stack).to contain_in_change_set("AWS::EC2::VPC", "vpc")
+    end
+
+    it 'fails when there is no matching resource id' do
+      expect(stack).not_to contain_in_change_set("AWS::EC2::VPC", "foo")
+    end
+
+    it 'fails when there is no matching resource type' do
+      expect(stack).not_to contain_in_change_set("AWS::EC2::Foo", "vpc")
+    end
+  end
+
+  context 'an invalid sparkleformation template' do
+    let(:template_file) { File.join('spec', 'fixtures', 'invalid_sparkle_vpc_template.rb') }
+    let(:stack) {{
+      compiler: :sparkleformation,
+      template_file: template_file,
+      compile_state: {}
+    }}
+    before do
+      allow(CloudFormationRSpec::ChangeSet).to receive(:from_sparkleformation_template).and_raise(CloudFormationRSpec::Sparkle::InvalidSparkleTemplate)
+      allow(change_set_mock).to receive(:status).and_return("FAILED")
+    end
+
+    it 'fails' do
+      expect { expect(stack).not_to contain_in_change_set("AWS::EC2::Foo", "vpc") }.to raise_error(CloudFormationRSpec::Sparkle::InvalidSparkleTemplate)
+    end
+  end
+end
+
+describe 'have_change_set_failed' do
+  let(:change_set_mock) { instance_double(CloudFormationRSpec::ChangeSet) }
+  let(:stack) {{
+    template_body: '{"Parameters": {"VpcCidr": {"Type": "String"}},"Resources": {"Foo": {"Type" : "AWS::EC2::VPC","Properties": {"Cidr" : {"Ref": "VpcCidr"}}}}}',
+    parameters: {
+      "VpcCidr" => "10.0.0.0/16"
+    }
+  }}
+  let(:sparkle_stack) {{
+    compiler: :sparkleformation,
+    template_file: File.join("templates", "vpc.rb"),
+    compile_state: {public_subnets: ["10.0.0.0/24", "10.0.1.0/24"], private_subnets: ["10.0.2.0/24", "10.0.3.0/24"]},
+    parameters: {
+      "VpcCidr" => "10.0.0.0/16",
+    }
+  }}
+  before do
+    allow(CloudFormationRSpec::ChangeSet).to receive(:new).and_return(change_set_mock)
+    allow(CloudFormationRSpec::ChangeSet).to receive(:from_sparkleformation_template).and_return(change_set_mock)
+    allow(CloudFormationRSpec::ChangeSet).to receive(:from_cloudformation_template).and_return(change_set_mock)
+  end
+
+  after do
+    CloudFormationRSpec::ChangeSet.flush_cache
+  end
+
+  context 'a valid cloudformation template' do
+    before do
+      allow(change_set_mock).to receive(:status).and_return("CREATE_COMPLETE")
+    end
+
+    it 'fails' do
+      expect(stack).not_to have_change_set_failed
+    end
+  end
+
+  context 'an invalid change' do
+    before do
+      allow(change_set_mock).to receive(:status).and_return("FAILED")
+    end
+
+    it 'succeeds' do
+      expect(stack).to have_change_set_failed
+    end
+  end
+
+  context 'an invalid sparkleformation template' do
+    let(:template_file) { File.join('spec', 'fixtures', 'invalid_sparkle_vpc_template.rb') }
+    let(:stack) {{
+      compiler: :sparkleformation,
+      template_file: template_file,
+      compile_state: {}
+    }}
+    before do
+      allow(CloudFormationRSpec::ChangeSet).to receive(:from_sparkleformation_template).and_raise(CloudFormationRSpec::Sparkle::InvalidSparkleTemplate)
+      allow(change_set_mock).to receive(:status).and_return("FAILED")
+    end
+
+    it 'fails' do
+      expect { expect(stack).to have_change_set_failed }.to raise_error(CloudFormationRSpec::Sparkle::InvalidSparkleTemplate)
+    end
+  end
+end

data/spec/matchers/output_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe 'have_output_including' do
+  context 'sparkleformation template' do
+    let(:template_file) { File.join('spec', 'fixtures', 'valid_sparkle_vpc_template.rb') }
+    let(:stack) {{
+      compiler: :sparkleformation,
+      template_file: template_file,
+      compile_state: {}
+    }}
+
+    it 'has a vpc_id output' do
+      expect(stack).to have_output_including("VpcId")
+    end
+
+    it 'has vpc_cidr output' do
+      expect(stack).to have_output_including("VpcCidr")
+    end
+
+    it 'does not have subnet_id output' do
+      expect(stack).not_to have_output_including("SubnetId")
+    end
+  end
+
+  context 'yaml template' do
+    let(:template_body) { File.read(File.join('spec', 'fixtures', 'valid_vpc_template.yml')) }
+
+    it 'has a vpc_id output' do
+      expect(template_body).to have_output_including("VpcId")
+    end
+
+    it 'does not have vpc_cidr output' do
+      expect(template_body).not_to have_output_including("VpcCidr")
+    end
+  end
+
+  context 'json template' do
+    let(:template_body) { File.read(File.join('spec', 'fixtures', 'valid_vpc_template.json')) }
+
+    it 'has a vpc_id output' do
+      expect(template_body).to have_output_including("VpcId")
+    end
+
+    it 'does not have vpc_cidr output' do
+      expect(template_body).not_to have_output_including("VpcCidr")
+    end
+
+    it 'provides a diff of the outputs' do
+      expect { expect(template_body).not_to have_output_including("VpcId") }.to raise_error(RSpec::Expectations::ExpectationNotMetError, 'expected ["VpcId"] not to have output including "VpcId"')
+    end
+  end
+
+  context 'garbage template' do
+    let(:template_body) { '   {lkajdflkasdjf' }
+    it 'raises an ArgumentError' do
+      expect{ expect(template_body).to have_output_including("VpcId") }.to raise_error(SyntaxError)
+    end
+  end
+end

data/spec/matchers/validate_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe 'be_valid' do
+  let(:cf_stub) { instance_double(Aws::CloudFormation::Client) }
+  before do
+    allow(Aws::CloudFormation::Client).to receive(:new).and_return(cf_stub)
+  end
+
+  context 'the stack is valid' do
+    before do
+      allow(cf_stub).to receive(:validate_template)
+    end
+
+    it 'succeeds' do
+      expect('{"Description": "My Template", "Resources": {"Foo": {"Type" : "AWS::EC2::Instance","Properties" : {"ImageId" : "ami-2f726546"}}}}').to be_valid
+    end
+  end
+
+  context 'the stack is not valid' do
+    let(:template) { '{"Description": "My Template"}' }
+    before do
+      allow(cf_stub).to receive(:validate_template).with(template_body: template).and_raise(Aws::CloudFormation::Errors::ValidationError.new(Seahorse::Client::RequestContext.new(), "Template format error: At least one Resources member must be defined."))
+    end
+
+    it 'fails' do
+      expect(template).not_to be_valid
+    end
+  end
+end
+
+describe 'be_valid_sparkleformation' do
+  let(:cf_stub) { instance_double(Aws::CloudFormation::Client) }
+  let(:compile_state) { {} }
+  let(:stack) {{
+    compiler: :sparkleformation,
+    template_file: template_file,
+    compile_state: compile_state
+  }}
+  before do
+    allow(Aws::CloudFormation::Client).to receive(:new).and_return(cf_stub)
+  end
+
+  context 'the stack is valid' do
+    let(:template_file) { File.join('spec', 'fixtures', 'valid_sparkle_vpc_template.rb') }
+    before do
+      allow(cf_stub).to receive(:validate_template)
+    end
+
+    it 'succeeds' do
+      expect(stack).to be_valid_sparkleformation
+    end
+  end
+
+  context 'the stack is not valid cloudformation' do
+    let(:template_file) { File.join('spec', 'fixtures', 'valid_sparkle_vpc_template.rb') }
+    before do
+      allow(cf_stub).to receive(:validate_template).and_raise(Aws::CloudFormation::Errors::ValidationError.new(Seahorse::Client::RequestContext.new(), "Template format error: At least one Resources member must be defined."))
+    end
+
+    it 'fails' do
+      expect(stack).not_to be_valid_sparkleformation
+    end
+  end
+
+  context 'the stack is not valid sparkleformation' do
+    let(:template_file) { File.join('spec', 'fixtures', 'invalid_sparkle_vpc_template.rb') }
+    before do
+      allow(cf_stub).to receive(:validate_template)
+    end
+
+    it 'fails' do
+      expect(cf_stub).not_to receive(:validate_template)
+      expect(stack).not_to be_valid_sparkleformation
+    end
+  end
+
+  context 'the stack has compile time parameters' do
+    let(:template_file) { File.join('spec', 'fixtures', 'template_with_compile_parameters.rb') }
+    let(:compile_state) { {vpc_cidr: "10.0.0.0/16"} }
+    before do
+      allow(cf_stub).to receive(:validate_template)
+    end
+
+    it 'succeed' do
+      expect(stack).to be_valid_sparkleformation
+    end
+  end
+end

data/spec/sparkle_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe CloudFormationRSpec::Sparkle do
+  let(:template_file) { File.join("spec", "fixtures", "vpc.rb") }
+  let(:compile_state) { {} }
+  subject { described_class.compile_sparkle_template(template_file, compile_state) }
+
+  context 'that doesnt compile to sparkleformation' do
+    before do
+      allow(SparkleFormation).to receive(:compile).and_raise(RuntimeError)
+    end
+
+    it 'raises InvalidSparkleTemplate' do
+      expect { subject }.to raise_error(described_class::InvalidSparkleTemplate)
+    end
+  end
+
+  context 'that doesnt compile to cloudformation' do
+    let(:sparkle_stub) { instance_double(SparkleFormation) }
+    before do
+      allow(SparkleFormation).to receive(:compile).and_return(sparkle_stub)
+      allow(sparkle_stub).to receive(:compile_state=)
+      allow(sparkle_stub).to receive(:to_json).and_raise(RuntimeError)
+    end
+
+    it 'raises InvalidCloudFormationTemplate' do
+      expect { subject }.to raise_error(described_class::InvalidCloudFormationTemplate)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'cloudformation_rspec'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: cloudformation_rspec
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+platform: ruby
+authors:
+- Patrick Robinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sparkle_formation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudformation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: CloudFormation RSpec matchers
+email:
+- patrick.robinson@envato.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- cloudformation-rspec.gemspec
+- lib/cloudformation_rspec.rb
+- lib/cloudformation_rspec/change_set.rb
+- lib/cloudformation_rspec/matchers.rb
+- lib/cloudformation_rspec/matchers/change_set.rb
+- lib/cloudformation_rspec/matchers/output.rb
+- lib/cloudformation_rspec/matchers/validate.rb
+- lib/cloudformation_rspec/resource_change.rb
+- lib/cloudformation_rspec/sparkle.rb
+- spec/change_set_spec.rb
+- spec/fixtures/invalid_sparkle_vpc_template.rb
+- spec/fixtures/template_with_compile_parameters.rb
+- spec/fixtures/valid_sparkle_vpc_template.rb
+- spec/fixtures/valid_vpc_template.json
+- spec/fixtures/valid_vpc_template.yml
+- spec/matchers/change_set_spec.rb
+- spec/matchers/output_spec.rb
+- spec/matchers/validate_spec.rb
+- spec/sparkle_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/envato/cloudformation_rspec
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Test your CloudFormation templates
+test_files:
+- spec/change_set_spec.rb
+- spec/fixtures/invalid_sparkle_vpc_template.rb
+- spec/fixtures/template_with_compile_parameters.rb
+- spec/fixtures/valid_sparkle_vpc_template.rb
+- spec/fixtures/valid_vpc_template.json
+- spec/fixtures/valid_vpc_template.yml
+- spec/matchers/change_set_spec.rb
+- spec/matchers/output_spec.rb
+- spec/matchers/validate_spec.rb
+- spec/sparkle_spec.rb
+- spec/spec_helper.rb