terraspace 0.5.8 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff60ae09b5f5278378d1d0343e68e19bd697825e3206a981fc3023d914b7710a
-  data.tar.gz: a036994bf09c8ef78323b64b234dd083d438bb63d552444178a611ac05cc886e
+  metadata.gz: 5e6515cd30855a02e17147354db57995da471812f6437611140f715726268bb6
+  data.tar.gz: 33a4066b1a30d091fe7881bbafccc0778f47715d6bea7671ba9f011e1f3702a5
 SHA512:
-  metadata.gz: 16e8f2ff6676201c697480a8c25f50b32a3a84c6fe7ee18d8517bef1ddf177f86cbbfcf3112e116e7ef93a7cf201e73c924306614a4f8061c9b8c75e13b75be7
-  data.tar.gz: 1cc236483836d3453216559c2ce378716b5352ddb482ff6ba03f6a4f2a58251b3e6f44f2f6dc56acac0be49ffed7bb683d572a8df5176ca2557165b2b16778eb
+  metadata.gz: 6b3b7c108ac28b8cf83c4cde07ed64f4fc84d8109bc77c5b1ddaa3018e70393e9cb57cbc7fc65315e7877e55833bd434695753ed8cb71b31bb249a440c96c910
+  data.tar.gz: 3b85a43ae356e6c95def1ab614ef86af19e3c875752d265a5de55ada4f66b12830d514d2655841f973690b449d8fc38f610ac6b146ba943e3d37d72694e86d79

data/.github/ISSUE_TEMPLATE.md

@@ -1,7 +1,7 @@
 Please fill out one of the templates on https://github.com/boltops-tools/terraspace/issues/new/choose
 
-If you want to ask a question please do so on sites like StackOverflow.
+If you want to ask a question please do so in the Terraspace category in the BoltOps Community forum: https://community.boltops.com
 
-To be sensitive to everyone's time, we may close issues asking questions without comment. Here are some additional options also https://terraspace.cloud/support/ 👌
+To be sensitive to everyone's time, we may close issues asking questions without comment. Posting your questions in the Terraspace community forum is the best place. It also benefits others by making the questions easier to find. Here are some additional options also https://terraspace.cloud/support/ 👌
 
 Thank you!

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -15,7 +15,8 @@ issue may be closed without comment. If you repeatedly fail to provide enough
 details, you may be blocked from ever submitting issues to Terraspace again.
 Please use your best judgment. 👍
 
-If you are unsure this is a bug in Terraspace, please consider asking your question at sites like StackOverflow.
+If you are unsure this is a bug in Terraspace, please consider asking your question at:
+https://community.boltops.com
 
 Thanks!
 -->
@@ -26,8 +27,8 @@ Thanks!
 Make sure that you've done all of these.  To mark a checkbox done, replace [ ] with [x]. Or after you create the issue you can click the checkbox.
 -->
 
-- [ ] Upgrade Terraspace: Are you using the latest version of Terraspace? This allows Terraspace to fix issues fast.
-- [ ] Reproducibility: Are you reporting a bug others will be able to reproduce and not asking a question. If you're unsure or want to ask a question, do so on StackOverflow.
+- [ ] Upgrade Terraspace: Are you using the latest version of Terraspace? This allows Terraspace to fix issues fast. There's an Upgrading Guide: https://terraspace.cloud/docs/misc/upgrading/
+- [ ] Reproducibility: Are you reporting a bug others will be able to reproduce and not asking a question. If you're unsure or want to ask a question, do so on https://community.boltops.com
 - [ ] Code sample: Have you put together a code sample to reproduce the issue and make it available?  Code samples help speed up fixes dramatically. If it's an easily reproducible issue, then code samples are not needed. If you're unsure, please include a code sample.
 
 ## My Environment

data/.github/ISSUE_TEMPLATE/question.md

@@ -7,8 +7,8 @@ assignees: ''
 
 ---
 
-The Terraspace issue tracker IS NOT for usage questions! Please post your question at sites like StackOverflow.
+The Terraspace issue tracker IS NOT for usage questions! Please post your question on our dedicated forum at https://community.boltops.com
 
 To be sensitive to everyone's time, we may close issues asking questions without comment. If you repeatedly post questions in the issues tracker, you may be blocked from ever submitting issues to Terraspace again. Please use your best judgment. 👍
 
-Here are some additional options also https://terraspace.cloud/support/ 😁
+Posting your questions in the Terraspace community forum benefits others by grouping questions in a dedicated place. Here are some additional options also https://terraspace.cloud/support/ 😁

data/CHANGELOG.md

@@ -3,6 +3,31 @@
 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.6.0] - 2021-03-03
+- Update README.md
+- [#87](https://github.com/boltops-tools/terraspace/pull/87) rename cloud to tfc command and improvements
+- [#88](https://github.com/boltops-tools/terraspace/pull/88) custom layering support
+- Rename `terraspace cloud` to `terraspace tfc` and tfc improvements
+- Improve stdout handling, so this works: `terraspace show demo --json | jq`
+- `terraspace plan --output plan.save` writes to relative cache path.
+- `terraspace up --plan plan.save` copies plan.save to cache path.
+- Add state command. Initial simple version.
+
+## [0.5.12] - 2021-02-27
+- [#79](https://github.com/boltops-tools/terraspace/pull/79) Fix syntax issue
+- [#85](https://github.com/boltops-tools/terraspace/pull/85) Add all.include_stacks option and fix all.ignore_stacks option when building dependency graph
+
+## [0.5.11] - 2021-02-11
+- [#76](https://github.com/boltops-tools/terraspace/pull/76) dont use auto generated plan when both yes and plan options used
+- fix plan path when 2 stacks of same name run at the same time
+
+## [0.5.10] - 2020-12-11
+- [#69](https://github.com/boltops-tools/terraspace/pull/69) require singleton earlier
+
+## [0.5.9] - 2020-12-11
+- [#68](https://github.com/boltops-tools/terraspace/pull/68) require singleton
+- fix graphviz check for format text, improve graphviz install help message
+
 ## [0.5.8] - 2020-12-04
 - [#67](https://github.com/boltops-tools/terraspace/pull/67) fix find placeholder stack so config/terraform only builds for stacks
 
@@ -93,7 +118,7 @@ This project *loosely tries* to adhere to [Semantic Versioning](http://semver.or
 * 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`
+* remove redundant `terraspace tfc setup`, instead use: `terraspace tfc sync`
 * improve terraspace info output
 * fix integration test pipeline
 
@@ -112,8 +137,8 @@ This project *loosely tries* to adhere to [Semantic Versioning](http://semver.or
 * Terraspace log: view and tail log files
 * Terraspace logs management commands: `terraspace logs truncate` and `terraspace logs remove`
 * TFC/TFE: Improve support. `config.cloud.vars`, `config.cloud.workspace.attrs`
-* TFC commands: terraspace cloud runs list, terraspace cloud runs prune
-* TFC VCS also sync as part of deploy. Also separate `terraspace cloud sync` command
+* TFC commands: terraspace tfc runs list, terraspace tfc runs prune
+* TFC VCS also sync as part of deploy. Also separate `terraspace tfc sync` command
 * Logger improvements: configurable formatter, log to stderr by default
 * Rename: `cloud.relative_root` to `cloud.working_dir_prefix`
 * Run a plan to capture the diff as part of `-y` option. IE: `terraspace up demo -y`
@@ -146,11 +171,11 @@ This project *loosely tries* to adhere to [Semantic Versioning](http://semver.or
 * New expander variables: TYPE_INSTANCE, INSTANCE, CACHE_ROOT. Also added strip trailing - and / behavior.
 * Timeout for terraform init. The default timeout is 10m and will then print out the terraform init log.
 * Terraspace 0.2.x is compatible with terraspace\_plugin_aws 0.2.x, terraspace\_plugin_google 0.2.x, and terraspace\_plugin_azurerm 0.2.x
-* New commands: terraspace list, terraspace cloud list, terraspace cloud setup, terraspace cloud destroy, terraspace new shim, terraspace new git_hook
+* New commands: terraspace list, terraspace tfc list, terraspace tfc setup, terraspace tfc destroy, terraspace new shim, terraspace new git_hook
 * terraspace list: list of modules and stacks
-* terraspace cloud list: shows list of TFC workspaces
-* terraspace cloud setup: setups up TFC workspace for VCS-driven workflow. This automatically happens for the TFC CLI-driven workflow.
-* terraspace cloud destroy: destroys the TFC workspace associated with the stack. Can also use the `terraspace down demo --destroy-workspace` option.
+* terraspace tfc list: shows list of TFC workspaces
+* terraspace tfc setup: setups up TFC workspace for VCS-driven workflow. This automatically happens for the TFC CLI-driven workflow.
+* terraspace tfc destroy: destroys the TFC workspace associated with the stack. Can also use the `terraspace down demo --destroy-workspace` option.
 * terraspace new shim: An quick way to generate a terraspace shim.
 * terraspace new git_hook: An quick way to set up a git pre-push hook for the TFC VCS-driven workflow.
 * terraspace down: works even if there's no app/stacks folder. A fake stack is built.

data/README.md

@@ -10,6 +10,8 @@
 
 The Terraform Framework.
 
+Please **watch/star** this repo to help grow and support the project.
+
 Official Docs Site: [terraspace.cloud](https://terraspace.cloud)
 
 Quick Start Demo:

data/lib/terraspace.rb

@@ -19,6 +19,7 @@ require "memoist"
 require "rainbow/ext/string"
 require "render_me_pretty"
 require "set"
+require "singleton"
 require "terraspace/ext"
 require "terraspace/version"
 

data/lib/terraspace/all/grapher.rb

@@ -109,13 +109,12 @@ module Terraspace::All
 
     # Check if Graphiz is installed and prints a user friendly message if it is not installed.
     def check_graphviz!
+      return if @options[:format] == 'text'
+
       installed = system("type dot > /dev/null 2>&1") # dot is a command that is part of the graphviz package
       return if installed
       logger.error "ERROR: It appears that the Graphviz is not installed.  Please install it to use the graph command.".color(:red)
-      if RUBY_PLATFORM =~ /darwin/
-        logger.error "You can install Graphviz with homebrew:"
-        logger.error "    brew install graphviz"
-      end
+      install_instructions
       logger.info <<~EOL
         Also consider:
 
@@ -125,5 +124,23 @@ module Terraspace::All
       EOL
       exit 1
     end
+
+    def install_instructions
+      installer = if RUBY_PLATFORM =~ /darwin/
+        "brew"
+      elsif system("type yum > /dev/null 2>&1")
+        "yum"
+      elsif system("type apt-get > /dev/null 2>&1")
+        "apt-get"
+      end
+
+      return unless installer
+      logger.error <<~EOL
+        You can install Graphviz with:
+
+            #{installer} install graphviz
+
+      EOL
+    end
   end
 end

data/lib/terraspace/app.rb

@@ -1,7 +1,9 @@
 module Terraspace
   class App
-    include Singleton
+    extend Memoist
     include DslEvaluator
+    include Singleton
+    include Terraspace::Util::Logging
 
     attr_reader :config
     def initialize
@@ -9,15 +11,14 @@ 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
       config.all.exit_on_fail = ActiveSupport::OrderedOptions.new
       config.all.exit_on_fail.down = true
       config.all.exit_on_fail.up = true
-      config.all.ignore_stacks = []
+      config.all.ignore_stacks = nil
+      config.all.include_stacks = nil
       config.allow = ActiveSupport::OrderedOptions.new
       config.allow.envs = nil
       config.allow.regions = nil
@@ -28,16 +29,6 @@ module Terraspace
       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.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
       config.init = ActiveSupport::OrderedOptions.new
       config.init.mode = "auto" # auto, never, always
@@ -46,22 +37,53 @@ module Terraspace
       config.logger = ts_logger
       config.logger.formatter = Logger::Formatter.new
       config.logger.level = ENV['TS_LOG_LEVEL'] || :info
+      config.layering = ActiveSupport::OrderedOptions.new
+      config.layering.names = {}
+      config.layering.enable_names = ActiveSupport::OrderedOptions.new
+      config.layering.enable_names.cache_dir = true
+      config.summary = ActiveSupport::OrderedOptions.new
+      config.summary.prune = false
       config.terraform = ActiveSupport::OrderedOptions.new
       config.terraform.plugin_cache = ActiveSupport::OrderedOptions.new
       config.terraform.plugin_cache.dir = ENV['TF_PLUGIN_CACHE_DIR'] || "#{Terraspace.tmp_root}/plugin_cache"
       config.terraform.plugin_cache.enabled = true
       config.terraform.plugin_cache.purge_on_error = true
       config.test_framework = "rspec"
+      config.tfc = ActiveSupport::OrderedOptions.new
+      config.tfc.auto_sync = true
+      config.tfc.hostname = nil
+      config.tfc.vars = ActiveSupport::OrderedOptions.new
+      config.tfc.vars.overwrite = true
+      config.tfc.vars.overwrite_sensitive = true
+      config.tfc.vars.show_message = "create"
+      config.tfc.working_dir_prefix = nil
+      config.tfc.workspace = ActiveSupport::OrderedOptions.new
+      config.tfc.workspace.attrs = ActiveSupport::OrderedOptions.new
       config
     end
 
+    def ts_logger
+      Logger.new(ENV['TS_LOG_PATH'] || $stderr)
+    end
+    memoize :ts_logger
+
     def configure
       yield(@config)
     end
 
     def load_project_config
       evaluate_file("#{Terraspace.root}/config/app.rb")
+
+      # deprecated config/env for config/envs
       path = "#{Terraspace.root}/config/env/#{Terraspace.env}.rb"
+      if File.exist?(path)
+        # so early on in the boot process that logger.info is unavailable, use ts_logger which is available and same thing.
+        ts_logger.info "DEPRECATED: Please rename config/env to config/envs. IE:".color(:yellow)
+        ts_logger.info "    mv config/env config/envs"
+        evaluate_file(path)
+      end
+
+      path = "#{Terraspace.root}/config/envs/#{Terraspace.env}.rb"
       evaluate_file(path)
     end
   end

data/lib/terraspace/app/inits.rb

@@ -0,0 +1,13 @@
+class Terraspace::App
+  class Inits
+    class << self
+      include DslEvaluator
+
+      def run_all
+        Dir.glob("#{Terraspace.root}/config/inits/*.rb").each do |path|
+          evaluate_file(path)
+        end
+      end
+    end
+  end
+end

data/lib/terraspace/booter.rb

@@ -5,6 +5,7 @@ module Terraspace
       load_plugin_default_configs
       Terraspace.config # load project config
       Terraspace::App::Hooks.run_hook(:on_boot)
+      Terraspace::App::Inits.run_all
       set_plugin_cache!
     end
 

data/lib/terraspace/cli.rb

@@ -10,7 +10,7 @@ module Terraspace
       option :format, desc: "output formats: json, text"
     }
     out_option = Proc.new {
-      option :out, aliases: :o, desc: "write the output to path"
+      option :out, aliases: :o, desc: "Write the output to path"
     }
     input_option = Proc.new {
       option :input, type: :boolean, desc: "Ask for input for variables if not directly set."
@@ -36,14 +36,14 @@ module Terraspace
     long_desc Help.text(:clean)
     subcommand "clean", Clean
 
-    desc "cloud SUBCOMMAND", "cloud subcommands"
-    long_desc Help.text(:cloud)
-    subcommand "cloud", Cloud
-
     desc "new SUBCOMMAND", "new subcommands"
     long_desc Help.text(:new)
     subcommand "new", New
 
+    desc "tfc SUBCOMMAND", "tfc subcommands"
+    long_desc Help.text(:tfc)
+    subcommand "tfc", Tfc
+
     desc "build [STACK]", "Build project."
     long_desc Help.text(:build)
     option :quiet, type: :boolean, desc: "quiet output"
@@ -123,6 +123,7 @@ module Terraspace
     instance_option.call
     out_option.call
     reconfigure_option.call
+    option :copy_to_root, type: :boolean, default: true, desc: "Copy plan file generated in the cache folder back to project root"
     def plan(mod)
       Commander.new("plan", options.merge(mod: mod)).run
     end
@@ -144,7 +145,7 @@ module Terraspace
     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"
+    option :where, desc: "where to create file. either under app or seed folder structure. values: seed or stack"
     init_option.call
     instance_option.call
     def seed(mod)
@@ -169,6 +170,12 @@ module Terraspace
       Commander.new("show", options.merge(mod: mod)).run
     end
 
+    desc "state SUBCOMMAND STACK", "Run state."
+    long_desc Help.text(:state)
+    def state(subcommand, mod)
+      State.new(options.merge(subcommand: subcommand, mod: mod)).run
+    end
+
     desc "test", "Run test."
     long_desc Help.text(:test)
     def test

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

@@ -26,7 +26,12 @@ module Terraspace::CLI::Build
 
     # Used by: terraspace build placeholder
     def find_stack
-      mod_path = Dir.glob("{app,vendor}/{stacks}/*").last
+      stack_paths = Dir.glob("{app,vendor}/stacks/*")
+      stack_paths.select! do |path|
+        select = Terraspace::Compiler::Select.new(path)
+        select.selected?
+      end
+      mod_path = stack_paths.last
       unless mod_path
         logger.info "No stacks found."
         exit 0

data/lib/terraspace/cli/commander.rb

@@ -7,7 +7,7 @@ class Terraspace::CLI
 
     def run
       Terraspace::Builder.new(@options).run unless @options[:build] # Up already ran build
-      Init.new(@options.merge(calling_command: @name)).run
+      Init.new(@options).run
       Terraspace::Terraform::Runner.new(@name, @options).run
     end
   end

data/lib/terraspace/cli/down.rb

@@ -14,7 +14,7 @@ class Terraspace::CLI
 
     def destroy
       Commander.new("destroy", @options.merge(command: "down")).run
-      Terraspace::Terraform::Cloud::Workspace.new(@options).destroy if @options[:destroy_workspace]
+      Terraspace::Terraform::Tfc::Workspace.new(@options).destroy if @options[:destroy_workspace]
     end
   end
 end

data/lib/terraspace/cli/help/{cloud → tfc}/destroy.md

@@ -1,6 +1,6 @@
 ## Example
 
-    $ terraspace cloud destroy demo
+    $ terraspace tfc destroy demo
     You are about to delete the workspace: demo-dev-us-west-2
     All variables, settings, run history, and state history will be removed.
     This cannot be undone.

data/lib/terraspace/cli/help/{cloud → tfc}/list.md

@@ -1,6 +1,6 @@
 ## Example
 
-    $ terraspace cloud list
+    $ terraspace tfc list
     Workspaces for boltops:
     demo-dev-us-west-2
     demo2-dev-us-west-2

data/lib/terraspace/cli/help/{cloud → tfc}/runs/list.md

@@ -2,7 +2,7 @@
 
 Statuses of pending and planned are shown by default.
 
-    $ terraspace cloud runs list demo
+    $ terraspace tfc runs list demo
     +----------------------+---------+---------------------------------+---------------------+
     |          Id          | Status  |             Message             |     Created At      |
     +----------------------+---------+---------------------------------+---------------------+
@@ -13,7 +13,7 @@ Statuses of pending and planned are shown by default.
 
 To see all most recent runs, use `--status all`.
 
-    $ terraspace cloud runs list demo --status all
+    $ terraspace tfc runs list demo --status all
     +----------------------+-----------+--------------------------------+---------------------+
     |          Id          |  Status   |            Message             |     Created At      |
     +----------------------+-----------+--------------------------------+---------------------+
@@ -26,7 +26,7 @@ To see all most recent runs, use `--status all`.
 
 You can provide a list of statuses to the `--status` filter option.
 
-    $ terraspace cloud runs list demo --status canceled discarded
+    $ terraspace tfc runs list demo --status canceled discarded
     +----------------------+-----------+--------------------------------+---------------------+
     |          Id          |  Status   |            Message             |     Created At      |
     +----------------------+-----------+--------------------------------+---------------------+