rake-terraform 0.0.8 → 0.2.0

data/lib/rake-terraform/errors.rb

@@ -0,0 +1,4 @@
+module RakeTerraform
+  # Something wrong with a configured nameserver
+  class TerraformNotInstalled < SystemCallError; end
+end

data/lib/rake-terraform/plan_task/config.rb

@@ -0,0 +1,61 @@
+require 'rake-terraform/env_process'
+
+module RakeTerraform
+  module PlanTask
+    # Configuration data for terraform plan task
+    class Config
+      prepend RakeTerraform::EnvProcess
+
+      attr_writer :aws_project, :credentials, :output_file
+
+      def initialize
+        # initialize RakeTerraform::EnvProcess
+        super
+      end
+
+      def aws_project
+        @aws_project ||= 'default'
+      end
+
+      def credentials
+        @credentials ||= File.expand_path(default_credentials)
+      end
+
+      def output_file
+        @output_file ||= File.expand_path(default_output)
+      end
+
+      def input_dir
+        @input_dir ||= File.expand_path 'terraform'
+      end
+
+      # setter method for input_dir triggers setters for tf_environment and
+      # state_file so that these are dynamically updated on change (but only if
+      # we are using directory state, and not explicit path to a state file)
+      def input_dir=(dir)
+        @tf_environment = dir
+        @state_file = tf_state_file if @state_dir
+        @input_dir = dir
+      end
+
+      def opts
+        Map.new(input_dir:   input_dir,
+                output_file: output_file,
+                credentials: credentials,
+                aws_project: aws_project,
+                unique_state: unique_state,
+                state_file: state_file)
+      end
+
+      private
+
+      def default_output
+        File.join('output', 'terraform', 'plan.tf')
+      end
+
+      def default_credentials
+        File.join('~', '.aws', 'credentials')
+      end
+    end
+  end
+end

data/lib/rake-terraform/plan_task/task.rb

@@ -0,0 +1,51 @@
+require 'rake-terraform/basetask'
+require 'rake-terraform/terraformcmd'
+module RakeTerraform
+  module PlanTask
+    # Custom rake task to run `terraform plan`
+    class Task < BaseTask
+      include RakeTerraform::TerraformCmd
+      attr_accessor :creds_file
+
+      def initialize(opts)
+        @creds_file = opts.get(:credentials)
+        @opts = opts
+        creds
+      end
+
+      def execute
+        pre_execute_checks
+        Dir.chdir(@opts.get(:input_dir)) do
+          puts "=> Generating plan for #{@opts.get(:input_dir)}..."
+          if @opts[:unique_state]
+            tf_plan(@creds[:accesskey], @creds[:secretkey],
+                    @opts[:output_file], @opts[:state_file])
+          else
+            tf_plan(@creds[:accesskey], @creds[:secretkey], @opts[:output_file])
+          end
+        end
+      end
+
+      def creds
+        @creds ||= get_aws_credentials(@creds_file, @opts.get(:aws_project))
+      end
+
+      private
+
+      # run pre execution checks
+      def pre_execute_checks
+        validate_terraform_installed
+        ensure_output_directory
+        Dir.chdir(@opts.get(:input_dir)) do
+          puts '=> Fetching modules...'
+          tf_get
+        end
+      end
+
+      def ensure_output_directory
+        dir = File.dirname @opts.get(:output_file)
+        FileUtils.mkdir_p dir unless File.exist? dir
+      end
+    end
+  end
+end

data/lib/rake-terraform/plantask.rb

@@ -0,0 +1,13 @@
+require 'rake-terraform/plan_task/config'
+require 'rake-terraform/plan_task/task'
+# TODO: only needed in < 1.9?
+require 'map'
+
+module RakeTerraform
+  # == RakeTerraform::PlanTask
+  #
+  # Helper classes for creating a terraform plan
+  #
+  module PlanTask
+  end
+end

data/lib/rake-terraform/terraformcmd.rb

@@ -0,0 +1,56 @@
+module RakeTerraform
+  # == RakeTerraform::TerraformCmd
+  #
+  # Helper module for running wrapping terraform calls
+  #
+  # TODO: refactor public methods to take splat arguments and write private
+  #       command builder methods
+  #
+  module TerraformCmd
+    # perform a 'terraform get'
+    def tf_get(update = false)
+      cmd = 'terraform get'
+      update && cmd << ' -update'
+      system(cmd)
+    end
+
+    # perform a 'terraform plan'
+    #
+    # access_key and secret_key are optional as terraform and it's underlying
+    # library have supported the standard AWS_PROFILE env var for a while
+    #
+    def tf_plan(access_key = nil, secret_key = nil,
+                output_file = nil, state_file = nil, module_depth = 2)
+      cmd = 'terraform plan'
+      cmd << " -module-depth #{module_depth}"
+      state_file && cmd << " -state #{state_file}"
+      if access_key && secret_key
+        # TODO: additional escaped quotes required?
+        cmd << " -var access_key=\"#{access_key}\""
+        cmd << " -var secret_key=\"#{secret_key}\""
+      elsif access_key || secret_key
+        fail ArgumentError, 'Only one of access_key or secret_key given'
+      end
+      output_file && cmd << " -out #{output_file}"
+      system(cmd)
+    end
+
+    # perform a 'terraform show'
+    #
+    def tf_show(plan_file, module_depth = 2)
+      cmd = 'terraform show'
+      cmd << " -module-depth #{module_depth}"
+      cmd << " #{plan_file}"
+      system(cmd)
+    end
+
+    # perform a 'terraform apply'
+    #
+    def tf_apply(plan_file, state_file = nil)
+      cmd = 'terraform apply'
+      state_file && cmd << " -state #{state_file}"
+      cmd << " #{plan_file}"
+      system(cmd)
+    end
+  end
+end

data/lib/rake-terraform/version.rb

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

data/rake-terraform.gemspec

@@ -23,6 +23,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1'
   spec.add_development_dependency 'rubocop', '~> 0.29'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_dependency 'dotenv', '~> 2.0.0'
+  spec.add_dependency 'wannabe_bool', '~> 0.3.0'
   spec.add_dependency 'rake', '~> 10.0'
   spec.add_dependency 'map', '~> 6.5'
   spec.add_runtime_dependency 'highline', '~> 1.7'

data/spec/fixtures/envprocess_uniq_state_dir_var_invalid.env

@@ -0,0 +1,3 @@
+TERRAFORM_UNIQUE_STATE="FALSE"
+TERRAFORM_STATE_FILE=""
+TERRAFORM_STATE_DIR_VAR="something/another_thing"

data/spec/fixtures/envprocess_uniq_state_dir_var_valid.env

@@ -0,0 +1,4 @@
+TERRAFORM_UNIQUE_STATE="FALSE"
+TERRAFORM_STATE_FILE=""
+TERRAFORM_STATE_DIR_VAR="SOMETHING"
+SOMETHING="staging"

data/spec/fixtures/envprocess_uniq_state_false.env

@@ -0,0 +1,2 @@
+# dotenv fixtures for RakeTerraform::EnvProcess testing for TERRAFORM_UNIQUE_STATE="FALSE"
+TERRAFORM_UNIQUE_STATE="FALSE"

data/spec/fixtures/envprocess_uniq_state_false_file_valid.env

@@ -0,0 +1,3 @@
+TERRAFORM_UNIQUE_STATE="FALSE"
+TERRAFORM_STATE_FILE="/tmp/some_state.tfstate"
+TERRAFORM_STATE_DIR_VAR=""

data/spec/fixtures/envprocess_uniq_state_invalid_state_file_str.env

@@ -0,0 +1,3 @@
+TERRAFORM_STATE_FILE="/._"
+TERRAFORM_STATE_DIR_VAR=""
+TERRAFORM_UNIQUE_STATE="FALSE"

data/spec/fixtures/envprocess_uniq_state_missing_dir_var.env

@@ -0,0 +1,4 @@
+# dotenv fixtures for RakeTerraform::EnvProcess testing for
+# where we are missing a target for TERRAFORM_STATE_DIR_VAR
+TERRAFORM_UNIQUE_STATE="TRUE"
+TERRAFORM_STATE_DIR_VAR="missing"

data/spec/fixtures/envprocess_uniq_state_true.env

@@ -0,0 +1,5 @@
+# dotenv fixtures for RakeTerraform::EnvProcess testing for TERRAFORM_UNIQUE_STATE="TRUE"
+TERRAFORM_UNIQUE_STATE="TRUE"
+TERRAFORM_STATE_FILE=""
+TERRAFORM_STATE_DIR_VAR=""
+

data/spec/fixtures/envprocess_uniq_state_true_both.env

@@ -0,0 +1,6 @@
+# dotenv fixtures for RakeTerraform::EnvProcess testing for
+# TERRAFORM_UNIQUE_STATE="TRUE" and more than one optional var given
+TERRAFORM_UNIQUE_STATE="TRUE"
+TERRAFORM_STATE_FILE="/tmp/some_state.tfstate"
+TF_TEST="something"
+TERRAFORM_STATE_DIR_VAR="TF_TEST"

data/spec/fixtures/envprocess_uniq_state_true_file_valid.env

@@ -0,0 +1,3 @@
+TERRAFORM_UNIQUE_STATE="TRUE"
+TERRAFORM_STATE_FILE="/tmp/some_state.tfstate"
+TERRAFORM_STATE_DIR_VAR=""

data/spec/fixtures/set_all_variables_nil.env

@@ -0,0 +1,8 @@
+# sets all known environment vars to nil
+TERRAFORM_UNIQUE_STATE=""
+TERRAFORM_STATE_FILE=""
+TERRAFORM_STATE_DIR_VAR=""
+TERRAFORM_AWS_PROJECT=""
+TERRAFORM_ENVIRONMENT_GLOB=""
+TERRAFORM_OUTPUT_BASE=""
+TERRAFORM_CREDENTIAL_FILE=""

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rake-terraform'
+require 'dotenv'
+
+PROJECT_ROOT = File.expand_path('../../', __FILE__)
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

data/spec/unit/applytask_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+require 'rake-terraform/applytask'
+
+module RakeTerraform
+  module ApplyTask
+    describe Config do
+      let(:default_plan_string) { "#{PROJECT_ROOT}/output/terraform/plan.tf" }
+      let(:non_existent_plan) { "#{PROJECT_ROOT}/some/none/existent/path.tf" }
+      let(:default_exec_path_string) { "#{PROJECT_ROOT}/terraform" }
+      let(:non_existent_path) { "#{PROJECT_ROOT}/some/none/existent/path" }
+      before(:each) do
+        # reset default config object before each test
+        @default_config = RakeTerraform::ApplyTask::Config.new
+      end
+      before(:all) do
+        Dotenv.overload(
+          'spec/fixtures/set_all_variables_nil.env'
+        )
+      end
+      it 'should initialize successfully with no arguments' do
+        expect { RakeTerraform::ApplyTask::Config.new }.to_not raise_error
+      end
+
+      describe 'plan' do
+        context 'with a default config object' do
+          it 'should be a string matching default_plan_string' do
+            expect(@default_config.plan).to eq(default_plan_string)
+          end
+          it 'should let me set the path to a non-existent path' do
+            expect { @default_config.plan = non_existent_plan }
+              .to_not raise_error
+            expect(@default_config.plan).to eq(non_existent_plan)
+          end
+        end
+      end
+
+      describe 'execution_path' do
+        after(:all) do
+          Dotenv.overload(
+            'spec/fixtures/set_all_variables_nil.env'
+          )
+        end
+        let(:tf_environment) { 'terraform/eu-west-1' }
+        let(:tf_state_dir_value) { "#{tf_environment}/state/staging" }
+        let(:tf_state_file_path) do
+          "#{PROJECT_ROOT}/#{tf_state_dir_value}/terraform.tfstate"
+        end
+        context 'with a default config object' do
+          it 'should be a string matching default_exec_path_string' do
+            expect(@default_config.execution_path)
+              .to eq(default_exec_path_string)
+          end
+          it 'should let me set the path to a non-existent path' do
+            expect { @default_config.execution_path = non_existent_path }
+              .to_not raise_error
+            expect(@default_config.execution_path).to eq(non_existent_path)
+          end
+        end
+        context 'when I set the execution_path to something else and ' \
+          'state_dir is true' do
+          Dotenv.overload(
+            'spec/fixtures/envprocess_uniq_state_dir_var_valid.env'
+          ) do
+            it 'should update execution_path , tf_environment and state_file' do
+              @default_config.execution_path = tf_environment
+              expect(@default_config.tf_environment).to eq(tf_environment)
+              expect(@default_config.state_file).to eq(tf_state_file_path)
+            end
+          end
+        end
+        context 'when I set execution_path to something else and state_dir ' \
+          'is false' do
+          Dotenv.overload(
+            'spec/fixtures/envprocess_uniq_state_true_file_valid.env'
+          ) do
+            it 'should update execution_path, tf_environment but _not_ ' \
+            'state_file' do
+              @default_config.execution_path = tf_environment
+              expect(@default_config.tf_environment).to eq(tf_environment)
+              expect(@default_config.state_file).to eq(nil)
+            end
+          end
+        end
+      end
+
+      describe 'opts' do
+        context 'with a default config object' do
+          it 'should return the default plan and execution path as keys' do
+            expect(@default_config.opts[:plan]).to eq(default_plan_string)
+            expect(@default_config.opts[:execution_path])
+              .to eq(default_exec_path_string)
+          end
+
+          it 'should reflect new values when the config object is updated' do
+            @default_config.plan = non_existent_plan
+            @default_config.execution_path = non_existent_path
+            expect(@default_config.opts[:plan]).to eq(non_existent_plan)
+            expect(@default_config.opts[:execution_path])
+              .to eq(non_existent_path)
+          end
+        end
+      end
+    end
+
+    describe Task do
+      it 'should raise an ArgumentError with no arguments' do
+        expect { RakeTerraform::ApplyTask::Task.new }
+          .to raise_error(ArgumentError)
+      end
+    end
+  end
+end