tfmodtest 0.0.1.rc2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ec2e150dfac98056bc676c0c88aa04619bca081
+  data.tar.gz: 1f371aa7bdbf6deace4dab3960b98f0681e99e61
+SHA512:
+  metadata.gz: 63b15f889ae62fe0e9df9a2ef79abbdf2c8040bd0a98a0d16de6d38f3ed7125bca131b2b5631039089d442788ad4e80446f81020ec9c93214d1931f2ff4015ac
+  data.tar.gz: e15f514af6e455aaab3569beef421f39f795867ffca008616acbc2e4c4fe384ed77f1018dd09b24b7e442d7278b44d40cca1a4fa355bb9db85d0ea52d15dc7d0

data/.gitignore

@@ -0,0 +1,88 @@
+
+# Created by https://www.gitignore.io/api/vim,terraform,visualstudiocode,ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### Terraform ###
+# Compiled files
+*.tfstate
+*.tfstate.backup
+
+# Module directory
+.terraform/
+
+### Terraform Patch ###
+*.tfvars
+### Vim ###
+# swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-v][a-z]
+[._]sw[a-p]
+# session
+Session.vim
+# temporary
+.netrwhist
+*~
+# auto-generated tag files
+tags
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history
+
+# End of https://www.gitignore.io/api/vim,terraform,visualstudiocode,ruby

data/.travis.yml

@@ -0,0 +1,17 @@
+sudo: false
+language: ruby
+rvm:
+- 2.1.6
+before_install:
+- gem install bundler -v 1.14.6
+os:
+- linux
+- osx
+deploy:
+  provider: rubygems
+  api_key:
+    secure: cEI9LKkhADHmTGsiCsqUwhjVAW/qtWd7NhPMPsgEvPbHFB6qO/zmocbceEWIcQT3WKp9i/RzSF5zrD3cmCEMmjs7e4XaVFn0NOoDFBQIZgWk5PfbGMlVaCArGJ80tbhCFLFfVqyw7pR4OtP5ov6nULi8HBdfq5ffmjC92Pg0phWDTsyKGHesXuvMUjyx8y61hZOaXkkYd5T8MaN/9ahdM0r6hp2XX5RZDWm0712b2qKO/9gBH1WUaYyiawiNmHtLsUwgobZC6s8i5EObqAY0EbFBr69vUy7mQvJtWUGQJP89RdZ9jpqOHFoSsYuBWhYixWUOmgoV2z4jBUYGGIU+Il+57SjQPB4bH5FK3OvSD6ctN7kbEWnenYhJsn2UnVtR68PrXu/xvrCmfKcQ5NgNb+eJLInjeE42OH3+Oqx2RAjGRB8yV8a+WW7rymXZ89UHYODZd8dhbRwMH8nkfblMa6f7uZXeUF9wtahh2d12xj4APLvQLN24EMX46/TXiP2IjYzeYQf4loG0SnDjds94g9aTX4SdybiIdSrThyKcgNwlrQtKq4Gp0/yfCQxtfhqcZDoPVOU3Rts3uITiqV4/jqyF2UeFPfdhZuEaAsy9OlnA9fgfN9L70b/ylhHbJfkyzVIUP8o/7VZzMqyiyXctYM9+XM4408GALFdqPwdDFM4=
+  gem: tfmodtest
+  on:
+    tags: true
+    repo: vistaprint/tfmodtest

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in terraform_module_testing.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2017 Cimpress
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,118 @@
+# Terraform Module Testing
+
+[![Build Status](https://travis-ci.org/vistaprint/tfmodtest.svg?branch=master)](https://travis-ci.org/vistaprint/tfmodtest)
+[![Gem Version](https://badge.fury.io/rb/tfmodtest.svg)](https://badge.fury.io/rb/tfmodtest)
+
+Terraform Module Testing is a set of rake tasks to easily enable testing for Terraform Module developement. It allows developers to specify tests in a rake task to test remote infrastructure is created as expected when using a module. It then destroys the environment after the test has run.
+
+Currently this repository is tightly coupled with AWS and has not been tested to work with other providers. We are actively working to change this and hope to have a more generic solution soon. If you would like to see support for your favourite cloud provider please have submit a pull request implementing support and we will be more than happy to merge your changes in.
+
+# Installation
+Add this line to your application's Gemfile:
+
+`gem 'tfmodtest'`  
+
+And then execute:
+
+`$ bundle`  
+
+Or install it yourself as:
+
+`$ gem install tfmodtest`
+
+## Getting started
+
+### A Minimal Rakefile
+
+In the root of your repository add a `Rakefile` with the following contents:
+
+```ruby
+require 'tfmodtest/module_tasks'
+```
+
+# Adding tests 
+
+In your repository create `test/<my_module>/Rakefile` and add:
+
+```ruby
+namespace '<your_modules_namespace>' do
+  # Required: Import TerraformDevKit base rake tasks.
+  # Set the root path of our tests to our location. 
+  # TerraformDevKit uses this path as the base from where
+  # all operations are run.
+  ROOT_PATH = File.dirname(File.expand_path(__FILE__))
+  spec = Gem::Specification.find_by_name 'TerraformDevKit'
+  load "#{spec.gem_dir}/tasks/devkit.rake"
+
+  # Optional: Use RSpec to run tests.
+  begin
+    require 'rspec/core/rake_task'
+    RSpec::Core::RakeTask.new(:spec)
+  rescue LoadError
+    raise 'Rspec not found'
+  end
+
+  # Required: Add a hook into TerraformDevKit to 
+  # run tests for your module. 
+  task :custom_test, [:env] => :spec
+end
+```
+
+The `custom_test` task is a hook in TerraformDevKit that is called once all the infrastructure is created. You can see a full list of useful hooks in TerraformDevKit [here](https://github.com/vistaprint/TerraformDevKit#tasks-and-hooks)
+
+Create `test/<my_module>/config/config-dev.yml` that contains:
+
+```yml
+terraform-version: 0.11.0
+project-name: my module tests
+aws:
+  profile: <profile>
+  region: <region>
+
+```
+
+This configuration determines where Terraform will create the infrastructure during test execution. 
+
+Finally to create your infrastructure under test place a `main.tf.mustache` file in `test/<my_module>`. This is the file TerraformDevKit will use to create you infrastructure. 
+
+```hcl
+provider "aws" {
+  # Use the profile specified in config/config-dev.yml
+  profile = "{{Profile}}"
+  region  = "us-east-1"
+}
+
+resource "aws_s3_bucket" "b" {
+  # Use the Environment name as part of the bucket name
+  bucket = "{{Environment}}my-tf-test-bucket"
+  acl    = "private"
+
+  tags {
+    Name        = "My bucket"
+    Environment = "Dev"
+  }
+}
+```
+
+## Optional but recommended
+
+[`awspec`](https://github.com/k1LoW/awspec) is a Ruby gem for running `rspec` tests against AWS infrastructure. It eases the pain of running tests against AWS:
+
+```ruby
+describe cloudwatch_alarm("www.example.com-5xxErrorRate") do
+  it { should exist }
+  it { should belong_to_metric('5xxErrorRate').namespace('AWS/CloudFront') }
+end
+```
+
+To start using `awspec` follow the [Getting Started ](https://github.com/k1LoW/awspec#getting-started) 
+
+# Requirements
+
+* Terraform 0.11.0 or above
+
+# Development
+
+To install this gem locally run `rake install` You should then be able to reference it in your local projects.
+
+

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+
+task :default => [:build]

data/lib/tfmodtest.rb

@@ -0,0 +1,4 @@
+require 'tfmodtest/module_helper'
+require 'tfmodtest/module_tasks'
+require 'tfmodtest/module_test'
+require 'tfmodtest/version.rb'

data/lib/tfmodtest/module_helper.rb

@@ -0,0 +1,47 @@
+require 'socket'
+require 'yaml'
+
+require 'tfmodtest'
+
+TMT = TFModTest
+
+HOSTNAME = Socket.gethostname
+DATE = Time.new.strftime('%y%m%d%H%M%S')
+DEFAULT_PREFIX = "TMT#{HOSTNAME}#{DATE}".freeze
+
+module TFModTest
+  class ModuleHelper
+    include Rake::DSL if defined? Rake::DSL
+
+    class << self
+      def install_tasks
+        new.install
+      end
+    end
+
+    def install
+      task default: [:preflight]
+
+      def run_task(task_name)
+        TMT::ModuleTestRepository.each do |m|
+          m.run_task(task_name)
+        end
+      end
+
+      desc 'Runs all the tests'
+      task :preflight do
+        run_task('preflight')
+      end
+
+      desc 'Destroy any remaining infrastructure'
+      task :destroy do
+        run_task('destroy')
+      end
+
+      desc 'Cleans up the project (after destroying infrastructure)'
+      task :clean do
+        run_task('clean')
+      end
+    end
+  end
+end

data/lib/tfmodtest/module_tasks.rb

@@ -0,0 +1,2 @@
+require 'tfmodtest/module_helper'
+TFModTest::ModuleHelper.install_tasks

data/lib/tfmodtest/module_test.rb

@@ -0,0 +1,53 @@
+require 'TerraformDevKit'
+
+module TFModTest
+  TDK = TerraformDevKit
+
+  class ModuleTest
+    def initialize(module_name)
+      @module_name = module_name
+    end
+
+    def run_task(task_name)
+      puts("=== Running task #{task_name} for module #{@module_name} ===")
+      module_path = File.join('test', @module_name)
+      run_task_in_directory(task_name, module_path)
+    end
+
+    private
+
+    def run_task_in_directory(task_name, dir)
+      Dir.chdir(dir) do
+        load 'Rakefile'
+        begin
+          Rake::Task["#{@module_name}:#{task_name}"].invoke(DEFAULT_PREFIX)
+        rescue RuntimeError => e
+          puts e.message
+          puts e.backtrace.join("\n")
+          Rake::Task["#{@module_name}:clean"].invoke(DEFAULT_PREFIX)
+          raise "Error testing module #{@module_name}"
+        end
+      end
+    end
+  end
+
+  class ModuleTestRepository
+    def self.each
+      modules_path = Rake::FileList.new('test/*')
+      modules_path.each do |path|
+        module_name = File.basename(path)
+        yield ModuleTest.new(module_name) unless excluded?(module_name)
+      end
+    end
+
+    private_class_method
+    def self.excluded?(module_name)
+      excluded_modules.include?(module_name)
+    end
+
+    private_class_method
+    def self.excluded_modules
+      ENV.fetch('TM_EXCLUDE_MODULES', '').split(',')
+    end
+  end
+end

data/lib/tfmodtest/version.rb

@@ -0,0 +1,3 @@
+module TFModTest
+  VERSION = '0.0.1.rc2'.freeze
+end

data/tfmodtest.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tfmodtest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tfmodtest'
+  spec.version       = TFModTest::VERSION
+  spec.authors       = ['Victor Jimenez', 'Daniel Baker']
+  spec.email         = ['vjimenez@vistaprint.com', 'dbaker@vistaprint.com']
+
+  spec.summary       = 'Set of scripts to ease testing od Terraform modules.'
+  spec.homepage      = 'https://github.com/vistaprint/TerraformModuleTesting'
+  spec.license       = 'Apache-2.0'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'TerraformDevKit', '~> 0.2'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: tfmodtest
+version: !ruby/object:Gem::Version
+  version: 0.0.1.rc2
+platform: ruby
+authors:
+- Victor Jimenez
+- Daniel Baker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: TerraformDevKit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email:
+- vjimenez@vistaprint.com
+- dbaker@vistaprint.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tfmodtest.rb
+- lib/tfmodtest/module_helper.rb
+- lib/tfmodtest/module_tasks.rb
+- lib/tfmodtest/module_test.rb
+- lib/tfmodtest/version.rb
+- tfmodtest.gemspec
+homepage: https://github.com/vistaprint/TerraformModuleTesting
+licenses:
+- Apache-2.0
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Set of scripts to ease testing od Terraform modules.
+test_files: []