terraspace 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28bdb53824befd6a98263c63612db913c5496546ef751ed408500b4140ac57c4
-  data.tar.gz: fe844bdeb2dacfbecfa954a912bfa4ef3e5b4e6265d2eea697d072d8533b2fd5
+  metadata.gz: 6b99a86e9b9b829fa0ac1b04a6774b02a43e67642219ea3f22aeb663869bfec6
+  data.tar.gz: f2b265d5e13a86949ddb753e991fc8784c77361909162123dfd7d06d0c1c3555
 SHA512:
-  metadata.gz: 7e01f4b80088de2c7a3f3f1c8ac81a401b4a999cbb3fbc4af78651ee8e1788246dcb8b889172b94ea5ff7a7932a4874f27e225f66dedac2603a5752a20fb383c
-  data.tar.gz: c0ca89b09e3d8ca3f36f6d2f513fedbaa29aad071af4c4c6e99c38438b8c2002582adaa49b2f7105becde5e2ac21785a7f5617b9c5fd1fd60ea25fbaadda7a54
+  metadata.gz: 7fd4d65aac675d439e5e23089db75f937e3f50c72158099d1088112db67ed97c93afef6c47e0555cdde5a6dfe3e175ede017fc9e509c5419128c53ee114de91d
+  data.tar.gz: 4ef8b0354c0e8dd14ccd074bc6ecd2cda96f80c846bfd3dc790dce4cf20f36efbe236020eff587555032ec1dd869ec405cde649a348e232e747ba7900ad79393

data/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.4.0]
+* improve hooks: allow multiple hooks of same type, change path hooks/terraform.rb
+* improve hooks: introduce terraspace-level as well as terraform-level hooks
+* improve hooks: can take Ruby block or shell script
+* improve auto init: reinit when module source changed, improve auto init: generalize retry check
+* fix already_init? detection for case when stack does use module
+* terraspace bundler options: can set any option now
+* add `terraspace all init` command
+* improve terraspace clean, prompt user and add `-y` option
+* bundle: check if in terraspace project
+* Rename NullObject to Unresolved
+* improve error message when stacks not found. give `terraspace list` hint
+* terraspace list. change default to `--type stack`
+* change summary option to --details
+* include terraspace version in generated Gemfile
+* logs command to handle viewing, and clean logs to clean
+
 ## [0.3.6]
 * #44 improve logs management commands: `terraspace logs remove` and `terraspace logs truncate`
 

data/lib/templates/base/project/README.md

@@ -14,4 +14,4 @@ To deploy individual stacks:
 
 ## Terrafile
 
-To add more modules for use, you can add them to the [Terrafile](https://terraspace.cloud/docs/terrafile/).
+To use more modules, add them to the [Terrafile](https://terraspace.cloud/docs/terrafile/).

data/lib/terraspace/all/runner.rb

@@ -105,6 +105,7 @@ module Terraspace::All
       set_log_path!(mod_name)
       name = command_map(@command)
       o = @options.merge(mod: mod_name, yes: true, build: false, input: false)
+      o.merge!(quiet: false) if @command == "init" # noisy so can filter and summarize output
       case @command
       when "up"
         Terraspace::CLI::Up.new(o).run

data/lib/terraspace/all/summary.rb

@@ -1,6 +1,6 @@
 module Terraspace::All
   class Summary
-    include Terraspace::CLI::Log::Concern
+    include Terraspace::CLI::Logs::Concern
     include Terraspace::Util::Logging
 
     def initialize(data={})
@@ -35,6 +35,13 @@ module Terraspace::All
       end
     end
 
+    def init
+      @lines.select! do |line|
+        line.include?("successfully initialized") || # success
+        line.include?("Error: ")  # error
+      end
+    end
+
     # Example 1:
     #     [2020-09-07T14:45:14 #23340 terraspace plan b1]: No changes. Infrastructure is up-to-date.
     # Example 2:

data/lib/terraspace/app.rb

@@ -9,6 +9,8 @@ module Terraspace
     end
 
     def defaults
+      ts_logger = Logger.new(ENV['TS_LOG_PATH'] || $stderr)
+
       config = ActiveSupport::OrderedOptions.new
       config.all = ActiveSupport::OrderedOptions.new
       config.all.concurrency = 5
@@ -21,14 +23,16 @@ module Terraspace
       config.build.cache_dir = ":CACHE_ROOT/:REGION/:ENV/:BUILD_DIR"
       config.build.cache_root = nil # defaults to /full/path/to/.terraspace-cache
       config.build.clean_cache = nil # defaults to /full/path/to/.terraspace-cache
+      config.bundle = ActiveSupport::OrderedOptions.new
+      config.bundle.logger = ts_logger
       config.cloud = ActiveSupport::OrderedOptions.new
       config.cloud.auto_sync = true
-      config.cloud.working_dir_prefix = nil
       config.cloud.hostname = nil
       config.cloud.vars = ActiveSupport::OrderedOptions.new
       config.cloud.vars.overwrite = true
       config.cloud.vars.overwrite_sensitive = true
       config.cloud.vars.show_message = "create"
+      config.cloud.working_dir_prefix = nil
       config.cloud.workspace = ActiveSupport::OrderedOptions.new
       config.cloud.workspace.attrs = ActiveSupport::OrderedOptions.new
       config.hooks = Hooks.new
@@ -36,14 +40,14 @@ module Terraspace
       config.init.mode = "auto" # auto, never, always
       config.log = ActiveSupport::OrderedOptions.new
       config.log.root = Terraspace.log_root
-      config.logger = Logger.new(ENV['TS_LOG_PATH'] || $stderr)
-      config.logger.level = ENV['TS_LOG_LEVEL'] || :info
+      config.logger = ts_logger
       config.logger.formatter = Logger::Formatter.new
-      config.test_framework = "rspec"
+      config.logger.level = ENV['TS_LOG_LEVEL'] || :info
       config.terraform = ActiveSupport::OrderedOptions.new
       config.terraform.plugin_cache = ActiveSupport::OrderedOptions.new
-      config.terraform.plugin_cache.enabled = true
       config.terraform.plugin_cache.dir = ENV['TF_PLUGIN_CACHE_DIR'] || "#{Terraspace.tmp_root}/plugin_cache"
+      config.terraform.plugin_cache.enabled = true
+      config.test_framework = "rspec"
       config
     end
 

data/lib/terraspace/builder.rb

@@ -1,7 +1,8 @@
 module Terraspace
   class Builder < Terraspace::CLI::Base
-    include Compiler::DirsConcern
     include Compiler::CommandsConcern
+    include Compiler::DirsConcern
+    include Hooks::Concern
 
     attr_reader :graph
 
@@ -14,11 +15,14 @@ module Terraspace
       placeholder_stack_message
       logger.info "Building #{build_dir}" unless @options[:quiet] # from terraspace all
 
-      build_unresolved
-      auto_create_backend
-      batches = build_batches
-      build_all
-      logger.info "Built in #{build_dir}" unless @options[:quiet] # from terraspace all
+      batches = nil
+      run_hooks("terraspace.rb", "build") do
+        build_unresolved
+        auto_create_backend
+        batches = build_batches
+        build_all
+        logger.info "Built in #{build_dir}" unless @options[:quiet] # from terraspace all
+      end
       batches
     end
 

data/lib/terraspace/cli.rb

@@ -32,14 +32,14 @@ module Terraspace
     long_desc Help.text(:all)
     subcommand "all", All
 
+    desc "clean SUBCOMMAND", "clean subcommands"
+    long_desc Help.text(:clean)
+    subcommand "clean", Clean
+
     desc "cloud SUBCOMMAND", "cloud subcommands"
     long_desc Help.text(:cloud)
     subcommand "cloud", Cloud
 
-    desc "logs SUBCOMMAND", "logs management subcommands"
-    long_desc Help.text(:logs)
-    subcommand "logs", Logs
-
     desc "new SUBCOMMAND", "new subcommands"
     long_desc Help.text(:new)
     subcommand "new", New
@@ -65,12 +65,6 @@ module Terraspace
       CheckSetup.new(options).run
     end
 
-    desc "clean", "Removes .terraspace-cache dir."
-    long_desc Help.text(:clean)
-    def clean
-      Clean.new(options).run
-    end
-
     desc "console STACK", "Run console in built terraform project."
     long_desc Help.text(:console)
     instance_option.call
@@ -105,19 +99,19 @@ module Terraspace
 
     desc "list", "List stacks and modules."
     long_desc Help.text(:list)
-    option :type, aliases: %w[t], desc: "Type: stack or module. Default all"
+    option :type, default: "stack", aliases: %w[t], desc: "Type: stack, module, or all"
     def list
       List.new(options).run
     end
 
-    desc "log [ACTION] [STACK]", "View and tail logs."
-    long_desc Help.text("log")
+    desc "logs [ACTION] [STACK]", "View and tail logs."
+    long_desc Help.text("logs")
     option :timestamps, aliases: %w[t], type: :boolean, desc: "Whether or not to show the leading timestamp. Defaults to timestamps for multiple logs, and no timestamp if a single log is specified. Note: In follow mode, timestamp always shown"
     option :follow, aliases: %w[f], type: :boolean, desc: "Follow the log in live tail fashion. Must specify a stack if using this option."
     option :limit, aliases: %w[n], default: 10, type: :numeric, desc: "Number of lines to limit showing. Only applies in no-follow mode."
     option :all, aliases: %w[a], type: :boolean, desc: "All mode turns off the limit. Defaults to all if a single log is specified. Only applies in no-follow mode."
-    def log(action=nil, stack=nil)
-      Log.new(@options.merge(action: action, stack: stack)).run
+    def logs(action=nil, stack=nil)
+      Logs.new(@options.merge(action: action, stack: stack)).run
     end
 
     desc "plan STACK", "Plan stack."
@@ -159,7 +153,7 @@ module Terraspace
     long_desc Help.text(:summary)
     option :mod, desc: "Module to build to generate a backend file for discovery. By default the last module is used. Usually, it wont matter."
     init_option.call
-    option :short, aliases: %w[s], type: :boolean, desc: "Only show statefiles"
+    option :details, type: :boolean, desc: "Show details of the listed resources"
     def summary
       Summary.new(options).run
     end

data/lib/terraspace/cli/all.rb

@@ -18,6 +18,12 @@ class Terraspace::CLI
       Terraspace::All::Grapher.new(@options.merge(stacks: stacks)).run
     end
 
+    desc "init", "Init."
+    long_desc Help.text("all/init")
+    def init(*stacks)
+      Terraspace::All::Runner.new("init", @options.merge(stacks: stacks)).run
+    end
+
     desc "refresh", "Refresh all or multiple stacks."
     long_desc Help.text("all/refresh")
     def refresh(*stacks)

data/lib/terraspace/cli/bundle.rb

@@ -1,5 +1,4 @@
 require "terraspace-bundler"
-TerraspaceBundler.config.logger = Terraspace.logger
 
 class Terraspace::CLI
   class Bundle
@@ -8,6 +7,8 @@ class Terraspace::CLI
     end
 
     def run
+      Terraspace.check_project!
+      TerraspaceBundler.config.deep_merge!(Terraspace.config.bundle)
       TerraspaceBundler::CLI.start(args)
     end
 

data/lib/terraspace/cli/clean.rb

@@ -1,12 +1,24 @@
 class Terraspace::CLI
-  class Clean
-    def initialize(options={})
-      @options = options
+  class Clean < Terraspace::Command
+    class_option :yes, aliases: :y, type: :boolean, desc: "bypass are you sure prompt"
+
+    desc "all", "Runs all clean operations."
+    long_desc Help.text("clean/all")
+    def all
+      All.new(options).run
+    end
+
+    desc "cache", "Removes cache dirs."
+    long_desc Help.text("clean/cache")
+    def cache
+      Cache.new(options).run
     end
 
-    def run
-      FileUtils.rm_rf(Terraspace.cache_root)
-      puts "Removed #{Terraspace::Util.pretty_path(Terraspace.cache_root)}"
+    desc "logs", "Removes or truncate logs."
+    long_desc Help.text("clean/logs")
+    option :truncate, aliases: :t, type: :boolean, desc: "Truncate instead of remove logs"
+    def logs
+      Logs.new(options).run
     end
   end
 end

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

@@ -0,0 +1,18 @@
+class Terraspace::CLI::Clean
+  class All < Base
+    def run
+      are_you_sure?
+      o = @options.merge(yes: true) # override to avoid double prompt
+      Cache.new(o).run
+      Logs.new(o).run
+    end
+
+    def are_you_sure?
+      message = <<~EOL.chomp
+        Will remove Terraspace cache and logs.
+        Are you sure?
+      EOL
+      sure?(message) # from Util::Sure
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+class Terraspace::CLI::Clean
+  class Base
+    include Terraspace::Util::Logging
+    include Terraspace::Util::Sure
+
+    def initialize(options={})
+      @options = options
+      Terraspace.check_project!
+    end
+
+    def pretty(path)
+      Terraspace::Util.pretty_path(path)
+    end
+  end
+end

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,21 +1,19 @@
-class Terraspace::CLI::Logs
-  class Tasks
-    include Terraspace::Util::Sure
-
-    def initialize(options={})
-      @options = options
-      Terraspace.check_project!
+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
-      are_you_sure?("truncate")
       log_files.each do |path|
         File.open(path, "w").close # truncates files
       end
     end
 
     def remove
-      are_you_sure?("remove")
       puts "Removing all files in #{pretty_log_root}/" unless @options[:mute]
       FileUtils.rm_rf(log_root)
       FileUtils.mkdir_p(log_root)
@@ -42,3 +40,4 @@ class Terraspace::CLI::Logs
     end
   end
 end
+

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/{log.md → logs.md}

@@ -4,7 +4,7 @@ The log commands will filter out the logs for the last ran terraspace command. I
 
 Follow all the logs as you're running `terraspace all up`:
 
-    terraspace log -f
+    terraspace logs -f
 
 Note, Terraspace automatically checks every second for new logs and adds them to be followed.
 
@@ -12,18 +12,18 @@ Note, Terraspace automatically checks every second for new logs and adds them to
 
 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
+    terraspace logs up network # view up log on 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 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
+    terraspace logs -n 2       # view last 2 lines of all logs: up, down, etc
 
 To show all logs, use the `-a` option.
 
-    terraspace log up -a
+    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`.
 
@@ -31,18 +31,18 @@ Note, if both an action and stack is specified, then it defaults to showing all
 
 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
+    terraspace logs up network -f # view up log on 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, 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
+    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 up up network --timestamps
+    terraspace logs up network --timestamps