tfwrapper 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a409c24d94dc580e26177dffa66ee8fcda8dae2
-  data.tar.gz: cd17b03ffbd735a4b684e9fe7fcd280856f94c07
+  metadata.gz: 68a638cd8db6246d0a17096f0b8bc125166772ea
+  data.tar.gz: 05301d7bfcc0a75562b8036e657cf610d4aa55a4
 SHA512:
-  metadata.gz: 2494aca6b7e544589c582c6cc85b563423dd0c88eb0746eb07b0721380061f8aeef810d29a2cb14fda3489ace4dc6e5befa9768ee40bae568e428c9086edc13b
-  data.tar.gz: f6f2ce058a1739f12aaabfdbba0d9b0c2eee0bf7c7965fa76f83eb81d04a40ad8c8a016020eba92e79d43ed6cde84a18b7889d6436357fade5dc4b82e7155bf2
+  metadata.gz: 23f2edc392399b115ad02465a1b3b9fad6d6c37b633e4bcc6ea8463799c3af4c641f00828b0eb6879e380abe48ca3c38a8ee21ce8bf96b677f069f0adede586d
+  data.tar.gz: 72af330049aab08bfb69c539985bb9dc0c2ef5b13c57b02ae682c77468410b4880672407d3b84e420d6858248c2f98cdd822fc0fa51d3a23fa77482a3ec0d66c

data/.travis.yml

@@ -50,13 +50,13 @@ matrix:
     name: "ruby-2.3 acceptance TF 0.11.2"
   - rvm: 2.3
     install: bundle install
-    script: bundle exec rake spec:acceptance TF_VERSION=latest
-    name: "ruby-2.3 acceptance TF latest"
+    script: bundle exec rake spec:acceptance TF_VERSION=0.11.14
+    name: "ruby-2.3 acceptance TF 0.11.14"
   - rvm: 2.4
     install: bundle install
     script: bundle exec rake spec:unit
     name: "ruby-2.4 unit"
   - rvm: 2.4
     install: bundle install
-    script: bundle exec rake spec:acceptance TF_VERSION=latest
-    name: "ruby-2.4 acceptance TF latest"
+    script: bundle exec rake spec:acceptance TF_VERSION=0.11.14
+    name: "ruby-2.4 acceptance TF 0.11.14"

data/ChangeLog.md

@@ -1,3 +1,8 @@
+Version 0.6.1
+
+  - Add ``allowed_empty_vars`` option.
+  - Only support terraform up to 0.11.14.
+
 Version 0.6.0
 
   - Include full terraform output when a terraform run fails with output including ``hrottling``, ``status code: 403``, or ``status code: 401``. Previously terraform output was suppressed in these cases, which causes confusion with providers other than "aws" that include these strings in their failure output.

data/README.md

@@ -4,7 +4,7 @@ Build of master branch: [![TravisCI](https://api.travis-ci.org/manheim/tfwrapper
 
 Documentation: [http://www.rubydoc.info/gems/tfwrapper/](http://www.rubydoc.info/gems/tfwrapper/)
 
-tfwrapper provides Rake tasks for working with [Hashicorp Terraform](https://www.terraform.io/) 0.9+, ensuring proper initialization and passing in variables from the environment or Ruby, as well as optionally pushing some information to Consul. tfwrapper also attempts to detect and retry
+tfwrapper provides Rake tasks for working with [Hashicorp Terraform](https://www.terraform.io/) 0.9 through 0.11, ensuring proper initialization and passing in variables from the environment or Ruby, as well as optionally pushing some information to Consul. tfwrapper also attempts to detect and retry
 failed runs due to AWS throttling or access denied errors.
 
 ## Overview
@@ -44,12 +44,12 @@ with 1.9.3 is simply too high to justify.
 Add to your ``Gemfile``:
 
 ```ruby
-gem 'tfwrapper', '~> 0.5.1'
+gem 'tfwrapper', '~> 0.6.1'
 ```
 
 ### Supported Terraform Versions
 
-tfwrapper only supports terraform 0.9+. It is tested against multiple versions from 0.9.2 to 0.10.2 and the current release.
+tfwrapper only supports terraform 0.9-0.11. It is tested against multiple versions from 0.9.2 to 0.11.14.
 
 ### Terraform Landscape
 
@@ -147,6 +147,10 @@ TFWrapper::RakeTasks.install_tasks(
 )
 ```
 
+These variables are tested to be set in the environment with a non-empty value, and will raise an error if any are
+missing or empty. If some should be allowed to be missing or empty empty, pass a ``allowed_empty_vars`` list with
+their environment variable names.
+
 ### Ruby Variables to Terraform Variables
 
 If you wish to explicitly bind values from your Ruby code to terraform variables, you can do this with

data/lib/tfwrapper/helpers.rb

@@ -78,9 +78,12 @@ module TFWrapper
     # non-empty. Raise StandardError if any aren't.
     #
     # @param required [Array] list of required environment variables
-    def self.check_env_vars(required)
+    # @param allowed_missing [Array] list of environment variables to allow to
+    #  be empty or missing.
+    def self.check_env_vars(required, allowed_missing)
       missing = []
       required.each do |name|
+        next if allowed_missing.include?(name)
         if !ENV.include?(name)
           puts "ERROR: Environment variable '#{name}' must be set."
           missing << name

data/lib/tfwrapper/raketasks.rb

@@ -55,6 +55,8 @@ module TFWrapper
     #   configurations in the same Rakefile.
     # @option opts [Hash] :tf_vars_from_env hash of Terraform variables to the
     #   (required) environment variables to populate their values from
+    # @option opts [Hash] :allowed_empty_vars array of environment variable
+    #   names (specified in :tf_vars_from_env) to allow to be empty or missing.
     # @option opts [Hash] :tf_extra_vars hash of Terraform variables to their
     #   values; overrides any same-named keys in ``tf_vars_from_env``
     # @option opts [String] :consul_url URL to access Consul at, for the
@@ -96,6 +98,7 @@ module TFWrapper
       @ns_prefix = opts.fetch(:namespace_prefix, nil)
       @consul_env_vars_prefix = opts.fetch(:consul_env_vars_prefix, nil)
       @tf_vars_from_env = opts.fetch(:tf_vars_from_env, {})
+      @allowed_empty_vars = opts.fetch(:allowed_empty_vars, [])
       @tf_extra_vars = opts.fetch(:tf_extra_vars, {})
       @backend_config = opts.fetch(:backend_config, {})
       @consul_url = opts.fetch(:consul_url, nil)
@@ -162,7 +165,9 @@ module TFWrapper
         desc 'Run terraform init with appropriate arguments'
         task :init do |t|
           @before_proc.call(t.name, @tf_dir) unless @before_proc.nil?
-          TFWrapper::Helpers.check_env_vars(@tf_vars_from_env.values)
+          TFWrapper::Helpers.check_env_vars(
+            @tf_vars_from_env.values, @allowed_empty_vars
+          )
           @tf_version = check_tf_version
           cmd = [
             'terraform',

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.6.0'
+  VERSION = '0.6.1'
 end

data/spec/unit/helpers_spec.rb

@@ -213,10 +213,16 @@ describe TFWrapper::Helpers do
     it 'returns nil if vars present' do
       ENV['foo'] = 'fooval'
       ENV['bar'] = 'barval'
-      expect(TFWrapper::Helpers.check_env_vars(%w[foo bar])).to be_nil
+      expect(TFWrapper::Helpers.check_env_vars(%w[foo bar], [])).to be_nil
       ENV.delete('foo')
       ENV.delete('bar')
     end
+    it 'returns nil if vars ignored' do
+      ENV['foo'] = ''
+      expect(TFWrapper::Helpers.check_env_vars(%w[foo bar], %w[foo bar]))
+        .to be_nil
+      ENV.delete('foo')
+    end
     it 'exits if not present' do
       ENV.delete('foo')
       ENV.delete('bar')
@@ -224,7 +230,7 @@ describe TFWrapper::Helpers do
         .with('ERROR: Environment variable \'foo\' must be set.')
       expect(STDOUT).to receive(:puts)
         .with('ERROR: Environment variable \'bar\' must be set.')
-      expect { TFWrapper::Helpers.check_env_vars(%w[foo bar]) }
+      expect { TFWrapper::Helpers.check_env_vars(%w[foo bar], %w[baz]) }
         .to raise_error StandardError, 'Missing or empty environment ' \
           'variables: ["foo", "bar"]'
     end
@@ -235,11 +241,31 @@ describe TFWrapper::Helpers do
         .with("ERROR: Environment variable 'foo' must not be empty.")
       expect(STDOUT).to receive(:puts)
         .with("ERROR: Environment variable 'bar' must not be empty.")
-      expect { TFWrapper::Helpers.check_env_vars(%w[foo bar]) }
+      expect { TFWrapper::Helpers.check_env_vars(%w[foo bar], %w[baz]) }
         .to raise_error StandardError, 'Missing or empty environment ' \
           'variables: ["foo", "bar"]'
       ENV.delete('foo')
       ENV.delete('bar')
     end
+    it 'exits if not present and partially ignored' do
+      ENV.delete('foo')
+      ENV.delete('bar')
+      expect(STDOUT).to receive(:puts)
+        .with('ERROR: Environment variable \'foo\' must be set.')
+      expect { TFWrapper::Helpers.check_env_vars(%w[foo bar], %w[bar]) }
+        .to raise_error StandardError, 'Missing or empty environment ' \
+          'variables: ["foo"]'
+    end
+    it 'exits if empty and partially ignored' do
+      ENV['foo'] = ''
+      ENV['bar'] = '    '
+      expect(STDOUT).to receive(:puts)
+        .with("ERROR: Environment variable 'foo' must not be empty.")
+      expect { TFWrapper::Helpers.check_env_vars(%w[foo bar], %w[bar]) }
+        .to raise_error StandardError, 'Missing or empty environment ' \
+          'variables: ["foo"]'
+      ENV.delete('foo')
+      ENV.delete('bar')
+    end
   end
 end

data/spec/unit/raketasks_spec.rb

@@ -59,6 +59,7 @@ describe TFWrapper::RakeTasks do
       expect(cls.instance_variable_get('@tf_dir')).to eq('/rake/dir/tfdir')
       expect(cls.instance_variable_get('@consul_env_vars_prefix')).to eq(nil)
       expect(cls.instance_variable_get('@tf_vars_from_env')).to eq({})
+      expect(cls.instance_variable_get('@allowed_empty_vars')).to eq([])
       expect(cls.instance_variable_get('@tf_extra_vars')).to eq({})
       expect(cls.instance_variable_get('@backend_config')).to eq({})
       expect(cls.instance_variable_get('@consul_url')).to eq(nil)
@@ -87,6 +88,7 @@ describe TFWrapper::RakeTasks do
         'tf/dir',
         consul_env_vars_prefix: 'cvprefix',
         tf_vars_from_env: { 'foo' => 'bar' },
+        allowed_empty_vars: %w[bar blam],
         tf_extra_vars: { 'baz' => 'blam' },
         consul_url: 'foobar',
         before_proc: bproc,
@@ -100,6 +102,8 @@ describe TFWrapper::RakeTasks do
         .to eq('cvprefix')
       expect(cls.instance_variable_get('@tf_vars_from_env'))
         .to eq('foo' => 'bar')
+      expect(cls.instance_variable_get('@allowed_empty_vars'))
+        .to eq(%w[bar blam])
       expect(cls.instance_variable_get('@tf_extra_vars'))
         .to eq('baz' => 'blam')
       expect(cls.instance_variable_get('@backend_config')).to eq({})
@@ -317,6 +321,7 @@ describe TFWrapper::RakeTasks do
         .to eq(Gem::Version.new('0.0.0'))
       vars = { foo: 'bar', baz: 'blam' }
       subject.instance_variable_set('@tf_vars_from_env', vars)
+      subject.instance_variable_set('@allowed_empty_vars', ['bar'])
       allow(TFWrapper::Helpers).to receive(:check_env_vars)
       allow(ENV).to receive(:[])
       subject.instance_variable_set(
@@ -329,7 +334,7 @@ describe TFWrapper::RakeTasks do
       allow(subject).to receive(:check_tf_version)
         .and_return(Gem::Version.new('0.9.5'))
       expect(TFWrapper::Helpers)
-        .to receive(:check_env_vars).once.ordered.with(vars.values)
+        .to receive(:check_env_vars).once.ordered.with(vars.values, ['bar'])
       expect(subject).to receive(:check_tf_version).once.ordered
       expect(subject).to receive(:terraform_runner).once.ordered
         .with('terraform init -input=false '\
@@ -351,7 +356,7 @@ describe TFWrapper::RakeTasks do
       allow(subject).to receive(:check_tf_version)
         .and_return(Gem::Version.new('0.10.2'))
       expect(TFWrapper::Helpers)
-        .to receive(:check_env_vars).once.ordered.with(vars.values)
+        .to receive(:check_env_vars).once.ordered.with(vars.values, [])
       expect(subject).to receive(:check_tf_version).once.ordered
       expect(subject).to receive(:terraform_runner).once.ordered
         .with('terraform init -input=false')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tfwrapper
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - jantman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2020-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retries
@@ -421,7 +421,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Rake tasks for running Hashicorp Terraform sanely