terraspace 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4501185815eeebafbdadd49e8afac52af4fc1c6b8d6d297269614482a38df47
-  data.tar.gz: b532e32f8c4a2a34e14b528649ff313041610adb7fc89349f7f97336a4c767d0
+  metadata.gz: 82d3075dd4d1feefc14c645c634b80fca976887120ccf4e531385745e7d4df3e
+  data.tar.gz: e3c035ee09b574247d563e3261e4f51e7d93bc5a6bf5af4d3b0ab083864f25af
 SHA512:
-  metadata.gz: b8e949cadb19e163b961bebc40cc8e31bfba8e6ccefb07e28cdabb88a6cf0696a7a8a62b7f4c5f73ab1ae420c9b1956f38d2916f65ad0bfae3ee4e64ba885de5
-  data.tar.gz: 0f0ef1edc6432743dc6f3535449c880615057038a4e097ca03227660d7dd39270da8186675c26315f86636344635017d16f4c60fef580dfb6188bd0c785e92ab
+  metadata.gz: 384d8c9ff03eec838719ebe438dd9ad047558e0e4d495732f66561364b9100879bf498609bf931e29def28c5e4e3c0cb5ad4875cde4955a46dd63f850ec43887
+  data.tar.gz: f475ab2126fe8c7807c9811a2f9f734cc9c47c702c61daa7b3cd4c995a192aa5b3669cde26f92c57b0592adf0131f4dbc80b45e0641900bca2090162d4e7529b

data/.cody/aws/bin/build.sh

@@ -10,4 +10,6 @@ export PATH=~/bin:$PATH # ~/bin/terraspace wrapper
 set -x
 terraspace new project infra --examples
 cd infra
+terraspace new bootstrap_test
+terraspace new project_test demo --examples
 terraspace test

data/.cody/azurerm/bin/build.sh

@@ -17,4 +17,6 @@ export ARM_TENANT_ID=$(cat ~/.azure/app-client.json | jq -r '.tenant_id')
 set -x
 terraspace new project infra --examples --plugin azurerm
 cd infra
+terraspace new bootstrap_test
+terraspace new project_test demo --examples --plugin azurerm
 terraspace test

data/.cody/google/bin/build.sh

@@ -14,4 +14,6 @@ export GOOGLE_PROJECT=$(cat $GOOGLE_APPLICATION_CREDENTIALS | jq -r '.project_id
 set -x
 terraspace new project infra --examples --plugin google
 cd infra
+terraspace new bootstrap_test
+terraspace new project_test demo --examples --plugin google
 terraspace test

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 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.3.4]
+* #42 update cli docs and bug fixes
+* fix console by using system instead of popen3
+* fix build for edge case when app/modules exist but app/stacks do not
+* terraspace new project: do not generate spec folder by default
+* improve all output summary
+* remove redundant `terraspace cloud setup`, instead use: `terraspace cloud sync`
+* improve terraspace info output
+* fix integration test pipeline
+
 ## [0.3.3]
 * #41 fix `terraspace build` and `terraspace seed` when bucket doesnt exist yet and there are dependenices defined.
 

data/lib/terraspace.rb

@@ -6,6 +6,7 @@ require "active_support/core_ext/class"
 require "active_support/core_ext/hash"
 require "active_support/core_ext/string"
 require "active_support/ordered_options"
+require "cli-format"
 require "deep_merge/rails_compat"
 require "dsl_evaluator"
 require "fileutils"

data/lib/terraspace/all/summary.rb

@@ -51,7 +51,15 @@ module Terraspace::All
     end
 
     def output
-      @lines # pass through all output info
+      if @lines.grep(/No outputs found/).empty?
+        @lines.select! do |line|
+          line.include?(" = ") # looks like output
+        end
+      else
+        @lines.select! do |line|
+          line.include?("No outputs found")
+        end
+      end
     end
 
     def show
@@ -65,6 +73,18 @@ module Terraspace::All
       @lines.unshift(summary) # add to top
     end
 
+    # [2020-09-19T19:36:33 #14387 terraspace providers c1]: => terraform providers
+    # [2020-09-19T19:36:33 #14387 terraspace providers c1]:
+    # [2020-09-19T19:36:33 #14387 terraspace providers c1]: Providers required by configuration:
+    # [2020-09-19T19:36:33 #14387 terraspace providers c1]: .
+    # [2020-09-19T19:36:33 #14387 terraspace providers c1]: └── provider[registry.terraform.io/hashicorp/random]
+    # [2020-09-19T19:36:33 #14387 terraspace providers c1]:
+    def providers
+      @lines.select! do |line|
+        line.include?("provider[")
+      end
+    end
+
     # [2020-09-07T14:53:36 #31106 terraspace show b1]: Outputs:
     # [2020-09-07T14:53:36 #31106 terraspace show b1]:
     # [2020-09-07T14:53:36 #31106 terraspace show b1]: length = 1

data/lib/terraspace/cli.rb

@@ -44,7 +44,7 @@ module Terraspace
     long_desc Help.text(:new)
     subcommand "new", New
 
-    desc "build [STACK]", "build"
+    desc "build [STACK]", "Build project."
     long_desc Help.text(:build)
     option :quiet, type: :boolean, desc: "quiet output"
     instance_option.call
@@ -53,32 +53,32 @@ module Terraspace
       Terraspace::Builder.new(options.merge(mod: mod)).run # building any stack builds them all
     end
 
-    desc "bundle", "bundle"
+    desc "bundle", "Bundle with Terrafile."
     long_desc Help.text(:bundle)
     def bundle(*args)
       Bundle.new(options.merge(args: args)).run
     end
 
-    desc "check_setup", "check_setup"
+    desc "check_setup", "Check setup."
     long_desc Help.text(:check_setup)
     def check_setup
       CheckSetup.new(options).run
     end
 
-    desc "clean", "clean .terraspace-cache dir"
+    desc "clean", "Removes .terraspace-cache dir."
     long_desc Help.text(:clean)
     def clean
       Clean.new(options).run
     end
 
-    desc "console STACK", "console .terraspace-cache dir"
+    desc "console STACK", "Run console in built terraform project."
     long_desc Help.text(:console)
     instance_option.call
     def console(mod)
-      Commander.new("console", options.merge(mod: mod)).run
+      Commander.new("console", options.merge(mod: mod, shell: "system")).run
     end
 
-    desc "down STACK", "down"
+    desc "down STACK", "Destroy infrastructure stack."
     long_desc Help.text(:down)
     instance_option.call
     yes_option.call
@@ -88,29 +88,29 @@ module Terraspace
       Down.new(options.merge(mod: mod)).run
     end
 
-    desc "info STACK", "info"
+    desc "info STACK", "Get info about stack."
     long_desc Help.text(:info)
-    format_option.call
     instance_option.call
+    option :format, desc: "Output formats: #{CliFormat.formats.join(', ')}"
     def info(mod)
       Info.new(options.merge(mod: mod)).run
     end
 
-    desc "init STACK", "init"
+    desc "init STACK", "Run init in built terraform project."
     long_desc Help.text(:init)
     instance_option.call
     def init(mod)
       Commander.new("init", options.merge(mod: mod, quiet: false)).run
     end
 
-    desc "list", "list stacks and modules"
+    desc "list", "List stacks and modules."
     long_desc Help.text(:list)
     option :type, aliases: %w[t], desc: "Type: stack or module. Default all"
     def list
       List.new(options).run
     end
 
-    desc "log [ACTION] [STACK]", "The log command allows you to view multiple logs."
+    desc "log [ACTION] [STACK]", "View and tail logs."
     long_desc Help.text("log")
     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."
@@ -120,7 +120,7 @@ module Terraspace
       Log.new(@options.merge(action: action, stack: stack)).run
     end
 
-    desc "plan STACK", "plan stack"
+    desc "plan STACK", "Plan stack."
     long_desc Help.text(:plan)
     auto_option.call
     input_option.call
@@ -131,21 +131,21 @@ module Terraspace
       Commander.new("plan", options.merge(mod: mod)).run
     end
 
-    desc "providers STACK", "providers"
+    desc "providers STACK", "Show providers."
     long_desc Help.text(:providers)
     instance_option.call
     def providers(mod)
       Commander.new("providers", options.merge(mod: mod)).run
     end
 
-    desc "refresh STACK", "refresh"
+    desc "refresh STACK", "Run refresh."
     long_desc Help.text(:refresh)
     instance_option.call
     def refresh(mod)
       Commander.new("refresh", options.merge(mod: mod)).run
     end
 
-    desc "seed STACK", "seed"
+    desc "seed STACK", "Build starer seed tfvars file."
     long_desc Help.text(:seed)
     option :yes, aliases: :y, type: :boolean, desc: "bypass prompts and force overwrite files"
     option :where, desc: "where to create file. either under app or seed folder structure. values: app or stack"
@@ -155,8 +155,8 @@ module Terraspace
       Seed.new(options.merge(mod: mod)).run
     end
 
-    desc "summary", "Summary of resources"
-    long_desc Help.text(:clean)
+    desc "summary", "Summarize resources."
+    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"
@@ -164,7 +164,7 @@ module Terraspace
       Summary.new(options).run
     end
 
-    desc "show STACK", "show"
+    desc "show STACK", "Run show."
     long_desc Help.text(:show)
     instance_option.call
     option :plan, desc: "path to created.plan"
@@ -173,13 +173,13 @@ module Terraspace
       Commander.new("show", options.merge(mod: mod)).run
     end
 
-    desc "test", "test"
+    desc "test", "Run test."
     long_desc Help.text(:test)
     def test
       Test.new(options).run
     end
 
-    desc "output STACK", "output"
+    desc "output STACK", "Run output."
     long_desc Help.text(:output)
     format_option.call
     instance_option.call
@@ -188,8 +188,8 @@ module Terraspace
       Commander.new("output", options.merge(mod: mod)).run
     end
 
-    desc "up STACK", "Deploy infrastructure. IE: terraform apply"
-    long_desc Help.text(:update)
+    desc "up STACK", "Deploy infrastructure stack."
+    long_desc Help.text(:up)
     auto_option.call
     init_option.call
     input_option.call
@@ -202,7 +202,7 @@ module Terraspace
       Up.new(options.merge(mod: mod)).run
     end
 
-    desc "validate STACK", "validate"
+    desc "validate STACK", "Validate stack."
     long_desc Help.text(:validate)
     instance_option.call
     def validate(mod)
@@ -221,7 +221,7 @@ module Terraspace
       Completer::Script.generate
     end
 
-    desc "version", "prints version"
+    desc "version", "Prints version."
     def version
       puts VERSION
     end

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,43 @@ class Terraspace::CLI
       Terraspace::All::Grapher.new(@options.merge(stacks: stacks)).run
     end
 
-    desc "refresh", "refresh all"
+    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/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/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
+    $