cloudformation_rspec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3db66fc637f051d0215b0a032ec4c4b8c53a79b8
-  data.tar.gz: 9c8369901d78964f71cab1d6663395162883d9ce
+SHA256:
+  metadata.gz: a073315a283411eaed933a0eb0e4eb51d3f87496e40e1f07673a94e6a2b6536c
+  data.tar.gz: 86dd0c5ca39eb1eb9f97c91e10194c71086cb231fb5b6127ce2241973af47b03
 SHA512:
-  metadata.gz: 6345dfdd804ccfa4624e262671e329a88ef21a99db8e35ede647c69477f56e7ddfa5339c3ef9003edcb11d83951077f5c2f95e9c2de55ba255b62165da12ec53
-  data.tar.gz: a97a4ddd76b905580867fdbdd2c54d48b5560a83bd06f3d6ce2e06ab9e54eac0dacf318eef66e67a687ac7659aaf57b4de6bed494dab05ae4ceb0bffaa0cc842
+  metadata.gz: a61097b4245128ba048d275f3244c04deafff180f3503cdd38b43bf4b3e35db89eecabfc88989aa422b568e69a511f1df978acabf2ecf7ee0ecf018f61a19996
+  data.tar.gz: 60f7bade60799bb6d8ed94ebe312fdc5cb3f0195294e2200978b45d7e57d16424aeecb28e81b75ae57c22b47f13a0ff096bf151bb156612d97b29415145e9bce

data/.travis.yml

@@ -1,6 +1,10 @@
 language: ruby
-rvm:
- - 2.3.7
- - 2.4.4
- - 2.5.1
-script: bundle exec rake spec
+
+services:
+  - docker
+
+before_install:
+  - docker build -t cloudformation_rspec -f Dockerfile.ci .
+
+script:
+  - docker run cloudformation_rspec  /bin/sh -c "bundle exec rake spec"

data/Dockerfile.ci

@@ -0,0 +1,10 @@
+FROM ruby:2.6.5-slim
+
+RUN apt update -y && apt install -y python-pip git && pip install cfn-lint
+
+COPY . /app
+WORKDIR /app
+
+RUN bundle install
+
+

data/cloudformation-rspec.gemspec

@@ -2,7 +2,7 @@ $:.unshift File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name    = "cloudformation_rspec"
-  gem.version = "0.1.0"
+  gem.version = "0.2.0"
 
   gem.authors     = ["Patrick Robinson"]
   gem.email       = ["patrick.robinson@envato.com"]

data/lib/cloudformation_rspec/matchers/validate.rb

@@ -1,4 +1,5 @@
 require 'aws-sdk-cloudformation'
+require 'open3'
 
 module CloudFormationRSpec::Matchers::Validate
   def validate_cf_template(template_body)
@@ -11,12 +12,35 @@ module CloudFormationRSpec::Matchers::Validate
     end
     true
   end
+
+  def lint_cf_template(template_body)
+    # Issue a warning if cfn-lint is not installed, but pass the test
+    unless cfn_lint_available
+      warn "Failed to run cfn-lint, do you have it installed and available in $PATH?"
+      return true
+    end
+
+    Tempfile.open(['cfn-lint', '.json']) do |f|
+      f.write(template_body)
+      f.flush
+      stdout, _stderr, status = Open3.capture3('cfn-lint', '-i', 'W', '--', f.path)
+      if status.exitstatus != 0
+        @error = stdout
+      end
+      status.exitstatus == 0
+    end
+  end
+
+  def cfn_lint_available
+    _, _, status = Open3.capture3('cfn-lint', '-l')
+    status.exitstatus == 0
+  end
 end
 
 RSpec::Matchers.define :be_valid do
   include CloudFormationRSpec::Matchers::Validate
   match do |cf_template|
-    validate_cf_template(cf_template)
+    validate_cf_template(cf_template) && lint_cf_template(cf_template)
   end
 
   failure_message do
@@ -39,7 +63,7 @@ RSpec::Matchers.define :be_valid_sparkleformation do
       @error = error
       return false
     end
-    validate_cf_template(template_body)
+    validate_cf_template(template_body) && lint_cf_template(template_body)
   end
 
   failure_message do

data/spec/fixtures/invalid_lint_template.json

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

data/spec/fixtures/template_with_compile_parameters.rb

@@ -13,4 +13,11 @@ SparkleFormation.new(:vpc,
     constraint_description 'CIDR block parameter must be in the form x.x.x.x/16-28'
     default state!(:vpc_cidr)
   end
+
+  resources.vpc do
+    type "AWS::EC2::VPC"
+    properties do
+      cidr_block ref!(:vpc_cidr)
+    end
+  end
 end

data/spec/fixtures/valid_sparkle_vpc_template.rb

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

data/spec/matchers/validate_spec.rb

@@ -26,6 +26,17 @@ describe 'be_valid' do
       expect(template).not_to be_valid
     end
   end
+
+  context "the stack fails linting" do
+    let(:template) { File.join('spec', 'fixtures', 'invalid_lint_template.json') }
+    before do
+      allow(cf_stub).to receive(:validate_template)
+    end
+
+    it 'succeeds' do
+      expect(template).not_to be_valid
+    end
+  end
 end
 
 describe 'be_valid_sparkleformation' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation_rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrick Robinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2020-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile.ci
 - Gemfile
 - LICENSE.md
 - README.md
@@ -89,6 +90,7 @@ files:
 - lib/cloudformation_rspec/resource_change.rb
 - lib/cloudformation_rspec/sparkle.rb
 - spec/change_set_spec.rb
+- spec/fixtures/invalid_lint_template.json
 - spec/fixtures/invalid_sparkle_vpc_template.rb
 - spec/fixtures/template_with_compile_parameters.rb
 - spec/fixtures/valid_sparkle_vpc_template.rb
@@ -117,13 +119,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Test your CloudFormation templates
 test_files:
 - spec/change_set_spec.rb
+- spec/fixtures/invalid_lint_template.json
 - spec/fixtures/invalid_sparkle_vpc_template.rb
 - spec/fixtures/template_with_compile_parameters.rb
 - spec/fixtures/valid_sparkle_vpc_template.rb