terraspace 0.3.4 → 0.4.2

data/lib/terraspace/compiler/dsl/syntax/tfvar.rb

@@ -1,5 +1,6 @@
 module Terraspace::Compiler::Dsl::Syntax
   module Tfvar
     include_dir("tfvar")
+    include Terraspace::Compiler::Dependencies::Helpers
   end
 end

data/lib/terraspace/compiler/erb/context.rb

@@ -1,6 +1,6 @@
 module Terraspace::Compiler::Erb
   class Context
-    include Terraspace::Compiler::Dsl::Syntax::Mod
+    include Helpers
 
     attr_reader :mod, :options
     def initialize(mod)

data/lib/terraspace/compiler/erb/helpers.rb

@@ -0,0 +1,6 @@
+module Terraspace::Compiler::Erb
+  module Helpers
+    include Terraspace::Compiler::Dsl::Syntax::Mod
+    include Terraspace::Compiler::Dependencies::Helpers
+  end
+end

data/lib/terraspace/dependency/helper/base.rb

@@ -0,0 +1,7 @@
+module Terraspace::Dependency::Helper
+  class Base
+    def initialize(mod, identifier, options)
+      @mod, @identifier, @options = mod, identifier, options
+    end
+  end
+end

data/lib/terraspace/dependency/helper/depends_on.rb

@@ -0,0 +1,12 @@
+module Terraspace::Dependency::Helper
+  class DependsOn < Base
+    def result
+      if @mod.resolved # dependencies have been resolved
+        # Note: A generated line is not really needed. Dependencies are stored in memory. Added to assist users with debugging
+        "# #{@mod.name} depends on #{@identifier}" # raw String value
+      else
+        Terraspace::Terraform::RemoteState::Marker::Output.new(@mod, @identifier, @options).build # Returns OutputProxy which defaults to json
+      end
+    end
+  end
+end

data/lib/terraspace/dependency/helper/output.rb

@@ -0,0 +1,11 @@
+module Terraspace::Dependency::Helper
+  class Output < Base
+    def result
+      if @mod.resolved # dependencies have been resolved
+        Terraspace::Terraform::RemoteState::Fetcher.new(@mod, @identifier, @options).output # Returns OutputProxy which defaults to json
+      else
+        Terraspace::Terraform::RemoteState::Marker::Output.new(@mod, @identifier, @options).build # Returns OutputProxy => Unresolved
+      end
+    end
+  end
+end

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,8 @@ module Terraspace
 
     def initialize(mod, command, options={})
       @mod, @command, @options = mod, command, options
-      @error_type, @error_messages = nil, ''
+      # error_messages holds aggregation of all error lines
+      @known_error, @error_messages = nil, ''
     end
 
     # requires @mod to be set
@@ -32,10 +33,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_messages << err # aggregate all error lines
+          @known_error ||= known_error_type(err)
+          unless @known_error
             # 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]
@@ -49,8 +49,8 @@ module Terraspace
     end
 
     def known_error_type(err)
-      if reinitialization_required?(err)
-        :reinitialization_required
+      if reinit_required?(err)
+        :reinit_required
       elsif bucket_not_found?(err)
         :bucket_not_found
       end
@@ -61,7 +61,12 @@ module Terraspace
       err.include?("Failed to get existing workspaces")
     end
 
-    def reinitialization_required?(err)
+    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")
@@ -71,9 +76,9 @@ module Terraspace
       return if status == 0
 
       exit_on_fail = @options[:exit_on_fail].nil? ? true : @options[:exit_on_fail]
-      if @error_type == :reinitialization_required
+      if @known_error == :reinit_required
         raise InitRequiredError.new(@error_messages)
-      elsif @error_type == :bucket_not_found
+      elsif @known_error == :bucket_not_found
         raise BucketNotFoundError.new(@error_messages)
       elsif exit_on_fail
         logger.error "Error running command: #{@command}".color(:red)

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/fetcher.rb

@@ -8,6 +8,7 @@ module Terraspace::Terraform::RemoteState
       @parent, @identifier, @options = parent, identifier, options
       child_name, @output_key = identifier.split('.')
       @child = Terraspace::Mod.new(child_name)
+      @child.resolved = @parent.resolved
     end
 
     def run
@@ -16,16 +17,24 @@ module Terraspace::Terraform::RemoteState
       load
     end
 
+    # Returns OutputProxy
     def output
       run
       if pull_success?
-        value = output_value
-        error = output_error(:key_not_found) unless @outputs.key?(@output_key)
-        OutputProxy.new(value, @options.merge(error: error))
+        pull_success_output
       else
         @error_type ||= :state_not_found # could be set to :bucket_not_found by bucket_not_found_error
         error = output_error(@error_type)
-        OutputProxy.new(nil, @options.merge(error: error))
+        OutputProxy.new(@child, nil, @options.merge(error: error))
+      end
+    end
+
+    def pull_success_output
+      if @outputs.key?(@output_key)
+        OutputProxy.new(@child, output_value, @options)
+      else
+        error = output_error(:key_not_found)
+        OutputProxy.new(@child, nil, @options.merge(error: error))
       end
     end
 

data/lib/terraspace/terraform/remote_state/marker/output.rb

@@ -8,6 +8,7 @@ module Terraspace::Terraform::RemoteState::Marker
       @child_name, @output_key = @identifier.split('.')
     end
 
+    # Returns OutputProxy
     def build
       if valid?
         Terraspace::Dependency::Registry.register(@parent_name, @child_name)
@@ -16,7 +17,7 @@ module Terraspace::Terraform::RemoteState::Marker
       end
       # MARKER for debugging. Only appears on 1st pass. Will not see unless changing Terraspace code for debugging.
       marker = "MARKER:terraform_output('#{@identifier}')"
-      Terraspace::Terraform::RemoteState::OutputProxy.new(marker, @options)
+      Terraspace::Terraform::RemoteState::OutputProxy.new(@mod, marker, @options)
     end
 
     def valid?
@@ -26,6 +27,7 @@ module Terraspace::Terraform::RemoteState::Marker
     def warning
       logger.warn "WARN: The #{@child_name} stack does not exist".color(:yellow)
       caller_line = caller.find { |l| l.include?('.tfvars') }
+      return unless caller_line # specs dont have a tfvars file
       source_code = PrettyTracer.new(caller_line).source_code
       logger.info source_code
     end

data/lib/terraspace/terraform/remote_state/output_proxy.rb

@@ -1,29 +1,33 @@
 module Terraspace::Terraform::RemoteState
   class OutputProxy
     # raw: can be anything: String, Array, Hash, etc
-    # options: original options passed by user with terraform_output
+    # options: original options passed by user from the output helper in tfvars
     attr_reader :raw, :options
-    def initialize(raw, options={})
-      @raw, @options = raw, options
+    def initialize(mod, raw, options={})
+      @mod, @raw, @options = mod, raw, options
       @format = @options[:format]
     end
 
     # Should always return a String
     def to_s
-      case @format
-      when "string"
-        content.to_s
-      else # "json"
-        content.to_json
+      if @mod.resolved
+        # 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
+        Unresolved.new
       end
     end
 
-    def content
-      if @raw.nil?
-        @options[:mock] || @options[:error]
-      else
-        @raw
-      end
+    def to_ruby
+      data = @raw.nil? ? mock_or_error : @raw
+      @mod.resolved ? data : Unresolved.new
+    end
+
+  private
+    def mock_or_error
+      @options[:mock] || @options[:error]
     end
   end
 end

data/lib/terraspace/terraform/remote_state/unresolved.rb

@@ -0,0 +1,40 @@
+module Terraspace::Terraform::RemoteState
+  class Unresolved
+    def to_a
+      []
+    end
+
+    def to_ary
+      []
+    end
+
+    def to_s
+      "(unresolved)" # always returned as part of first unresolved processing pass
+    end
+    alias_method :to_str, :to_s # ERB requires to_str
+
+    def to_f
+      0.0
+    end
+
+    def to_i
+      0
+    end
+
+    def nil?
+      true
+    end
+
+    def inspect
+      format("#<%s:0x%x>", self.class, object_id)
+    end
+
+    def method_missing(*_args, &_block)
+      self
+    end
+
+    def respond_to?(_message, _include_private = false)
+      true
+    end
+  end
+end