terraspace 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bae908fcf2dc448dc5b0d2bba463eedd9487c428a296b74955975b66e2faa7c3
-  data.tar.gz: bef0979ecaeab8eca50387da95a119719696a759ecff7de55659ff0d8cbac322
+  metadata.gz: bbf29f1226e7dc336c0eaf99892e158aff3b804bd56bbd1dc744fd17a65c6ff0
+  data.tar.gz: 6c32f1fe94e9dc53f6ddbfca3cef7c1178a11d788b32ad6ad3fdc88d64e268fa
 SHA512:
-  metadata.gz: 882b9a94cf48af9399a66540385dcd7dbcdbb8118df046c6af833e053f265e57dfeb0a3692f32e315b6a13bb59334c51cfc856db0fc68a067cee4800bc1a3a32
-  data.tar.gz: 720aa71881469e415445a1ff83e853c1ece6d71873830111eb1de59c121e9408e478ddaabdd30e6c29e2d48d39b1ec1c96c739e16ca682b3e13e129253594d44
+  metadata.gz: b5e45213f23aaed8b4348d4a68179b2706577d6cdf7cf2588f979feb6433e742851392331a8d2909be4a745b6ef9089c419d22d4dd6140ec981c536e809c29df
+  data.tar.gz: f9e436d5ee96f410c66d673819a789ffdca814f8d53c8f7c97b2b005c9d2bd5cd48fc9a6619407ec7da42e0d3ca503666a5e3d2f2124f30b211a22ba87ec7075

data/CHANGELOG.md

@@ -3,6 +3,21 @@
 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.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

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

@@ -0,0 +1,3 @@
+command("<%= arg_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("<%= hook_name %>",
+  execute: "echo '<%= hook_path %>: test <%= type %> before hook for <%= kind %> <%= hook_name %>'",
+)
+
+after("<%= hook_name %>",
+  execute: "echo '<%= hook_path %>: test <%= type %> after hook for <%= kind %> <%= hook_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,9 +22,6 @@ require "set"
 require "terraspace/ext"
 require "terraspace/version"
 
-require "terraspace/autoloader"
-Terraspace::Autoloader.setup
-
 DslEvaluator.backtrace_reject = "lib/terraspace"
 
 module Terraspace

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

@@ -1,8 +1,15 @@
-require "terraspace/bundle"
-Terraspace::Bundle.setup
+if File.exist?("config/app.rb")
+  require "terraspace/bundle"
+  Terraspace::Bundle.setup
+end
 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 +23,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/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/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/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/new.rb

@@ -1,5 +1,9 @@
 class Terraspace::CLI
   class New < Terraspace::Command
+    long_desc Help.text("new/arg")
+    Arg.options.each { |args| option(*args) }
+    register(Arg, "arg", "arg NAME", "Generates new arg.")
+
     long_desc Help.text("new/git_hook")
     GitHook.cli_options.each { |args| option(*args) }
     register(GitHook, "git_hook", "git_hook", "Generates new git hook.")
@@ -8,33 +12,35 @@ class Terraspace::CLI
     Shim.cli_options.each { |args| option(*args) }
     register(Shim, "shim", "shim", "Generates terraspace shim.")
 
+    long_desc Help.text("new/helper")
+    Helper.options.each { |args| option(*args) }
+    register(Helper, "helper", "helper NAME", "Generates new helper.")
+
+    long_desc Help.text("new/hook")
+    Hook.options.each { |args| option(*args) }
+    register(Hook, "hook", "hook NAME", "Generates new hook.")
+
     long_desc Help.text("new/module")
     Module.base_options.each { |args| option(*args) }
     Module.component_options.each { |args| option(*args) }
     register(Module, "module", "module NAME", "Generates new module.")
 
-    long_desc Help.text("new/stack")
-    Stack.base_options.each { |args| option(*args) }
-    Stack.component_options.each { |args| option(*args) }
-    register(Stack, "stack", "stack NAME", "Generates new stack.")
-
     long_desc Help.text("new/project")
     Project.base_options.each { |args| option(*args) }
     Project.project_options.each { |args| option(*args) }
     register(Project, "project", "project NAME", "Generates new project.")
 
-    long_desc Help.text("new/project_test")
-    register(Test::Project, "project_test", "project_test NAME", "Generates new project test.")
-
-    long_desc Help.text("new/module_test")
-    register(Test::Module, "module_test", "module_test NAME", "Generates new module test.")
-
-    long_desc Help.text("new/bootstrap_test")
-    Test::Bootstrap.options.each { |args| option(*args) }
-    register(Test::Bootstrap, "bootstrap_test", "bootstrap_test", "Generates bootstrap test setup.")
-
     long_desc Help.text("new/plugin")
     Plugin.options.each { |args| option(*args) }
-    register(Plugin, "plugin", "plugin", "Generates plugin.")
+    register(Plugin, "plugin", "plugin NAME", "Generates plugin.")
+
+    long_desc Help.text("new/stack")
+    Stack.base_options.each { |args| option(*args) }
+    Stack.component_options.each { |args| option(*args) }
+    register(Stack, "stack", "stack NAME", "Generates new stack.")
+
+    long_desc Help.text("new/test")
+    Test.options.each { |args| option(*args) }
+    register(Test, "test", "test NAME", "Generates new test.")
   end
 end

data/lib/terraspace/cli/new/arg.rb

@@ -0,0 +1,62 @@
+class Terraspace::CLI::New
+  class Arg < Thor::Group
+    include Thor::Actions
+
+    argument :stack, required: false
+
+    def self.options
+      [
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:name, default: "apply", desc: "command name"],
+        [:type, default: "project", desc: "project, stack or module"],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+    def self.source_root
+      File.expand_path("../../../templates/base/arg", __dir__)
+    end
+
+  private
+    def type
+      valid_types = %w[project stack module]
+      type = @options[:type]
+      valid_types.include?(type) ? type : "project" # fallback to project if user provides invalid type
+    end
+
+    def name
+      options[:name] ?  options[:name] : "apply"
+    end
+
+    def dest
+      map = {
+        project: "config/args",
+        stack:   "app/stacks/#{stack}/config/args",
+        module:  "app/modules/#{stack}/config/args",
+      }
+      map[type.to_sym]
+    end
+
+    def arg_path
+      "#{dest}/#{kind}.rb"
+    end
+
+  public
+
+    def check_stack_arg
+      return if type == "project"
+      return unless stack.nil?
+      # Else check for STACK argument for type module or stack
+      puts <<~EOL
+        Required STACK argument, either the module or stack name. Usage:
+
+            terraspace new arg STACK --type #{type}
+      EOL
+      exit 1
+    end
+
+    def create
+      directory ".", dest
+    end
+  end
+end

data/lib/terraspace/cli/new/helper.rb

@@ -1,22 +1,54 @@
 class Terraspace::CLI::New
-  module Helper
-    include Helper::PluginGem
+  class Helper < Thor::Group
+    include Thor::Actions
+
+    argument :stack
+
+    def self.options
+      [
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:name, desc: "Helper name used for the filename. Defaults to the project, module or stack name"],
+        [:type, default: "project", desc: "project, stack or module"],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+    def self.source_root
+      File.expand_path("../../../templates/base/helper", __dir__)
+    end
 
   private
-    def build_gemfile(*list)
-      lines = []
-      list.each do |name|
-        lines << gem_line(name)
-      end
-      lines.join("\n")
+    def type
+      valid_types = %w[project stack module]
+      type = @options[:type]
+      valid_types.include?(type) ? type : "project" # fallback to project if user provides invalid type
     end
 
-    def gem_line(name)
-      if name == "terraspace"
-        %Q|gem "#{name}", '~> #{Terraspace::VERSION}'|
+    def helper_class
+      if type == "project"
+        "Terraspace::#{type.camelize}::#{name.camelize}Helper"
       else
-        %Q|gem "#{name}"|
+        "Terraspace::#{type.camelize}::#{stack.camelize}::#{name.camelize}Helper"
       end
     end
+
+    def name
+      options[:name] || stack
+    end
+
+    def dest
+      map = {
+        project: "config/helpers",
+        stack:   "app/stacks/#{stack}/config/helpers",
+        module:  "app/modules/#{stack}/config/helpers",
+      }
+      map[type.to_sym]
+    end
+
+  public
+
+    def create
+      directory ".", dest
+    end
   end
 end