terraspace 0.4.0 → 0.5.0

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

@@ -1,5 +1,5 @@
 class Terraspace::CLI::New::Plugin
-  module Helper
+  module Helpers
   private
     # helper
     def camel_name

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

@@ -4,16 +4,23 @@ class Terraspace::CLI::New
       [
         [:bundle, type: :boolean, default: true, desc: "Runs bundle install on the project"],
         [:config, type: :boolean, default: true, desc: "Whether or not to generate config files."],
-        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
-        [:test_structure, type: :boolean, desc: "Create project bootstrap test structure."]
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
+        [:quiet, type: :boolean, desc: "Quiet output."],
+        [:test_structure, type: :boolean, desc: "Create project bootstrap test structure."],
       ]
     end
 
     base_options.each { |args| class_option(*args) }
     project_options.each { |args| class_option(*args) }
 
+  private
+    def log(msg)
+      logger.info(msg) unless @options[:quiet]
+    end
+
+  public
     def creating_messaging
-      puts "=> Creating new project called #{name}."
+      log "=> Creating new project called #{name}."
     end
 
     def create_base
@@ -60,15 +67,17 @@ class Terraspace::CLI::New
 
     def bundle_install
       return if @options[:bundle] == false
-      puts "=> Installing dependencies with: bundle install"
+      log "=> Installing dependencies with: bundle install"
       Bundler.with_unbundled_env do
-        system("BUNDLE_IGNORE_CONFIG=1 bundle install", chdir: name)
+        bundle = "BUNDLE_IGNORE_CONFIG=1 bundle install"
+        bundle << " > /dev/null 2>&1" if @options[:quiet]
+        system(bundle, chdir: name)
       end
     end
 
     def welcome_message_examples
       return unless options[:examples]
-      puts <<~EOL
+      log <<~EOL
         #{"="*64}
         Congrats! You have successfully created a terraspace project.
         Check out the created files. Adjust to the examples and then deploy with:
@@ -83,7 +92,7 @@ class Terraspace::CLI::New
 
     def welcome_message_no_examples
       return if options[:examples]
-      puts <<~EOL
+      log <<~EOL
         #{"="*64}
         Congrats! You have successfully created a terraspace project.
         Check out the created files.

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

@@ -3,12 +3,13 @@ require 'thor'
 class Terraspace::CLI::New
   class Sequence < Thor::Group
     include Thor::Actions
-    include Helper
+    include Terraspace::Util::Logging
+    include Helpers
 
     def self.base_options
       [
         [:examples, type: :boolean, default: false, desc: "Also generate examples"],
-        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
         [:lang, default: "hcl", desc: "Language to use: HCL/ERB or Ruby DSL"],
         [:plugin, aliases: %w[p], default: "aws", desc: "Cloud Plugin. Supports: aws, google"],
         [:test, type: :boolean, desc: "Whether or not to generate tests"],
@@ -47,13 +48,5 @@ class Terraspace::CLI::New
       source = Source::Plugin.new(self, @options)
       source.set_source_paths(template, type)
     end
-
-    # A generator script hook to allow for further customizations
-    # The dest folder like app/modules/demo is provided as a first argument to the command.
-    def run_script(script, dest)
-      command = "#{script} #{dest}"
-      puts "Running: #{command}" unless ENV['TS_GENERATOR_MUTE']
-      system(command)
-    end
   end
 end

data/lib/terraspace/cli/new/source/core.rb

@@ -1,6 +1,6 @@
 module Terraspace::CLI::New::Source
   class Core
-    include Terraspace::CLI::New::Helper::PluginGem
+    include Terraspace::CLI::New::Helpers::PluginGem
     include Terraspace::Util
 
     def initialize(sequence, options)

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

@@ -5,22 +5,11 @@ class Terraspace::CLI::New
     argument :name
 
     def create_stack
-      plugin_template_source(@options[:lang], "stack") # IE: plugin_template_source("hcl", "stack")
-
       puts "=> Creating new stack called #{name}."
+      plugin_template_source(@options[:lang], "stack") # IE: plugin_template_source("hcl", "stack")
       dest = "app/stacks/#{name}"
       dest = "#{@options[:project_name]}/#{dest}" if @options[:project_name]
       directory ".", dest
     end
-
-    def create_test
-      Test::Project.start(component_args(name, @options[:project_name]))
-    end
-
-    def run_generator_hook_script
-      script = ENV['TS_GENERATOR_STACK']
-      return unless script
-      run_script(script, "app/stacks/#{name}")
-    end
   end
 end

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

@@ -0,0 +1,50 @@
+class Terraspace::CLI::New
+  class Test < Thor::Group
+    include Thor::Actions
+    include Terraspace::CLI::New::Helpers
+
+    argument :name
+
+    def self.options
+      [
+        [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:test_name, desc: "Test name. Defaults to the project, module or stack name"],
+        [:type, default: "project", desc: "project, stack or module"],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+  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 test_name
+      options[:test_name] || name
+    end
+
+    def dest
+      map = {
+        project: ".", # Terraspace.root
+        stack:   "app/stacks/#{name}",
+        module:  "app/modules/#{name}",
+      }
+      map[type.to_sym]
+    end
+
+    def test_template_source(template, type)
+      source = Terraspace::CLI::New::Source::Test.new(self, @options)
+      source.set_source_paths(template, type)
+    end
+
+  public
+
+    def create
+      test_template_source(@options[:lang], type)
+      puts "=> Creating #{type} test: #{name}"
+      directory ".", dest
+    end
+  end
+end

data/lib/terraspace/cli/summary.rb

@@ -11,7 +11,6 @@ class Terraspace::CLI
     end
 
     def run
-      Terraspace.check_project!
       build_placeholder
       puts "Summary of resources based on backend storage statefiles"
       backend_expr = '.terraspace-cache/**/backend.*'

data/lib/terraspace/command.rb

@@ -27,7 +27,11 @@ Thor::Util.singleton_class.prepend(ThorPrepend::Util)
 module Terraspace
   class Command < Thor
     class << self
+      include Terraspace::Util::Logging
+
       def dispatch(m, args, options, config)
+        check_project!(args.first)
+
         # Allow calling for help via:
         #   terraspace command help
         #   terraspace command -h
@@ -54,6 +58,18 @@ module Terraspace
         super
       end
 
+      def check_project!(command_name)
+        return if subcommand?
+        return if %w[-h -v completion completion_script help new test version].include?(command_name)
+        return if File.exist?("#{Terraspace.root}/config/app.rb")
+        logger.error "ERROR: It doesnt look like this is a terraspace project. Are you sure you are in a terraspace project?".color(:red)
+        ENV['TS_TEST'] ? raise : exit(1)
+      end
+
+      def subcommand?
+        !!caller.detect { |l| l.include?('in subcommand') }
+      end
+
       # Override command_help to include the description at the top of the
       # long_description.
       def command_help(shell, command_name)

data/lib/terraspace/compiler/builder.rb

@@ -73,6 +73,8 @@ module Terraspace::Compiler
     def skip?(src_path)
       return true unless File.file?(src_path)
       # certain folders will be skipped
+      src_path.include?("#{@mod.root}/config/args") ||
+      src_path.include?("#{@mod.root}/config/hooks") ||
       src_path.include?("#{@mod.root}/test")
     end
   end

data/lib/terraspace/compiler/dsl/mod.rb

@@ -1,8 +1,10 @@
 module Terraspace::Compiler::Dsl
   class Mod < Base
     include Syntax::Mod
+    include Terraspace::Compiler::HelperExtender
 
     def build
+      extend_module_level_helpers
       evaluate
       build_content
     end

data/lib/terraspace/compiler/dsl/syntax/mod.rb

@@ -3,5 +3,7 @@ module Terraspace::Compiler::Dsl::Syntax
     include Terraspace::Util::Logging
     include_dir("mod")
     include_dir("helpers")
+    include_plugin_helpers
+    include_project_level_helpers
   end
 end

data/lib/terraspace/compiler/dsl/syntax/mod/backend.rb

@@ -11,7 +11,7 @@ module Terraspace::Compiler::Dsl::Syntax::Mod
       Terraspace::Compiler::Expander.new(@mod, backend_name).expand(props)
     end
 
-    # Can set opts to explicitly use an specfic backend. Example:
+    # Can set opts to explicitly use an specific backend. Example:
     #
     #    opts = {backend: s3}
     #

data/lib/terraspace/compiler/erb/context.rb

@@ -1,11 +1,13 @@
 module Terraspace::Compiler::Erb
   class Context
     include Helpers
+    include Terraspace::Compiler::HelperExtender
 
     attr_reader :mod, :options
     def initialize(mod)
       @mod = mod
       @options = mod.options # so user has access to cli options
+      extend_module_level_helpers
     end
   end
 end

data/lib/terraspace/compiler/helper_extender.rb

@@ -0,0 +1,27 @@
+module Terraspace::Compiler
+  module HelperExtender
+  private
+    def extend_module_level_helpers
+      full_dir = "#{@mod.root}/config/helpers"
+      Dir.glob("#{full_dir}/**/*").each do |path|
+        regexp = Regexp.new(".*/helpers/")
+        klass = path.sub(regexp, '').sub('.rb','').camelize
+        klass = "#{mod_namespace}::#{klass}"
+        require path # able to use require instead of load since each helper has unique namespace
+        send :extend, klass.constantize
+      end
+    end
+
+    # IE: mod_namespace = Terraspace::Module::Demo
+    # Use separate namespaces scope with module name so custom helper methods from different modules are isolated.
+    def mod_namespace
+      mod_name = @mod.name.camelize
+      ns = "Terraspace::#{@mod.type.camelize}".constantize # IE: Terraspace::Module or Terraspace::Stack
+      if ns.const_defined?(mod_name.to_sym)
+        "#{ns}::#{mod_name}".constantize
+      else
+        ns.const_set(mod_name, Module.new)
+      end
+    end
+  end
+end

data/lib/terraspace/core.rb

@@ -51,11 +51,5 @@ module Terraspace
     def logger=(v)
       @@logger = v
     end
-
-    def check_project!
-      return if File.exist?("#{Terraspace.root}/config/app.rb")
-      logger.error "ERROR: It doesnt look like this is a terraspace project. Are you sure you are in a terraspace project?".color(:red)
-      ENV['TS_TEST'] ? raise : exit(1)
-    end
   end
 end

data/lib/terraspace/ext/core/module.rb

@@ -16,4 +16,20 @@ class Module
       include klass.constantize
     end
   end
+
+  def include_project_level_helpers
+    full_dir = "#{Terraspace.root}/config/helpers"
+    Dir.glob("#{full_dir}/**/*").each do |path|
+      regexp = Regexp.new(".*/config/helpers/")
+      klass = path.sub(regexp, '').sub('.rb','').camelize
+      klass = "Terraspace::Project::#{klass}"
+      include klass.constantize
+    end
+  end
+
+  def include_plugin_helpers
+    Terraspace::Plugin.helper_classes.each do |klass|
+      include klass # IE: TerraspacePluginAws::Interfaces::Helper
+    end
+  end
 end

data/lib/terraspace/hooks/builder.rb

@@ -7,14 +7,14 @@ module Terraspace::Hooks
 
     # IE: dsl_file: config/hooks/terraform.rb
     attr_accessor :name
-    def initialize(mod, dsl_file, name)
-      @mod, @dsl_file, @name = mod, dsl_file, name
+    def initialize(mod, file, name)
+      @mod, @file, @name = mod, file, name
       @hooks = {before: {}, after: {}}
     end
 
     def build
-      return @hooks unless File.exist?(@dsl_file)
-      evaluate_file(@dsl_file)
+      evaluate_file("#{Terraspace.root}/config/hooks/#{@file}")
+      evaluate_file("#{@mod.root}/config/hooks/#{@file}")
       @hooks.deep_stringify_keys!
     end
     memoize :build
@@ -37,11 +37,10 @@ module Terraspace::Hooks
     def run_hook(type, hook)
       return unless run?(hook)
 
-      command = File.basename(@dsl_file).sub('.rb','') # IE: kubes, kubectl, docker
+      command = File.basename(@file).sub('.rb','') # IE: terraform or terraspace
       id = "#{command} #{type} #{@name}"
       label = " label: #{hook["label"]}" if hook["label"]
-      logger.info  "Running #{id} hook.#{label}"
-      logger.debug "Hook options: #{hook}"
+      logger.info  "Hook: Running #{id} hook.#{label}".color(:cyan)
       Runner.new(@mod, hook).run
     end
 

data/lib/terraspace/hooks/concern.rb

@@ -1,7 +1,7 @@
 module Terraspace::Hooks
   module Concern
-    def run_hooks(dsl_file, name, &block)
-      hooks = Builder.new(@mod, "#{Terraspace.root}/config/hooks/#{dsl_file}", name)
+    def run_hooks(file, name, &block)
+      hooks = Builder.new(@mod, file, name)
       hooks.build # build hooks
       hooks.run_hooks(&block)
     end

data/lib/terraspace/logger.rb

@@ -2,6 +2,12 @@ require 'logger'
 
 module Terraspace
   class Logger < ::Logger
+    def initialize(*args)
+      super
+      self.formatter = Formatter.new
+      self.level = :info
+    end
+
     def format_message(severity, datetime, progname, msg)
       line = if @logdev.dev == $stdout || @logdev.dev == $stderr
         msg # super simple format if stdout

data/lib/terraspace/mod.rb

@@ -31,7 +31,6 @@ module Terraspace
     end
 
     def check_exist!
-      Terraspace.check_project!
       return if root
 
       pretty_paths = paths.map { |p| Terraspace::Util.pretty_path(p) }.join(", ")

data/lib/terraspace/plugin.rb

@@ -16,14 +16,18 @@ module Terraspace
       @@meta
     end
 
-    def layer_classes
-      @@meta.map { |plugin, data| data[:layer_class] }.compact
-    end
-
     def config_classes
       @@meta.map { |plugin, data| data[:config_class] }.compact
     end
 
+    def helper_classes
+      @@meta.map { |plugin, data| data[:helper_class] }.compact
+    end
+
+    def layer_classes
+      @@meta.map { |plugin, data| data[:layer_class] }.compact
+    end
+
     # The resource map can be used to customized the mapping from the resource "first word" to the plugin.
     #
     # resource map is in meta structure.

data/lib/terraspace/plugin/config/interface.rb

@@ -16,8 +16,8 @@ module Terraspace::Plugin::Config
     end
 
     def load_project_config
-      project_config = "#{Terraspace.root}/config/plugins/#{provider}.rb"
-      evaluate_file(project_config)
+      evaluate_file("#{Terraspace.root}/config/plugins/#{provider}.rb")
+      evaluate_file("#{Terraspace.root}/config/plugins/#{provider}/#{Terraspace.env}.rb")
     end
 
     def configure

data/lib/terraspace/plugin/helper/interface.rb

@@ -0,0 +1,31 @@
+module Terraspace::Plugin::Helper
+  module Interface
+    extend ActiveSupport::Concern
+
+    # Useful for plugin helpers. Can check this only run logic after dependency resolution.
+    def resolved?
+      !!@mod.resolved
+    end
+
+    class_methods do
+      @@helper_cache = {}
+      # This method is useful to avoid double call of heavy processing logic for tfvars,
+      # since the tfvars files get evaluated twice.
+      # Note: Not setting any cache or doing any logic unless resolved.
+      def cache_helper(meth)
+        uncached_meth = "uncached_#{meth}"
+        alias_method(uncached_meth, meth)
+        define_method(meth) do |*args|
+          return unless resolved? # return nil in first unresolved pass
+          id = Marshal.dump([meth] + args)
+          exist = @@helper_cache.key?(id)
+          if exist
+            @@helper_cache[id]
+          else
+            @@helper_cache[id] = send(uncached_meth, *args)
+          end
+        end
+      end
+    end
+  end
+end