terraspace 0.3.6 → 0.4.4

data/lib/terraspace/hooks/builder.rb

@@ -0,0 +1,52 @@
+module Terraspace::Hooks
+  class Builder
+    extend Memoist
+    include Dsl
+    include DslEvaluator
+    include Terraspace::Util
+
+    # IE: dsl_file: config/hooks/terraform.rb
+    attr_accessor :name
+    def initialize(mod, dsl_file, name)
+      @mod, @dsl_file, @name = mod, dsl_file, name
+      @hooks = {before: {}, after: {}}
+    end
+
+    def build
+      return @hooks unless File.exist?(@dsl_file)
+      evaluate_file(@dsl_file)
+      @hooks.deep_stringify_keys!
+    end
+    memoize :build
+
+    def run_hooks
+      build
+      run_each_hook("before")
+      out = yield if block_given?
+      run_each_hook("after")
+      out
+    end
+
+    def run_each_hook(type)
+      hooks = @hooks.dig(type, @name) || []
+      hooks.each do |hook|
+        run_hook(type, hook)
+      end
+    end
+
+    def run_hook(type, hook)
+      return unless run?(hook)
+
+      command = File.basename(@dsl_file).sub('.rb','') # IE: kubes, kubectl, docker
+      id = "#{command} #{type} #{@name}"
+      label = " label: #{hook["label"]}" if hook["label"]
+      logger.info  "Running #{id} hook.#{label}"
+      logger.debug "Hook options: #{hook}"
+      Runner.new(@mod, hook).run
+    end
+
+    def run?(hook)
+      !!hook["execute"]
+    end
+  end
+end

data/lib/terraspace/hooks/concern.rb

@@ -0,0 +1,9 @@
+module Terraspace::Hooks
+  module Concern
+    def run_hooks(dsl_file, name, &block)
+      hooks = Builder.new(@mod, "#{Terraspace.root}/config/hooks/#{dsl_file}", name)
+      hooks.build # build hooks
+      hooks.run_hooks(&block)
+    end
+  end
+end

data/lib/terraspace/{terraform/hooks → hooks}/dsl.rb

@@ -1,4 +1,4 @@
-module Terraspace::Terraform::Hooks
+module Terraspace::Hooks
   module Dsl
     def before(*commands, **props)
       commands.each do |name|
@@ -13,7 +13,8 @@ module Terraspace::Terraform::Hooks
     end
 
     def each_hook(type, name, props={})
-      @hooks[type][name] = props
+      @hooks[type][name] ||= []
+      @hooks[type][name] << props
     end
   end
 end

data/lib/terraspace/hooks/runner.rb

@@ -0,0 +1,23 @@
+module Terraspace::Hooks
+  class Runner
+    include Terraspace::Util
+
+    def initialize(mod, hook)
+      @mod, @hook = mod, hook
+      @execute = @hook["execute"]
+    end
+
+    def run
+      case @execute
+      when String
+        Terraspace::Shell.new(@mod, @execute, exit_on_fail: @hook["exit_on_fail"]).run
+      when -> (e) { e.respond_to?(:public_instance_methods) && e.public_instance_methods.include?(:call) }
+        @execute.new.call
+      when -> (e) { e.respond_to?(:call) }
+        @execute.call
+      else
+        logger.warn "WARN: execute option not set for hook: #{@hook.inspect}"
+      end
+    end
+  end
+end

data/lib/terraspace/mod.rb

@@ -34,8 +34,17 @@ module Terraspace
       Terraspace.check_project!
       return if root
 
-      pretty_paths = paths.map { |p| Terraspace::Util.pretty_path(p) }
-      logger.error "ERROR: Unable to find #{@name.color(:green)} module. Searched paths: #{pretty_paths}"
+      pretty_paths = paths.map { |p| Terraspace::Util.pretty_path(p) }.join(", ")
+      logger.error <<~EOL
+        ERROR: Unable to find #{@name.color(:green)}. Searched paths:
+
+            #{pretty_paths}
+
+        To see available stacks, try running:
+
+            terraspace list
+
+      EOL
       ENV['TS_TEST'] ? raise : exit(1)
     end
 

data/lib/terraspace/plugin/summary/interface.rb

@@ -64,7 +64,9 @@ module Terraspace::Plugin::Summary
 
     def show_each(path)
       data = JSON.load(IO.read(path))
+      return unless data # edge case: blank file
       resources = data['resources']
+      return unless resources
       remove_statefile(path) if resources && resources.size == 0 && !ENV['TS_KEEP_EMPTY_STATEFILES']
       return unless resources && resources.size > 0
 
@@ -75,7 +77,7 @@ module Terraspace::Plugin::Summary
         identifier = r['instances'].map do |i|
           i['attributes']['name'] || i['attributes']['id']
         end.join(',')
-        return if @options[:short]
+        return unless @options[:details]
         logger.info "    #{r['type']} #{r['name']}: #{identifier}"
       end
     end

data/lib/terraspace/shell.rb

@@ -6,7 +6,6 @@ module Terraspace
 
     def initialize(mod, command, options={})
       @mod, @command, @options = mod, command, options
-      @error_type, @error_messages = nil, ''
     end
 
     # requires @mod to be set
@@ -32,10 +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_type ||= known_error_type(err)
-          if @error_type
-            @error_messages << err
-          else
+          @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,33 +46,12 @@ module Terraspace
       end
     end
 
-    def known_error_type(err)
-      if reinitialization_required?(err)
-        :reinitialization_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 reinitialization_required?(err)
-      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 @error_type == :reinitialization_required
-        raise InitRequiredError.new(@error_messages)
-      elsif @error_type == :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,7 +7,7 @@ module Terraspace::Terraform::Args
     attr_accessor :name
     def initialize(mod, name)
       @mod, @name = mod, name
-      @file = "#{Terraspace.root}/config/cli/args.rb"
+      @file = "#{Terraspace.root}/config/args/terraform.rb"
       @commands = {}
     end
 

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/remote_state/output_proxy.rb

@@ -11,18 +11,18 @@ module Terraspace::Terraform::RemoteState
     # Should always return a String
     def to_s
       if @mod.resolved
-        # Dont use NullObject wrapper because Integer get changed to Strings.
+        # Dont use Unresolved wrapper because Integer get changed to Strings.
         # Want raw value to be used for the to_json call
         value = @raw.nil? ? mock_or_error : @raw
         value.to_json
       else
-        NullObject.new # to_s => (unresolved)
+        Unresolved.new
       end
     end
 
     def to_ruby
       data = @raw.nil? ? mock_or_error : @raw
-      @mod.resolved ? data : NullObject.new
+      @mod.resolved ? data : Unresolved.new
     end
 
   private

data/lib/terraspace/terraform/remote_state/{null_object.rb → unresolved.rb}

@@ -1,5 +1,5 @@
 module Terraspace::Terraform::RemoteState
-  class NullObject
+  class Unresolved
     def to_a
       []
     end

data/lib/terraspace/terraform/runner.rb

@@ -1,13 +1,13 @@
 module Terraspace::Terraform
   class Runner < Terraspace::CLI::Base
     extend Memoist
+    include Terraspace::Hooks::Concern
     include Terraspace::Util
 
     attr_reader :name
     def initialize(name, options={})
       @name = name
       super(options)
-      @retries = 1
     end
 
     def run
@@ -20,24 +20,17 @@ module Terraspace::Terraform
       current_dir_message # only show once
 
       params = args.flatten.join(' ')
-      command = "terraform #{name} #{params}"
-      run_hooks(name) do
+      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
 
@@ -53,12 +46,6 @@ module Terraspace::Terraform
       @options[:quiet] ? logger.debug(msg) : logger.info(msg)
     end
 
-    def run_hooks(name, &block)
-      hooks = Hooks::Builder.new(@mod, name)
-      hooks.build # build hooks
-      hooks.run_hooks(&block)
-    end
-
     def args
       # base at end in case of redirection. IE: terraform output > /path
       custom.args + custom.var_files + default.args

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

@@ -0,0 +1,65 @@
+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
+        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}"
+      purge_caches # Purging the cache "fixes" this terraform bug
+      reinit
+    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