terraspace 0.4.2 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0174dca33a15bfe2c0eb0a1e0f573599ab7de2850d746e6f0be4e34aec573e39
-  data.tar.gz: 4d2b91fb5631d3fa1c32379845cc1f3d677238edc7133015cf99050e874339f4
+  metadata.gz: f6a2a88fa818f4181306424fffdba0416c2df409e464b632ea941e761b8ed275
+  data.tar.gz: eaf2ce61be5ff4b72f01e6f4ca9da7eb4ee573f42e5865319a90630659544c2e
 SHA512:
-  metadata.gz: b624c36518fd03e4b03c8ddba62dc196ea656f26921086ddb3dec4859f613b3da2534f0320f0c6197a53fd31d9f5a44ad98f5c5c4b3914164185707a42eb007e
-  data.tar.gz: 87b7625d52efd046193ec7ed9abfb7e311b7b143d70e492db84e60cccb4b90fea872d1f6333901d95a6c9af7d07bf2d5027980aa482794d5f60b27ed9a8e3e41
+  metadata.gz: b6b38903334e7855e19517ec79059dd9887d85aa44819ed811af0deedaae8fbed5d8502546e675302c786604a7c110313a27b312a5489cff26071a9c784e8bd0
+  data.tar.gz: f117135d46f25c238e89a459666ade7fe4ef944726abae05fe9af4e6101e42198d5f91d39e06f42bfbb20f987f172ac4b677d08e3bf66c84272c0746751fdcfe

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

@@ -10,6 +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 new test demo --type stack
+cd app/stacks/demo
 terraspace test

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

@@ -17,6 +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 new test demo --type stack
+cd app/stacks/demo
 terraspace test

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

@@ -14,6 +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 new test demo --type stack
+cd app/stacks/demo
 terraspace test

data/.github/ISSUE_TEMPLATE.md

@@ -2,6 +2,6 @@ Please fill out one of the templates on https://github.com/boltops-tools/terrasp
 
 If you want to ask a question please do so on sites like StackOverflow.
 
-To be sensitive to everyone's time, we may close issues asking questions without comment. Here are some additional options also https://terraspace.cloud/docs/support/ 👌
+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/ 👌
 
 Thank you!

data/CHANGELOG.md

@@ -3,6 +3,37 @@
 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.5.2] - 2020-11-27
+- [#59](https://github.com/boltops-tools/terraspace/pull/59) only run bundler/setup within terraspace project and check standalone install
+- fix terraspace help
+- fix terraspace setup check when terraform is not installed
+
+## [0.5.1] - 2020-11-17
+- [#56](https://github.com/boltops-tools/terraspace/pull/56) fix arg and hook generators
+- fix ci build
+
+## [0.5.0] - 2020-11-15
+- [#55](https://github.com/boltops-tools/terraspace/pull/55) custom helpers support
+- plugin helpers support: aws_secret, aws_ssm, google_secret, etc
+- introduce stack-level test concept and change project-level test concept
+- generators: standardize and unifiy new test
+- new generators: arg, hook, helper
+- clean up Terraspace check project
+- setup up autoloader and bundler/setup earlier. removes need for shim
+- test generator plugin autodetection
+- remove internal run_generator_hook_script
+- stack-level args customization support
+- improve test output noise-level
+- new setting: config.terraform.plugin_cache.purge_on_error
+- quiet option for project generator
+
+## [0.4.4]
+- #50 retry logic for shared cache error
+- #51 fix cloud sync: call build first
+
+## [0.4.3]
+* #49 add info --path option
+
 ## [0.4.2]
 * #48 add logs pid option
 * default to input false, encourage set tfvars

data/README.md

@@ -105,10 +105,11 @@ To install modules:
 
 * [Config Structure](https://terraspace.cloud/docs/config/): A common config structure that gets materializes with the deployed module. Configs can be dynamically controlled to keep your code DRY. You can override the settings if needed, like for using existing backends. See: [Existing Backends](https://terraspace.cloud/docs/state/existing/).
 * [Generators](https://terraspace.cloud/docs/generators/): Built-in generators to quickly create the starter module. Focus on code instead of boilerplate structure.
-* [Tfvars](https://terraspace.cloud/docs/tfvars/) & [Layering](https://terraspace.cloud/docs/tfvars/layering/): Use the same code with different tfvars to create multiple environments. Terraspace conventionally loads tfvars from the `tfvars` folder. Rich layering support allows you to build different environments like dev and prod with the same code.  Examples are in [Full Layering](https://terraspace.cloud/docs/tfvars/full-layering/).
+* [Multiple Environments](https://terraspace.cloud/docs/patterns/multiple-envs/): [Tfvars](https://terraspace.cloud/docs/tfvars/) & [Layering](https://terraspace.cloud/docs/tfvars/layering/) allow you to the same code with different tfvars to create multiple environments. Terraspace conventionally loads tfvars from the `tfvars` folder. Rich layering support allows you to build different environments like dev and prod with the same code.  Examples are in [Full Layering](https://terraspace.cloud/docs/tfvars/full-layering/).
 * [Deploy Multiple Stacks](https://terraspace.cloud/docs/intro/deploy-all/): The ability to deploy multiple stacks with a single command. Terraspace calculates the [dependency graph](https://terraspace.cloud/docs/dependencies/) and deploys stacks in the right order. You can also target specific stacks and deploy [subgraphs](https://terraspace.cloud/docs/dependencies/subgraphs/).
-* [Terrafile](https://terraspace.cloud/docs/terrafile/}): Terraspace makes it easy to use Terraform modules sourced from your own git repositories, other git repositories, or the Terraform Registry. The git repos can be private or public. This is an incredibly powerful feature of Terraspace because it opens up a world of modules for you to use.  Use any module you want.
-* [Configurable CLI](https://terraspace.cloud/docs/cli/): Configurable [CLI Hooks](https://terraspace.cloud/docs/cli/hooks/) and [CLI Args](https://terraspace.cloud/docs/cli/args/) allow you to adjust the underlying terraform command.
+* [Secrets Support](https://terraspace.cloud/docs/helpers/aws/secrets/): Terraspace has built-in secrets support for [AWS Secrets Manager](https://terraspace.cloud/docs/helpers/aws/secrets/), [AWS SSM Parameter Store](https://terraspace.cloud/docs/helpers/aws/ssm/), [Azure Key Vault](https://terraspace.cloud/docs/helpers/azure/secrets/), [Google Secrets Manager](https://terraspace.cloud/docs/helpers/google/secrets/). Easily set variables from Cloud secrets providers.
+* [Terrafile](https://terraspace.cloud/docs/terrafile/): Terraspace makes it easy to use Terraform modules sourced from your own git repositories, other git repositories, or the Terraform Registry. The git repos can be private or public. This is an incredibly powerful feature of Terraspace because it opens up a world of modules for you to use.  Use any module you want.
+* [Configurable CLI](https://terraspace.cloud/docs/config/args/): Configurable [CLI Hooks](https://terraspace.cloud/docs/config/hooks/) and [CLI Args](https://terraspace.cloud/docs/config/args/) allow you to adjust the underlying terraform command.
 * [Testing](https://terraspace.cloud/docs/testing/): A testing framework that allows you to create test harnesses, deploy real-resources, and have higher confidence that your code works.
 * [Terraform Cloud and Terraform Enterprise Support](https://terraspace.cloud/docs/cloud/): TFC and TFE are both supported. Terraspace adds additional conveniences to make working with Terraform Cloud Workspaces easier.
 

data/lib/templates/base/arg/terraform.rb.tt

@@ -0,0 +1,3 @@
+command("<%= name %>",
+  args: ["-lock-timeout=22m"],
+)

data/lib/templates/base/helper/%name%_helper.rb.tt

@@ -0,0 +1,2 @@
+module <%= helper_class %>
+end

data/lib/templates/base/hook/%kind%.rb.tt

@@ -0,0 +1,7 @@
+before("<%= name %>",
+  execute: "echo '<%= hook_path %>: test <%= type %> before hook for <%= kind %> <%= name %>'",
+)
+
+after("<%= name %>",
+  execute: "echo '<%= hook_path %>: test <%= type %> after hook for <%= kind %> <%= name %>'"
+)

data/lib/terraspace.rb

@@ -1,6 +1,10 @@
 $stdout.sync = true unless ENV["TS_STDOUT_SYNC"] == "0"
 
 $:.unshift(File.expand_path("../", __FILE__))
+
+require "terraspace/autoloader"
+Terraspace::Autoloader.setup
+
 require "active_support/concern"
 require "active_support/core_ext/class"
 require "active_support/core_ext/hash"
@@ -18,16 +22,15 @@ require "set"
 require "terraspace/ext"
 require "terraspace/version"
 
-require "terraspace/autoloader"
-Terraspace::Autoloader.setup
-
 DslEvaluator.backtrace_reject = "lib/terraspace"
 
 module Terraspace
   extend Core # for Terraspace.root
   class Error < StandardError; end
-  class InitRequiredError < Error; end
+
   class BucketNotFoundError < Error; end
+  class InitRequiredError < Error; end
+  class SharedCacheError < Error; end
 end
 
 Terraspace::Booter.boot

data/lib/terraspace/all/base.rb

@@ -2,7 +2,6 @@ module Terraspace::All
   class Base
     def initialize(options={})
       @options = options
-      Terraspace.check_project! unless ENV['TS_TEST']
     end
   end
 end

data/lib/terraspace/app.rb

@@ -47,6 +47,7 @@ module Terraspace
       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
     end

data/lib/terraspace/autoloader.rb

@@ -3,6 +3,11 @@ Terraspace::Bundle.setup
 require "zeitwerk"
 
 module Terraspace
+  # These modules are namespaces for user-defined custom helpers
+  module Module; end
+  module Project; end
+  module Stack; end
+
   class Autoloader
     class Inflector < Zeitwerk::Inflector
       def camelize(basename, _abspath)
@@ -16,10 +21,20 @@ module Terraspace
         loader = Zeitwerk::Loader.new
         loader.inflector = Inflector.new
         loader.push_dir(File.dirname(__dir__)) # lib
+        loader.push_dir(project_helpers, namespace: Terraspace::Project) if File.exist?(project_helpers)
         loader.log! if ENV["TS_AUTOLOAD_LOG"]
-        loader.ignore("#{__dir__}/core_ext.rb")
+        loader.ignore("#{__dir__}/ext.rb")
         loader.setup
       end
+
+      def project_helpers
+        "#{ts_root}/config/helpers"
+      end
+
+      # Duplicate definition because autoloader logic runs very early and doesnt have access to core methods yet
+      def ts_root
+        ENV['TS_ROOT'] || Dir.pwd
+      end
     end
   end
 end

data/lib/terraspace/bundle.rb

@@ -8,6 +8,7 @@ module Terraspace
     #
     def setup
       return unless gemfile?
+      return unless terraspace_project?
       Kernel.require "bundler/setup"
       Bundler.setup # Same as Bundler.setup(:default)
     rescue LoadError => e
@@ -16,12 +17,17 @@ module Terraspace
 
     def require
       return unless gemfile?
+      return unless terraspace_project?
       Kernel.require "bundler/setup"
       Bundler.require(*bundler_groups)
     rescue LoadError => e
       handle_error(e)
     end
 
+    def terraspace_project?
+      File.exist?("config/app.rb")
+    end
+
     def handle_error(e)
       puts e.message
       return if e.message.include?("already activated")

data/lib/terraspace/cli.rb

@@ -86,6 +86,7 @@ module Terraspace
     long_desc Help.text(:info)
     instance_option.call
     option :format, desc: "Output formats: #{CliFormat.formats.join(', ')}"
+    option :path, desc: "Print path to built path"
     def info(mod)
       Info.new(options.merge(mod: mod)).run
     end

data/lib/terraspace/cli/bundle.rb

@@ -7,7 +7,6 @@ class Terraspace::CLI
     end
 
     def run
-      Terraspace.check_project!
       TerraspaceBundler.config.deep_merge!(Terraspace.config.bundle)
       TerraspaceBundler::CLI.start(args)
     end

data/lib/terraspace/cli/check_setup.rb

@@ -39,6 +39,11 @@ class Terraspace::CLI
     end
 
     def ok?
+      unless terraform_bin
+        puts "Terraform not installed. Unable to detect a terraform command. Please double check that terraform is installed."
+        exit 1
+      end
+
       version = terraform_version_message.sub(/.*v/,'') # => 0.12.24
       unless version.match(/\d+\.\d+\.\d+/) # just parse did not find the version number
         puts "WARN: Unable to get the terraform version".color(:yellow)

data/lib/terraspace/cli/clean/base.rb

@@ -5,7 +5,6 @@ class Terraspace::CLI::Clean
 
     def initialize(options={})
       @options = options
-      Terraspace.check_project!
     end
 
     def pretty(path)

data/lib/terraspace/cli/clean/cache.rb

@@ -1,7 +1,6 @@
 class Terraspace::CLI::Clean
   class Cache < Base
     def run
-      Terraspace.check_project!
       paths = [Terraspace.cache_root, Terraspace.tmp_root]
       are_you_sure?(paths)
       paths.each do |path|

data/lib/terraspace/cli/cloud.rb

@@ -16,6 +16,7 @@ class Terraspace::CLI
 
     desc "destroy STACK", "Destroy workspace by specifying the stack"
     long_desc Help.text("cloud:destroy")
+    yes_option.call
     def destroy(mod)
       Workspace.new(options.merge(mod: mod)).destroy
     end
@@ -24,6 +25,7 @@ class Terraspace::CLI
     long_desc Help.text("cloud:sync")
     yes_option.call
     def sync(*stacks)
+      Terraspace::CLI::Build::Placeholder.new(options).build
       Syncer.new(options.merge(stacks: stacks, override_auto_sync: true)).run
     end
 

data/lib/terraspace/cli/help/new/arg.md

@@ -0,0 +1,19 @@
+## Examples
+
+Project-level arg:
+
+    $ terraspace new arg --type project
+          create  config/args
+          create  config/args/terraform.rb
+
+Stack-level arg:
+
+    $ terraspace new arg demo --type stack
+          create  app/stacks/demo/config/args
+          create  app/stacks/demo/config/args/terraform.rb
+
+Module-level arg:
+
+    $ terraspace new arg example --type module
+          create  app/modules/example/config/args
+          create  app/modules/example/config/args/terraform.rb

data/lib/terraspace/cli/help/new/helper.md

@@ -0,0 +1,39 @@
+## Project Examples
+
+Conventionally name the helper custom.
+
+    $ terraspace new helper custom --type project
+          create  config/helpers
+          create  config/helpers/custom_helper.rb
+
+## Stack Examples
+
+Conventionally name the helper to be the same as the stack name.
+
+    $ terraspace new helper demo --type stack
+          create  app/stacks/demo/config/helpers
+          create  app/stacks/demo/config/helpers/demo_helper.rb
+    $
+
+Explictly name helper method. IE: custom here.
+
+    $ terraspace new helper demo --type stack --name custom
+          create  app/stacks/demo/config/helpers
+          create  app/stacks/demo/config/helpers/custom_helper.rb
+    $
+
+## Module Examples
+
+Conventionally name the helper to be the same as the module name.
+
+    $ terraspace new helper example --type module
+          create  app/module/example/config/helpers
+          create  app/module/example/config/helpers/example_helper.rb
+    $
+
+Explictly name helper method. IE: custom here.
+
+    $ terraspace new helper example --type module --name custom
+          create  app/module/example/config/helpers
+          create  app/module/example/config/helpers/custom_helper.rb
+    $

data/lib/terraspace/cli/help/new/hook.md

@@ -0,0 +1,25 @@
+## Examples
+
+Project-level hook:
+
+    $ terraspace new hook --type project
+          create  config/hooks
+          create  config/hooks/terraform.rb
+
+Stack-level hook:
+
+    $ terraspace new hook demo --type stack
+          create  app/stacks/demo/config/hooks
+          create  app/stacks/demo/config/hooks/terraform.rb
+
+Stack-level hook with kind option:
+
+    $ terraspace new hook demo --type stack --kind terraspace
+           exist  app/stacks/demo/config/hooks
+          create  app/stacks/demo/config/hooks/terraspace.rb
+
+Module-level hook:
+
+    $ terraspace new hook example --type module
+          create  app/modules/example/config/hooks
+          create  app/modules/example/config/hooks/terraform.rb

data/lib/terraspace/cli/help/new/test.md

@@ -0,0 +1,34 @@
+## Stack Examples
+
+    $ terraspace new test demo --type stack
+    => Creating stack test: example
+           exist  app/stacks/example
+          create  app/stacks/example/test/.rspec
+          create  app/stacks/example/test/Gemfile
+          create  app/stacks/example/test/spec/fixtures/stack/main.tf
+          create  app/stacks/example/test/spec/fixtures/stack/outputs.tf
+          create  app/stacks/example/test/spec/main_spec.rb
+          create  app/stacks/example/test/spec/spec_helper.rb
+    $
+
+## Module Examples
+
+    $ terraspace new test example --type module
+    => Creating module test: example
+           exist  app/modules/example
+          create  app/modules/example/test/.rspec
+          create  app/modules/example/test/Gemfile
+          create  app/modules/example/test/spec/fixtures/stack/main.tf
+          create  app/modules/example/test/spec/fixtures/stack/outputs.tf
+          create  app/modules/example/test/spec/main_spec.rb
+          create  app/modules/example/test/spec/spec_helper.rb
+    $
+
+## Project Examples
+
+    $ terraspace new test my --type project
+    => Creating test bootstrap structure
+           exist
+          create  .rspec
+          create  spec/spec_helper.rb
+    $

data/lib/terraspace/cli/info.rb

@@ -3,6 +3,14 @@ class Terraspace::CLI
     extend Memoist
 
     def run
+      if @options[:path]
+        show_path
+      else
+        show_all
+      end
+    end
+
+    def show_all
       presenter = CliFormat::Presenter.new(@options)
       presenter.header = %w[Name Value]
       info.each do |k,v|
@@ -11,6 +19,10 @@ class Terraspace::CLI
       presenter.show
     end
 
+    def show_path
+      puts info[:cache_dir]
+    end
+
     def info
       @mod.to_info
     end