terraspace 0.2.1 → 0.3.1

data/lib/terraspace/cli/build/placeholder.rb

@@ -16,7 +16,7 @@ module Terraspace::CLI::Build
       return if ENV['TS_SUMMARY_BUILD'] == '0'
 
       mod = @options[:mod]
-      if !mod or mod == "placeholder"
+      if !mod or %w[placeholder].include?(mod)
         logger.info "Building one of the modules to get backend.tf info"
         mod = find_mod
       end
@@ -28,10 +28,7 @@ module Terraspace::CLI::Build
     def find_mod
       mod_path = Dir.glob("{app,vendor}/{modules,stacks}/*").last
       unless mod_path
-        logger.info <<~EOL
-          No modules or stacks found.
-          Unable to determine the backend state path without at least one module.
-        EOL
+        logger.info "No modules or stacks found."
         exit 0
       end
       File.basename(mod_path) # mod name

data/lib/terraspace/cli/bundle.rb

@@ -1,5 +1,5 @@
 require "terraspace-bundler"
-TerraspaceBundler.logger = Terraspace.logger
+TerraspaceBundler.config.logger = Terraspace.logger
 
 class Terraspace::CLI
   class Bundle

data/lib/terraspace/cli/check_setup.rb

@@ -23,17 +23,27 @@ class Terraspace::CLI
     end
 
     def check_required_version!
-      puts "Terraspace requires Terraform v#{REQUIRED_TERRAFORM_VERSION}.x"
+      puts "Terraspace requires Terraform v#{REQUIRED_TERRAFORM_VERSION}.x and above"
       if ok?
         puts "You're all set!"
       else
-        puts "The installed version of terraform may not work with terraspace. Recommend using terraform v#{REQUIRED_TERRAFORM_VERSION}.x"
-        exit 1
+        puts "The installed version of terraform may not work with terraspace."
+        puts "Recommend using at least terraform v#{REQUIRED_TERRAFORM_VERSION}.x"
+        puts "If you would like to bypass this check. Use TS_VERSION_CHECK=0" unless check_command?
+        exit 1 unless ENV['TS_VERSION_CHECK'] == '0'
       end
     end
 
+    def check_command?
+      ARGV[0] == "check_setup"
+    end
+
     def ok?
       version = terraform_version_message.sub(/.*v/,'') # => 0.12.24
+      unless version.match(/\d+\.\d+\.\d+/) # just parse did not find the version number
+        puts "WARN: Unable to get the terraform version".color(:yellow)
+        return true
+      end
       major, minor, _ = version.split('.')
       required_major, required_minor = REQUIRED_TERRAFORM_VERSION.split('.')
       x = major.to_i >= required_major.to_i
@@ -47,7 +57,8 @@ class Terraspace::CLI
     end
     memoize :terraform_bin
 
-    # First line contains the Terraform version info:
+    # Sometimes Terraform shows the version info on the first line and sometimes on the bottom line.
+    # Account for that by finding the line.
     #
     #     $ terraform --version
     #     Terraform v0.12.24
@@ -55,8 +66,9 @@ class Terraspace::CLI
     #     Your version of Terraform is out of date! The latest version
     #     is 0.12.26. You can update by downloading from https://www.terraform.io/downloads.html
     #
+    # Note: The -json option is only available in v0.13+
     def terraform_version_message
-      `terraform --version`.split("\n").first.strip
+      `terraform --version`.split("\n").find { |l| l =~ /^Terraform / }.strip
     end
     memoize :terraform_version_message
 

data/lib/terraspace/cli/cloud.rb

@@ -1,24 +1,40 @@
 class Terraspace::CLI
   class Cloud < Terraspace::Command
+    Syncer = Terraspace::Terraform::Cloud::Syncer
     Workspace = Terraspace::Terraform::Cloud::Workspace
 
+    yes_option = Proc.new {
+      option :yes, aliases: :y, type: :boolean, desc: "bypass are you sure prompt"
+    }
+
     desc "list", "List workspaces"
     long_desc Help.text("cloud:list")
+    yes_option.call
     def list
       Workspace.new(options).list
     end
 
-    desc "destroy", "Destroy workspace"
+    desc "destroy STACK", "Destroy workspace by specifying the stack"
     long_desc Help.text("cloud:destroy")
-    option :yes, aliases: :y, type: :boolean, desc: "bypass are you sure prompt"
     def destroy(mod)
       Workspace.new(options.merge(mod: mod)).destroy
     end
 
-    desc "setup", "Setup workspace"
+    desc "setup STACK", "Setup workspace"
     long_desc Help.text("cloud:setup")
     def setup(mod)
       Workspace.new(options.merge(mod: mod)).setup
     end
+
+    desc "sync [STACK]", "sync workspace"
+    long_desc Help.text("cloud:sync")
+    yes_option.call
+    def sync(mod=nil)
+      Syncer.new(options.merge(mod: mod, override_auto_sync: true)).run
+    end
+
+    desc "runs SUBCOMMAND", "runs subcommands"
+    long_desc Help.text(:runs)
+    subcommand "runs", Runs
   end
 end

data/lib/terraspace/cli/cloud/runs.rb

@@ -0,0 +1,24 @@
+require 'cli-format'
+
+class Terraspace::CLI::Cloud
+  class Runs < Terraspace::Command
+    Help = Terraspace::CLI::Help
+    Runs = Terraspace::Terraform::Cloud::Runs
+
+    desc "list STACK", "List runs."
+    long_desc Help.text("cloud:runs:list")
+    option :format, desc: "Output formats: #{CliFormat.formats.join(', ')}"
+    option :status, default: %w[pending planned], type: :array, desc: "Filter by statuses: pending, planned, all"
+    def list(mod)
+      Runs.new(options.merge(mod: mod)).list
+    end
+
+    desc "prune STACK", "Prune runs that are possible to cancel or discard."
+    long_desc Help.text("cloud:runs:prune")
+    option :noop, type: :boolean, desc: "Shows what would be cancelled/discarded."
+    option :yes, aliases: :y, type: :boolean, desc: "bypass are you sure prompt"
+    def prune(mod)
+      Runs.new(options.merge(mod: mod)).prune
+    end
+  end
+end

data/lib/terraspace/cli/commander.rb

@@ -5,17 +5,10 @@ class Terraspace::CLI
       super(options)
     end
 
-    # Commander always runs Build#run
     def run
-      Terraspace::Builder.new(@options).run # generate and init
-      auto_create_backend
+      Terraspace::Builder.new(@options).run unless @options[:build] # Up already ran build
       Init.new(@options.merge(calling_command: @name)).run
       Terraspace::Terraform::Runner.new(@name, @options).run
     end
-
-    def auto_create_backend
-      return unless @name == "apply"
-      Terraspace::Compiler::Backend.new(@mod).create
-    end
   end
 end

data/lib/terraspace/cli/down.rb

@@ -0,0 +1,20 @@
+class Terraspace::CLI
+  class Down < Base
+    include TfcConcern
+
+    def run
+      plan if @options[:yes] && !tfc?
+      destroy
+    end
+
+  private
+    def plan
+      Commander.new("plan", @options.merge(destroy: true)).run
+    end
+
+    def destroy
+      Commander.new("destroy", @options.merge(command: "down")).run
+      Terraspace::Terraform::Cloud::Workspace.new(@options).destroy if @options[:destroy_workspace]
+    end
+  end
+end

data/lib/terraspace/cli/help/cloud/runs/list.md

@@ -0,0 +1,36 @@
+## Example
+
+Statuses of pending and planned are shown by default.
+
+    $ terraspace cloud runs list pet
+    +----------------------+---------+---------------------------------+---------------------+
+    |          Id          | Status  |             Message             |     Created At      |
+    +----------------------+---------+---------------------------------+---------------------+
+    | run-AuTXsYU1svQEzQVg | pending | Queued manually using Terraform | 2020-09-18T11:30:41 |
+    | run-LuwMibh3ebiG7KQZ | planned | test                            | 2020-09-17T23:16:36 |
+    +----------------------+---------+---------------------------------+---------------------+
+    $
+
+To see all most recent runs, use `--status all`.
+
+    $ terraspace cloud runs list pet --status all
+    +----------------------+-----------+--------------------------------+---------------------+
+    |          Id          |  Status   |            Message             |     Created At      |
+    +----------------------+-----------+--------------------------------+---------------------+
+    | run-LuwMibh3ebiG7KQZ | planned   | test 3                         | 2020-09-17T23:16:36 |
+    | run-z9f67TNMRamZiGMR | canceled  | test 2                         | 2020-09-17T23:15:55 |
+    | run-cN3CKT5po29p35Ta | discarded | test                           | 2020-09-17T22:24:31 |
+    | run-rXMd7dm3fHvVsA36 | discarded | Queued from Terraform Cloud UI | 2020-09-17T20:00:20 |
+    +----------------------+-----------+--------------------------------+---------------------+
+    $
+
+You can provide a list of statuses to the `--status` filter option.
+
+    $ terraspace cloud runs list pet --status canceled discarded
+    +----------------------+-----------+--------------------------------+---------------------+
+    |          Id          |  Status   |            Message             |     Created At      |
+    +----------------------+-----------+--------------------------------+---------------------+
+    | run-gS2m1avc3U4j1fip | canceled  | test                           | 2020-09-17T23:15:43 |
+    | run-ojwQ4r7MxuzyK3d9 | discarded | test                           | 2020-09-17T22:33:00 |
+    | run-dczeLQsMc3ya4XnY | canceled  | test                           | 2020-09-17T22:32:55 |
+    +----------------------+-----------+--------------------------------+---------------------+

data/lib/terraspace/cli/help/cloud/runs/prune.md

@@ -0,0 +1,25 @@
+This leaves the to most recent run alone. The top run will immediately start planning. Runs that are also in "Needs Confirmation" will be cancelled.
+
+## Examples
+
+    terraspace cloud runs prune demo --noop
+    terraspace cloud runs prune demo # live run
+
+## Example with Output
+
+    $ terraspace cloud runs prune pet
+    Will keep:
+
+        run-9muMrjrd22vhsP4u pending test 2020-09-18T12:47:11
+
+    Will prune:
+
+        run-fYTDzmKfCQf558UN pending test 2020-09-18T12:46:34
+        run-6bgSTattJGpaRn9X pending test 2020-09-18T12:46:28
+        run-jDHEtZb3vuFnuXqJ planned test 2020-09-18T12:38:35
+
+    Are you sure? (y/N) y
+    Cancelled run-fYTDzmKfCQf558UN test
+    Cancelled run-6bgSTattJGpaRn9X test
+    Discarded run-jDHEtZb3vuFnuXqJ test
+    $

data/lib/terraspace/cli/help/cloud/sync.md

@@ -0,0 +1,19 @@
+## Example
+
+    $ terraspace cloud sync
+    About to sync these project stacks with Terraform Cloud workspaces:
+
+        Stack => Workspace
+        demo => demo-dev-us-west-2
+        demo2 => demo2-dev-us-west-2
+
+    A sync does the following for each workspace:
+
+      1. Create or update workspace, including the VCS settings.
+      2. Set the working dir.
+      3. Set env and terraform variables.
+
+    Are you sure? (y/N) y
+    Syncing to Terraform Cloud: demo => demo-dev-us-west-2
+    Syncing to Terraform Cloud: demo2 => demo2-dev-us-west-2
+    $

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

@@ -0,0 +1,42 @@
+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 log -f
+
+## View Logs
+
+View last 10 lines of each log file.
+
+    terraspace log up network # view up log on specific stack
+    terraspace log up         # view all up logs
+    terraspace log down       # view all down logs
+    terraspace log            # view all logs: up, down, etc
+
+By default, the log command shows the last 10 lines of the logs for each log file. You can use the `-n` option to adjust this.
+
+    terraspace log -n 2       # view last 2 lines of all logs: up, down, etc
+
+To show all logs, use the `-a` option.
+
+    terraspace log up -a
+
+Note, if both an action and stack is specified, then it defaults to showing all logs. If you want to not show all logs in thta case, then you can use `--no-all`.
+
+## Tail Logs
+
+To tail logs, use the `-f` option.
+
+    terraspace log up network -f # view up log on specific stack
+    terraspace log up -f         # view all up logs
+    terraspace log down -f       # view all down logs
+    terraspace log -f            # view all logs: up, down, etc
+
+## Timestamps
+
+The timestamps are shown by default when you are looking for multiple files.  When you specify a both the action and stack for a single log file, then timestamps are not shown.
+
+    terraspace log up         # timestamps will be shown in this case
+    terraspace log up network # timestamps not be shown in this case

data/lib/terraspace/cli/init.rb

@@ -10,13 +10,14 @@ class Terraspace::CLI
     end
 
     def run
-      init if init?
-      build_remote_dependencies # runs after terraform init, which downloads remote modules
+      init
+      # build_remote_dependencies # runs after terraform init, which downloads remote modules
       sync_cloud
     end
 
     # Note the init will always create the Terraform Cloud Workspace
     def init
+      return unless run_init? # check here because RemoteState::Fetcher#pull calls init directly
       # default init timeout is pretty generous in case of slow internet to download the provider plugins
       init_timeout = Integer(ENV['TS_INIT_TIMEOUT'] || 600)
       Timeout::timeout(init_timeout) do
@@ -28,7 +29,7 @@ class Terraspace::CLI
     end
 
     def sync_cloud
-      Terraspace::Terraform::Cloud.new(@options).run if %w[apply plan destroy cloud-setup].include?(@calling_command)
+      Terraspace::Terraform::Cloud::Sync.new(@options).run if %w[apply plan destroy cloud-setup].include?(@calling_command)
     end
 
     # Currently only handles remote modules only one-level deep.
@@ -47,8 +48,8 @@ class Terraspace::CLI
       return if local_source?(meta["Source"])
       return if meta['Dir'] == '.' # root is already built
 
-      remote_mod = Mod::Remote.new(meta, @mod)
-      Compiler::Builder.new(remote_mod).build
+      remote_mod = Terraspace::Mod::Remote.new(meta, @mod)
+      Terraspace::Compiler::Builder.new(remote_mod).build
     end
 
     def auto?
@@ -60,8 +61,35 @@ class Terraspace::CLI
        s =~ %r{^\.} || s =~ %r{^/}
     end
 
-    def init?
-      %w[apply console destroy output plan providers refresh show validate cloud-setup].include?(@calling_command)
+    def run_init?
+      commands = %w[apply console destroy output plan providers refresh show validate cloud-setup]
+      return false unless commands.include?(@calling_command)
+      mode = ENV['TS_INIT_MODE'] || Terraspace.config.init.mode
+      case mode.to_sym
+      when :auto
+        !already_initialized?
+      when :always
+        true
+      when :never
+        false
+      end
+    end
+
+    # Would like to improve this detection
+    #
+    # 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?
+      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)
     end
   end
 end

data/lib/terraspace/cli/list.rb

@@ -2,11 +2,24 @@ class Terraspace::CLI
   class List
     def initialize(options={})
       @options = options
+      @type_dir = normalized_type
     end
 
     def run
       Dir.glob("{app,vendor}/{modules,stacks}/*").sort.each do |path|
-        puts path
+        if @type_dir
+          puts path if path.include?("/#{@type_dir}/")
+        else
+          puts path
+        end
+      end
+    end
+
+  private
+    def normalized_type
+      type = @options[:type]
+      if %w[stack module].include?(type)
+        type.pluralize
       end
     end
   end

data/lib/terraspace/cli/log.rb

@@ -0,0 +1,112 @@
+require "eventmachine"
+require "eventmachine-tail"
+
+class Terraspace::CLI
+  class Log < Base
+    include Log::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
+
+    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