terraspace 0.5.11 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ab8d16e8890ccbd14785cdc20245e47a126593337d0330bfecbb902336a32d8
-  data.tar.gz: 51f9b735befd7ea059ff6541414e3f80631a9bc5b511fc69f4e1f489e6f9a72e
+  metadata.gz: f9b4a9918ee0ab0e10c6c4d2d0ed1a88851fda09b7a6b1475db084c6f7cb1699
+  data.tar.gz: 2b66a6e8be57c94aaf24334a073943c28e11fbcd77f1d7853cf0885e9e87ec9e
 SHA512:
-  metadata.gz: b3d6fca3b2b9b2fcdabd48d6b093e7a3dcfafe4f53a482dc7fffb3a001bca89a743b294b12ccc92e2cb7010799e0d147e402406afaa93de48149d94fd9c894f3
-  data.tar.gz: 5a36c2d3d9f847989f639829be9fae0b5b1a9a6e48f636478b1560a94a45fca2ff74db5800ebaa8ed97977c2b5e83a72a99292f8737c6737ebabd1ba748bd026
+  metadata.gz: dcabae82c7a30ddcc364a13ce85f73ce461307cde54ab95fd2fb1d2c21558c03123058c8d282e339ae4f47f0fd927061eee12d74ba71f403cc6b7cb9f7fd8e3e
+  data.tar.gz: f8c625671745fccdb13139efcd13c737b6f4a2ee0161badc75677bdedc544a94566c0eb8e865c2c68635bab7c648232d7275b88f20d0f9a8677d74b74c95c75f

data/CHANGELOG.md

@@ -3,6 +3,30 @@
 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.3] - 2021-03-12
+- [#91](https://github.com/boltops-tools/terraspace/pull/91) Camelcase
+- [#92](https://github.com/boltops-tools/terraspace/pull/92) disable terraform.plugin_cache by default
+- skip build config/helpers
+
+## [0.6.2] - 2021-03-05
+- [#90](https://github.com/boltops-tools/terraspace/pull/90) Boot hooks: new and improved boot hooks interface
+- remove old config.hooks.on_boot
+
+## [0.6.1] - 2021-03-04
+- [#89](https://github.com/boltops-tools/terraspace/pull/89) rename option to enable_names.expansion
+
+## [0.6.0] - 2021-03-03
+- [#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
+- 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
@@ -104,7 +128,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
 
@@ -123,8 +147,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`
@@ -157,11 +181,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,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,17 +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
       config.log = ActiveSupport::OrderedOptions.new
@@ -46,22 +36,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.expansion = 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.enabled = false
       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

@@ -1,10 +1,10 @@
 module Terraspace
   module Booter
     def boot
+      run_hooks
       Terraspace::Bundle.require # load plugins
       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
 
@@ -23,6 +23,23 @@ module Terraspace
       dir
     end
 
+    # Special boot hooks run super early, even before plugins are loaded.
+    # Useful for setting env vars and other early things.
+    #
+    #    config/boot.rb
+    #    config/boot/dev.rb
+    #
+    def run_hooks
+      run_hook
+      run_hook(Terraspace.env)
+    end
+
+    def run_hook(env=nil)
+      name = env ? "boot/#{env}" : "boot"
+      path = "#{Terraspace.root}/config/#{name}.rb"
+      require path if File.exist?(path)
+    end
+
     extend self
   end
 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      |
     +----------------------+-----------+--------------------------------+---------------------+

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