rake-terraform 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmZiOTEzNThjZDlkMDU1MmQzOTJiMmNlMGFhY2E0ODg3ODdjMzQ1NA==
+  data.tar.gz: !binary |-
+    YWFlOWViNWExNTNkNDhiYTZiMTg3Mjg3NWQ1MTQ2ZTliMzEzMTFmNQ==
+SHA512:
+  metadata.gz: !binary |-
+    YmMzMDlhZTFiYmM0OGViOWRiYjYzZGYzMmI3YTA3Mjk4YjM4MTg1ZDQyZDU1
+    Y2M2M2ZmN2E3MzQyZjBhYWMyZjk1MDkyZDU5YmY1ZDY0YjdiMjk5MDhiNTNm
+    YzA3ZGVhMWQ0ZmZkODk1ZDU4NzA0N2FjZDJjYjU3ZWFiZjJkNjg=
+  data.tar.gz: !binary |-
+    NTA2NGYxNThhZDZlZmIzYmVlNGYwZDFhY2ZmNDVmZTIxMzI3YjYxMjc1YzZk
+    NDQ5OGIzMjQyYWEwYmY3NTc3ODc5YjE3ZDQ5OTIzYjZmYjBlZDY0MzcxMmM3
+    ZTQ1ZWJhNGNjYjhkMGMyMmViNDYxZDYyOWNjYTg1NGU3NzRiOTE=

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+terraform/
+.idea/

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 2.1.0
+- 2.0.0
+deploy:
+  provider: rubygems
+  gem: rake-terraform
+  on:
+    tags: true
+    all_branches: true
+  api_key:
+    secure: hOaHuMk5/lcedaCiP/GkICXy+tNS6uHrrkizoFn4Tv5GhWoAao77e4FWuZh9KNSAmiZIQwPa1z5b9kn8Rq2UE0QjrxBYmDFFp5uM4fDl7xzqPXREfZcBNmrjMFUhXSRnyZnm4rC69lGRQKTSJkHZDAUZfWobFMnouMtRyoDSCbU=

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Norm MacLennan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# rake-terraform
+
+[![Build Status](https://travis-ci.org/maclennann/rake-terraform.svg?branch=master)](https://travis-ci.org/maclennann/rake-terraform)
+[![Code Climate](https://codeclimate.com/github/maclennann/rake-terraform/badges/gpa.svg)](https://codeclimate.com/github/maclennann/rake-terraform)
+[![Test Coverage](https://codeclimate.com/github/maclennann/rake-terraform/badges/coverage.svg)](https://codeclimate.com/github/maclennann/rake-terraform)
+[![Gem](https://img.shields.io/gem/dtv/rake-terraform.svg)]()
+
+`rake-terraform` is a gem with a collection of rake tasks for working with [Hashicorp Terraform](https://terraform.io)
+ and terraform configuration files.
+
+ It provides tasks to calculate and execute plans based on a variety of file and module structures.
+
+ Note: This gem was specifically written for use with the AWS terraform provider. If you need to use another one,
+ please open an issue and/or file a pull request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rake-terraform'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rake-terraform
+
+## Usage
+
+This gem currently provides two different types of tasks:
+
+### `terraform_plan`
+This task can be used to calculate plans for a terraform configuration.
+
+You can set the following configuration for the task:
+
+* `t.input_dir` - the directory from which to read terraform config (default: `./terraform`)
+* `t.output_file` - the path and name of the plan file to generate (default: `./output/terraform/plan.tf`)
+* `t.credentials` - the path of the [AWS credentials file](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-config-files) to read from (default: `~/.aws/credentials`)
+* `t.aws_project` - the name of the project to use from your credentials file (default: `default`)
+
+### `terraform_apply`
+This task can be used to apply a calculated terraform plan.
+
+You can set the following configuration for the task:
+
+* `t.plan`: The name of the plan file to apply (default: `./output/terraform/plan.tf`)
+* `t.execution_path`: The path from which to execute the plan (default: `./terraform`)
+    * This is useful if you are referencing cloud-config files using relative paths
+
+To use these tasks, you should `require 'rake_terraform'` at the top of your Rakefile.
+
+### Default Tasks
+
+This gem provides a `default_tasks` partial rakefile that should work for most use-cases.
+It includes the concept of terraform 'environments'. This is useful for the AWS provider,
+as terraform can only control one AWS region at a time. Which means a separate Terraform
+configuration needs to be kept per region.
+
+To use it, just `require 'rake-terraform/default_tasks'` at the top of your `Rakefile`.
+
+Given, the following terraform hierarchy:
+```bash
+ terraform
+     us-east-1
+         main.tf
+         variables.tf
+         output.tf
+     us-west-1
+         main.tf
+         variables.tf
+         output.tf
+```
+
+It wil automatically generate the following rake tasks:
+
+```bash
+rake terraform:all              # Plan and migrate all environments
+
+rake terraform:apply_us-east-1  # Execute plan for us-east-1
+rake terraform:apply_us-west-1  # Execute plan for us-west-1
+
+rake terraform:plan_us-east-1   # Plan migration of us-east-1
+rake terraform:plan_us-west-1   # Plan migration of us-west-1
+
+rake terraform:us-east-1        # Plan and migrate us-east-1
+rake terraform:us-west-1        # Plan and migrate us-west-1
+```
+
+The following environment variables can be set to tweak `default_task`'s behavior:
+* `ENV['TERRAFORM_AWS_PROJECT']` - Sets `t.aws_project` on the `terraform_plan` tasks (default: `default`)
+* `ENV['TERRAFORM_ENVIRONMENT_GLOB']` - Dir glob used to discover terraform environments (default: `terraform/**/*.tf`)
+* `ENV['TERRAFORM_OUTPUT_BASE']` - Directory to which plan files are saved/read. The environment name is appended to this automatically (default: `output/terraform`)
+
+## Contributing
+
+1. Fork it ( https://github.com/maclennann/rake-terraform/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake-terraform/default_tasks'
+require 'rubocop/rake_task'
+
+task default: :rubocop
+
+RuboCop::RakeTask.new

data/lib/rake-terraform/default_tasks.rb

@@ -0,0 +1,31 @@
+require 'rake_terraform'
+
+namespace :terraform do
+  env_glob = ENV['TERRAFORM_ENVIRONMENT_GLOB'] || 'terraform/**/*.tf'
+  output_base = ENV['TERRAFORM_OUTPUT_BASE'] || 'output/terraform'
+  environments = (Dir.glob env_glob).map { |f| File.dirname f }.uniq
+
+  environments.each do |env|
+    short_name = File.basename env
+    plan_path = File.expand_path File.join(output_base, "#{short_name}.tf")
+
+    desc "Plan migration of #{short_name}"
+    terraform_plan "plan_#{short_name}" do |t|
+      t.input_dir = env
+      t.aws_project = ENV['TERRAFORM_AWS_PROJECT'] || 'default'
+      t.output_file = plan_path
+    end
+
+    desc "Execute plan for #{short_name}"
+    terraform_apply "apply_#{short_name}" do |t|
+      t.plan = plan_path
+      t.execution_path = env
+    end
+
+    desc "Plan and migrate #{short_name}"
+    task short_name => %W(plan_#{short_name} apply_#{short_name})
+  end
+
+  desc 'Plan and migrate all environments'
+  task all: environments.map { |e| File.basename e }.uniq
+end

data/lib/rake-terraform/dsl.rb

@@ -0,0 +1,29 @@
+require 'rake'
+
+# Rake terraform
+module RakeTerraform
+  private
+
+  # Definitions of methods for custom rake tasks
+  module DSL
+    def terraform_plan(*args)
+      require 'rake-terraform/tasks/plantask'
+      Rake::Task.define_task(*args) do
+        c = RakeTerraform::PlanTask::Config.new
+        yield c
+        RakeTerraform::PlanTask::Task.new(c.opts).execute
+      end
+    end
+
+    def terraform_apply(*args)
+      require 'rake-terraform/tasks/applytask'
+      Rake::Task.define_task(*args) do
+        c = RakeTerraform::ApplyTask::Config.new
+        yield c
+        RakeTerraform::ApplyTask::Task.new(c.opts).execute
+      end
+    end
+  end
+end
+
+extend RakeTerraform::DSL

data/lib/rake-terraform/tasks/applytask.rb

@@ -0,0 +1,55 @@
+module RakeTerraform
+  module ApplyTask
+    # Configuration data for terraform apply task
+    class Config
+      attr_accessor :plan
+      attr_accessor :execution_path
+      def initialize
+        @plan = File.expand_path(default_plan)
+        @execution_path = File.expand_path 'terraform'
+      end
+
+      def opts
+        Map.new(plan: @plan,
+                execution_path: @execution_path)
+      end
+
+      private
+
+      def default_plan
+        File.join('output', 'terraform', 'plan.tf')
+      end
+    end
+
+    # Custom rake task to run `terraform apply`
+    class Task < BaseTask
+      def initialize(opts)
+        @opts = opts
+      end
+
+      def execute
+        require 'highline/import'
+
+        plan = @opts.get(:plan)
+        validate_terraform_installed
+        ensure_plan_exists plan
+
+        system "terraform show  --module-depth=2 #{plan}"
+
+        say 'The above changes will be applied to your environment.'
+        exit unless agree 'Are you sure you want to execute this plan? (y/n)'
+
+        Dir.chdir(@opts.get(:execution_path)) do
+          system "terraform apply #{plan}"
+        end
+      end
+
+      private
+
+      def ensure_plan_exists(plan)
+        require 'fileutils'
+        fail "Plan #{plan} does not exist! Aborting!" unless File.exist? plan
+      end
+    end
+  end
+end

data/lib/rake-terraform/tasks/basetask.rb

@@ -0,0 +1,29 @@
+require 'rake/task'
+require 'iniparse'
+require 'English'
+
+module RakeTerraform
+  # Methods that all tasks have in common
+  class BaseTask < Rake::Task
+    def validate_terraform_installed
+      error = 'Please ensure you have terraform installed and on your path!'
+      fail error unless terraform_installed?
+    end
+
+    def terraform_installed?
+      `terraform version`
+      $CHILD_STATUS.success?
+    rescue => _
+      false
+    end
+
+    def get_aws_credentials(creds_file, project = 'default')
+      error = "Could not locate AWS credentials in #{creds_file}!"
+      fail error unless File.exist? creds_file
+
+      credentials = IniParse.parse(File.read(creds_file))
+      { accesskey: credentials[project]['aws_access_key_id'],
+        secretkey: credentials[project]['aws_secret_access_key'] }
+    end
+  end
+end

data/lib/rake-terraform/tasks/plantask.rb

@@ -0,0 +1,87 @@
+require 'rake/task'
+require 'rake-terraform/tasks/basetask'
+require 'map'
+
+# Custom rake task to perform `terraform plan`
+module RakeTerraform
+  module PlanTask
+    # Configuration data for terraform plan task
+    class Config
+      attr_accessor :input_dir
+      attr_accessor :output_file
+      attr_accessor :credentials
+      attr_accessor :aws_project
+
+      def initialize
+        @input_dir = File.expand_path 'terraform'
+        @output_file = File.expand_path(default_output)
+        @credentials = File.expand_path(default_credentials)
+        @aws_project = 'default'
+      end
+
+      def opts
+        Map.new(input_dir:   @input_dir,
+                output_file: @output_file,
+                credentials: @credentials,
+                aws_project: @aws_project)
+      end
+
+      private
+
+      def default_output
+        File.join('output', 'terraform', 'plan.tf')
+      end
+
+      def default_credentials
+        File.join('~', '.aws', 'credentials')
+      end
+    end
+
+    # Custom rake task to run `terraform plan`
+    class Task < BaseTask
+      attr_accessor :creds_file
+
+      def initialize(opts)
+        @creds_file = opts.get(:credentials)
+        @opts = opts
+      end
+
+      def execute
+        validate_terraform_installed
+        ensure_output_directory
+
+        creds = get_aws_credentials(@creds_file, @opts.get(:aws_project))
+
+        Dir.chdir(@opts.get(:input_dir)) do
+          puts '=> Fetching modules...'
+          system('terraform get')
+
+          command = construct_command creds
+          puts "=> Generating plan for #{@opts.get(:input_dir)}..."
+          system(command)
+        end
+      end
+
+      private
+
+      def construct_command(creds)
+        access_key = creds[:accesskey]
+        secret_key = creds[:secretkey]
+
+        command = 'terraform plan '
+        command << "-var access_key=\"#{access_key}\" "
+        command << "-var secret_key=\"#{secret_key}\" "
+        command << '-module-depth 2 '
+        command << "-out #{@opts.get(:output_file)}" if @opts.get(:output_file)
+
+        command
+      end
+
+      def ensure_output_directory
+        require 'fileutils'
+        dir = File.dirname @opts.get(:output_file)
+        FileUtils.mkdir_p dir unless File.exist? dir
+      end
+    end
+  end
+end

data/lib/rake-terraform/version.rb

@@ -0,0 +1,4 @@
+# Version of the gem
+module RakeTerraform
+  VERSION = '0.0.3'
+end

data/lib/rake_terraform.rb

@@ -0,0 +1,6 @@
+require 'rake-terraform/version'
+require 'rake-terraform/dsl'
+
+# Top-level module
+module RakeTerraform
+end

data/rake-terraform.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake-terraform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rake-terraform'
+  spec.version       = RakeTerraform::VERSION
+  spec.authors       = ['Norm MacLennan']
+  spec.email         = ['norm.maclennan@gmail.com']
+  spec.summary       = 'Rake tasks for use with Terraform.'
+  spec.description   = 'A collection of rake tasks that can
+                        be used to plan, apply, and manage
+                        configurations for Hashicorp Terraform.'
+
+  spec.homepage      = 'https://github.com/maclennann/rake-terraform'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rubocop', '~> 0.29'
+  spec.add_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'map', '~> 6.5'
+  spec.add_runtime_dependency 'highline', '~> 1.7'
+  spec.add_runtime_dependency 'iniparse', '~> 1.3'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: rake-terraform
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Norm MacLennan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.29'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: map
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '6.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '6.5'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: iniparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: ! "A collection of rake tasks that can\n                        be used
+  to plan, apply, and manage\n                        configurations for Hashicorp
+  Terraform."
+email:
+- norm.maclennan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rake-terraform/default_tasks.rb
+- lib/rake-terraform/dsl.rb
+- lib/rake-terraform/tasks/applytask.rb
+- lib/rake-terraform/tasks/basetask.rb
+- lib/rake-terraform/tasks/plantask.rb
+- lib/rake-terraform/version.rb
+- lib/rake_terraform.rb
+- rake-terraform.gemspec
+homepage: https://github.com/maclennann/rake-terraform
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Rake tasks for use with Terraform.
+test_files: []