TerraformDevKit 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43d9a31480f56ff1f3f54e95c92b6938cf206c53
-  data.tar.gz: f795680f411b57a400ae4de2748d7343667ec0ee
+  metadata.gz: a94f0642cf970c5994db6fc663a2f2add47810e4
+  data.tar.gz: 8fa17cf1bf78f83abe26094616904692db12fdf2
 SHA512:
-  metadata.gz: 1d61c3537b6b0892e6ee0fe2ebfa3c5ae9f995a9062a227da300087e1312656a2df13172732424436adfba57bbc44c7693d6cfc56e958aea7ad84275e74f8123
-  data.tar.gz: e5cb3bcb16a29cfb10dcd390dbf9c6bc6e2f8fccc6a35ca3a1851b6d6be52ef46b08c52ca4f1104cd02319c7a0576038446486cd7f5e622673101b462e4ccf4b
+  metadata.gz: daf674ba9d45403f922f157eccb704ac0581470c801c9d8c86d90b1c3dab5a3899993706931b42712b9994fe3b104d232b8ddb17d816184a887ff5f844ff3285
+  data.tar.gz: 9171fd82c7de355a543053b1fd95bbd7f868ec2cb39547b4dec5faeb6510a820ec929e3931fec624683de7f8f924b694e767e44f20bb8c837708b0708bdbf64a

data/README.md

@@ -89,6 +89,27 @@ task :custom_test, [:env] do |_, args|
 end
 ```
 
+### Tasks and Hooks
+
+TerraformDevKit provides a set of generic tasks to perform:
+
+* `prepare`: prepares the environment
+* `plan`: shows the plan to create the infrastructure
+* `apply`: creates the infrastructure
+* `destroy`: destroys the infrastructure
+* `clean`: cleans the environment (after destroying the infrastructure)
+* `test`: tests a local environment
+* `preflight`: creates a temporary infrastructure and runs the test task
+
+Additionally, TerraformDevKit allows users to define a set of hooks that will be called during the different steps required to complete the previous list of tasks. The following hooks are available:
+
+* `pre_apply`: invoked before `apply` task runs
+* `post_apply`: invoked after `apply` task runs
+* `pre_destroy`: invoked before `destroy` task runs
+* `post_destroy`: invoked after `destroy` task runs
+* `custom_prepare`: invoked during the preparation process, before terraform is initialized
+* `custom_test`: invoked during as part of the `test` task, right after `apply` completes.
+
 ### Sample Terraform/Terragrunt Templates
 
 The following file (`main.tf.mustache`) contains the infrastructure configuration (a single S3 bucket) as well as information related to the AWS provider.
@@ -148,9 +169,7 @@ terragrunt = {
 
 ### Injecting Additional Variables into Template Files
 
-In addition to the default variables that are passed to Mustache when rendering
-a template file, users can provide additional variables. To do so, users must register a procedure that receives the environment as a parameter and returns
-a map with the extra variables and their values. An example is shown next:
+In addition to the default variables that are passed to Mustache when rendering a template file, users can provide additional variables. To do so, users must register a procedure that receives the environment as a parameter and returns a map with the extra variables and their values. An example is shown next:
 
 ```ruby
 TDK::TerraformConfigManager.register_extra_vars_proc(
@@ -160,14 +179,11 @@ TDK::TerraformConfigManager.register_extra_vars_proc(
 )
 ```
 
-### Skipping Module Updates
+### Updating Modules
 
-For safety and correctness reasons, TerraformDevKit requests to update every
-module when it executes Terraform. This may take a while, depending on the
-number of modules used in the infrastructure.
+Terraform will get the necessary modules every time a new environment is created. Once the modules are cached, there is generally no need to keep updating the modules each time Terraform is executed. When using a module repository it is possible to select a specific version to use (as shown [here](https://www.terraform.io/docs/modules/sources.html#ref)). In such a case, Terraform will automatically update the modules whenever the version number is changed.
 
-When users are sure that an update is not necessary, this step can be skipped
-by setting the environment variable `TF_DEVKIT_SKIP_MODULE_UPDATE` to `true`.
+When using local modules (e.g., during development process) it might be desirable to update the modules every time Terraform runs. This can be achieved by setting the environment variable `TF_DEVKIT_UPDATE_MODULES` to `true`.
 
 ## Development
 

data/lib/TerraformDevKit/terraform_config_manager.rb

@@ -17,10 +17,8 @@ module TerraformDevKit
     end
 
     def self.update_modules?
-      skip_update = ENV.fetch('TF_DEVKIT_SKIP_MODULE_UPDATE', 'false')
-                       .strip
-                       .downcase
-      skip_update != 'true'
+      var = ENV.fetch('TF_DEVKIT_UPDATE_MODULES', 'false')
+      var.strip.casecmp('true').zero?
     end
 
     private_class_method

data/lib/TerraformDevKit/terraform_installer.rb

@@ -10,13 +10,21 @@ module TerraformDevKit
     LOCAL_FILE_NAME = 'terraform.zip'.freeze
 
     def self.installed_terraform_version
-      version = Command.run('terraform --version')[0]
-      match = /Terraform v(\d+\.\d+\.\d+)/.match(version)
-      match[1] unless match.nil?
+      extract_version(Command.run('terraform --version'))
     rescue
       nil
     end
 
+    def self.extract_version(output)
+      # Terraform vx.y.z might be anywhere in the output (warnings may appear
+      # before the version does). Therefore we scan all the lines.
+
+      matches = output.map { |line| /Terraform v(\d+\.\d+\.\d+)/.match(line) }
+                      .reject(&:nil?)
+
+      matches.count == 1 ? matches[0][1] : nil
+    end
+
     def self.install_local(version, directory: Dir.pwd)
       if installed_terraform_version == version
         puts 'Terraform already installed'

data/lib/TerraformDevKit/version.rb

@@ -1,3 +1,3 @@
 module TerraformDevKit
-  VERSION = '0.1.13'.freeze
+  VERSION = '0.1.14'.freeze
 end

data/tasks/devkit.rake

@@ -21,6 +21,12 @@ rescue StandardError => e
   raise
 end
 
+def invoke_if_defined(task_name, env)
+  if Rake::Task.task_defined?(task_name)
+    task(task_name).invoke(env)
+  end
+end
+
 desc 'Prepares the environment to create the infrastructure'
 task :prepare, [:env] do |_, args|
   puts "== Configuring environment #{args.env}"
@@ -41,9 +47,7 @@ task :prepare, [:env] do |_, args|
 
   TDK::TerraformConfigManager.setup(env)
 
-  if Rake::Task.task_defined?('custom_prepare')
-    task('custom_prepare').invoke(args.env)
-  end
+  invoke_if_defined('custom_prepare', args.env)
 
   TDK::Command.run(
     'terragrunt init -upgrade=false',
@@ -64,13 +68,14 @@ end
 
 desc 'Creates the infrastructure'
 task :apply, [:env] => :prepare do |_, args|
+  invoke_if_defined('pre_apply', args.env)
+
   env = TDK::Environment.new(args.env)
   destroy_if_fails(env) do
     TDK::Command.run('terragrunt apply', directory: env.working_dir)
   end
-  if Rake::Task.task_defined?('post_apply')
-    task('post_apply').invoke(args.env)
-  end
+
+  invoke_if_defined('post_apply', args.env)
 end
 
 desc 'Tests a local environment'
@@ -81,9 +86,7 @@ task :test, [:env] do |_, args|
   task('apply').invoke(env.name)
 
   destroy_if_fails(env) do
-    if Rake::Task.task_defined?('custom_test')
-      task('custom_test').invoke(args.env)
-    end
+    invoke_if_defined('custom_test', args.env)
   end
 end
 
@@ -97,13 +100,14 @@ end
 
 desc 'Destroys the infrastructure'
 task :destroy, [:env] => :prepare do |_, args|
+  invoke_if_defined('pre_destroy', args.env)
+
   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)
-  if Rake::Task.task_defined?('custom_destroy')
-    task('custom_destroy').invoke(args.env)
-  end
+
+  invoke_if_defined('post_destroy', args.env)
 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.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Victor Jimenez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2017-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler