terraspace 0.4.3 → 0.5.3

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,12 @@ 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_standalone_install!
+        check_project!(args.first)
+
         # Allow calling for help via:
         #   terraspace command help
         #   terraspace command -h
@@ -54,6 +59,51 @@ module Terraspace
         super
       end
 
+      def check_standalone_install!
+        return unless opt?
+        version_manager = "rvm" if rvm?
+        version_manager = "rbenv" if rbenv?
+        if rbenv? || rvm?
+          puts <<~EOL.color(:yellow)
+            WARN: It looks like a standalone Terraspace install and #{version_manager} is also in use.
+            Different gems from the standalone Terraspace install and #{version_manager} can cause all kinds of trouble.
+            Please install Terraspace as a gem instead and remove the standalone Terraspace /opt/terraspace installation.
+            See: https://terraspace.cloud/docs/install/gem/
+          EOL
+        end
+      end
+
+      def opt?
+        paths = ENV['PATH'].split(':')
+        opt = paths.detect { |p| p.include?('/opt/terraspace') }
+        opt && File.exist?('/opt/terraspace')
+      end
+
+      def rvm?
+        paths = ENV['PATH'].split(':')
+        rvm = paths.detect { |p| p.include?('/rvm/') || p.include?('/.rvm/') }
+        rvm && system("type rvm > /dev/null 2>&1")
+      end
+
+      def rbenv?
+        paths = ENV['PATH'].split(':')
+        rbenv = paths.detect { |p| p.include?('/rbenv/') || p.include?('/.rbenv/') }
+        rbenv && system("type rbenv > /dev/null 2>&1")
+      end
+
+      def check_project!(command_name)
+        return if subcommand?
+        return if command_name.nil?
+        return if %w[-h -v check_setup 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

data/lib/terraspace/shell.rb

@@ -6,8 +6,6 @@ module Terraspace
 
     def initialize(mod, command, options={})
       @mod, @command, @options = mod, command, options
-      # error_messages holds aggregation of all error lines
-      @known_error, @error_messages = nil, ''
     end
 
     # requires @mod to be set
@@ -33,9 +31,9 @@ module Terraspace
       Open3.popen3(env, @command, chdir: @mod.cache_dir) do |stdin, stdout, stderr, wait_thread|
         mimic_terraform_input(stdin, stdout)
         while err = stderr.gets
-          @error_messages << err # aggregate all error lines
-          @known_error ||= known_error_type(err)
-          unless @known_error
+          @error ||= Error.new
+          @error.lines << err # aggregate all error lines
+          unless @error.known?
             # Sometimes may print a "\e[31m\n" which like during dependencies fetcher init
             # suppress it so dont get a bunch of annoying "newlines"
             next if err == "\e[31m\n" && @options[:suppress_error_color]
@@ -48,38 +46,12 @@ module Terraspace
       end
     end
 
-    def known_error_type(err)
-      if reinit_required?(err)
-        :reinit_required
-      elsif bucket_not_found?(err)
-        :bucket_not_found
-      end
-    end
-
-    def bucket_not_found?(err)
-      # Message is included in aws, azurerm, and google. See: https://bit.ly/3iOKDri
-      err.include?("Failed to get existing workspaces")
-    end
-
-    def reinit_required?(err)
-      # Example error: https://gist.github.com/tongueroo/f7e0a44b64f0a2e533089b18f331c21e
-      squeezed = @error_messages.gsub("\n", ' ').squeeze(' ') # remove double whitespaces and newlines
-      general_check = squeezed.include?("terraform init") && squeezed.include?("Error:")
-
-      general_check ||
-      err.include?("reinitialization required") ||
-      err.include?("terraform init") ||
-      err.include?("require reinitialization")
-    end
-
     def exit_status(status)
       return if status == 0
 
       exit_on_fail = @options[:exit_on_fail].nil? ? true : @options[:exit_on_fail]
-      if @known_error == :reinit_required
-        raise InitRequiredError.new(@error_messages)
-      elsif @known_error == :bucket_not_found
-        raise BucketNotFoundError.new(@error_messages)
+      if @error && @error.known?
+        raise @error.instance
       elsif exit_on_fail
         logger.error "Error running command: #{@command}".color(:red)
         exit status

data/lib/terraspace/shell/error.rb

@@ -0,0 +1,46 @@
+class Terraspace::Shell
+  class Error
+    attr_accessor :lines
+    def initialize
+      @lines = '' # holds aggregation of all error lines
+    end
+
+    def known?
+      !!instance
+    end
+
+    def instance
+      if reinit_required?
+        Terraspace::InitRequiredError.new(@lines)
+      elsif bucket_not_found?
+        Terraspace::BucketNotFound.new(@lines)
+      elsif shared_cache_error?
+        Terraspace::SharedCacheError.new(@lines)
+      end
+    end
+
+    def bucket_not_found?
+      # Message is included in aws, azurerm, and google. See: https://bit.ly/3iOKDri
+      message.include?("Failed to get existing workspaces")
+    end
+
+    def reinit_required?
+      # Example error: https://gist.github.com/tongueroo/f7e0a44b64f0a2e533089b18f331c21e
+      general_check = message.include?("terraform init") && message.include?("Error:")
+      general_check ||
+      message.include?("reinitialization required") ||
+      message.include?("terraform init") ||
+      message.include?("require reinitialization")
+    end
+
+    def message
+      @lines.gsub("\n", ' ').squeeze(' ') # remove double whitespaces and newlines
+    end
+
+    def shared_cache_error?
+      # Example: https://gist.github.com/tongueroo/4f2c925709d21f5810229ce9ca482560
+      message.include?("Failed to install provider from shared cache") ||
+      message.include?("Failed to validate installed provider")
+    end
+  end
+end

data/lib/terraspace/terraform/args/custom.rb

@@ -7,13 +7,12 @@ module Terraspace::Terraform::Args
     attr_accessor :name
     def initialize(mod, name)
       @mod, @name = mod, name
-      @file = "#{Terraspace.root}/config/args/terraform.rb"
       @commands = {}
     end
 
     def build
-      return @commands unless File.exist?(@file)
-      evaluate_file(@file)
+      evaluate_file("#{Terraspace.root}/config/args/terraform.rb")
+      evaluate_file("#{@mod.root}/config/args/terraform.rb")
       @commands.deep_stringify_keys!
     end
     memoize :build