TerraformDevKit 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03871ccc5d65b7a7563ab9aef556ea126c8e9c88
-  data.tar.gz: 8f7f6ad94c285ff7340d725fc60510bc5d5ac65b
+  metadata.gz: 4e92fbd82b70265947a9eb3db56bad0c5b85d78f
+  data.tar.gz: 9048f6a2ea5e8ff08181d87515050ccf10e0931e
 SHA512:
-  metadata.gz: bac5b976127e46c5d7c570798d7589caf413f7ce5a73e857e23ecae1b407eff162aa9a49303a4c36ff3192de5b1c30e26459b3867375d68d5b6b6e6e3cc6139f
-  data.tar.gz: c6478f25739d5ecfa3ed710208f0f5ec105ea7c2438d3b94b17298f9449253f1af6c2080733be61f88117cb2781d078070129a3bef9f8104acdcf18f8102fa96
+  metadata.gz: 1ebef969303e8fc2f00e1911a04990d3f3abbf790277f3a863788cdd57ea00bb848c25d5bdb346bd9a931375e3dcd7bbfbdb06a708a83067d950235d77ec6490
+  data.tar.gz: 294017e43b6b007d2c0fc23e93ab7bbed995e65c011eaeda6062ca8a6381f28d1361575ce7cc2ff15e3175d292bd48b7a72570571786f925eccbf6ccf28cfb8b

data/README.md

@@ -1,22 +1,24 @@
 # TerraformDevKit
 
-[![Build Status](https://travis-ci.org/betabandido/TerraformDevKit.svg?branch=master)](https://travis-ci.org/betabandido/TerraformDevKit) [![Build status](https://ci.appveyor.com/api/projects/status/4vkyr196li83vju6/branch/master?svg=true)](https://ci.appveyor.com/project/betabandido/terraformdevkit/branch/master)
+[![Build Status](https://travis-ci.org/vistaprint/TerraformDevKit.svg?branch=master)](https://travis-ci.org/vistaprint/TerraformDevKit) [![Build status](https://ci.appveyor.com/api/projects/status/4vkyr196li83vju6/branch/master?svg=true)](https://ci.appveyor.com/project/betabandido/terraformdevkit/branch/master)
 
 Set of scripts to ease development and testing with [Terraform](https://www.terraform.io/).
 
-The script collection incldues support for:
+The script collection includes support for:
 
 * Managing AWS credentials
-* Simple reading and writing to AWS DynamoDB
-* Polling an AWS ApiGateway endpoint until it becomes ready
-* Executing commands
-* Locally installing Terraform and [Terragrunt](https://github.com/gruntwork-io/terragrunt)
 * Backing up the state from a failed Terraform execution
-* Multiplatform tools
+* Executing external commands
 * Simple configuration management
+* Simple reading and writing to AWS DynamoDB
+* Multiplatform tools
+* Making simple HTTP requests
+* Retrying a block of code
 * Terraform environment management
+* Locally installing Terraform and [Terragrunt](https://github.com/gruntwork-io/terragrunt)
+* Filtering Terraform logging messages
 
-Most of these scripts exist to provide support to a module development and testing environment for Terraform: [TerraformModules](https://github.com/betabandido/TerraformModules). But, they might be useful for other purposes too.
+Most of these scripts exist to provide support to a module development and testing environment for Terraform: [TerraformModules](https://github.com/vistaprint/TerraformModules). But, they might be useful for other purposes too.
 
 ## Installation
 
@@ -50,8 +52,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/betabandido/TerraformDevKit.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/vistaprint/TerraformDevKit.
 
 ## License
 

data/TerraformDevKit.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['vjimenez@vistaprint.com']
 
   spec.summary       = 'Set of scripts to ease development and testing with Terraform.'
-  spec.homepage      = 'https://github.com/betabandido/TerraformDevKit'
+  spec.homepage      = 'https://github.com/vistaprint/TerraformDevKit'
   spec.license       = 'Apache-2.0'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '~> 3.0.1'
 
   spec.add_runtime_dependency 'aws-sdk', '~> 2.9.37'
+  spec.add_runtime_dependency 'mustache', '~> 1.0.2'
   spec.add_runtime_dependency 'rubyzip', '~> 1.2.1'
 end

data/lib/TerraformDevKit.rb

@@ -3,12 +3,15 @@ require 'TerraformDevKit/backup_state'
 require 'TerraformDevKit/command'
 require 'TerraformDevKit/config'
 require 'TerraformDevKit/dynamodb'
+require 'TerraformDevKit/environment'
 require 'TerraformDevKit/os'
 require 'TerraformDevKit/request'
 require 'TerraformDevKit/retry'
+require 'TerraformDevKit/terraform_config_manager'
 require 'TerraformDevKit/terraform_env_manager'
 require 'TerraformDevKit/terraform_installer'
 require 'TerraformDevKit/terraform_log_filter'
+require 'TerraformDevKit/terraform_template_config_file'
 require 'TerraformDevKit/terragrunt_installer'
 require 'TerraformDevKit/url'
 require 'TerraformDevKit/version'

data/lib/TerraformDevKit/environment.rb

@@ -0,0 +1,47 @@
+require 'socket'
+
+module TerraformDevKit
+  class Environment
+    attr_reader :name
+
+    def initialize(name)
+      raise 'Environment must not be null' if name.nil?
+      raise "Invalid environment name: #{name}" unless /^[0-9a-zA-Z]+$/ =~ name
+      @name = name.downcase
+    end
+
+    def config
+      case @name
+      when 'prod'
+        'prod'
+      when 'test'
+        'test'
+      else
+        'dev'
+      end
+    end
+
+    def local_backend?
+      case @name
+      when 'prod', 'test'
+        false
+      else
+        true
+      end
+    end
+
+    def working_dir
+      "envs/#{@name}"
+    end
+
+    def self.temp_name
+      hostname = Socket.gethostname
+      date = Time.now.strftime('%y%m%d%H%M')
+      "#{hostname}#{date}"
+    end
+
+    def self.running_on_jenkins?
+      ENV.key?('JENKINS_URL') && ENV.key?('BUILD_ID')
+    end
+  end
+end

data/lib/TerraformDevKit/terraform_config_manager.rb

@@ -0,0 +1,67 @@
+require 'TerraformDevKit/terraform_template_config_file'
+
+require 'fileutils'
+
+module TerraformDevKit
+  class TerraformConfigManager
+    def self.setup(env, extra_vars: {})
+      fix_configuration(env)
+      create_environment_directory(env)
+      render_template_config_files(env, extra_vars)
+    end
+
+    def self.update_modules?
+      skip_update = ENV.fetch('TF_DEV_KIT_SKIP_MODULE_UPDATE', 'false')
+                       .strip
+                       .downcase
+      skip_update != 'true'
+    end
+
+    private_class_method
+    def self.fix_configuration(env)
+      raise 'No AWS section in the config file' if Configuration.get('aws').nil?
+      if Environment.running_on_jenkins?
+        Configuration.get('aws').delete('profile')
+      elsif Configuration.get('aws').key?('profile')
+        unless env.local_backend?
+          raise "AWS credentials for environment #{env.name} must not be stored!"
+        end
+      else
+        profile = request_profile(env)
+        Configuration.get('aws')['profile'] = profile
+      end
+    end
+
+    private_class_method
+    def self.create_environment_directory(env)
+      FileUtils.makedirs(env.working_dir)
+    end
+
+    private_class_method
+    def self.render_template_config_files(env, extra_vars)
+      aws_config = Configuration.get('aws')
+      file_list = Dir['*.tf.mustache'] + Dir['*.tfvars.mustache']
+      file_list.each do |fname|
+        template_file = TerraformTemplateConfigFile.new(
+          File.read(fname),
+          env,
+          aws_config,
+          extra_vars: extra_vars
+        )
+        config_fname = File.basename(fname, File.extname(fname))
+        Dir.chdir(env.working_dir) do
+          File.open(config_fname, 'w') { |f| f.write(template_file.render) }
+        end
+      end
+    end
+
+    private_class_method
+    def self.request_profile(env)
+      puts "Environment #{env.name} requires manual input of AWS credentials"
+      print 'Enter the profile to use: '
+      profile = $stdin.gets.tr("\r\n", '')
+      raise 'Invalid profile name' unless /^\w+$/ =~ profile
+      profile
+    end
+  end
+end

data/lib/TerraformDevKit/terraform_template_config_file.rb

@@ -0,0 +1,26 @@
+require 'mustache'
+
+module TerraformDevKit
+  class TerraformTemplateConfigFile
+    def initialize(content, env, aws_config, extra_vars: {})
+      @content = content
+      @env = env
+      @aws_config = aws_config
+      @extra_vars = extra_vars
+    end
+
+    def render
+      args = {
+        Profile: @aws_config.fetch('profile', ''),
+        Region:  @aws_config.fetch('region'),
+        Environment: @env.name,
+        LocalBackend: @env.local_backend?
+      }
+      args.merge!(@extra_vars)
+      Mustache.render(
+        @content,
+        args
+      )
+    end
+  end
+end

data/lib/TerraformDevKit/version.rb

@@ -1,3 +1,3 @@
 module TerraformDevKit
-  VERSION = '0.1.9'.freeze
+  VERSION = '0.1.10'.freeze
 end

data/tasks/devkit.rake

@@ -0,0 +1,106 @@
+require 'fileutils'
+require 'TerraformDevKit'
+
+TDK = TerraformDevKit
+
+raise 'ROOT_PATH is not defined' if defined?(ROOT_PATH).nil?
+BIN_PATH = File.join(ROOT_PATH, 'bin')
+
+# Ensure terraform and terragrunt are in the PATH
+ENV['PATH'] = TDK::OS.join_env_path(
+  TDK::OS.convert_to_local_path(BIN_PATH),
+  ENV['PATH']
+)
+
+TF_CONFIG_EXTRA_VARS = {}.freeze unless defined?(TF_CONFIG_EXTRA_VARS)
+
+def destroy_if_fails(env)
+  yield
+rescue StandardError => e
+  puts "ERROR: #{e.message}"
+  puts e.backtrace.join("\n")
+  task('destroy').invoke(env.name) if env.local_backend?
+  raise
+end
+
+desc 'Prepares the environment to create the infrastructure'
+task :prepare, [:env] do |_, args|
+  puts "== Configuring environment #{args.env}"
+  env = TDK::Environment.new(args.env)
+
+  config_file = "config/config-#{env.config}.yml"
+  puts "== Loading configuration from #{config_file}"
+  TDK::Configuration.init(config_file)
+
+  TDK::TerraformInstaller.install_local(
+    TDK::Configuration.get('terraform-version'),
+    directory: BIN_PATH
+  )
+  TDK::TerragruntInstaller.install_local(
+    TDK::Configuration.get('terragrunt-version'),
+    directory: BIN_PATH
+  )
+
+  TDK::TerraformConfigManager.setup(env, extra_vars: TF_CONFIG_EXTRA_VARS)
+
+  task('custom_prepare').invoke(args.env) if Rake::Task.task_defined?('custom_prepare')
+
+  TDK::Command.run(
+    'terragrunt init',
+    directory: env.working_dir,
+    close_stdin: false
+  )
+
+  cmd = 'terragrunt get'
+  cmd += ' -update=true' if TDK::TerraformConfigManager.update_modules?
+  TDK::Command.run(cmd, directory: env.working_dir)
+end
+
+desc 'Shows the plan to create the infrastructure'
+task :plan, [:env] => :prepare do |_, args|
+  env = TDK::Environment.new(args.env)
+  TDK::Command.run('terragrunt plan', directory: env.working_dir)
+end
+
+desc 'Creates the infrastructure'
+task :apply, [:env] => :prepare do |_, args|
+  env = TDK::Environment.new(args.env)
+  destroy_if_fails(env) do
+    TDK::Command.run('terragrunt apply', directory: env.working_dir)
+  end
+end
+
+desc 'Tests a local environment'
+task :test, [:env] do |_, args|
+  env = TDK::Environment.new(args.env)
+  raise 'Testing is only allowed for local environments' unless env.local_backend?
+
+  task('apply').invoke(env.name)
+
+  destroy_if_fails(env) do
+    task('custom_test').invoke(args.env) if Rake::Task.task_defined?('custom_test')
+  end
+end
+
+desc 'Creates the infrastructure and run the tests'
+task :preflight, [:teardown] do |_, args|
+  args.with_defaults(teardown: 'true')
+  env = TDK::Environment.new(TDK::Environment.temp_name)
+  task('test').invoke(env.name)
+  task('clean').invoke(env.name) if args.teardown == 'true'
+end
+
+desc 'Destroys the infrastructure'
+task :destroy, [:env] => :prepare do |_, args|
+  env = TDK::Environment.new(args.env)
+  cmd = 'terragrunt destroy'
+  cmd += ' -force' if env.local_backend?
+  TDK::Command.run(cmd, directory: env.working_dir, close_stdin: false)
+end
+
+desc 'Cleans an environment (infrastructure is destroyed too)'
+task :clean, [:env] => :destroy do |_, args|
+  env = TDK::Environment.new(args.env)
+  puts "Deleting environment #{env.name}"
+  FileUtils.rm_rf(env.working_dir, secure: true)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: TerraformDevKit
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Victor Jimenez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.9.37
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -121,17 +135,21 @@ files:
 - lib/TerraformDevKit/config.rb
 - lib/TerraformDevKit/download.rb
 - lib/TerraformDevKit/dynamodb.rb
+- lib/TerraformDevKit/environment.rb
 - lib/TerraformDevKit/os.rb
 - lib/TerraformDevKit/request.rb
 - lib/TerraformDevKit/retry.rb
+- lib/TerraformDevKit/terraform_config_manager.rb
 - lib/TerraformDevKit/terraform_env_manager.rb
 - lib/TerraformDevKit/terraform_installer.rb
 - lib/TerraformDevKit/terraform_log_filter.rb
+- lib/TerraformDevKit/terraform_template_config_file.rb
 - lib/TerraformDevKit/terragrunt_installer.rb
 - lib/TerraformDevKit/url.rb
 - lib/TerraformDevKit/version.rb
 - lib/TerraformDevKit/zip_file_generator.rb
-homepage: https://github.com/betabandido/TerraformDevKit
+- tasks/devkit.rake
+homepage: https://github.com/vistaprint/TerraformDevKit
 licenses:
 - Apache-2.0
 metadata: {}