terraspace 0.4.0 → 0.5.0

data/lib/terraspace/shell.rb

@@ -6,8 +6,6 @@ module Terraspace
 
     def initialize(mod, command, options={})
       @mod, @command, @options = mod, command, options
-      # error_messages holds aggregation of all error lines
-      @known_error, @error_messages = nil, ''
     end
 
     # requires @mod to be set
@@ -33,9 +31,9 @@ module Terraspace
       Open3.popen3(env, @command, chdir: @mod.cache_dir) do |stdin, stdout, stderr, wait_thread|
         mimic_terraform_input(stdin, stdout)
         while err = stderr.gets
-          @error_messages << err # aggregate all error lines
-          @known_error ||= known_error_type(err)
-          unless @known_error
+          @error ||= Error.new
+          @error.lines << err # aggregate all error lines
+          unless @error.known?
             # Sometimes may print a "\e[31m\n" which like during dependencies fetcher init
             # suppress it so dont get a bunch of annoying "newlines"
             next if err == "\e[31m\n" && @options[:suppress_error_color]
@@ -48,38 +46,12 @@ module Terraspace
       end
     end
 
-    def known_error_type(err)
-      if reinit_required?(err)
-        :reinit_required
-      elsif bucket_not_found?(err)
-        :bucket_not_found
-      end
-    end
-
-    def bucket_not_found?(err)
-      # Message is included in aws, azurerm, and google. See: https://bit.ly/3iOKDri
-      err.include?("Failed to get existing workspaces")
-    end
-
-    def reinit_required?(err)
-      # Example error: https://gist.github.com/tongueroo/f7e0a44b64f0a2e533089b18f331c21e
-      squeezed = @error_messages.gsub("\n", ' ').squeeze(' ') # remove double whitespaces and newlines
-      general_check = squeezed.include?("terraform init") && squeezed.include?("Error:")
-
-      general_check ||
-      err.include?("reinitialization required") ||
-      err.include?("terraform init") ||
-      err.include?("require reinitialization")
-    end
-
     def exit_status(status)
       return if status == 0
 
       exit_on_fail = @options[:exit_on_fail].nil? ? true : @options[:exit_on_fail]
-      if @known_error == :reinit_required
-        raise InitRequiredError.new(@error_messages)
-      elsif @known_error == :bucket_not_found
-        raise BucketNotFoundError.new(@error_messages)
+      if @error && @error.known?
+        raise @error.instance
       elsif exit_on_fail
         logger.error "Error running command: #{@command}".color(:red)
         exit status

data/lib/terraspace/shell/error.rb

@@ -0,0 +1,46 @@
+class Terraspace::Shell
+  class Error
+    attr_accessor :lines
+    def initialize
+      @lines = '' # holds aggregation of all error lines
+    end
+
+    def known?
+      !!instance
+    end
+
+    def instance
+      if reinit_required?
+        Terraspace::InitRequiredError.new(@lines)
+      elsif bucket_not_found?
+        Terraspace::BucketNotFound.new(@lines)
+      elsif shared_cache_error?
+        Terraspace::SharedCacheError.new(@lines)
+      end
+    end
+
+    def bucket_not_found?
+      # Message is included in aws, azurerm, and google. See: https://bit.ly/3iOKDri
+      message.include?("Failed to get existing workspaces")
+    end
+
+    def reinit_required?
+      # Example error: https://gist.github.com/tongueroo/f7e0a44b64f0a2e533089b18f331c21e
+      general_check = message.include?("terraform init") && message.include?("Error:")
+      general_check ||
+      message.include?("reinitialization required") ||
+      message.include?("terraform init") ||
+      message.include?("require reinitialization")
+    end
+
+    def message
+      @lines.gsub("\n", ' ').squeeze(' ') # remove double whitespaces and newlines
+    end
+
+    def shared_cache_error?
+      # Example: https://gist.github.com/tongueroo/4f2c925709d21f5810229ce9ca482560
+      message.include?("Failed to install provider from shared cache") ||
+      message.include?("Failed to validate installed provider")
+    end
+  end
+end

data/lib/terraspace/terraform/args/custom.rb

@@ -7,13 +7,12 @@ module Terraspace::Terraform::Args
     attr_accessor :name
     def initialize(mod, name)
       @mod, @name = mod, name
-      @file = "#{Terraspace.root}/config/args/terraform.rb"
       @commands = {}
     end
 
     def build
-      return @commands unless File.exist?(@file)
-      evaluate_file(@file)
+      evaluate_file("#{Terraspace.root}/config/args/terraform.rb")
+      evaluate_file("#{@mod.root}/config/args/terraform.rb")
       @commands.deep_stringify_keys!
     end
     memoize :build

data/lib/terraspace/terraform/args/default.rb

@@ -26,7 +26,7 @@ module Terraspace::Terraform::Args
         args << var_files.map { |f| "-var-file #{Dir.pwd}/#{f}" }.join(' ')
       end
 
-      args << input_option if input_option
+      args << input_option
 
       # must be at the end
       plan = @options[:plan]
@@ -45,27 +45,17 @@ module Terraspace::Terraform::Args
     end
 
     def input_option
-      option = nil
-      if @options[:auto] && @options[:input].nil?
-        option = " -input=false"
-      end
-      unless @options[:input].nil?
-        input = @options[:input] ? "true" : "false"
-        option = " -input=#{input}" # = sign required for apply when there's a plan at the end. so input=false works input false doesnt
-      end
-      option
+      option = if @options[:auto]
+                 "false"
+               else
+                 @options[:input] ? @options[:input] : "false"
+               end
+      " -input=#{option}"
     end
 
     def init_args
       args = "-get"
-      if @options[:auto] && @options[:input].nil?
-        args << " -input=false"
-      end
-      unless @options[:input].nil?
-        input = @options[:input] ? "true" : "false"
-        args << " -input=#{input}"
-      end
-
+      args << input_option
       args << " -reconfigure" if @options[:reconfigure]
 
       # must be at the end
@@ -86,7 +76,7 @@ module Terraspace::Terraform::Args
 
     def plan_args
       args = []
-      args << input_option if input_option
+      args << input_option
       args << "-destroy" if @options[:destroy]
       args << "-out #{expanded_out}" if @options[:out]
       args

data/lib/terraspace/terraform/runner.rb

@@ -8,7 +8,6 @@ module Terraspace::Terraform
     def initialize(name, options={})
       @name = name
       super(options)
-      @retries = 1
     end
 
     def run
@@ -21,24 +20,17 @@ module Terraspace::Terraform
       current_dir_message # only show once
 
       params = args.flatten.join(' ')
-      command = "terraform #{name} #{params}"
+      command = "terraform #{name} #{params}".squish
       run_hooks("terraform.rb", name) do
         Terraspace::Shell.new(@mod, command, @options.merge(env: custom.env_vars)).run
       end
-    rescue Terraspace::InitRequiredError => e
-      logger.info "Terraform reinitialization required detected. Will run `terraform init` and try again."
-      logger.debug "Retry attempt: #{@retries}"
-      logger.debug "#{e.class}"
-      Runner.new("init", @options).run
-      if @retries <= 3
-        backoff = 2 ** @retries # 2, 4, 8
-        logger.debug "Waiting #{backoff}s before retrying"
-        sleep(backoff)
-        @retries += 1
+    rescue Terraspace::SharedCacheError, Terraspace::InitRequiredError
+      @retryer ||= Retryer.new(@mod, @options, name, $!)
+      if @retryer.retry?
+        @retryer.run
         retry
       else
-        logger.info "ERROR: #{e.message}"
-        exit 1
+        exit(1)
       end
     end
 

data/lib/terraspace/terraform/runner/retryer.rb

@@ -0,0 +1,69 @@
+class Terraspace::Terraform::Runner
+  class Retryer
+    include Terraspace::Util::Logging
+    include Terraspace::Util::Pretty
+
+    def initialize(mod, options, command_name, exception)
+      @mod, @options, @command_name, @exception = mod, options, command_name, exception
+      @retries = 1
+    end
+
+    def retry?
+      if @retries <= 3 && !@stop_retrying
+        true # will retry
+      else
+        logger.info "ERROR: #{@exception.message}"
+        false # will not retry
+      end
+    end
+
+    def run
+      backoff = 2 ** @retries # 2, 4, 8
+      logger.debug "Waiting #{backoff}s before retrying"
+      sleep(backoff)
+      @retries += 1
+
+      case @exception
+      when Terraspace::SharedCacheError
+        shared_cache_error
+      when Terraspace::InitRequiredError
+        init_required_error
+      end
+    end
+
+    def shared_cache_error
+      logger.info "Terraform Shared Cache error detected. Will purge caches and run `terraform init` to try again."
+      logger.debug "Retry attempt: #{@retries}"
+      logger.debug "#{@exception.class}"
+      logger.debug "#{@exception.message}"
+      if Terraspace.config.terraform.plugin_cache.purge_on_error # Purging the cache "fixes" this terraform bug
+        purge_caches
+        reinit
+      else
+        @stop_retrying = true
+      end
+    end
+
+    def init_required_error
+      logger.info "Terraform reinitialization required detected. Will run `terraform init` and try again."
+      logger.debug "Retry attempt: #{@retries}"
+      logger.debug "#{@exception.class}"
+      reinit
+    end
+
+    def reinit
+      Terraspace::Terraform::Runner.new("init", @options).run unless @command_name == "init"
+    end
+
+    def purge_caches
+      dir = "#{@mod.cache_dir}/.terraform"
+      logger.info "Purging #{pretty_path(dir)}"
+      FileUtils.rm_rf(dir)
+
+      dir = "#{Terraspace.config.terraform.plugin_cache.dir}"
+      logger.info "Purging #{pretty_path(dir)}"
+      FileUtils.rm_rf(dir)
+      FileUtils.mkdir_p(dir) # need /tmp/terraspace/plugin_cache dir to exist
+    end
+  end
+end

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/terraspace/terraform/args/custom_spec.rb

@@ -10,17 +10,18 @@ describe Terraspace::Terraform::Args::Custom do
     let(:file) { fixture("terraform/args/single.rb") }
     let(:name) { "apply" }
     it "build creates the @commands structure" do
+      custom.evaluate_file(file)
       commands = custom.build
       expect(commands.keys).to include("apply")
     end
 
     it "args" do
-      custom.build
+      custom.evaluate_file(file)
       expect(custom.args).to eq(["-lock-timeout=20m"])
     end
 
     it "var_files" do
-      custom.build
+      custom.evaluate_file(file)
       allow(custom).to receive(:var_file_exist?).and_return(true)
       expect(custom.var_files).to eq(["-var-file=a.tfvars", "-var-file=b.tfvars"])
     end
@@ -30,17 +31,18 @@ describe Terraspace::Terraform::Args::Custom do
     let(:file) { fixture("terraform/args/multiple.rb") }
     let(:name) { "apply" }
     it "build creates the @commands structure" do
+      custom.evaluate_file(file)
       commands = custom.build
       expect(commands.keys).to include("apply")
     end
 
     it "args" do
-      custom.build
+      custom.evaluate_file(file)
       expect(custom.args).to eq(["-lock-timeout=20m"])
     end
 
     it "var_files" do
-      custom.build
+      custom.evaluate_file(file)
       allow(custom).to receive(:var_file_exist?).and_return(true)
       expect(custom.var_files).to eq([])
     end

data/terraspace.gemspec

@@ -34,10 +34,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "zeitwerk"
 
   # core baseline plugins
-  spec.add_dependency "terraspace_plugin_aws", "~> 0.2.0"
-  spec.add_dependency "terraspace_plugin_azurerm", "~> 0.2.0"
-  spec.add_dependency "terraspace_plugin_google", "~> 0.2.0"
-  spec.add_dependency "rspec-terraspace"
+  spec.add_dependency "terraspace_plugin_aws", "~> 0.3.0"
+  spec.add_dependency "terraspace_plugin_azurerm", "~> 0.3.0"
+  spec.add_dependency "terraspace_plugin_google", "~> 0.3.0"
+  spec.add_dependency "rspec-terraspace", "~> 0.2.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-18 00:00:00.000000000 Z
+date: 2020-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -212,56 +212,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: terraspace_plugin_azurerm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: terraspace_plugin_google
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rspec-terraspace
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -385,7 +385,10 @@ files:
 - README.md
 - Rakefile
 - exe/terraspace
+- lib/templates/base/arg/terraform.rb.tt
 - lib/templates/base/git_hook/hook.sh
+- lib/templates/base/helper/%name%_helper.rb.tt
+- lib/templates/base/hook/%kind%.rb.tt
 - lib/templates/base/project/.gitignore
 - lib/templates/base/project/Gemfile.tt
 - lib/templates/base/project/README.md
@@ -481,6 +484,7 @@ files:
 - lib/terraspace/cli/help.rb
 - lib/terraspace/cli/help/all/down.md
 - lib/terraspace/cli/help/all/graph.md
+- lib/terraspace/cli/help/all/init.md
 - lib/terraspace/cli/help/all/output.md
 - lib/terraspace/cli/help/all/plan.md
 - lib/terraspace/cli/help/all/providers.md
@@ -509,16 +513,17 @@ files:
 - lib/terraspace/cli/help/logs.md
 - lib/terraspace/cli/help/logs/remove.md
 - lib/terraspace/cli/help/logs/truncate.md
-- lib/terraspace/cli/help/new/bootstrap_test.md
+- lib/terraspace/cli/help/new/arg.md
 - lib/terraspace/cli/help/new/example.md
 - lib/terraspace/cli/help/new/git_hook.md
+- lib/terraspace/cli/help/new/helper.md
+- lib/terraspace/cli/help/new/hook.md
 - lib/terraspace/cli/help/new/module.md
-- lib/terraspace/cli/help/new/module_test.md
 - lib/terraspace/cli/help/new/plugin.md
 - lib/terraspace/cli/help/new/project.md
-- lib/terraspace/cli/help/new/project_test.md
 - lib/terraspace/cli/help/new/shim.md
 - lib/terraspace/cli/help/new/stack.md
+- lib/terraspace/cli/help/new/test.md
 - lib/terraspace/cli/help/output.md
 - lib/terraspace/cli/help/plan.md
 - lib/terraspace/cli/help/providers.md
@@ -535,9 +540,12 @@ files:
 - lib/terraspace/cli/logs.rb
 - lib/terraspace/cli/logs/concern.rb
 - lib/terraspace/cli/new.rb
+- lib/terraspace/cli/new/arg.rb
 - lib/terraspace/cli/new/git_hook.rb
 - lib/terraspace/cli/new/helper.rb
-- lib/terraspace/cli/new/helper/plugin_gem.rb
+- lib/terraspace/cli/new/helpers.rb
+- lib/terraspace/cli/new/helpers/plugin_gem.rb
+- lib/terraspace/cli/new/hook.rb
 - lib/terraspace/cli/new/module.rb
 - lib/terraspace/cli/new/plugin.rb
 - lib/terraspace/cli/new/plugin/helper.rb
@@ -548,10 +556,7 @@ files:
 - lib/terraspace/cli/new/source/plugin.rb
 - lib/terraspace/cli/new/source/test.rb
 - lib/terraspace/cli/new/stack.rb
-- lib/terraspace/cli/new/test/base.rb
-- lib/terraspace/cli/new/test/bootstrap.rb
-- lib/terraspace/cli/new/test/module.rb
-- lib/terraspace/cli/new/test/project.rb
+- lib/terraspace/cli/new/test.rb
 - lib/terraspace/cli/seed.rb
 - lib/terraspace/cli/summary.rb
 - lib/terraspace/cli/test.rb
@@ -589,6 +594,7 @@ files:
 - lib/terraspace/compiler/erb/helpers.rb
 - lib/terraspace/compiler/erb/render.rb
 - lib/terraspace/compiler/expander.rb
+- lib/terraspace/compiler/helper_extender.rb
 - lib/terraspace/compiler/strategy/abstract_base.rb
 - lib/terraspace/compiler/strategy/mod.rb
 - lib/terraspace/compiler/strategy/mod/base.rb
@@ -629,6 +635,7 @@ files:
 - lib/terraspace/plugin/expander/generic.rb
 - lib/terraspace/plugin/expander/interface.rb
 - lib/terraspace/plugin/finder.rb
+- lib/terraspace/plugin/helper/interface.rb
 - lib/terraspace/plugin/infer_provider.rb
 - lib/terraspace/plugin/layer/interface.rb
 - lib/terraspace/plugin/meta.rb
@@ -638,6 +645,7 @@ files:
 - lib/terraspace/seeder/content.rb
 - lib/terraspace/seeder/where.rb
 - lib/terraspace/shell.rb
+- lib/terraspace/shell/error.rb
 - lib/terraspace/terraform/api.rb
 - lib/terraspace/terraform/api/base.rb
 - lib/terraspace/terraform/api/client.rb
@@ -669,6 +677,7 @@ files:
 - lib/terraspace/terraform/remote_state/output_proxy.rb
 - lib/terraspace/terraform/remote_state/unresolved.rb
 - lib/terraspace/terraform/runner.rb
+- lib/terraspace/terraform/runner/retryer.rb
 - lib/terraspace/tester.rb
 - lib/terraspace/tester/finder.rb
 - lib/terraspace/tester/meta.rb
@@ -825,7 +834,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: 'Terraspace: The Terraspace Framework'