tfwrapper 0.4.1 → 0.6.2

data/lib/tfwrapper/version.rb

@@ -4,5 +4,5 @@ module TFWrapper
   # version of the Gem/module; used in the gemspec and in messages.
   # NOTE: When updating this, also update the version in the "Installation"
   # section of README.md
-  VERSION = '0.4.1'
+  VERSION = '0.6.2'
 end

data/spec/acceptance/acceptance_helpers.rb

@@ -3,6 +3,7 @@
 require 'ffi'
 require 'faraday'
 require 'json'
+require 'retries'
 
 def fixture_dir
   File.absolute_path(
@@ -24,12 +25,24 @@ def desired_tf_version
     return ENV['TF_VERSION']
   end
   # else get the latest release from GitHub
-  resp = Faraday.get('https://api.github.com/repos/hashicorp/terraform/releases/latest')
-  rel = JSON.parse(resp.body)['tag_name'].sub(/^v/, '')
-  puts "Found latest terraform release on GitHub: #{rel}"
+  latest_tf_version
+end
+
+def latest_tf_version
+  resp = Faraday.get('https://checkpoint-api.hashicorp.com/v1/check/terraform')
+  rel = JSON.parse(resp.body)['current_version']
+  puts "Found latest terraform release as: #{rel}"
   rel
 end
 
+# Given the example terraform plan output with placeholders for the
+# latest terraform version and fixtures path, return the interpolated string.
+def clean_tf_plan_output(raw_out, latest_ver, fixture_path)
+  raw_out
+    .gsub('%%TF_LATEST_VER%%', latest_ver)
+    .gsub('%%FIXTUREPATH%%', fixture_path)
+end
+
 class HashicorpFetcher
   def initialize(program, version)
     @program = program

data/spec/acceptance/acceptance_spec.rb

@@ -18,6 +18,10 @@ else
   APPLY_CMD = 'terraform apply'
 end
 
+without_landscape = !HAVE_LANDSCAPE && TF_VERSION == '0.11.2'
+with_landscape = HAVE_LANDSCAPE && TF_VERSION == '0.11.2'
+latest_tf_ver = latest_tf_version
+
 Diplomat.configure do |config|
   config.url = 'http://127.0.0.1:8500'
 end
@@ -734,4 +738,229 @@ describe 'tfwrapper' do
       end
     end
   end
+  context 'landscapeTest', order: :defined do
+    before(:all) do
+      @fixturepath = File.absolute_path(
+        File.join(File.dirname(__FILE__), '..', 'fixtures', 'landscapeTest')
+      )
+    end
+    before(:each) do
+      Diplomat::Kv.put(
+        'landscapeTest/foo', '{"bar":"barval","baz":"bazval","foo":"fooval"}'
+      )
+      Diplomat::Kv.put(
+        'terraform/landscapeTest',
+        File.read(File.join(@fixturepath, 'state.json'))
+      )
+    end
+    context 'without landscape installed', if: without_landscape do
+      describe 'default_tf:plan' do
+        before(:all) do
+          @out_err, @ecode = Open3.capture2e(
+            'timeout -k 60 45 bundle exec rake default_tf:plan',
+            chdir: @fixturepath
+          )
+          @varpath = File.join(@fixturepath, 'default_build.tfvars.json')
+        end
+        after(:all) do
+          File.delete(@varpath) if File.file?(@varpath)
+        end
+        it 'does not time out' do
+          expect(@ecode.exitstatus).to_not eq(124)
+          expect(@ecode.exitstatus).to_not eq(137)
+        end
+        it 'exits zero' do
+          expect(@ecode.exitstatus).to eq(0)
+        end
+        it 'returns unmodified terraform output' do
+          expected = clean_tf_plan_output(
+            File.read(File.join(@fixturepath, 'without_landscape.out')),
+            latest_tf_ver, @fixturepath
+          )
+          expect(@out_err.strip).to eq(expected.strip)
+        end
+      end
+    end
+    context 'with landscape installed', if: with_landscape do
+      context 'and disabled' do
+        describe 'disabled_tf:plan' do
+          before(:all) do
+            @out_err, @ecode = Open3.capture2e(
+              'timeout -k 60 45 bundle exec rake disabled_tf:plan',
+              chdir: @fixturepath
+            )
+            @varpath = File.join(@fixturepath, 'disabled_build.tfvars.json')
+          end
+          after(:all) do
+            File.delete(@varpath) if File.file?(@varpath)
+          end
+          it 'does not time out' do
+            expect(@ecode.exitstatus).to_not eq(124)
+            expect(@ecode.exitstatus).to_not eq(137)
+          end
+          it 'exits zero' do
+            expect(@ecode.exitstatus).to eq(0)
+          end
+          it 'returns unmodified terraform output' do
+            expected = clean_tf_plan_output(
+              File.read(File.join(@fixturepath, 'without_landscape.out')),
+              latest_tf_ver, @fixturepath
+            ).gsub('default_build.tfvars.json', 'disabled_build.tfvars.json')
+            expect(@out_err.strip).to eq(expected.strip)
+          end
+        end
+      end
+      context 'and default progress' do
+        describe 'default_tf:plan' do
+          before(:all) do
+            @out_err, @ecode = Open3.capture2e(
+              'timeout -k 60 45 bundle exec rake default_tf:plan',
+              chdir: @fixturepath
+            )
+            @varpath = File.join(@fixturepath, 'default_build.tfvars.json')
+          end
+          after(:all) do
+            File.delete(@varpath) if File.file?(@varpath)
+          end
+          it 'does not time out' do
+            expect(@ecode.exitstatus).to_not eq(124)
+            expect(@ecode.exitstatus).to_not eq(137)
+          end
+          it 'exits zero' do
+            expect(@ecode.exitstatus).to eq(0)
+          end
+          it 'returns landscape output and no plan output' do
+            expected = clean_tf_plan_output(
+              File.read(File.join(@fixturepath, 'with_landscape_default.out')),
+              latest_tf_ver, @fixturepath
+            )
+            expect(@out_err.strip).to eq(expected.strip)
+          end
+        end
+      end
+      context 'and dots progress' do
+        describe 'dots_tf:plan' do
+          before(:all) do
+            @out_err, @ecode = Open3.capture2e(
+              'timeout -k 60 45 bundle exec rake dots_tf:plan',
+              chdir: @fixturepath
+            )
+            @varpath = File.join(@fixturepath, 'dots_build.tfvars.json')
+          end
+          after(:all) do
+            File.delete(@varpath) if File.file?(@varpath)
+          end
+          it 'does not time out' do
+            expect(@ecode.exitstatus).to_not eq(124)
+            expect(@ecode.exitstatus).to_not eq(137)
+          end
+          it 'exits zero' do
+            expect(@ecode.exitstatus).to eq(0)
+          end
+          it 'returns progress dots for plan output and landscape output' do
+            expected = clean_tf_plan_output(
+              File.read(File.join(@fixturepath, 'with_landscape_dots.out')),
+              latest_tf_ver, @fixturepath
+            )
+            expect(@out_err.strip).to eq(expected.strip)
+          end
+        end
+      end
+      context 'and lines progress' do
+        describe 'lines_tf:plan' do
+          before(:all) do
+            @out_err, @ecode = Open3.capture2e(
+              'timeout -k 60 45 bundle exec rake lines_tf:plan',
+              chdir: @fixturepath
+            )
+            @varpath = File.join(@fixturepath, 'lines_build.tfvars.json')
+          end
+          after(:all) do
+            File.delete(@varpath) if File.file?(@varpath)
+          end
+          it 'does not time out' do
+            expect(@ecode.exitstatus).to_not eq(124)
+            expect(@ecode.exitstatus).to_not eq(137)
+          end
+          it 'exits zero' do
+            expect(@ecode.exitstatus).to eq(0)
+          end
+          it 'returns progress lines for plan output and landscape output' do
+            expected = clean_tf_plan_output(
+              File.read(File.join(@fixturepath, 'with_landscape_lines.out')),
+              latest_tf_ver, @fixturepath
+            )
+            expect(@out_err.strip).to eq(expected.strip)
+          end
+        end
+      end
+      context 'and stream progress' do
+        describe 'stream_tf:plan' do
+          before(:all) do
+            @out_err, @ecode = Open3.capture2e(
+              'timeout -k 60 45 bundle exec rake stream_tf:plan',
+              chdir: @fixturepath
+            )
+            @varpath = File.join(@fixturepath, 'stream_build.tfvars.json')
+          end
+          after(:all) do
+            File.delete(@varpath) if File.file?(@varpath)
+          end
+          it 'does not time out' do
+            expect(@ecode.exitstatus).to_not eq(124)
+            expect(@ecode.exitstatus).to_not eq(137)
+          end
+          it 'exits zero' do
+            expect(@ecode.exitstatus).to eq(0)
+          end
+          it 'returns streaming plan output and landscape output' do
+            expected = clean_tf_plan_output(
+              File.read(File.join(@fixturepath, 'with_landscape_stream.out')),
+              latest_tf_ver, @fixturepath
+            )
+            expect(@out_err.strip).to eq(expected.strip)
+          end
+        end
+      end
+      context 'when terraform fails' do
+        describe 'failing_tf:plan' do
+          before(:all) do
+            @out_err, @ecode = Open3.capture2e(
+              'timeout -k 60 45 bundle exec rake failing_tf:plan',
+              chdir: @fixturepath
+            )
+            @varpath = File.join(@fixturepath, 'failing_build.tfvars.json')
+          end
+          after(:all) do
+            File.delete(@varpath) if File.file?(@varpath)
+          end
+          it 'does not time out' do
+            expect(@ecode.exitstatus).to_not eq(124)
+            expect(@ecode.exitstatus).to_not eq(137)
+          end
+          it 'exits 1' do
+            expect(@ecode.exitstatus).to eq(1)
+          end
+          it 'returns the terraform output' do
+            expect(@out_err).to match(
+              /Terraform\sv0\.11\.2.*
+               terraform_runner\scommand:\s'terraform\sinit\s-input=false'.*
+               Running\swith:\sTerraform\sv0\.11\.2.*
+               Initializing\sthe\sbackend\.\.\..*
+               Successfully\sconfigured\sthe\sbackend\s"consul".*
+               Terraform\shas\sbeen\ssuccessfully\sinitialized.*
+               terraform_runner\scommand\s'terraform\sinit\s-input=false'\s
+               finished\sand\sexited\s0.*
+               consul_key_prefix\.landscapeTest:\s"path_prefix":\srequired\s
+               field\sis\snot\sset.*
+               rake\saborted.*
+               StandardError:\sErrors\shave\soccurred\sexecuting:\s
+               'terraform\splan\s-var-file.*
+               Tasks:\sTOP\s=>\sfailing_tf:plan.*/xm
+            )
+          end
+        end
+      end
+    end
+  end
 end

data/spec/fixtures/landscapeTest/Rakefile

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'tfwrapper/raketasks'
+
+TFWrapper::RakeTasks.install_tasks(
+  '.',
+  namespace_prefix: 'default'
+)
+
+TFWrapper::RakeTasks.install_tasks(
+  '.',
+  namespace_prefix: 'disabled',
+  disable_landscape: true
+)
+
+TFWrapper::RakeTasks.install_tasks(
+  '.',
+  namespace_prefix: 'stream',
+  landscape_progress: :stream
+)
+
+TFWrapper::RakeTasks.install_tasks(
+  '.',
+  namespace_prefix: 'dots',
+  landscape_progress: :dots
+)
+
+TFWrapper::RakeTasks.install_tasks(
+  '.',
+  namespace_prefix: 'lines',
+  landscape_progress: :lines
+)
+
+TFWrapper::RakeTasks.install_tasks(
+  'failingTerraform/',
+  namespace_prefix: 'failing',
+  landscape_progress: :dots
+)

data/spec/fixtures/landscapeTest/failingTerraform/main.tf

@@ -0,0 +1,28 @@
+terraform {
+  required_version = "> 0.9.0"
+  backend "consul" {
+    address = "127.0.0.1:8500"
+    path    = "terraform/landscapeTestFailure"
+  }
+}
+
+provider "consul" {
+  address = "127.0.0.1:8500"
+  version = "1.0.0"
+}
+
+locals {
+  keys = {
+    foo = "foo2val"
+    bar = "bar2val"
+    baz = "baz2val"
+  }
+}
+
+variable "foo" { default = "bar" }
+
+resource "consul_key_prefix" "landscapeTest" {
+  invalid_param = "whoCares"
+}
+
+output "foo_variable" { value = "${var.foo}" }

data/spec/fixtures/landscapeTest/main.tf

@@ -0,0 +1,32 @@
+terraform {
+  required_version = "> 0.9.0"
+  backend "consul" {
+    address = "127.0.0.1:8500"
+    path    = "terraform/landscapeTest"
+  }
+}
+
+provider "consul" {
+  address = "127.0.0.1:8500"
+  version = "1.0.0"
+}
+
+locals {
+  keys = {
+    foo = "foo2val"
+    bar = "bar2val"
+    baz = "baz2val"
+  }
+}
+
+variable "foo" { default = "bar" }
+
+resource "consul_key_prefix" "landscapeTest" {
+  path_prefix = "landscapeTest/"
+
+  subkeys = {
+    foo = "${jsonencode(local.keys)}"
+  }
+}
+
+output "foo_variable" { value = "${var.foo}" }

data/spec/fixtures/landscapeTest/state.json

@@ -0,0 +1,43 @@
+{
+    "version": 3,
+    "terraform_version": "0.11.2",
+    "serial": 1,
+    "lineage": "2bab32f5-67fc-4210-8a74-af61d21a5420",
+    "modules": [
+        {
+            "path": [
+                "root"
+            ],
+            "outputs": {
+                "foo_variable": {
+                    "sensitive": false,
+                    "type": "string",
+                    "value": "bar"
+                }
+            },
+            "resources": {
+                "consul_key_prefix.landscapeTest": {
+                    "type": "consul_key_prefix",
+                    "depends_on": [
+                        "local.keys"
+                    ],
+                    "primary": {
+                        "id": "landscapeTest/",
+                        "attributes": {
+                            "datacenter": "dc1",
+                            "id": "landscapeTest/",
+                            "path_prefix": "landscapeTest/",
+                            "subkeys.%": "1",
+                            "subkeys.foo": "{\"bar\":\"bar2val\",\"baz\":\"baz2val\",\"foo\":\"foo2val\"}"
+                        },
+                        "meta": {},
+                        "tainted": false
+                    },
+                    "deposed": [],
+                    "provider": "provider.consul"
+                }
+            },
+            "depends_on": []
+        }
+    ]
+}

data/spec/fixtures/landscapeTest/with_landscape_default.out

@@ -0,0 +1,45 @@
+Terraform v0.11.2
+
+Your version of Terraform is out of date! The latest version
+is %%TF_LATEST_VER%%. You can update by downloading from www.terraform.io/downloads.html
+terraform_runner command: 'terraform init -input=false' (in %%FIXTUREPATH%%)
+Running with: Terraform v0.11.2
+
+Your version of Terraform is out of date! The latest version
+is %%TF_LATEST_VER%%. You can update by downloading from www.terraform.io/downloads.html
+
+Initializing the backend...
+
+Successfully configured the backend "consul"! Terraform will automatically
+use this backend unless the backend configuration changes.
+
+Initializing provider plugins...
+- Checking for available provider plugins on https://releases.hashicorp.com...
+- Downloading plugin for provider "consul" (1.0.0)...
+
+Terraform has been successfully initialized!
+
+You may now begin working with Terraform. Try running "terraform plan" to see
+any changes that are required for your infrastructure. All Terraform commands
+should now work.
+
+If you ever set or change modules or backend configuration for Terraform,
+rerun this command to reinitialize your working directory. If you forget, other
+commands will detect it and remind you to do so if necessary.
+terraform_runner command 'terraform init -input=false' finished and exited 0
+Terraform vars written to: %%FIXTUREPATH%%/default_build.tfvars.json
+terraform_runner command: 'terraform plan -var-file %%FIXTUREPATH%%/default_build.tfvars.json' (in %%FIXTUREPATH%%)
+Terraform vars:
+terraform_runner command 'terraform plan -var-file %%FIXTUREPATH%%/default_build.tfvars.json' finished and exited 0
+~ consul_key_prefix.landscapeTest
+    subkeys.foo:   {
+                   -  "bar": "barval",
+                   -  "baz": "bazval",
+                   -  "foo": "fooval"
+                   +  "bar": "bar2val",
+                   +  "baz": "baz2val",
+                   +  "foo": "foo2val"
+                    }
+
+Plan: 0 to add, 1 to change, 0 to destroy.
+