terraspace 0.3.3 → 0.4.1

data/lib/terraspace/cli/all.rb

@@ -3,14 +3,14 @@ class Terraspace::CLI
     class_option :yes, aliases: :y, type: :boolean, desc: "auto approve all batch commands"
     class_option :exit_on_fail, type: :boolean, desc: "whether or not to exit when one of the batch commands fails"
 
-    desc "down", "destroy all"
+    desc "down", "Destroy all or multiple stacks."
     long_desc Help.text("all/down")
     option :destroy_workspace, type: :boolean, desc: "Also destroy the Cloud workspace. Only applies when using Terraform Cloud remote backend."
     def down(*stacks)
       Terraspace::All::Runner.new("down", @options.merge(stacks: stacks)).run
     end
 
-    desc "graph", "graph all"
+    desc "graph", "Draw a dependency graph."
     long_desc Help.text("all/graph")
     option :format, default: "png", desc: "format: text or diagram"
     option :full,type: :boolean, desc: "draw the full graph with highlighted nodes or draw the subgraph. text format defaults to false, graph format defaults to true"
@@ -18,43 +18,49 @@ class Terraspace::CLI
       Terraspace::All::Grapher.new(@options.merge(stacks: stacks)).run
     end
 
-    desc "refresh", "refresh all"
+    desc "init", "Init all or multiple stacks."
+    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)
       Terraspace::All::Runner.new("refresh", @options.merge(stacks: stacks)).run
     end
 
-    desc "output", "output all"
+    desc "output", "Show output for all or multiple stacks."
     long_desc Help.text("all/output")
     def output(*stacks)
       Terraspace::All::Runner.new("output", @options.merge(stacks: stacks)).run
     end
 
-    desc "plan", "plan all"
+    desc "plan", "Run plan for all or multiple stacks."
     long_desc Help.text("all/plan")
     def plan(*stacks)
       Terraspace::All::Runner.new("plan", @options.merge(stacks: stacks)).run
     end
 
-    desc "providers", "providers all"
+    desc "providers", "Show providers for all or multiple stacks."
     long_desc Help.text("all/providers")
     def providers(*stacks)
       Terraspace::All::Runner.new("providers", @options.merge(stacks: stacks)).run
     end
 
-    desc "show", "show all"
+    desc "show", "Run show for all or multiple stacks."
     long_desc Help.text("all/show")
     def show(*stacks)
       Terraspace::All::Runner.new("show", @options.merge(stacks: stacks)).run
     end
 
-    desc "up", "deploy all"
+    desc "up", "Deploy all or multiple stacks."
     long_desc Help.text("all/up")
     def up(*stacks)
       Terraspace::All::Runner.new("up", @options.merge(stacks: stacks)).run
     end
 
-    desc "validate", "validate all"
+    desc "validate", "Validate all or multiple stacks."
     long_desc Help.text("all/validate")
     def validate(*stacks)
       Terraspace::All::Runner.new("validate", @options.merge(stacks: stacks)).run

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,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/cloud.rb

@@ -20,17 +20,11 @@ class Terraspace::CLI
       Workspace.new(options.merge(mod: mod)).destroy
     end
 
-    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"
+    desc "sync [STACK]", "Sync all or multiple workspaces."
     long_desc Help.text("cloud:sync")
     yes_option.call
-    def sync(mod=nil)
-      Syncer.new(options.merge(mod: mod, override_auto_sync: true)).run
+    def sync(*stacks)
+      Syncer.new(options.merge(stacks: stacks, override_auto_sync: true)).run
     end
 
     desc "runs SUBCOMMAND", "runs subcommands"

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

@@ -1,5 +1,3 @@
-require 'cli-format'
-
 class Terraspace::CLI::Cloud
   class Runs < Terraspace::Command
     Help = Terraspace::CLI::Help

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

@@ -0,0 +1,32 @@
+## Example
+
+    $ terraspace all down
+    Will run:
+       terraspace down a1 # batch 1
+       terraspace down b1 # batch 2
+       terraspace down b2 # batch 2
+       terraspace down c1 # batch 3
+    Are you sure? (y/N)
+
+Once you confirm, Terraspace destroys the infrastructure.
+
+    Are you sure? (y/N) y
+    Batch Run 1:
+    Running: terraspace down a1 Logs: log/down/a1.log
+    terraspace down a1:  Changes to Outputs:
+    terraspace down a1:  Destroy complete! Resources: 2 destroyed.
+    Batch Run 2:
+    Running: terraspace down b1 Logs: log/down/b1.log
+    Running: terraspace down b2 Logs: log/down/b2.log
+    terraspace down b1:  Changes to Outputs:
+    terraspace down b1:  Destroy complete! Resources: 2 destroyed.
+    terraspace down b2:  Changes to Outputs:
+    terraspace down b2:  Destroy complete! Resources: 1 destroyed.
+    Batch Run 3:
+    Running: terraspace down c1 Logs: log/down/c1.log
+    terraspace down c1:  Changes to Outputs:
+    terraspace down c1:  Destroy complete! Resources: 1 destroyed.
+    Time took: 15s
+    $
+
+Terraspace provides a reduced-noise summary of the runs. The full logs are also written for further inspection and debugging. The [terraspace log](https://terraspace.cloud/reference/terraspace-log/) command is useful for viewing the logs.

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

@@ -0,0 +1,21 @@
+## Example
+
+    $ terraspace all graph
+    Building graph...
+    Graph saved to .terraspace-cache/graph/dependencies-20200919192103.png
+    $
+
+The graph will auto-open on macosx and cloud9.
+
+![](https://img.boltops.com/boltops/tools/terraspace/graphs/example-a1.png)
+
+## Text Form
+
+You can also generate a graph in text, tree-like form
+
+    $ terraspace all graph --format text
+    a1
+    ├── b2
+    │   └── c1
+    └── b1
+        └── c1

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/all/output.md

@@ -0,0 +1,22 @@
+## Example
+
+    $ terraspace all output
+    Running:
+       terraspace output c1 # batch 1
+       terraspace output b1 # batch 2
+       terraspace output b2 # batch 2
+       terraspace output a1 # batch 3
+    Batch Run 1:
+    Running: terraspace output c1 Logs: log/output/c1.log
+    terraspace output c1:  length = 1
+    Batch Run 2:
+    Running: terraspace output b1 Logs: log/output/b1.log
+    Running: terraspace output b2 Logs: log/output/b2.log
+    terraspace output b1:  length = 1
+    terraspace output b1:  length2 = 1
+    terraspace output b2:  length = 1
+    Batch Run 3:
+    Running: terraspace output a1 Logs: log/output/a1.log
+    terraspace output a1:  Warning: No outputs found
+    Time took: 12s
+    $

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

@@ -0,0 +1,25 @@
+## Example
+
+    $ terraspace all plan
+    Running:
+       terraspace plan c1 # batch 1
+       terraspace plan b1 # batch 2
+       terraspace plan b2 # batch 2
+       terraspace plan a1 # batch 3
+    Batch Run 1:
+    Running: terraspace plan c1 Logs: log/plan/c1.log
+    terraspace plan c1:  Plan: 1 to add, 0 to change, 0 to destroy.
+    terraspace plan c1:  Changes to Outputs:
+    Batch Run 2:
+    Running: terraspace plan b1 Logs: log/plan/b1.log
+    Running: terraspace plan b2 Logs: log/plan/b2.log
+    terraspace plan b1:  Plan: 2 to add, 0 to change, 0 to destroy.
+    terraspace plan b1:  Changes to Outputs:
+    terraspace plan b2:  Plan: 1 to add, 0 to change, 0 to destroy.
+    terraspace plan b2:  Changes to Outputs:
+    Batch Run 3:
+    Running: terraspace plan a1 Logs: log/plan/a1.log
+    terraspace plan a1:  Plan: 2 to add, 0 to change, 0 to destroy.
+    terraspace plan a1:  Changes to Outputs:
+    Time took: 11s
+    $

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

@@ -0,0 +1,21 @@
+## Example
+
+    $ terraspace all providers
+    Running:
+       terraspace providers c1 # batch 1
+       terraspace providers b1 # batch 2
+       terraspace providers b2 # batch 2
+       terraspace providers a1 # batch 3
+    Batch Run 1:
+    Running: terraspace providers c1 Logs: log/providers/c1.log
+    terraspace providers c1:  └── provider[registry.terraform.io/hashicorp/random]
+    Batch Run 2:
+    Running: terraspace providers b1 Logs: log/providers/b1.log
+    Running: terraspace providers b2 Logs: log/providers/b2.log
+    terraspace providers b1:  └── provider[registry.terraform.io/hashicorp/random]
+    terraspace providers b2:  └── provider[registry.terraform.io/hashicorp/random]
+    Batch Run 3:
+    Running: terraspace providers a1 Logs: log/providers/a1.log
+    terraspace providers a1:  └── provider[registry.terraform.io/hashicorp/random]
+    Time took: 9s
+    $

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

@@ -0,0 +1,17 @@
+## Example
+
+    $ terraspace all refresh
+    Running:
+       terraspace refresh c1 # batch 1
+       terraspace refresh b1 # batch 2
+       terraspace refresh b2 # batch 2
+       terraspace refresh a1 # batch 3
+    Batch Run 1:
+    Running: terraspace refresh c1 Logs: log/refresh/c1.log
+    Batch Run 2:
+    Running: terraspace refresh b1 Logs: log/refresh/b1.log
+    Running: terraspace refresh b2 Logs: log/refresh/b2.log
+    Batch Run 3:
+    Running: terraspace refresh a1 Logs: log/refresh/a1.log
+    Time took: 11s
+    $

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

@@ -0,0 +1,21 @@
+## Example
+
+    $ terraspace all show
+    Running:
+       terraspace show c1 # batch 1
+       terraspace show b1 # batch 2
+       terraspace show b2 # batch 2
+       terraspace show a1 # batch 3
+    Batch Run 1:
+    Running: terraspace show c1 Logs: log/show/c1.log
+    terraspace show c1: Resources: 0 Outputs: 1
+    Batch Run 2:
+    Running: terraspace show b1 Logs: log/show/b1.log
+    Running: terraspace show b2 Logs: log/show/b2.log
+    terraspace show b1: Resources: 0 Outputs: 2
+    terraspace show b2: Resources: 0 Outputs: 1
+    Batch Run 3:
+    Running: terraspace show a1 Logs: log/show/a1.log
+    terraspace show a1: Resources: 0 Outputs: 0
+    Time took: 12s
+    $