terraspace 0.5.12 → 0.6.4

data/lib/terraspace/ext.rb

@@ -1,2 +1,3 @@
 require_relative "ext/bundler"
 require_relative "ext/core/module"
+require_relative "ext/core/string"

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

@@ -0,0 +1,5 @@
+class String
+  def camelcase
+    self.underscore.camelize
+  end
+end

data/lib/terraspace/layering.rb

@@ -0,0 +1,24 @@
+require "active_support/lazy_load_hooks"
+
+module Terraspace
+  module Layering
+    def layers
+      pre_layers + main_layers + post_layers
+    end
+
+    def main_layers
+      # '' prefix for base layer
+      [''] + plugins
+    end
+
+    def pre_layers
+      []
+    end
+
+    def post_layers
+      []
+    end
+  end
+end
+
+ActiveSupport.run_load_hooks(:terraspace_layering, Terraspace::Layering)

data/lib/terraspace/logger.rb

@@ -5,7 +5,7 @@ module Terraspace
     def initialize(*args)
       super
       self.formatter = Formatter.new
-      self.level = :info
+      self.level = ENV['TS_LOG_LEVEL'] || :info # note: only respected when config.logger not set in config/app.rb
     end
 
     def format_message(severity, datetime, progname, msg)
@@ -16,5 +16,12 @@ module Terraspace
       end
       line =~ /\n$/ ? line : "#{line}\n"
     end
+
+    # Used to allow terraform output to always go to stdout
+    # Terraspace output goes to stderr by default
+    # See: terraspace/shell.rb
+    def stdout(msg)
+      puts msg
+    end
   end
 end

data/lib/terraspace/mod.rb

@@ -75,7 +75,7 @@ module Terraspace
     #
     #   down - so user can delete stacks w/o needing to create an empty app/stacks/demo folder
     #   null - for the terraspace summary command when there are zero stacks.
-    #          Also useful for terraspace cloud list_workspaces
+    #          Also useful for terraspace tfc list_workspaces
     #
     def possible_fake_root
       if @options[:command] == "down"
@@ -111,9 +111,24 @@ module Terraspace
 
     # Full path with build_dir
     def cache_dir
-      pattern = Terraspace.config.build.cache_dir # IE: :CACHE_ROOT/:REGION/:ENV/:BUILD_DIR
+      # config.build.cache_dir is a String or object that respond_to call. IE:
+      #   :CACHE_ROOT/:REGION/:ENV/:BUILD_DIR
+      #   CustomBuildDir.call
+      # The call method should return a String pattern used for substitutions
+      object = Terraspace.config.build.cache_dir
+      pattern = if object.is_a?(String)
+          object
+        elsif object.respond_to?(:call)
+          object.call(self)
+        elsif object.public_instance_methods.include?(:call)
+          instance = object.new
+          instance.call(self)
+        else
+          raise "ERROR: config.build.cache_dir is not a String or responds to the .call method."
+        end
+
       expander = Terraspace::Compiler::Expander.autodetect(self)
-      expander.expansion(pattern)
+      expander.expansion(pattern) # pattern is a String that contains placeholders for substitutions
     end
     memoize :cache_dir
 

data/lib/terraspace/plugin/expander/friendly.rb

@@ -0,0 +1,10 @@
+module Terraspace::Plugin::Expander
+  module Friendly
+    # used by
+    #   Terraspace::Compiler::Strategy::Tfvar::Layer
+    #   Terraspace::Plugin::Expander::Interface
+    def friendly_name(name)
+      Terraspace.config.layering.names[name.to_sym] || name
+    end
+  end
+end

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

@@ -7,6 +7,7 @@
 module Terraspace::Plugin::Expander
   module Interface
     include Terraspace::Plugin::InferProvider
+    include Terraspace::Plugin::Expander::Friendly
 
     delegate :build_dir, :type_dir, :type, to: :mod
 
@@ -68,7 +69,11 @@ module Terraspace::Plugin::Expander
 
     def var_value(name)
       name = name.sub(':','').downcase
-      send(name)
+      value = send(name)
+      if name == "namespace" && Terraspace.config.layering.enable_names.expansion
+        value = friendly_name(value)
+      end
+      value
     end
 
     def mod_name

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

@@ -67,7 +67,7 @@ module Terraspace::Plugin::Summary
       return unless data # edge case: blank file
       resources = data['resources']
       return unless resources
-      remove_statefile(path) if resources && resources.size == 0 && !ENV['TS_KEEP_EMPTY_STATEFILES']
+      remove_statefile(path) if Terraspace.config.summary.prune && resources && resources.size == 0
       return unless resources && resources.size > 0
 
       pretty_path = path.sub(Regexp.new(".*#{@bucket}/#{@folder}"), '')

data/lib/terraspace/shell.rb

@@ -30,6 +30,10 @@ module Terraspace
     def popen3(env)
       Open3.popen3(env, @command, chdir: @mod.cache_dir) do |stdin, stdout, stderr, wait_thread|
         mimic_terraform_input(stdin, stdout)
+        while out = stdout.gets
+          terraform_to_stdout(out)
+        end
+
         while err = stderr.gets
           @error ||= Error.new
           @error.lines << err # aggregate all error lines
@@ -69,7 +73,7 @@ module Terraspace
         "\e[0m\e[1mvar.", # prompts for variable input. can happen on plan or apply. looking for bold marker also in case "var." shows up somewhere else
       ]
       while out = stdout.gets
-        logger.info(out) unless shown && out.include?("Enter a value:")
+        terraform_to_stdout(out) unless shown && out.include?("Enter a value:")
         shown = false if out.include?("Enter a value:") # reset shown in case of multiple input prompts
 
         # Sometimes stdout doesnt flush and show "Enter a value: ", so mimic it
@@ -80,5 +84,16 @@ module Terraspace
         end
       end
     end
+
+    # Allows piping to jq. IE:
+    #   terraspace show demo --json | jq
+    def terraform_to_stdout(out)
+      # so terraform output goes stdout
+      if logger.respond_to?(:stdout) && !@options[:log_to_stderr]
+        logger.stdout(out)
+      else
+        logger.info(out)
+      end
+    end
   end
 end

data/lib/terraspace/terraform/api/runs.rb

@@ -8,8 +8,19 @@ class Terraspace::Terraform::Api
     end
 
     def list
-      payload = http.get("workspaces/#{@workspace_id}/runs")
-      payload['data'] if payload
+      data, next_page = [], :start
+      while next_page == :start || next_page
+        url = "workspaces/#{@workspace_id}/runs"
+        if next_page
+          qs = URI.encode_www_form('page[number]': next_page) if next_page
+          url += "?#{qs}"
+        end
+        payload = http.get(url)
+        return unless payload
+        data += payload['data']
+        next_page = payload['meta']['pagination']['next-page']
+      end
+      data
     end
 
     def discard(id)

data/lib/terraspace/terraform/api/token.rb

@@ -51,11 +51,11 @@ class Terraspace::Terraform::Api
     end
 
     def hostname
-      ENV['TS_HOST'] || Terraspace.config.cloud.hostname || 'app.terraform.io'
+      ENV['TFC_HOST'] || Terraspace.config.tfc.hostname || 'app.terraform.io'
     end
 
     def hostname_configured?
-      !!Terraspace.config.cloud.hostname
+      !!Terraspace.config.tfc.hostname
     end
 
     def self.get

data/lib/terraspace/terraform/api/var.rb

@@ -31,7 +31,7 @@ class Terraspace::Terraform::Api
     end
 
     def vars
-      Terraspace.config.cloud.vars
+      Terraspace.config.tfc.vars
     end
 
     def variable_id(key)

data/lib/terraspace/terraform/api/vars.rb

@@ -33,7 +33,7 @@ class Terraspace::Terraform::Api
 
     def vars_path
       # .rb takes higher precedence
-      Dir.glob("#{Terraspace.root}/config/terraform/cloud/vars.{rb,json}").first
+      Dir.glob("#{Terraspace.root}/config/terraform/tfc/vars.{rb,json}").first
     end
   end
 end

data/lib/terraspace/terraform/api/vars/base.rb

@@ -1,5 +1,7 @@
 class Terraspace::Terraform::Api::Vars
   class Base
+    include Terraspace::Util::Logging
+
     def initialize(mod, vars_path)
       @mod, @vars_path = mod, vars_path
     end

data/lib/terraspace/terraform/api/vars/json.rb

@@ -4,11 +4,23 @@ class Terraspace::Terraform::Api::Vars
       context = Terraspace::Compiler::Erb::Context.new(@mod)
       result = RenderMePretty.result(@vars_path, context: context)
 
-      data = JSON.load(result)
+      data = json_load(result)
       items = data.select do |item|
         item['data']['type'] == 'vars'
       end
       items.map { |i| i['data']['attributes'] }
     end
+
+    def json_load(result)
+      JSON.load(result)
+    rescue JSON::ParserError => e
+      # TODO: show exact line with error
+      logger.info("ERROR in json: #{e.class}: #{e.message}")
+      path = "/tmp/terraspace/debug/vars.json"
+      logger.info("Result also written to #{path} for inspection")
+      FileUtils.mkdir_p(File.dirname(path))
+      IO.write(path, result)
+      exit 1
+    end
   end
 end

data/lib/terraspace/terraform/api/workspace.rb

@@ -24,7 +24,7 @@ class Terraspace::Terraform::Api
 
     def working_directory
       cache_dir = @mod.cache_dir.sub("#{Terraspace.root}/", '')
-      prefix = Terraspace.config.cloud.working_dir_prefix # prepended to TFC Working Directory
+      prefix = Terraspace.config.tfc.working_dir_prefix # prepended to TFC Working Directory
       prefix ? "#{prefix}/#{cache_dir}" : cache_dir
     end
 
@@ -38,7 +38,8 @@ class Terraspace::Terraform::Api
       #
       #     terraspace up demo --no-init
       #
-      unless payload || options[:exit_on_fail] == false
+      exit_on_fail = options[:exit_on_fail].nil? ? true : options[:exit_on_fail]
+      if exit_on_fail && not_found_error?(payload)
         logger.error "ERROR: Unable to find the workspace: #{@name}. The workspace may not exist. Or the Terraform token may be invalid. Please double check your Terraform token.".color(:red)
         exit 1
       end
@@ -46,6 +47,12 @@ class Terraspace::Terraform::Api
     end
     memoize :details
 
+    def not_found_error?(payload)
+      return true unless payload
+      return false unless payload.key?('errors')
+      payload['errors'][0]['status'] == '404'
+    end
+
     def destroy
       # response payload from delete operation is nil
       http.delete("/organizations/#{@organization}/workspaces/#{@name}")
@@ -74,7 +81,7 @@ class Terraspace::Terraform::Api
 
     def attributes
       attrs = { name: @name }
-      config = Terraspace.config.cloud.workspace.attrs
+      config = Terraspace.config.tfc.workspace.attrs
       attrs.merge!(config)
       # Default: run on all changes since app/modules can affect app/stacks
       if config['vcs-repo'] && config['file-triggers-enabled'].nil?

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

@@ -23,7 +23,10 @@ module Terraspace::Terraform::Args
       args = auto_approve_arg
       var_files = @options[:var_files]
       if var_files
-        args << var_files.map { |f| "-var-file #{Dir.pwd}/#{f}" }.join(' ')
+        var_files.each do |file|
+          copy_to_cache(plan)
+        end
+        args << var_files.map { |f| "-var-file #{f}" }.join(' ')
       end
 
       args << input_option
@@ -31,15 +34,8 @@ module Terraspace::Terraform::Args
       # must be at the end
       plan = @options[:plan]
       if plan
-        if plan.starts_with?('/')
-          src  = plan
-          dest = src
-        else
-          src = "#{Dir.pwd}/#{plan}"
-          dest = "#{@mod.cache_dir}/#{File.basename(src)}"
-        end
-        FileUtils.cp(src, dest) unless same_file?(src, dest)
-        args << " #{dest}"
+        copy_to_cache(plan)
+        args << " #{plan}"
       end
       args
     end
@@ -79,19 +75,24 @@ module Terraspace::Terraform::Args
       args << input_option
       args << "-destroy" if @options[:destroy]
       args << "-out #{expanded_out}" if @options[:out]
+      # Note: based on the @options[:out] will run an internal hook to copy plan
+      # file back up to the root project folder for use. Think this is convenient and expected behavior.
       args
     end
 
     def show_args
       args = []
       args << " -json" if @options[:json]
-      args << " #{@options[:plan]}" if @options[:plan] # terraform show /path/to/plan
+      plan = @options[:plan]
+      if plan
+        copy_to_cache(@options[:plan])
+        args << " #{@options[:plan]}" # terraform show /path/to/plan
+      end
       args
     end
 
     def expanded_out
-      out = @options[:out]
-      out.starts_with?('/') ? out : "#{Dir.pwd}/#{out}"
+      @options[:out]
     end
 
     def destroy_args
@@ -123,5 +124,14 @@ module Terraspace::Terraform::Args
     def same_file?(src, dest)
       src == dest
     end
+
+    def copy_to_cache(file)
+      return if file =~ %r{^/} # not need to copy absolute path
+      name = file.sub("#{Terraspace.root}/",'')
+      src = name
+      dest = "#{@mod.cache_dir}/#{name}"
+      FileUtils.mkdir_p(File.dirname(dest))
+      FileUtils.cp(src, dest) unless same_file?(src, dest)
+    end
   end
 end

data/lib/terraspace/terraform/ihooks/after/plan.rb

@@ -0,0 +1,17 @@
+module Terraspace::Terraform::Ihooks::After
+  class Plan < Terraspace::Terraform::Ihooks::Base
+    def run
+      return if !@options[:out] || @options[:copy_to_root] == false
+      copy_to_root(@options[:out])
+    end
+
+    def copy_to_root(file)
+      return if file =~ %r{^/} # not need to copy absolute path
+      name = file.sub("#{Terraspace.root}/",'')
+      src = "#{@mod.cache_dir}/#{name}"
+      dest = name
+      FileUtils.mkdir_p(File.dirname(dest))
+      FileUtils.cp(src, dest)
+    end
+  end
+end

data/lib/terraspace/terraform/ihooks/base.rb

@@ -0,0 +1,8 @@
+module Terraspace::Terraform::Ihooks
+  class Base < Terraspace::CLI::Base
+    def initialize(name, options={})
+      @name = name
+      super(options)
+    end
+  end
+end

data/lib/terraspace/terraform/ihooks/before/plan.rb

@@ -0,0 +1,14 @@
+module Terraspace::Terraform::Ihooks::Before
+  class Plan < Terraspace::Terraform::Ihooks::Base
+    def run
+      out = @options[:out]
+      return unless out
+      return if out =~ %r{^/} # not need to create parent dir for copy with absolute path
+
+      out = @options[:out]
+      name = out.sub("#{Terraspace.root}/",'')
+      dest = "#{@mod.cache_dir}/#{name}"
+      FileUtils.mkdir_p(File.dirname(dest))
+    end
+  end
+end

data/lib/terraspace/terraform/remote_state/fetcher.rb

@@ -84,7 +84,7 @@ module Terraspace::Terraform::RemoteState
     end
 
     def init
-      Terraspace::CLI::Init.new(mod: @child.name, calling_command: "apply", quiet: true, suppress_error_color: true).init
+      Terraspace::CLI::Init.new(mod: @child.name, quiet: true, suppress_error_color: true).init
       true
     rescue Terraspace::BucketNotFoundError # from Terraspace::Shell
       bucket_not_found_error

data/lib/terraspace/terraform/runner.rb

@@ -22,7 +22,9 @@ module Terraspace::Terraform
       params = args.flatten.join(' ')
       command = "terraform #{name} #{params}".squish
       run_hooks("terraform.rb", name) do
+        run_internal_hook(:before, name)
         Terraspace::Shell.new(@mod, command, @options.merge(env: custom.env_vars)).run
+        run_internal_hook(:after, name)
       end
     rescue Terraspace::SharedCacheError, Terraspace::InitRequiredError
       @retryer ||= Retryer.new(@mod, @options, name, $!)
@@ -34,6 +36,16 @@ module Terraspace::Terraform
       end
     end
 
+    def run_internal_hook(type, name)
+      begin
+        klass = "Terraspace::Terraform::Ihooks::#{type.to_s.classify}::#{name.classify}".constantize
+      rescue NameError
+        return
+      end
+      ihook = klass.new(name, @options)
+      ihook.run
+    end
+
     @@current_dir_message_shown = false
     def current_dir_message
       return if @@current_dir_message_shown