terraspace 0.3.2 → 0.4.0

data/lib/terraspace/cli/{log → logs}/concern.rb

@@ -1,4 +1,4 @@
-class Terraspace::CLI::Log
+class Terraspace::CLI::Logs
   module Concern
     # Filters for lines that belong to the last ran process pid
     def readlines(path)

data/lib/terraspace/cli/new.rb

@@ -1,40 +1,40 @@
 class Terraspace::CLI
   class New < Terraspace::Command
-    long_desc Help.text(:git_hook)
+    long_desc Help.text("new/git_hook")
     GitHook.cli_options.each { |args| option(*args) }
-    register(GitHook, "git_hook", "git_hook", "Generates new git hook")
+    register(GitHook, "git_hook", "git_hook", "Generates new git hook.")
 
-    long_desc Help.text(:shim)
+    long_desc Help.text("new/shim")
     Shim.cli_options.each { |args| option(*args) }
-    register(Shim, "shim", "shim", "Generates terraspace shim")
+    register(Shim, "shim", "shim", "Generates terraspace shim.")
 
-    long_desc Help.text(:module)
+    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")
+    register(Module, "module", "module NAME", "Generates new module.")
 
-    long_desc Help.text(:stack)
+    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")
+    register(Stack, "stack", "stack NAME", "Generates new stack.")
 
-    long_desc Help.text(:project)
+    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")
+    register(Project, "project", "project NAME", "Generates new project.")
 
-    long_desc Help.text(:project_test)
-    register(Test::Project, "project_test", "project_test NAME", "Generates new project test")
+    long_desc Help.text("new/project_test")
+    register(Test::Project, "project_test", "project_test NAME", "Generates new project test.")
 
-    long_desc Help.text(:module_test)
-    register(Test::Module, "module_test", "module_test NAME", "Generates new module test")
+    long_desc Help.text("new/module_test")
+    register(Test::Module, "module_test", "module_test NAME", "Generates new module test.")
 
-    long_desc Help.text(:bootstrap_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")
+    register(Test::Bootstrap, "bootstrap_test", "bootstrap_test", "Generates bootstrap test setup.")
 
-    long_desc Help.text(:plugin)
+    long_desc Help.text("new/plugin")
     Plugin.options.each { |args| option(*args) }
-    register(Plugin, "plugin", "plugin", "Generates plugin")
+    register(Plugin, "plugin", "plugin", "Generates plugin.")
   end
 end

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

@@ -15,7 +15,10 @@ class Terraspace::CLI::New
     end
 
     def create
-      return unless File.exist?(".git")
+      unless File.exist?(".git")
+        puts "No .git folder found. Not creating git hook."
+        return
+      end
       dest = ".git/hooks/#{options[:type]}"
       template "hook.sh", dest
       chmod dest, 0755

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

@@ -6,10 +6,17 @@ class Terraspace::CLI::New
     def build_gemfile(*list)
       lines = []
       list.each do |name|
-        line =  %Q|gem "#{name}"|
-        lines << line
+        lines << gem_line(name)
       end
       lines.join("\n")
     end
+
+    def gem_line(name)
+      if name == "terraspace"
+        %Q|gem "#{name}", '~> #{Terraspace::VERSION}'|
+      else
+        %Q|gem "#{name}"|
+      end
+    end
   end
 end

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

@@ -54,7 +54,7 @@ class Terraspace::CLI::New
     end
 
     def create_test
-      return if @options[:test_structure] == false
+      return unless @options[:test_structure]
       Test::Bootstrap.start(["--dir", name])
     end
 

data/lib/terraspace/cli/summary.rb

@@ -12,7 +12,7 @@ class Terraspace::CLI
 
     def run
       Terraspace.check_project!
-      build
+      build_placeholder
       puts "Summary of resources based on backend storage statefiles"
       backend_expr = '.terraspace-cache/**/backend.*'
       # Currently summary assumes backend are within the same bucket and key prefix
@@ -22,7 +22,7 @@ class Terraspace::CLI
 
     # Grab the last module and build that.
     # Assume the backend key has the same prefix
-    def build
+    def build_placeholder
       Build::Placeholder.new(@options).build
     end
 

data/lib/terraspace/command.rb

@@ -86,7 +86,7 @@ module Terraspace
 
       # meant to be overriden
       def website
-        ""
+        "https://terraspace.cloud"
       end
 
       # https://github.com/erikhuda/thor/issues/244

data/lib/terraspace/compiler/backend.rb

@@ -6,7 +6,13 @@ module Terraspace::Compiler
       @mod = mod
     end
 
+    @@created = {}
     def create
+      return if @@created[cache_key]
+      # set immediately, since local storage wont reach bottom.
+      # if fail for other backends, there will be an exception anyway
+      @@created[cache_key] = true
+
       klass = backend_interface(backend_name)
       return unless klass # in case auto-creation is not supported for specific backend
 
@@ -14,6 +20,10 @@ module Terraspace::Compiler
       interface.call
     end
 
+    def cache_key
+      @mod.build_dir
+    end
+
     def backend_name
       backend.keys.first # IE: s3, gcs, etc
     end

data/lib/terraspace/compiler/builder.rb

@@ -1,5 +1,6 @@
 module Terraspace::Compiler
   class Builder
+    include CommandsConcern
     include Basename
 
     def initialize(mod)
@@ -9,7 +10,7 @@ module Terraspace::Compiler
     def build
       build_config
       build_module if @mod.resolved
-      build_tfvars
+      build_tfvars unless command_is?(:seed) #  avoid dependencies being built and erroring when backend bucket doesnt exist
     end
 
     # build common config files: provider and backend for the root module

data/lib/terraspace/compiler/commands_concern.rb

@@ -0,0 +1,18 @@
+module Terraspace::Compiler
+  module CommandsConcern
+    def requires_backend?
+      command_is?(requires_backend_commands)
+    end
+
+    def requires_backend_commands
+      %w[down init output plan providers refresh show up validate]
+    end
+
+    def command_is?(*commands)
+      commands.flatten!
+      commands.map!(&:to_s)
+      commands.include?(ARGV[0]) ||                  # IE: terraspace up
+      ARGV[0] == "all" && commands.include?(ARGV[1]) # IE: terraspace all up
+    end
+  end
+end

data/lib/terraspace/compiler/dependencies/helpers.rb

@@ -0,0 +1,34 @@
+module Terraspace::Compiler::Dependencies
+  # This is a separate module specifically because the DSL also has an output method.
+  # The module allows us to include dependency related methods only within tfvars context for the DSL.
+  #
+  #     1. Only include this module to DSL tfvars context.
+  #        So the output method works in tfvars .rb files works.
+  #        At the same time, the DSL usage of output also works for normal main.tf files.
+  #        Passing specs prove this.
+  #     2. For ERB, there's currently only one ERB context. So this module is included in all contexts.
+  #        The builder only processes dependencies from tfvars, so these helpers are only respected there.
+  #
+  # Where the module is included in the code:
+  #
+  #     1. lib/terraspace/compiler/dsl/syntax/tfvar.rb
+  #     2. lib/terraspace/compiler/erb/helpers.rb
+  #
+  module Helpers
+    def output(identifier, options={})
+      Terraspace::Dependency::Helper::Output.new(@mod, identifier, options).result
+    end
+    alias_method :terraform_output, :output # backwards compatibility
+
+    def depends_on(*child_names, **options)
+      child_names.flatten!
+      child_names.map do |child_name|
+        each_depends_on(child_name, options)
+      end.join("\n")
+    end
+
+    def each_depends_on(child_name, options={})
+      Terraspace::Dependency::Helper::DependsOn.new(@mod, child_name, options).result
+    end
+  end
+end

data/lib/terraspace/compiler/dsl/syntax/helpers/common.rb

@@ -1,8 +1,6 @@
 module Terraspace::Compiler::Dsl::Syntax::Helpers
   module Common
     extend Memoist
-    Fetcher = Terraspace::Terraform::RemoteState::Fetcher
-    Marker = Terraspace::Terraform::RemoteState::Marker
     Meta = Terraspace::Compiler::Dsl::Meta
 
     def var
@@ -25,29 +23,5 @@ module Terraspace::Compiler::Dsl::Syntax::Helpers
       command = ["terraspace"] + args
       command.join(separator)
     end
-
-    def terraform_output(identifier, options={})
-      if @mod.resolved # dependencies have been resolved
-        Fetcher.new(@mod, identifier, options).output
-      else
-        Marker::Output.new(@mod, identifier, options).build
-      end
-    end
-
-    def depends_on(*child_names, **options)
-      child_names.flatten!
-      child_names.map do |child_name|
-        each_depends_on(child_name, options)
-      end.join("\n")
-    end
-
-    def each_depends_on(child_name, options={})
-      if @mod.resolved # dependencies have been resolved
-        # Note: A generated line is not really needed. Dependencies are stored in memory. Added to assist users with debugging
-        "# #{@mod.name} depends on #{child_name}"
-      else
-        Marker::Output.new(@mod, child_name, options).build
-      end
-    end
   end
 end

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

@@ -1,5 +1,6 @@
 module Terraspace::Compiler::Dsl::Syntax
   module Tfvar
     include_dir("tfvar")
+    include Terraspace::Compiler::Dependencies::Helpers
   end
 end

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

@@ -1,6 +1,6 @@
 module Terraspace::Compiler::Erb
   class Context
-    include Terraspace::Compiler::Dsl::Syntax::Mod
+    include Helpers
 
     attr_reader :mod, :options
     def initialize(mod)

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

@@ -0,0 +1,6 @@
+module Terraspace::Compiler::Erb
+  module Helpers
+    include Terraspace::Compiler::Dsl::Syntax::Mod
+    include Terraspace::Compiler::Dependencies::Helpers
+  end
+end

data/lib/terraspace/dependency/graph.rb

@@ -20,8 +20,9 @@ module Terraspace::Dependency
       @batches
     end
 
+    # Only check when stacks option is pass. Edge case: There can be app/modules but no app/stacks yet
     def check_empty_nodes!
-      return unless @nodes.empty?
+      return unless @nodes.empty? && @options[:stacks]
       logger.error "ERROR: No stacks were found that match: #{@options[:stacks].join(' ')}".color(:red)
       exit 1
     end

data/lib/terraspace/dependency/helper/base.rb

@@ -0,0 +1,7 @@
+module Terraspace::Dependency::Helper
+  class Base
+    def initialize(mod, identifier, options)
+      @mod, @identifier, @options = mod, identifier, options
+    end
+  end
+end

data/lib/terraspace/dependency/helper/depends_on.rb

@@ -0,0 +1,12 @@
+module Terraspace::Dependency::Helper
+  class DependsOn < Base
+    def result
+      if @mod.resolved # dependencies have been resolved
+        # Note: A generated line is not really needed. Dependencies are stored in memory. Added to assist users with debugging
+        "# #{@mod.name} depends on #{@identifier}" # raw String value
+      else
+        Terraspace::Terraform::RemoteState::Marker::Output.new(@mod, @identifier, @options).build # Returns OutputProxy which defaults to json
+      end
+    end
+  end
+end

data/lib/terraspace/dependency/helper/output.rb

@@ -0,0 +1,11 @@
+module Terraspace::Dependency::Helper
+  class Output < Base
+    def result
+      if @mod.resolved # dependencies have been resolved
+        Terraspace::Terraform::RemoteState::Fetcher.new(@mod, @identifier, @options).output # Returns OutputProxy which defaults to json
+      else
+        Terraspace::Terraform::RemoteState::Marker::Output.new(@mod, @identifier, @options).build # Returns OutputProxy => Unresolved
+      end
+    end
+  end
+end

data/lib/terraspace/hooks/builder.rb

@@ -0,0 +1,52 @@
+module Terraspace::Hooks
+  class Builder
+    extend Memoist
+    include Dsl
+    include DslEvaluator
+    include Terraspace::Util
+
+    # IE: dsl_file: config/hooks/terraform.rb
+    attr_accessor :name
+    def initialize(mod, dsl_file, name)
+      @mod, @dsl_file, @name = mod, dsl_file, name
+      @hooks = {before: {}, after: {}}
+    end
+
+    def build
+      return @hooks unless File.exist?(@dsl_file)
+      evaluate_file(@dsl_file)
+      @hooks.deep_stringify_keys!
+    end
+    memoize :build
+
+    def run_hooks
+      build
+      run_each_hook("before")
+      out = yield if block_given?
+      run_each_hook("after")
+      out
+    end
+
+    def run_each_hook(type)
+      hooks = @hooks.dig(type, @name) || []
+      hooks.each do |hook|
+        run_hook(type, hook)
+      end
+    end
+
+    def run_hook(type, hook)
+      return unless run?(hook)
+
+      command = File.basename(@dsl_file).sub('.rb','') # IE: kubes, kubectl, docker
+      id = "#{command} #{type} #{@name}"
+      label = " label: #{hook["label"]}" if hook["label"]
+      logger.info  "Running #{id} hook.#{label}"
+      logger.debug "Hook options: #{hook}"
+      Runner.new(@mod, hook).run
+    end
+
+    def run?(hook)
+      !!hook["execute"]
+    end
+  end
+end

data/lib/terraspace/hooks/concern.rb

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

data/lib/terraspace/{terraform/hooks → hooks}/dsl.rb

@@ -1,4 +1,4 @@
-module Terraspace::Terraform::Hooks
+module Terraspace::Hooks
   module Dsl
     def before(*commands, **props)
       commands.each do |name|
@@ -13,7 +13,8 @@ module Terraspace::Terraform::Hooks
     end
 
     def each_hook(type, name, props={})
-      @hooks[type][name] = props
+      @hooks[type][name] ||= []
+      @hooks[type][name] << props
     end
   end
 end

data/lib/terraspace/hooks/runner.rb

@@ -0,0 +1,23 @@
+module Terraspace::Hooks
+  class Runner
+    include Terraspace::Util
+
+    def initialize(mod, hook)
+      @mod, @hook = mod, hook
+      @execute = @hook["execute"]
+    end
+
+    def run
+      case @execute
+      when String
+        Terraspace::Shell.new(@mod, @execute, exit_on_fail: @hook["exit_on_fail"]).run
+      when -> (e) { e.respond_to?(:public_instance_methods) && e.public_instance_methods.include?(:call) }
+        @execute.new.call
+      when -> (e) { e.respond_to?(:call) }
+        @execute.call
+      else
+        logger.warn "WARN: execute option not set for hook: #{@hook.inspect}"
+      end
+    end
+  end
+end