terraspace 0.5.12 → 0.6.0

data/lib/terraspace/compiler/builder.rb

@@ -39,6 +39,7 @@ module Terraspace::Compiler
       expr = "#{Terraspace.root}/config/terraform/**/*"
       Dir.glob(expr).each do |path|
         next unless File.file?(path)
+        next if path.include?('config/terraform/tfvars')
         build_config_file(basename(path))
       end
     end
@@ -73,6 +74,7 @@ module Terraspace::Compiler
     def skip?(src_path)
       return true unless File.file?(src_path)
       # certain folders will be skipped
+      src_path.include?("#{@mod.root}/tfvars") ||
       src_path.include?("#{@mod.root}/config/args") ||
       src_path.include?("#{@mod.root}/config/hooks") ||
       src_path.include?("#{@mod.root}/test")

data/lib/terraspace/compiler/strategy/tfvar.rb

@@ -20,18 +20,30 @@ module Terraspace::Compiler::Strategy
       end
     end
 
+    def layer_paths
+      Layer.new(@mod).paths
+    end
+
     # Tact on number to ensure that tfvars will be processed in desired order.
     # Also name auto.tfvars so it will automatically load
     def ordered_name(layer_path)
       @order += 1
-      prefix = @order.to_s.rjust(2, '0') # add leading 0 in case there are more than 10 layers
-      name = "#{prefix}-#{File.basename(layer_path)}"
+      prefix = @order.to_s
+      # add leading 0 when more than 10 layers
+      prefix = prefix.rjust(2, '0') if layer_paths.size > 9
+      name = "#{prefix}-#{tfvar_name(layer_path)}"
       name.sub('.tfvars','.auto.tfvars')
           .sub('.rb','.auto.tfvars.json')
     end
 
-    def layer_paths
-      Layer.new(@mod).paths
+    def tfvar_name(layer_path)
+      if layer_path.include?('/tfvars/')
+        name = layer_path.sub(%r{.*/tfvars/},'').gsub('/','-')
+        name = "project-#{name}" if layer_path.include?("config/terraform/tfvars")
+        name
+      else
+        File.basename(layer_path)
+      end
     end
 
     def strategy_class(ext)

data/lib/terraspace/compiler/strategy/tfvar/layer.rb

@@ -1,11 +1,51 @@
+# Layers in order
+#
+#     Name / Pattern                 | Example
+#     -------------------------------|---------------
+#     base                           | base.tfvars
+#     env                            | dev.tfvars
+#     region/base                    | us-west-2/base.tfvars (provider specific)
+#     region/env                     | us-west-2/dev.tfvars (provider specific)
+#     namespace/base                 | 112233445566/base.tfvars (provider specific)
+#     namespace/env                  | 112233445566/dev.tfvars (provider specific)
+#     namespace/region/base          | 112233445566/us-west-2/base.tfvars (provider specific)
+#     namespace/region/env           | 112233445566/us-west-2/dev.tfvars (provider specific)
+#     provider/base                  | aws/base.tfvars (provider specific)
+#     provider/env                   | aws/dev.tfvars (provider specific)
+#     provider/region/base           | aws/us-west-2/base.tfvars (provider specific)
+#     provider/region/env            | aws/us-west-2/dev.tfvars (provider specific)
+#     provider/namespace/base        | aws/112233445566/base.tfvars (provider specific)
+#     provider/namespace/env         | aws/112233445566/dev.tfvars (provider specific)
+#     provider/namespace/region/base | aws/112233445566/us-west-2/base.tfvars (provider specific)
+#     provider/namespace/region/env  | aws/112233445566/us-west-2/dev.tfvars (provider specific)
+#
+# namespace and region depends on the provider. Here an example of the mapping:
+#
+#              | AWS     | Azure        | Google
+#    ----------|---------|--------------|-------
+#    namespace | account | subscription | project
+#    region    | region  | location     | region
+#
+#
 class Terraspace::Compiler::Strategy::Tfvar
   class Layer
+    extend Memoist
+    include Terraspace::Layering
+    include Terraspace::Plugin::Expander::Friendly
+
     def initialize(mod)
       @mod = mod
     end
 
     def paths
-      layer_paths = layers.map do |layer|
+      project_paths = full_paths(project_tfvars_dir)
+      stack_paths   = full_paths(stack_tfvars_dir)
+      project_paths + stack_paths
+    end
+    memoize :paths
+
+    def full_paths(tfvars_dir)
+      layer_paths = full_layering.map do |layer|
         [
           "#{tfvars_dir}/#{layer}.tfvars",
           "#{tfvars_dir}/#{layer}.rb",
@@ -17,74 +57,58 @@ class Terraspace::Compiler::Strategy::Tfvar
       end
     end
 
-    # Layers in order
-    #
-    #     Name / Pattern                 | Example
-    #     -------------------------------|---------------
-    #     base                           | base.tfvars
-    #     env                            | dev.tfvars
-    #     region/base                    | us-west-2/base.tfvars (provider specific)
-    #     region/env                     | us-west-2/dev.tfvars (provider specific)
-    #     namespace/base                 | 112233445566/base.tfvars (provider specific)
-    #     namespace/env                  | 112233445566/dev.tfvars (provider specific)
-    #     namespace/region/base          | 112233445566/us-west-2/base.tfvars (provider specific)
-    #     namespace/region/env           | 112233445566/us-west-2/dev.tfvars (provider specific)
-    #     provider/base                  | aws/base.tfvars (provider specific)
-    #     provider/env                   | aws/dev.tfvars (provider specific)
-    #     provider/region/base           | aws/us-west-2/base.tfvars (provider specific)
-    #     provider/region/env            | aws/us-west-2/dev.tfvars (provider specific)
-    #     provider/namespace/base        | aws/112233445566/base.tfvars (provider specific)
-    #     provider/namespace/env         | aws/112233445566/dev.tfvars (provider specific)
-    #     provider/namespace/region/base | aws/112233445566/us-west-2/base.tfvars (provider specific)
-    #     provider/namespace/region/env  | aws/112233445566/us-west-2/dev.tfvars (provider specific)
-    #
-    # namespace and region depends on the provider. Here an example of the mapping:
-    #
-    #              | AWS     | Azure        | Google
-    #    ----------|---------|--------------|-------
-    #    namespace | account | subscription | project
-    #    region    | region  | location     | region
+    def full_layering
+      # layers is defined in Terraspace::Layering module
+      layers.inject([]) do |sum, layer|
+        sum += layer_levels(layer) unless layer.nil?
+        sum
+      end
+    end
+
+    # adds prefix and to each layer pair that has base and Terraspace.env. IE:
     #
+    #    "#{prefix}/base"
+    #    "#{prefix}/#{Terraspace.env}"
     #
-    def layers
-      layer_levels + plugin_layers
+    def layer_levels(prefix=nil)
+      levels = ["base", Terraspace.env, @mod.instance].reject(&:blank?) # layer levels. @mod.instance can be nil
+      env_levels = levels.map { |l| "#{Terraspace.env}/#{l}" } # env folder also
+      levels = levels + env_levels
+      levels.map! do |i|
+        # base layer has prefix of '', reject with blank so it doesnt produce '//'
+        [prefix, i].reject(&:blank?).join('/')
+      end
+      levels.unshift(prefix) unless prefix.blank? # IE: tfvars/us-west-2.tfvars
+      levels
     end
 
-    def plugin_layers
+    def plugins
       layers = []
       Terraspace::Plugin.layer_classes.each do |klass|
         layer = klass.new
 
         # region is high up because its simpler and the more common case is a single provider
-        layers += layer_levels(layer.region)
+        layers << layer.region
+
+        namespace = friendly_name(layer.namespace)
 
         # namespace is a simple way keep different tfvars between different engineers on different accounts
-        layers += layer_levels(layer.namespace)
-        layers += layer_levels("#{layer.namespace}/#{layer.region}")
+        layers << namespace
+        layers << "#{namespace}/#{layer.region}"
 
         # in case using multiple providers and one region
-        layers += layer_levels(layer.provider)
-        layers += layer_levels("#{layer.provider}/#{layer.region}") # also in case another provider has colliding regions
+        layers << layer.provider
+        layers << "#{layer.provider}/#{layer.region}" # also in case another provider has colliding regions
 
         # Most general layering
-        layers += layer_levels("#{layer.provider}/#{layer.namespace}")
-        layers += layer_levels("#{layer.provider}/#{layer.namespace}/#{layer.region}")
+        layers << "#{layer.provider}/#{namespace}"
+        layers << "#{layer.provider}/#{namespace}/#{layer.region}"
       end
       layers
     end
 
-    # adds prefix and to each layer pair that has base and Terraspace.env. IE:
-    #
-    #    "#{prefix}/base"
-    #    "#{prefix}/#{Terraspace.env}"
-    #
-    def layer_levels(prefix=nil)
-      levels = ["base", Terraspace.env, @mod.instance] # layer levels
-      env_levels = levels.map { |l| "#{Terraspace.env}/#{l}" } # env folder also
-      levels = levels + env_levels
-      levels.map do |i|
-        [prefix, i].compact.join('/')
-      end
+    def project_tfvars_dir
+      "#{Terraspace.root}/config/terraform/tfvars"
     end
 
     # seed dir takes higher precedence than the tfvars folder within the stack module. Example:
@@ -98,13 +122,12 @@ class Terraspace::Compiler::Strategy::Tfvar
     # Will also consider app/modules/demo/tfvars. Though modules to be reuseable and stacks is where business logic
     # should go.
     #
-    def tfvars_dir
+    def stack_tfvars_dir
       seed_dir = "#{Terraspace.root}/seed/tfvars/#{@mod.build_dir(disable_instance: true)}"
       mod_dir = "#{@mod.root}/tfvars"
 
       empty = Dir.glob("#{seed_dir}/*").empty?
       empty ? mod_dir : seed_dir
     end
-
   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.cache_dir
+        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