TerraformDevKit 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0a6b6bc02df8351a7ce6b5fa4184335d77e9058
-  data.tar.gz: 65ad8fb0acce6af24e09bfe3023be632f0b49a46
+  metadata.gz: 3b16b145303034cd5bb4067a2067cb6375fd2671
+  data.tar.gz: 2ba0084ba9439bfc8b225f0692bd4ee56f3065cd
 SHA512:
-  metadata.gz: 509b73c78dcb20c729f5d952d2c7cf0b33dd748e9c3fe5ce0bc6854b5c93ccbc8963b743c533eca5f75267c4fe36d80bfb5f2d65f920376f7a9e57850b0ca6f4
-  data.tar.gz: 98d862ea73043dbcdd3e8e18c9676d4d24729829f2f94c2342a711bce560cfab10a2fca0d6eaba44bf0c786ed34471bdb183fe7bb1776aa6c6d847e4990df568
+  metadata.gz: 5dceda5b12de14d4b694d15c91b605f42063b4cf81ae05768b794d709b96335fd1009e602f4e2c989c39d5cb49c792f12d0734613cba3edd83312f4afb51e1f6
+  data.tar.gz: d9cd74d4249954c8596ea643eb5d0ed41e630c31d5218bb4046f870e841a2c0fb7ab58f124c8ac669a52fcc7244fd7b8dc6cd78a0a9a47f779a0bab7cb8f22f5

data/README.md

@@ -20,6 +20,8 @@ The script collection includes support for:
 
 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.
 
+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:
@@ -89,6 +91,16 @@ task :custom_test, [:env] do |_, args|
 end
 ```
 
+#### Overrides
+
+It's possible to override the location of your config files by setting the variable `CONFIG_FILE` in the top level `Rakefile`
+
+```ruby
+# %s will be substituted with the environment name.
+# File is exected to live in /c/path/to/root/config/config-dev.yml
+CONFIG_FILE = File.join(ROOT_PATH, 'config', 'config-%s.yml')
+```
+
 ### Tasks and Hooks
 
 TerraformDevKit provides a set of generic tasks to perform:

data/TerraformDevKit.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 3.0'
 
-  spec.add_runtime_dependency 'aws-sdk', '~> 2.9'
+  spec.add_runtime_dependency 'aws-sdk', '~> 3'
   spec.add_runtime_dependency 'mustache', '~> 1.0'
   spec.add_runtime_dependency 'rainbow', '~> 3.0'
   spec.add_runtime_dependency 'rubyzip', '~> 1.2'

data/lib/TerraformDevKit/command.rb

@@ -1,26 +1,26 @@
-require 'open3'
+require 'open3'
+
+module TerraformDevKit
+  class Command
+    def self.run(cmd, directory: Dir.pwd, print_output: true)
+      Open3.popen2e(cmd, chdir: directory) do |_, stdout_and_stderr, thread|
+        output = process_output(stdout_and_stderr, print_output)
 
-module TerraformDevKit
-  class Command
-    def self.run(cmd, directory: Dir.pwd, print_output: true)
-      Open3.popen2e(cmd, chdir: directory) do |_, stdout_and_stderr, thread|
-        output = process_output(stdout_and_stderr, print_output)
-
-        thread.join
-        raise "Error running command #{cmd}" unless thread.value.success?
-        return output
-      end
-    end
-
-    private_class_method
-    def self.process_output(stream, print_output)
-      lines = []
-
-      until (line = stream.gets).nil?
-        print line if print_output
-        lines << line.strip
-      end
-      lines
-    end
-  end
-end
+        thread.join
+        raise "Error running command #{cmd}" unless thread.value.success?
+        return output
+      end
+    end
+
+    private_class_method
+    def self.process_output(stream, print_output)
+      lines = []
+
+      until (line = stream.gets).nil?
+        print line if print_output
+        lines << line.strip
+      end
+      lines
+    end
+  end
+end

data/lib/TerraformDevKit/environment.rb

@@ -30,7 +30,7 @@ module TerraformDevKit
     end
 
     def working_dir
-      "envs/#{@name}"
+      File.join(ROOT_PATH, 'envs', @name)
     end
 
     def self.temp_name

data/lib/TerraformDevKit/version.rb

@@ -1,3 +1,3 @@
 module TerraformDevKit
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.5'.freeze
 end

data/tasks/devkit.rake

@@ -6,6 +6,7 @@ TDK = TerraformDevKit
 
 raise 'ROOT_PATH is not defined' if defined?(ROOT_PATH).nil?
 BIN_PATH = File.join(ROOT_PATH, 'bin')
+CONFIG_FILE ||= File.join(ROOT_PATH, 'config', 'config-%s.yml')
 
 # Ensure terraform is in the PATH
 ENV['PATH'] = TDK::OS.join_env_path(
@@ -15,17 +16,28 @@ ENV['PATH'] = TDK::OS.join_env_path(
 
 PLAN_FILE = 'plan.tfplan'.freeze
 
-def destroy_if_fails(env)
+def destroy_if_fails(env, task)
   yield
-rescue StandardError => e
+rescue Exception => e
   puts "ERROR: #{e.message}"
   puts e.backtrace.join("\n")
-  task('destroy').invoke(env.name) if env.local_backend?
+  invoke('destroy', task, env.name) if env.local_backend?
   raise
 end
 
-def invoke_if_defined(task_name, env)
-  task(task_name).invoke(env) if Rake::Task.task_defined?(task_name)
+def invoke(task_name, task_context, env, safe_invoke: false)
+  task_in_context = task_in_current_namespace(task_name, task_context)
+  should_invoke = !safe_invoke || Rake::Task.task_defined?(task_in_context)
+  Rake::Task[task_in_context].invoke(env) if should_invoke
+end
+
+def task_in_current_namespace(task_name, current_task)
+  namespace = current_task.scope.path.to_s
+  if namespace.empty?
+    return task_name
+  end
+
+  return "#{namespace}:#{task_name}"
 end
 
 def remote_state
@@ -46,7 +58,7 @@ task :prepare, [:env] do |_, args|
   puts "== Configuring environment #{args.env}"
   env = TDK::Environment.new(args.env)
 
-  config_file = "config/config-#{env.config}.yml"
+  config_file = CONFIG_FILE % env.config
   puts "== Loading configuration from #{config_file}"
   TDK::Configuration.init(config_file)
 
@@ -65,7 +77,7 @@ task :prepare, [:env] do |_, args|
     remote_state.init(env, project_config)
   end
 
-  invoke_if_defined('custom_prepare', args.env)
+  invoke('custom_prepare', task, args.env, safe_invoke: true)
 
   if File.exist?(File.join(env.working_dir, '.terraform'))
     get_cmd  = 'terraform get'
@@ -88,12 +100,12 @@ task :plan, [:env] => :prepare do |_, args|
 end
 
 desc 'Creates the infrastructure'
-task :apply, [:env] => :prepare do |_, args|
-  invoke_if_defined('pre_apply', args.env)
+task :apply, [:env] => :prepare do |task, args|
+  invoke('pre_apply', task, args.env, safe_invoke: true)
 
   env = TDK::Environment.new(args.env)
 
-  task('plan').invoke(env.name)
+  invoke('plan', task, env.name)
 
   unless env.local_backend?
     puts Rainbow("Are you sure you want to apply the above plan?\n" \
@@ -105,38 +117,40 @@ task :apply, [:env] => :prepare do |_, args|
     end
   end
 
-  destroy_if_fails(env) do
+  destroy_if_fails(env, task) do
     Dir.chdir(env.working_dir) do
       system("terraform apply \"#{PLAN_FILE}\"")
     end
   end
 
-  invoke_if_defined('post_apply', args.env)
+  invoke('post_apply', task, args.env, safe_invoke: true)
 end
 
 desc 'Tests a local environment'
-task :test, [:env] do |_, args|
+task :test, [:env] do |task, args|
   env = TDK::Environment.new(args.env)
   env.local_backend? || (raise 'Testing is only allowed for local environments')
 
-  task('apply').invoke(env.name, true)
+  invoke('apply', task, env.name)
 
-  destroy_if_fails(env) do
-    invoke_if_defined('custom_test', args.env)
+  destroy_if_fails(env, task) do
+    invoke('custom_test', task, args.env, safe_invoke: true)
   end
 end
 
-desc 'Creates the infrastructure and run the tests'
-task :preflight, [:teardown] do |_, args|
+desc 'Creates the infrastructure and runs the tests'
+task :preflight, [:prefix, :teardown] do |task, 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'
+  args.with_defaults(prefix: TDK::Environment.temp_name)
+  env = TDK::Environment.new(args.prefix)
+
+  invoke('test', task, env.name)
+  invoke('clean', task, env.name) if args.teardown == 'true'
 end
 
 desc 'Destroys the infrastructure'
-task :destroy, [:env] => :prepare do |_, args|
-  invoke_if_defined('pre_destroy', args.env)
+task :destroy, [:env] => :prepare do |task, args|
+  invoke('pre_destroy', task, args.env, safe_invoke: true)
 
   env = TDK::Environment.new(args.env)
   cmd = 'terraform destroy'
@@ -159,7 +173,7 @@ task :destroy, [:env] => :prepare do |_, args|
   Dir.chdir(env.working_dir) do
     system(cmd)
   end
-  invoke_if_defined('pre_destroy', args.env)
+  invoke('pre_destroy', task, args.env, safe_invoke: true)
 
   unless env.local_backend?
     project_config = TDK::TerraformProjectConfig.new(
@@ -168,7 +182,7 @@ task :destroy, [:env] => :prepare do |_, args|
     remote_state.destroy(env, project_config)
   end
 
-  invoke_if_defined('post_destroy', args.env)
+  invoke('post_destroy', task, args.env, safe_invoke: true)
 end
 
 desc 'Cleans an environment (infrastructure is destroyed too)'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: TerraformDevKit
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Victor Jimenez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement