terraspace 0.5.12 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85fe397ec78c3f7aef5a84305c0a1f64bb6c8f1fe600f42b0d6595de4b5e579b
-  data.tar.gz: 5549151c17289da5bf06dcdbae93437cd53ec338c1e8f6649fef7f2c71eb21da
+  metadata.gz: 56392f488a05d42760586d379da36022589979733b654ea3f5f3d5fcb879de26
+  data.tar.gz: 690b3d0fa3e192aee02fd34ae187ab4628caccd335a1733ce10040ff2ef55b32
 SHA512:
-  metadata.gz: 3155ac6e54e382836f73fa2bd3904544bbc9be86eb9a7f4a140a78062e83c320c493efc67fa92db0fa5d5a7e994d8293b674f324f70ff39b5242130883d6c28c
-  data.tar.gz: 368950badea2768a4221593d65eadda27c3a84eb4f2f1a9b4af0e5a53da05faa67cbfff8d99850d846c2e64aa110bd347178866e2caa05e9e084c8411489a9af
+  metadata.gz: 4dcc7b6c1d1f2d21be6115d02cc34bbeb9f773e6ece16e8549ac3a8e6a4167fb6392a2917399399a0ba0ddde4ff880c9dff8de2ee5261def5250fc2525527ce1
+  data.tar.gz: 476d2c10897c2915a3cd601b556e783a639cb29a97c11505b5e34f32d8079c311e5ad8f6efeeee6cf9a143a2f63b9b46b76a9b6741d78802fd53baf8de319b29

data/CHANGELOG.md

@@ -3,6 +3,29 @@
 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.4] - 2021-03-22
+- [#94](https://github.com/boltops-tools/terraspace/pull/94) terraspace fmt command
+
+## [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
@@ -108,7 +131,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 +150,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 +184,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,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
@@ -47,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"
@@ -82,6 +82,12 @@ module Terraspace
       Down.new(options.merge(mod: mod)).run
     end
 
+    desc "fmt", "Run terraform fmt"
+    long_desc Help.text(:fmt)
+    def fmt
+      Fmt.new(options).run
+    end
+
     desc "info STACK", "Get info about stack."
     long_desc Help.text(:info)
     instance_option.call
@@ -123,6 +129,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 +176,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/concerns/source_dirs.rb

@@ -0,0 +1,13 @@
+module Terraspace::CLI::Concerns
+  module SourceDirs
+    # used by list
+    def source_dirs
+      Dir.glob("{app,vendor}/{modules,stacks}/*").select { |p| File.directory?(p) }.sort
+    end
+
+    # dont include vendor: used by fmt
+    def app_source_dirs
+      Dir.glob("{app}/{modules,stacks}/*").select { |p| File.directory?(p) }.sort
+    end
+  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/fmt.rb

@@ -0,0 +1,21 @@
+class Terraspace::CLI
+  class Fmt
+    include Concerns::SourceDirs
+    include Terraspace::Util::Logging
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def run
+      logger.info "Formating terraform files"
+      app_source_dirs.each do |dir|
+        format(dir)
+      end
+    end
+
+    def format(dir)
+      Runner.new(dir).format!
+    end
+  end
+end

data/lib/terraspace/cli/fmt/runner.rb

@@ -0,0 +1,64 @@
+class Terraspace::CLI::Fmt
+  class Runner
+    include Terraspace::CLI::Concerns::SourceDirs
+    include Terraspace::Util::Logging
+    SKIP_PATTERN = /\.skip$/
+
+    def initialize(dir)
+      @dir = dir
+    end
+
+    def format!
+      logger.info @dir.color(:green)
+      Dir.chdir(@dir) do
+        skip_rename
+        begin
+          terraform_fmt
+        ensure
+          restore_rename
+        end
+      end
+    end
+
+    def skip_rename
+      tf_files.each do |path|
+        if !skip?(path) && erb?(path)
+          FileUtils.mv(path, "#{path}.skip")
+        end
+      end
+    end
+
+    def terraform_fmt
+      sh "terraform fmt"
+    end
+
+    def sh(command)
+      logger.debug("=> #{command}")
+      success = system(command)
+      return if success
+      logger.info "WARN: There were some errors running terraform fmt for files in #{@dir}:".color(:yellow)
+      logger.info "The errors are shown above"
+    end
+
+    def restore_rename
+      tf_files.each do |path|
+        if skip?(path) && erb?(path)
+          FileUtils.mv(path, path.sub(SKIP_PATTERN, '')) # original name
+        end
+      end
+    end
+
+  private
+    def skip?(path)
+      !!(path =~ SKIP_PATTERN)
+    end
+
+    def erb?(path)
+      IO.readlines(path).detect { |l| l.include?('<%') }
+    end
+
+    def tf_files
+      Dir.glob("#{Terraspace.root}/#{@dir}/**/*.{tf,skip}").select { |p| File.file?(p) }
+    end
+  end
+end

data/lib/terraspace/cli/help/fmt.md

@@ -0,0 +1,10 @@
+## Example
+
+    $ terraspace fmt
+    Formating terraform files
+    app/modules/example
+    main.tf
+    outputs.tf
+    variables.tf
+    app/stacks/demo
+    main.tf

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