terraspace 0.5.12 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85fe397ec78c3f7aef5a84305c0a1f64bb6c8f1fe600f42b0d6595de4b5e579b
-  data.tar.gz: 5549151c17289da5bf06dcdbae93437cd53ec338c1e8f6649fef7f2c71eb21da
+  metadata.gz: 5e6515cd30855a02e17147354db57995da471812f6437611140f715726268bb6
+  data.tar.gz: 33a4066b1a30d091fe7881bbafccc0778f47715d6bea7671ba9f011e1f3702a5
 SHA512:
-  metadata.gz: 3155ac6e54e382836f73fa2bd3904544bbc9be86eb9a7f4a140a78062e83c320c493efc67fa92db0fa5d5a7e994d8293b674f324f70ff39b5242130883d6c28c
-  data.tar.gz: 368950badea2768a4221593d65eadda27c3a84eb4f2f1a9b4af0e5a53da05faa67cbfff8d99850d846c2e64aa110bd347178866e2caa05e9e084c8411489a9af
+  metadata.gz: 6b3b7c108ac28b8cf83c4cde07ed64f4fc84d8109bc77c5b1ddaa3018e70393e9cb57cbc7fc65315e7877e55833bd434695753ed8cb71b31bb249a440c96c910
+  data.tar.gz: 3b85a43ae356e6c95def1ab614ef86af19e3c875752d265a5de55ada4f66b12830d514d2655841f973690b449d8fc38f610ac6b146ba943e3d37d72694e86d79

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.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
@@ -108,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
 
@@ -127,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`
@@ -161,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/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,8 +11,6 @@ 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
@@ -29,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
@@ -47,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
@@ -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/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      |
     +----------------------+-----------+--------------------------------+---------------------+

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

@@ -2,12 +2,12 @@ This leaves the top run alone. The top run usually starts immediately planning o
 
 ## Examples
 
-    terraspace cloud runs prune demo --noop
-    terraspace cloud runs prune demo # live run
+    terraspace tfc runs prune demo --noop
+    terraspace tfc runs prune demo # live run
 
 ## Example with Output
 
-    $ terraspace cloud runs prune demo
+    $ terraspace tfc runs prune demo
     Will keep:
 
         run-9muMrjrd22vhsP4u pending test 2020-09-18T12:47:11

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

@@ -2,7 +2,7 @@
 
 Sync all stacks:
 
-    $ terraspace cloud sync
+    $ terraspace tfc sync
     About to sync these project stacks with Terraform Cloud workspaces:
 
         Stack => Workspace
@@ -22,7 +22,7 @@ Sync all stacks:
 
 Sync specific stacks:
 
-    $ terraspace cloud sync demo
+    $ terraspace tfc sync demo
     About to sync these project stacks with Terraform Cloud workspaces:
 
         Stack => Workspace
@@ -40,4 +40,4 @@ Sync specific stacks:
 
 Can also specify multiple stacks:
 
-    terraspace cloud sync demo demo2
+    terraspace tfc sync demo demo2

data/lib/terraspace/cli/init.rb

@@ -3,10 +3,9 @@ require 'timeout'
 class Terraspace::CLI
   class Init < Base
     def initialize(options={})
-      # Original calling command. Can be from Commander which is a terraform command. IE: terraform apply
-      # Or can be from terraspace cloud setup. Which will be cloud-setup.
-      @calling_command = options[:calling_command]
-      super(options)
+      # terraform init output goes to default Terraspace.logger.info which is stderr
+      # Unless the logger has been overridden.
+      super(options.merge(log_to_stderr: true))
     end
 
     def run
@@ -29,7 +28,11 @@ class Terraspace::CLI
     end
 
     def sync_cloud
-      Terraspace::Terraform::Cloud::Sync.new(@options).run if %w[apply plan destroy cloud-setup].include?(@calling_command)
+      Terraspace::Terraform::Tfc::Sync.new(@options).run if sync_cloud?
+    end
+
+    def sync_cloud?
+       %w[apply down plan up].include?(calling_command)
     end
 
     # Currently only handles remote modules only one-level deep.
@@ -54,16 +57,21 @@ class Terraspace::CLI
 
     def auto?
       # command is only passed from CLI in the update specifically for this check
-      @options[:auto] && @calling_command == "apply"
+      @options[:auto] && calling_command == "up"
     end
   private
     def local_source?(s)
        s =~ %r{^\.} || s =~ %r{^/}
     end
 
+    def auto_init?
+      # terraspace commands not terraform commands. included some extra terraform commands here in case terrapace adds those later
+      commands = %w[all apply console down output plan providers refresh show state up validate]
+      commands.include?(calling_command)
+    end
+
     def run_init?
-      commands = %w[apply console destroy output plan providers refresh show validate cloud-setup]
-      return false unless commands.include?(@calling_command)
+      return false unless auto_init?
       mode = ENV['TS_INIT_MODE'] || Terraspace.config.init.mode
       case mode.to_sym
       when :auto
@@ -87,5 +95,10 @@ class Terraspace::CLI
       end
       !!provider
     end
+
+    # only top level command considered
+    def calling_command
+      ARGV[0]
+    end
   end
 end

data/lib/terraspace/cli/state.rb

@@ -0,0 +1,10 @@
+class Terraspace::CLI
+  class State < Base
+    def run
+      @name = "state #{@options[:subcommand]}" # command name. IE: state list
+      Terraspace::Builder.new(@options).run
+      Init.new(@options).run
+      Terraspace::Terraform::Runner.new(@name, @options).run
+    end
+  end
+end

data/lib/terraspace/cli/{cloud.rb → tfc.rb}

@@ -1,7 +1,7 @@
 class Terraspace::CLI
-  class Cloud < Terraspace::Command
-    Syncer = Terraspace::Terraform::Cloud::Syncer
-    Workspace = Terraspace::Terraform::Cloud::Workspace
+  class Tfc < Terraspace::Command
+    Syncer = Terraspace::Terraform::Tfc::Syncer
+    Workspace = Terraspace::Terraform::Tfc::Workspace
 
     yes_option = Proc.new {
       option :yes, aliases: :y, type: :boolean, desc: "bypass are you sure prompt"

data/lib/terraspace/cli/{cloud → tfc}/runs.rb

@@ -1,10 +1,10 @@
-class Terraspace::CLI::Cloud
+class Terraspace::CLI::Tfc
   class Runs < Terraspace::Command
     Help = Terraspace::CLI::Help
-    Runs = Terraspace::Terraform::Cloud::Runs
+    Runs = Terraspace::Terraform::Tfc::Runs
 
     desc "list STACK", "List runs."
-    long_desc Help.text("cloud:runs:list")
+    long_desc Help.text("tfc: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)
@@ -12,7 +12,7 @@ class Terraspace::CLI::Cloud
     end
 
     desc "prune STACK", "Prune runs that are possible to cancel or discard."
-    long_desc Help.text("cloud:runs:prune")
+    long_desc Help.text("tfc: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)