rubycfn 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0b96f071bbb09b6b63d1b9671330ecccdf35e0c
-  data.tar.gz: ab86d11cdf67f1de25a9a0fa6a84ad2b9e79af86
+  metadata.gz: a50e005191c0b01c26c19c2947b21aa68efc4484
+  data.tar.gz: b2d40bc520b69a35494e6a69f822571d7c05bacf
 SHA512:
-  metadata.gz: fac7d3197bccd39005f3fb1e312db165db6b2ff938d16f40ff89139f86bf868c85be6b96fc3797e1405a509dc020bd17aa20d9f198454f21976727df77be9a4c
-  data.tar.gz: 63c4c0164126765d8ddadae458c4b505545f99fa518c3d1e7b385ede3e6c0946463891ac0c6f52296a75b843eb417bb8d26a1728aac1921eae358ef82b826443
+  metadata.gz: 5b11a4f464588c4bc027154ce588fbd26837007a3da6c60abd11e3834d016b492272f85befbb03d40cc2ad2a90649b4622db6e3292755031ec40126d4f7f8b44
+  data.tar.gz: 1226f8c46e3b2e9c458a49f67c24cc2dd7599a3e6e6d28add060367ec52c9ec0e03174283509ce9ac6217d2a408ef833a0798a47306dfa48537607501c51ca8c

data/CHANGELOG.md

@@ -2,10 +2,13 @@
 All notable changes to Rubycfn will be documented in this file.
 This project uses [Semantic Versioning](http://semver.org/).
 
-## 0.1.9 (Next Release)
+## 0.1.10 (Next Release)
+
+## 0.1.9
+  * Merged feature/cicd into release :')
 
 ## 0.1.8
-  * `Export` in outputs now takes both strings and hashes
+  * `Export` in outputs now takes both strings and hashes -- [@dennisvink][@dennisvink]
 
 ## 0.1.7
   * Added specs to default project -- [@dennisvink][@dennisvink]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubycfn (0.1.8)
+    rubycfn (0.1.9)
       activesupport (~> 5.1.5)
       dotenv (~> 2.4.0)
       json (~> 2.1.0)

data/README.md

@@ -12,7 +12,7 @@ or, create a Gemfile with this content:
 ```
 source "https://rubygems.org"
 
-gem "rubycfn", "~> 0.1.8"
+gem "rubycfn", "~> 0.1.9"
 
 ```
 
@@ -24,6 +24,10 @@ Typing `rubycfn` at the prompt and answering its questions generates a new sampl
 
 You can find stack examples at [https://github.com/dennisvink/rubycfn-example](https://github.com/dennisvink/rubycfn-example/)
 
+## Installing Gems
+
+Type `bundle install` to install all dependencies that are listed in the Gemfile.
+
 ## Running specs
 
 Type `rake` to run the tests. It tests if RubyCfn creates a valid

data/bin/rubycfn

@@ -32,14 +32,18 @@ dotenv = render('.env', {
   :region => region
 }, path)
 
+buildspec = render('buildspec.yml', {}, path)
+cicd = render('cicd.rb', { name: project_name.capitalize, small_name: project_name }, path)
+compile = render('compile.rb', {}, path)
 dotenv_test = render('.env.test', { project_name: project_name }, path)
+example_spec = render('example_stack_spec.rb', { name: project_name.capitalize }, path)
 gemfile = render('Gemfile', { version: Rubycfn::VERSION }, path)
-rakefile = render('Rakefile', {}, path)
-main = render('main.rb', {}, path)
-compile = render('compile.rb', {}, path)
 global_variables = render('global_variables.rb', {}, path)
-project_stack = render('project_stack.rb', { name: project_name.capitalize }, path)
+main = render('main.rb', {}, path)
 project_concern = render('project_concern.rb', { name: project_name.capitalize }, path)
+project_stack = render('project_stack.rb', { name: project_name.capitalize }, path)
+rakefile = render('Rakefile', {}, path)
+spec_helper = render('spec_helper.rb', {}, path)
 
 # Create directory structure
 FileUtils.mkdir_p project_path + '/lib/stacks/' + project_name + '_stack'
@@ -51,9 +55,13 @@ File.open("#{project_path}/.env", 'w') { |file| file.write(dotenv) }
 File.open("#{project_path}/.env.test", 'w') { |file| file.write(dotenv_test) }
 File.open("#{project_path}/Gemfile", 'w') { |file| file.write(gemfile) }
 File.open("#{project_path}/Rakefile", 'w') { |file| file.write(rakefile) }
+File.open("#{project_path}/config/buildspec.yml", 'w') { |file| file.write(buildspec) }
 File.open("#{project_path}/lib/main.rb", 'w') { |file| file.write(main) }
 File.open("#{project_path}/lib/compile.rb", 'w') { |file| file.write(compile) }
 File.open("#{project_path}/lib/shared_concerns/global_variables.rb", 'w') { |file| file.write(global_variables) }
 File.open("#{project_path}/lib/stacks/#{project_name}_stack.rb", 'w') { |file| file.write(project_stack) }
 File.open("#{project_path}/lib/stacks/#{project_name}_stack/example.rb", 'w') { |file| file.write(project_concern) }
+File.open("#{project_path}/lib/stacks/#{project_name}_stack/cicd.rb", 'w') { |file| file.write(cicd) }
+File.open("#{project_path}/spec/spec_helper.rb", 'w') { |file| file.write(spec_helper) }
+File.open("#{project_path}/spec/lib/#{project_name}_spec.rb", 'w') { |file| file.write(example_spec) }
 

data/lib/cli_methods.rb

@@ -39,7 +39,10 @@ def rubycfn_structure(project_name)
   [
     project_name,
     project_name + '/build',
+    project_name + '/config',
+    project_name + '/lib/shared_concerns',
     project_name + '/lib/stacks',
-    project_name + '/lib/shared_concerns'
+    project_name + '/spec',
+    project_name + '/spec/lib'
   ]
 end

data/lib/rubycfn/version.rb

@@ -1,4 +1,4 @@
 # Rubycfn version
 module Rubycfn
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/lib/rubycfn.rb

@@ -106,7 +106,7 @@ class ::Hash
 
   def recursive_compact
     delete_if do |k, v|
-      next if v === false
+      next if v === false || k =~ /Fn\:/
       (v.respond_to?(:empty?) ? v.empty? : !v) or v.instance_of?(Hash) && v.recursive_compact.empty?
     end
   end

data/templates/.env.erb

@@ -1,4 +1,5 @@
 AWS_ACCOUNT_ID="<%= account_id %>"
 AWS_REGION="<%= region %>"
-PROJECT_NAME="<%= project_name %>"
 ENVIRONMENT="test"
+GITHUB_REPOSITORY="https://github.com/dennisvink/elastic-cloud-engineering/"
+PROJECT_NAME="<%= project_name %>"

data/templates/Gemfile.erb

@@ -1,3 +1,9 @@
-source 'https://rubygems.org' do
-  gem 'rubycfn', '~> <%= version %>'
+source "https://rubygems.org" do
+  gem "rubycfn", "~> <%= version %>"
+  gem "rspec", "~> 3.2"
+  gem "rspec-its", "~> 1.2"
+  gem "rspec-given", "~> 3.7"
+  gem "rspec_junit_formatter", "~> 0.2"
+  gem "simplecov", "~> 0.16.1"
+  gem "launchy", "~> 2.4.3"
 end

data/templates/Rakefile.erb

@@ -1,6 +1,12 @@
 require "rubygems"
 require "bundler"
-Bundler.setup
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = \
+    " --format RspecJunitFormatter" \
+    " --out test-reports/rspec.xml"
+end
 
 desc "Compile CloudFormation"
 task :compile do
@@ -8,4 +14,4 @@ task :compile do
   require_relative "lib/compile"
 end
 
-task default: [:compile]
+task default: %i(spec compile)

data/templates/buildspec.yml.erb

@@ -0,0 +1,21 @@
+version: 0.1
+
+phases:
+  install:
+    commands:
+      - gem install cfn-nag
+      - bundle install
+  pre_build:
+    commands:
+      - echo Do nothing
+  build:
+    commands:
+      - echo Build started on `date`
+      - rake
+      - cfn_nag_scan --input-path build
+  post_build:
+    commands:
+      - echo Build completed on `date`
+artifacts:
+  files:
+    - ./**

data/templates/cicd.rb.erb

@@ -0,0 +1,91 @@
+module <%= name %>Stack
+  module CICD
+    extend ActiveSupport::Concern
+
+    included do
+      variable :github_repository,
+               default: "https://github.com/dennisvink/elastic-cloud-engineering/",
+               value: ENV["GITHUB_REPOSITORY"]
+
+      resource :code_build_<%= small_name %>_service_role,
+               type: "AWS::IAM::Role" do |r|
+        r.property(:assume_role_policy_document) do
+          {
+	    "Version": "2012-10-17",
+	    "Statement": [
+	      {
+		"Effect": "Allow",
+		"Principal": {
+		  "Service": [
+		    "codebuild.amazonaws.com"
+		  ]
+		},
+		"Action": [
+		  "sts:AssumeRole"
+		]
+	      }
+	    ]
+          }
+        end
+        r.property(:path) { "/service-role/" }
+        r.property(:policies) do
+          [
+            {
+              "PolicyName": "CodeBuildAccessPolicies",
+              "PolicyDocument": {
+                "Version": "2012-10-17",
+                "Statement": [
+                    {
+                        "Effect": "Allow",
+                        "Action": [
+                            "logs:CreateLogGroup",
+                            "logs:CreateLogStream",
+                            "logs:PutLogEvents"
+                        ],
+                        "Resource": [
+                          "arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/codebuild/*".fnsub
+                        ]
+                    }
+                ]
+              }
+            }
+          ]
+        end
+      end
+
+      resource :code_build_<%= small_name %>_project,
+               type: "AWS::CodeBuild::Project" do |r|
+        r.property(:name) { "<%= name %>-project-${AWS::Region}-${AWS::StackName}".fnsub }
+        r.property(:service_role) { "code_build_<%= small_name %>_service_role".cfnize.ref("Arn") }
+        r.property(:artifacts) do
+          {
+            "Type": "no_artifacts"
+          }
+        end
+        r.property(:environment) do
+          {
+            "Type": "LINUX_CONTAINER",
+            "ComputeType": "BUILD_GENERAL1_SMALL",
+            "Image": "aws/codebuild/ruby:2.3.1"
+          }
+        end
+        r.property(:source) do
+          {
+            "BuildSpec": text = File.read("config/buildspec.yml"),
+            "Auth": {
+              "Type": "OAUTH"
+            },
+            "Location": "#{github_repository}",
+            "Type": "GITHUB"
+          }
+        end
+        r.property(:triggers) do
+          {
+            "Webhook": true
+          }
+        end
+        r.property(:timeout_in_minutes) { 10 }
+      end
+    end
+  end
+end

data/templates/example_stack_spec.rb.erb

@@ -0,0 +1,101 @@
+require "spec_helper"
+
+require "rubycfn"
+require "active_support/concern"
+require_relative "../../lib/main.rb"
+
+describe Rubycfn do
+  module RspecStack
+    extend ActiveSupport::Concern
+    include Rubycfn
+
+    included do
+      description "RSpec Stack"
+      include <%= name %>Stack::CICD
+    end
+  end
+
+  CloudFormation = include RspecStack
+  RspecStack = CloudFormation.render_template
+  Given(:json) { JSON.parse(RspecStack) }
+
+  context "Renders template" do
+    let(:template) { json }
+    subject { template }
+
+    it { should_not have_key "Parameters" }
+    it { should have_key "Resources" }
+
+    context "Has Codebuild Resources" do
+      let(:resources) { template["Resources"] }
+      subject { resources }
+
+      it { should have_key "CodeBuild<%= name %>Project" }
+      it { should have_key "CodeBuild<%= name %>ServiceRole" }
+
+      context "Codebuild Repository" do
+        let(:repository) { resources["CodeBuild<%= name %>Project"] }
+        subject { repository }
+
+        it { should have_key "Properties" }
+
+        context "Codebuild properties" do
+          let(:codebuild_properties) { repository["Properties"] }
+          subject { codebuild_properties }
+
+          it { should have_key "Artifacts" }
+          it { should have_key "Environment" }
+          it { should have_key "Name" }
+          it { should have_key "ServiceRole" }
+          it { should have_key "Source" }
+          it { should have_key "TimeoutInMinutes" }
+          it { should have_key "Triggers" }
+
+          context "Codebuild Auth Type" do
+            let(:auth_type) { codebuild_properties["Source"]["Auth"]["Type"] }
+            subject { auth_type }
+          
+            it { should eq "OAUTH" }
+          end
+
+          context "Codebuild creates webhook" do
+            let(:webhook) { codebuild_properties["Triggers"]["Webhook"] }
+            subject { webhook }
+
+            it { should eq true }
+          end
+        end
+      end
+
+      context "Codebuild Service Role" do
+        let(:code_build_service_role) { resources["CodeBuild<%= name %>ServiceRole"] }
+        subject { code_build_service_role }
+
+        it { should have_key "Properties" }
+
+        context "Code build service role properties" do
+          let(:code_build_service_role_properties) { code_build_service_role["Properties"] }
+          subject { code_build_service_role_properties }
+
+          it { should have_key "AssumeRolePolicyDocument" }
+          it { should have_key "Path" }
+          it { should have_key "Policies" }
+
+          context "Code build service role policy document" do
+            let(:policy_document) { code_build_service_role_properties["Policies"][0]["PolicyDocument"] }
+            subject { policy_document }
+
+            it { should have_key "Statement" }
+
+            context "Code build service role actions" do
+              let(:statement) { policy_document["Statement"][0]["Action"] }
+              subject { statement }
+
+              it { should eq %w(logs:CreateLogGroup logs:CreateLogStream logs:PutLogEvents) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/templates/project_concern.rb.erb

@@ -19,8 +19,6 @@ module <%= name %>Stack
                default: true
       variable :enable_dns_hostnames,
                default: true
-      variable :instance_tenancy,
-               filter: :validate_instance_tenancy
 
       # Example resource, custom name
       resource :my_example_s3_bucket,

data/templates/project_stack.rb.erb

@@ -4,5 +4,6 @@ module <%= name %>Stack
 
   included do
     include <%= name %>Stack::Main
+    include <%= name %>Stack::CICD
   end
 end

data/templates/spec_helper.rb.erb

@@ -0,0 +1,26 @@
+require "simplecov"
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require "json"
+require "launchy"
+require "rspec"
+require "rspec/its"
+require "rspec/given"
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = "documentation"
+
+  config.mock_with :rspec do |c|
+    c.syntax = %i(should expect)
+  end
+
+  config.filter_run_excluding broken: true
+  config.filter_run_excluding turn_off: true
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+  config.filter_run_excluding :slow unless ENV["SLOW_SPECS"]
+  config.filter_run_excluding :debug unless ENV["DEBUG_SPECS"]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycfn
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Dennis Vink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-08 00:00:00.000000000 Z
+date: 2018-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neatjson
@@ -276,11 +276,15 @@ files:
 - templates/.env.test.erb
 - templates/Gemfile.erb
 - templates/Rakefile.erb
+- templates/buildspec.yml.erb
+- templates/cicd.rb.erb
 - templates/compile.rb.erb
+- templates/example_stack_spec.rb.erb
 - templates/global_variables.rb.erb
 - templates/main.rb.erb
 - templates/project_concern.rb.erb
 - templates/project_stack.rb.erb
+- templates/spec_helper.rb.erb
 homepage: https://github.com/dennisvink/rubycfn
 licenses:
 - MIT
@@ -310,3 +314,6 @@ test_files:
 - spec/lib/rubycfn_spec.rb
 - spec/spec_helper.rb
 - templates/.env.test.erb
+- templates/buildspec.yml.erb
+- templates/example_stack_spec.rb.erb
+- templates/spec_helper.rb.erb