tfwrapper 0.4.1 → 0.5.0

data/spec/fixtures/landscapeTest/Rakefile

@@ -0,0 +1,32 @@
+# 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
+)

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"
+}
+
+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.
+

data/spec/fixtures/landscapeTest/with_landscape_dots.out

@@ -0,0 +1,46 @@
+Terraform v0.11.2
+
+Your version of Terraform is out of date! The latest version
+is 0.11.5. You can update by downloading from www.terraform.io/downloads.html
+terraform_runner command: 'terraform init -input=false' (in /home/jantman/manheim/git/github_dot_com/tfwrapper/spec/fixtures/landscapeTest)
+Running with: Terraform v0.11.2
+
+Your version of Terraform is out of date! The latest version
+is 0.11.5. 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: /home/jantman/manheim/git/github_dot_com/tfwrapper/spec/fixtures/landscapeTest/dots_build.tfvars.json
+terraform_runner command: 'terraform plan -var-file /home/jantman/manheim/git/github_dot_com/tfwrapper/spec/fixtures/landscapeTest/dots_build.tfvars.json' (in /home/jantman/manheim/git/github_dot_com/tfwrapper/spec/fixtures/landscapeTest)
+Terraform vars:
+..........................terraform_runner command 'terraform plan -var-file /home/jantman/manheim/git/github_dot_com/tfwrapper/spec/fixtures/landscapeTest/dots_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.
+

data/spec/fixtures/landscapeTest/with_landscape_lines.out

@@ -0,0 +1,71 @@
+Terraform v0.11.2
+
+Your version of Terraform is out of date! The latest version
+is 0.11.5. You can update by downloading from www.terraform.io/downloads.html
+terraform_runner command: 'terraform init -input=false' (in /home/jantman/manheim/git/github_dot_com/tfwrapper/spec/fixtures/landscapeTest)
+Running with: Terraform v0.11.2
+
+Your version of Terraform is out of date! The latest version
+is 0.11.5. 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: /home/jantman/manheim/git/github_dot_com/tfwrapper/spec/fixtures/landscapeTest/lines_build.tfvars.json
+terraform_runner command: 'terraform plan -var-file /home/jantman/manheim/git/github_dot_com/tfwrapper/spec/fixtures/landscapeTest/lines_build.tfvars.json' (in /home/jantman/manheim/git/github_dot_com/tfwrapper/spec/fixtures/landscapeTest)
+Terraform vars:
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+.
+terraform_runner command 'terraform plan -var-file /home/jantman/manheim/git/github_dot_com/tfwrapper/spec/fixtures/landscapeTest/lines_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.
+

data/spec/fixtures/landscapeTest/with_landscape_stream.out

@@ -0,0 +1,71 @@
+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%%/stream_build.tfvars.json
+terraform_runner command: 'terraform plan -var-file %%FIXTUREPATH%%/stream_build.tfvars.json' (in %%FIXTUREPATH%%)
+Terraform vars:
+Refreshing Terraform state in-memory prior to plan...
+The refreshed state will be used to calculate this plan, but will not be
+persisted to local or remote state storage.
+
+consul_key_prefix.landscapeTest: Refreshing state... (ID: landscapeTest/)
+
+------------------------------------------------------------------------
+
+An execution plan has been generated and is shown below.
+Resource actions are indicated with the following symbols:
+  ~ update in-place
+
+Terraform will perform the following actions:
+
+  ~ 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.
+
+------------------------------------------------------------------------
+
+Note: You didn't specify an "-out" parameter to save this plan, so Terraform
+can't guarantee that exactly these actions will be performed if
+"terraform apply" is subsequently run.
+
+terraform_runner command 'terraform plan -var-file %%FIXTUREPATH%%/stream_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.
+

data/spec/fixtures/landscapeTest/without_landscape.out

@@ -0,0 +1,62 @@
+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:
+Refreshing Terraform state in-memory prior to plan...
+The refreshed state will be used to calculate this plan, but will not be
+persisted to local or remote state storage.
+
+
+------------------------------------------------------------------------
+
+An execution plan has been generated and is shown below.
+Resource actions are indicated with the following symbols:
+  + create
+
+Terraform will perform the following actions:
+
+  + consul_key_prefix.landscapeTest
+      id:          <computed>
+      datacenter:  <computed>
+      path_prefix: "landscapeTest/"
+      subkeys.%:   "1"
+      subkeys.foo: "{\"bar\":\"bar2val\",\"baz\":\"baz2val\",\"foo\":\"foo2val\"}"
+
+
+Plan: 1 to add, 0 to change, 0 to destroy.
+
+------------------------------------------------------------------------
+
+Note: You didn't specify an "-out" parameter to save this plan, so Terraform
+can't guarantee that exactly these actions will be performed if
+"terraform apply" is subsequently run.
+
+terraform_runner command 'terraform plan -var-file %%FIXTUREPATH%%/default_build.tfvars.json' finished and exited 0

data/spec/spec_helper.rb

@@ -4,6 +4,13 @@ require 'simplecov'
 require 'simplecov-console'
 require 'rspec_junit_formatter'
 
+begin
+  require 'terraform_landscape'
+  HAVE_LANDSCAPE = true
+rescue LoadError
+  HAVE_LANDSCAPE = false
+end
+
 ENV['CONSUL_ADDR'] ||= '127.0.0.1:8500'
 ENV['CONSUL_URL']  ||= "http://#{ENV['CONSUL_ADDR']}"
 

data/spec/unit/helpers_spec.rb

@@ -54,12 +54,91 @@ describe TFWrapper::Helpers do
         expect(Open3).to receive(:popen2e)
           .once.with('foo bar', chdir: '/foo')
         expect(STDOUT).to receive(:puts).once.with('mystdout')
+        expect(STDOUT).to_not receive(:print)
         expect($stdout).to receive(:sync=).once.with(true)
         expect($stdout).to receive(:sync=).once.with(false)
         expect(TFWrapper::Helpers.run_cmd_stream_output('foo bar', '/foo'))
           .to eq(['mystdout', 0])
       end
     end
+    context 'progress dots' do
+      it 'prints dots and returns output' do
+        dbl_wait_thread = double(Thread)
+        @outerrpipe_w.write('mystdout')
+        @outerrpipe_w.close
+        es = double('exitstatus', exitstatus: 0)
+        allow(dbl_wait_thread).to receive(:value).and_return(es)
+        allow($stdout).to receive(:sync).and_return(false)
+        allow($stdout).to receive(:sync=).with(true)
+        allow(Open3).to receive(:popen2e).and_yield(
+          @inpipe_w, @outerrpipe_r, dbl_wait_thread
+        )
+
+        expect(Open3).to receive(:popen2e)
+          .once.with('foo bar', chdir: '/foo')
+        expect(STDOUT).to receive(:puts).once.with('')
+        expect(STDOUT).to receive(:print).once.with('.')
+        expect($stdout).to receive(:sync=).once.with(true)
+        expect($stdout).to receive(:sync=).once.with(false)
+        expect(
+          TFWrapper::Helpers.run_cmd_stream_output(
+            'foo bar', '/foo', progress: :dots
+          )
+        ).to eq(['mystdout', 0])
+      end
+    end
+    context 'progress lines' do
+      it 'prints a dot per line and returns output' do
+        dbl_wait_thread = double(Thread)
+        @outerrpipe_w.write('mystdout')
+        @outerrpipe_w.close
+        es = double('exitstatus', exitstatus: 0)
+        allow(dbl_wait_thread).to receive(:value).and_return(es)
+        allow($stdout).to receive(:sync).and_return(false)
+        allow($stdout).to receive(:sync=).with(true)
+        allow(Open3).to receive(:popen2e).and_yield(
+          @inpipe_w, @outerrpipe_r, dbl_wait_thread
+        )
+
+        expect(Open3).to receive(:popen2e)
+          .once.with('foo bar', chdir: '/foo')
+        expect(STDOUT).to receive(:puts).once.with('.')
+        expect(STDOUT).to_not receive(:print)
+        expect($stdout).to receive(:sync=).once.with(true)
+        expect($stdout).to receive(:sync=).once.with(false)
+        expect(
+          TFWrapper::Helpers.run_cmd_stream_output(
+            'foo bar', '/foo', progress: :lines
+          )
+        ).to eq(['mystdout', 0])
+      end
+    end
+    context 'progress nil' do
+      it 'does not print anything but returns output' do
+        dbl_wait_thread = double(Thread)
+        @outerrpipe_w.write('mystdout')
+        @outerrpipe_w.close
+        es = double('exitstatus', exitstatus: 0)
+        allow(dbl_wait_thread).to receive(:value).and_return(es)
+        allow($stdout).to receive(:sync).and_return(false)
+        allow($stdout).to receive(:sync=).with(true)
+        allow(Open3).to receive(:popen2e).and_yield(
+          @inpipe_w, @outerrpipe_r, dbl_wait_thread
+        )
+
+        expect(Open3).to receive(:popen2e)
+          .once.with('foo bar', chdir: '/foo')
+        expect(STDOUT).to_not receive(:puts)
+        expect(STDOUT).to_not receive(:print)
+        expect($stdout).to receive(:sync=).once.with(true)
+        expect($stdout).to receive(:sync=).once.with(false)
+        expect(
+          TFWrapper::Helpers.run_cmd_stream_output(
+            'foo bar', '/foo', progress: nil
+          )
+        ).to eq(['mystdout', 0])
+      end
+    end
     context 'IOError' do
       it 'handles IOErrors gracefully' do
         dbl_wait_thread = double(Thread)
@@ -106,6 +185,29 @@ describe TFWrapper::Helpers do
           .to eq(["mystdout\nSTDERR\n", 23])
       end
     end
+    context 'invalid :progress option' do
+      it 'raises an error' do
+        dbl_wait_thread = double(Thread)
+        @outerrpipe_w.write('mystdout')
+        @outerrpipe_w.close
+        es = double('exitstatus', exitstatus: 0)
+        allow(dbl_wait_thread).to receive(:value).and_return(es)
+        allow($stdout).to receive(:sync).and_return(false)
+        allow($stdout).to receive(:sync=).with(true)
+        allow(Open3).to receive(:popen2e).and_yield(
+          @inpipe_w, @outerrpipe_r, dbl_wait_thread
+        )
+
+        expect(Open3).to_not receive(:popen2e)
+        expect(STDOUT).to_not receive(:puts)
+        expect($stdout).to_not receive(:sync=)
+        expect do
+          TFWrapper::Helpers.run_cmd_stream_output(
+            'foo bar', '/foo', progress: :foo
+          )
+        end.to raise_error(ArgumentError, /progress option must be one of/)
+      end
+    end
   end
   describe '#check_env_vars' do
     it 'returns nil if vars present' do