terraspace 0.3.3 → 0.4.1

data/lib/terraspace/cli/logs.rb

@@ -1,15 +1,112 @@
+require "eventmachine"
+require "eventmachine-tail"
+
 class Terraspace::CLI
-  class Logs < Terraspace::Command
-    desc "truncate", "Truncates logs. IE: Removes contents and zero bytes the files"
-    long_desc Help.text("logs/truncate")
-    def truncate
-      Tasks.new(options).truncate
+  class Logs < Base
+    include Concern
+
+    def initialize(options={})
+      super
+      @action, @stack = options[:action], options[:stack]
+      @action ||= '**'
+      @stack  ||= '*'
+    end
+
+    def run
+      check_logs!
+      if @options[:follow]
+        follow_logs
+      else
+        all_log_paths.each { |path| show_log(path) }
+      end
+    end
+
+    def follow_logs
+      glob_path = "#{Terraspace.log_root}/#{@action}/#{@stack}.log"
+      Dir.glob(glob_path).each do |path|
+        puts "Following #{pretty(path)}".color(:purple)
+      end
+      EventMachine.run do
+        interval = Integer(ENV['TS_LOG_GLOB_INTERNAL'] || 1)
+        EventMachine::FileGlobWatchTail.new(glob_path, nil, interval) do |filetail, line|
+          puts line # always show timestamp in follow mode
+        end
+      end
+    end
+
+    def show_log(path)
+      report_log(path)
+      lines = readlines(path)
+      lines = apply_limit(lines)
+      lines.each do |line|
+        puts format(line)
+      end
+    end
+
+    def report_log(path)
+      pretty_path = pretty(path)
+      if File.exist?(path)
+        puts "Showing: #{pretty_path}".color(:purple)
+      end
+    end
+
+    def format(line)
+      if timestamps
+        line
+      else
+        line.sub(/.*\]: /,'')
+      end
+    end
+
+    def all_log_paths
+      Dir.glob("#{Terraspace.log_root}/#{@action}/#{@stack}.log")
     end
 
-    desc "remove", "Removes logs"
-    long_desc Help.text("logs/remove")
-    def remove
-      Tasks.new(options).remove
+    def check_logs!
+      return unless all_log_paths.empty?
+      puts "WARN: No logs found".color(:yellow)
+    end
+
+    # Only need to check if both action and stack are provided. Otherwise the Dir.globs are used to discover the files
+    def check_log!
+      return unless single_log?
+      path = "#{Terraspace.log_root}/#{@action}/#{@stack}.log"
+      return if File.exist?(path)
+      puts "ERROR: Log file was not found: #{pretty(path)}".color(:red)
+      exit 1
+    end
+
+    def single_log?
+      @action != '**' && @stack != '*'
+    end
+
+    def apply_limit(lines)
+      return lines if all
+      left = limit * -1
+      lines[left..-1] || []
+    end
+
+    def all
+      if single_log?
+        @options[:all].nil? ? true : @options[:all]
+      else # multiple
+        @options[:all].nil? ? false : @options[:all]
+      end
+    end
+
+    def limit
+      @options[:limit].nil? ? 10 : @options[:limit]
+    end
+
+    def timestamps
+      if single_log?
+        @options[:timestamps].nil? ? false : @options[:timestamps]
+      else
+        @options[:timestamps].nil? ? true : @options[:timestamps]
+      end
+    end
+    def pretty(path)
+      Terraspace::Util.pretty_path(path)
     end
   end
 end

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/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