terraspace 0.3.4 → 0.4.2

data/lib/terraspace/cli/clean/cache.rb

@@ -0,0 +1,25 @@
+class Terraspace::CLI::Clean
+  class Cache < Base
+    def run
+      Terraspace.check_project!
+      paths = [Terraspace.cache_root, Terraspace.tmp_root]
+      are_you_sure?(paths)
+      paths.each do |path|
+        FileUtils.rm_rf(path)
+        puts "Removed #{pretty(path)}"
+      end
+    end
+
+    def are_you_sure?(paths)
+      pretty_paths = paths.map { |p| "    #{pretty(p)}" }.join("\n")
+      message = <<~EOL.chomp
+        Will remove these folders and all their files:
+
+        #{pretty_paths}
+
+        Are you sure?
+      EOL
+      sure?(message) # from Util::Sure
+    end
+  end
+end

data/lib/terraspace/cli/{logs/tasks.rb → clean/logs.rb}

@@ -1,11 +1,13 @@
-class Terraspace::CLI::Logs
-  class Tasks
-    def initialize(options={})
-      @options = options
+class Terraspace::CLI::Clean
+  class Logs < Base
+    def run
+      action = @options[:truncate] ? "truncate" : "remove"
+      are_you_sure?(action)
+      @options[:truncate] ? truncate : remove
+      logger.info "Logs #{action}d" # IE: Logs truncated or Logs removed
     end
 
     def truncate
-      puts "Truncating log files in #{pretty_log_root}/" unless @options[:mute]
       log_files.each do |path|
         File.open(path, "w").close # truncates files
       end
@@ -28,5 +30,14 @@ class Terraspace::CLI::Logs
     def log_root
       Terraspace.config.log.root
     end
+
+    def are_you_sure?(action)
+      message = <<~EOL.chomp
+        Will #{action} all the log files in #{pretty_log_root}/ folder
+        Are you sure?
+      EOL
+      sure?(message) # from Util::Sure
+    end
   end
 end
+

data/lib/terraspace/cli/help/all/init.md

@@ -0,0 +1,33 @@
+## Example
+
+    $ terraspace all init
+    Building one stack to build all stacks
+    Building .terraspace-cache/us-west-2/dev/stacks/c1
+    Downloading tfstate files for dependencies defined in tfvars...
+    Built in .terraspace-cache/us-west-2/dev/stacks/c1
+    Running:
+        terraspace init c1 # batch 1
+        terraspace init b1 # batch 2
+        terraspace init b2 # batch 2
+        terraspace init a1 # batch 3
+    Batch Run 1:
+    Running: terraspace init c1 Logs: log/init/c1.log
+    terraspace init c1:  Terraform has been successfully initialized!
+    Batch Run 2:
+    Running: terraspace init b1 Logs: log/init/b1.log
+    Running: terraspace init b2 Logs: log/init/b2.log
+    terraspace init b1:  Terraform has been successfully initialized!
+    terraspace init b2:  Terraform has been successfully initialized!
+    Batch Run 3:
+    Running: terraspace init a1 Logs: log/init/a1.log
+    terraspace init a1:  Terraform has been successfully initialized!
+    Time took: 6s
+    $
+
+If Terraform is having trouble initializing, clearing the cache may help:
+
+    $ terraspace clean cache -y
+    Removed .terraspace-cache
+    Removed /tmp/terraspace
+
+Also consider disabling the [terraform.plugin_cache.enabled](https://terraspace.cloud/docs/config/reference/).

data/lib/terraspace/cli/help/clean/all.md

@@ -0,0 +1,10 @@
+## Examples
+
+    $ terraspace clean all
+    Will remove Terraspace cache and logs.
+    Are you sure? (y/N) y
+    Removed .terraspace-cache
+    Removed /tmp/terraspace
+    Removing all files in log/
+    Logs removed
+    $

data/lib/terraspace/cli/help/clean/cache.md

@@ -0,0 +1,12 @@
+## Example
+
+    $ terraspace clean cache
+    Will remove these folders and all their files:
+
+        .terraspace-cache
+        /tmp/terraspace
+
+    Are you sure? (y/N)
+    Removed .terraspace-cache
+    Removed /tmp/terraspace
+    $

data/lib/terraspace/cli/help/clean/logs.md

@@ -0,0 +1,17 @@
+## Examples
+
+Remove logs completely:
+
+    $ terraspace clean logs
+    Will remove all the log files in log/ folder
+    Are you sure? (y/N) y
+    Removing all files in log/
+    Logs removed
+
+Truncate logs. IE: Keeps the files but removes contents and zero bytes the files.
+
+    $ terraspace clean logs --truncate
+    Will truncate all the log files in log/ folder
+    Are you sure? (y/N) y
+    Logs truncated
+    $

data/lib/terraspace/cli/help/logs.md

@@ -0,0 +1,48 @@
+The log commands will filter out the logs for the last ran terraspace command. It does this by filtering for the last found PID in the log files.
+
+## Quick Start
+
+Follow all the logs as you're running `terraspace all up`:
+
+    terraspace logs -f
+
+Note, Terraspace automatically checks every second for new logs and adds them to be followed.
+
+## View Logs
+
+View last 10 lines of each log file.
+
+    terraspace logs up network # view up log on a specific stack
+    terraspace logs up         # view all up logs
+    terraspace logs down       # view all down logs
+    terraspace logs            # view all logs: up, down, etc
+
+By default, the logs command shows the last 10 lines for each log file. You can use the `-n` option to adjust this.
+
+    terraspace logs -n 2       # view last 2 lines of all logs: up, down, etc
+
+To show all logs, use the `-a` option.
+
+    terraspace logs up -a
+
+Note, if both an action and stack is specified, then it defaults to showing all logs. If you want not to show all logs, use `--no-all`.
+
+## Tail Logs
+
+To tail logs, use the `-f` option.
+
+    terraspace logs up network -f # view up log on a specific stack
+    terraspace logs up -f         # view all up logs
+    terraspace logs down -f       # view all down logs
+    terraspace logs -f            # view all logs: up, down, etc
+
+## Timestamps
+
+The timestamps are shown by default when you are looking for multiple files.  When you specify both the action and stack for a single log file, the timestamps are not shown.
+
+    terraspace logs up         # timestamps will be shown in this case
+    terraspace logs up network # timestamps not be shown in this case
+
+To show timestamps:
+
+    terraspace logs up network --timestamps

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

@@ -6,7 +6,8 @@ class Terraspace::CLI
     end
 
     def run
-      Dir.glob("{app,vendor}/{modules,stacks}/*").sort.each do |path|
+      dirs = Dir.glob("{app,vendor}/{modules,stacks}/*").select { |p| File.directory?(p) }
+      dirs.sort.each do |path|
         if @type_dir
           puts path if path.include?("/#{@type_dir}/")
         else

data/lib/terraspace/cli/logs.rb

@@ -1,15 +1,112 @@
+require "eventmachine"
+require "eventmachine-tail"
+
 class Terraspace::CLI
-  class Logs < Terraspace::Command
-    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
+  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
+
+    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)
@@ -17,6 +17,7 @@ class Terraspace::CLI::Log
 
     # [2020-09-06T21:58:25 #11313 terraspace up b1]:
     def pid(line)
+      return @options[:pid] if @options && @options[:pid] # Terraspace::All::Summary: doesnt have @options set
       md = line.match(/:\d{2} #(\d+) /)
       md[1] if md
     end

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/compiler/dependencies/helpers.rb

@@ -0,0 +1,34 @@
+module Terraspace::Compiler::Dependencies
+  # This is a separate module specifically because the DSL also has an output method.
+  # The module allows us to include dependency related methods only within tfvars context for the DSL.
+  #
+  #     1. Only include this module to DSL tfvars context.
+  #        So the output method works in tfvars .rb files works.
+  #        At the same time, the DSL usage of output also works for normal main.tf files.
+  #        Passing specs prove this.
+  #     2. For ERB, there's currently only one ERB context. So this module is included in all contexts.
+  #        The builder only processes dependencies from tfvars, so these helpers are only respected there.
+  #
+  # Where the module is included in the code:
+  #
+  #     1. lib/terraspace/compiler/dsl/syntax/tfvar.rb
+  #     2. lib/terraspace/compiler/erb/helpers.rb
+  #
+  module Helpers
+    def output(identifier, options={})
+      Terraspace::Dependency::Helper::Output.new(@mod, identifier, options).result
+    end
+    alias_method :terraform_output, :output # backwards compatibility
+
+    def depends_on(*child_names, **options)
+      child_names.flatten!
+      child_names.map do |child_name|
+        each_depends_on(child_name, options)
+      end.join("\n")
+    end
+
+    def each_depends_on(child_name, options={})
+      Terraspace::Dependency::Helper::DependsOn.new(@mod, child_name, options).result
+    end
+  end
+end

data/lib/terraspace/compiler/dsl/syntax/helpers/common.rb

@@ -1,8 +1,6 @@
 module Terraspace::Compiler::Dsl::Syntax::Helpers
   module Common
     extend Memoist
-    Fetcher = Terraspace::Terraform::RemoteState::Fetcher
-    Marker = Terraspace::Terraform::RemoteState::Marker
     Meta = Terraspace::Compiler::Dsl::Meta
 
     def var
@@ -25,29 +23,5 @@ module Terraspace::Compiler::Dsl::Syntax::Helpers
       command = ["terraspace"] + args
       command.join(separator)
     end
-
-    def terraform_output(identifier, options={})
-      if @mod.resolved # dependencies have been resolved
-        Fetcher.new(@mod, identifier, options).output
-      else
-        Marker::Output.new(@mod, identifier, options).build
-      end
-    end
-
-    def depends_on(*child_names, **options)
-      child_names.flatten!
-      child_names.map do |child_name|
-        each_depends_on(child_name, options)
-      end.join("\n")
-    end
-
-    def each_depends_on(child_name, options={})
-      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 #{child_name}"
-      else
-        Marker::Output.new(@mod, child_name, options).build
-      end
-    end
   end
 end