terraspace 0.3.6 → 0.4.0

data/lib/terraspace/cli/init.rb

@@ -67,7 +67,7 @@ class Terraspace::CLI
       mode = ENV['TS_INIT_MODE'] || Terraspace.config.init.mode
       case mode.to_sym
       when :auto
-        !already_initialized?
+        !already_init?
       when :always
         true
       when :never
@@ -80,16 +80,12 @@ class Terraspace::CLI
     # Traverse symlink dirs also: linux_amd64 is a symlink
     #   plugins/registry.terraform.io/hashicorp/google/3.39.0/linux_amd64/terraform-provider-google_v3.39.0_x5
     #
-    # Check modules/modules.json also because during the tfvars dependency pass main.tf modules are not built.
-    # So init happens again during the second pass.
-    #
-    def already_initialized?
+    def already_init?
       terraform = "#{@mod.cache_dir}/.terraform"
       provider = Dir.glob("#{terraform}/**{,/*/**}/*").find do |path|
         path.include?("terraform-provider-")
       end
-      modules = File.exist?("#{terraform}/modules/modules.json")
-      !!(provider && modules)
+      !!provider
     end
   end
 end

data/lib/terraspace/cli/logs.rb

@@ -1,17 +1,112 @@
+require "eventmachine"
+require "eventmachine-tail"
+
 class Terraspace::CLI
-  class Logs < Terraspace::Command
-    class_option :yes, aliases: :y, type: :boolean, desc: "bypass are you sure prompt"
+  class Logs < Base
+    include Concern
+
+    def initialize(options={})
+      super
+      @action, @stack = options[:action], options[:stack]
+      @action ||= '**'
+      @stack  ||= '*'
+    end
+
+    def run
+      check_logs!
+      if @options[:follow]
+        follow_logs
+      else
+        all_log_paths.each { |path| show_log(path) }
+      end
+    end
+
+    def follow_logs
+      glob_path = "#{Terraspace.log_root}/#{@action}/#{@stack}.log"
+      Dir.glob(glob_path).each do |path|
+        puts "Following #{pretty(path)}".color(:purple)
+      end
+      EventMachine.run do
+        interval = Integer(ENV['TS_LOG_GLOB_INTERNAL'] || 1)
+        EventMachine::FileGlobWatchTail.new(glob_path, nil, interval) do |filetail, line|
+          puts line # always show timestamp in follow mode
+        end
+      end
+    end
+
+    def show_log(path)
+      report_log(path)
+      lines = readlines(path)
+      lines = apply_limit(lines)
+      lines.each do |line|
+        puts format(line)
+      end
+    end
+
+    def report_log(path)
+      pretty_path = pretty(path)
+      if File.exist?(path)
+        puts "Showing: #{pretty_path}".color(:purple)
+      end
+    end
+
+    def format(line)
+      if timestamps
+        line
+      else
+        line.sub(/.*\]: /,'')
+      end
+    end
 
-    desc "truncate", "Truncates logs. IE: Keeps the files but removes contents and zero bytes the files."
-    long_desc Help.text("logs/truncate")
-    def truncate
-      Tasks.new(options).truncate
+    def all_log_paths
+      Dir.glob("#{Terraspace.log_root}/#{@action}/#{@stack}.log")
     end
 
-    desc "remove", "Removes logs"
-    long_desc Help.text("logs/remove")
-    def remove
-      Tasks.new(options).remove
+    def check_logs!
+      return unless all_log_paths.empty?
+      puts "WARN: No logs found".color(:yellow)
+    end
+
+    # Only need to check if both action and stack are provided. Otherwise the Dir.globs are used to discover the files
+    def check_log!
+      return unless single_log?
+      path = "#{Terraspace.log_root}/#{@action}/#{@stack}.log"
+      return if File.exist?(path)
+      puts "ERROR: Log file was not found: #{pretty(path)}".color(:red)
+      exit 1
+    end
+
+    def single_log?
+      @action != '**' && @stack != '*'
+    end
+
+    def apply_limit(lines)
+      return lines if all
+      left = limit * -1
+      lines[left..-1] || []
+    end
+
+    def all
+      if single_log?
+        @options[:all].nil? ? true : @options[:all]
+      else # multiple
+        @options[:all].nil? ? false : @options[:all]
+      end
+    end
+
+    def limit
+      @options[:limit].nil? ? 10 : @options[:limit]
+    end
+
+    def timestamps
+      if single_log?
+        @options[:timestamps].nil? ? false : @options[:timestamps]
+      else
+        @options[:timestamps].nil? ? true : @options[:timestamps]
+      end
+    end
+    def pretty(path)
+      Terraspace::Util.pretty_path(path)
     end
   end
 end

data/lib/terraspace/cli/{log → logs}/concern.rb

@@ -1,4 +1,4 @@
-class Terraspace::CLI::Log
+class Terraspace::CLI::Logs
   module Concern
     # Filters for lines that belong to the last ran process pid
     def readlines(path)

data/lib/terraspace/cli/new/helper.rb

@@ -6,10 +6,17 @@ class Terraspace::CLI::New
     def build_gemfile(*list)
       lines = []
       list.each do |name|
-        line =  %Q|gem "#{name}"|
-        lines << line
+        lines << gem_line(name)
       end
       lines.join("\n")
     end
+
+    def gem_line(name)
+      if name == "terraspace"
+        %Q|gem "#{name}", '~> #{Terraspace::VERSION}'|
+      else
+        %Q|gem "#{name}"|
+      end
+    end
   end
 end

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

@@ -4,7 +4,7 @@ module Terraspace::Dependency::Helper
       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 is NullObject when unresolved
+        Terraspace::Terraform::RemoteState::Marker::Output.new(@mod, @identifier, @options).build # Returns OutputProxy => Unresolved
       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/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,6 +1,7 @@
 module Terraspace::Terraform
   class Runner < Terraspace::CLI::Base
     extend Memoist
+    include Terraspace::Hooks::Concern
     include Terraspace::Util
 
     attr_reader :name
@@ -21,7 +22,7 @@ module Terraspace::Terraform
 
       params = args.flatten.join(' ')
       command = "terraform #{name} #{params}"
-      run_hooks(name) do
+      run_hooks("terraform.rb", name) do
         Terraspace::Shell.new(@mod, command, @options.merge(env: custom.env_vars)).run
       end
     rescue Terraspace::InitRequiredError => e
@@ -53,12 +54,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