terraspace 0.5.10 → 0.6.2

data/lib/terraspace/cli/init.rb

@@ -3,10 +3,9 @@ require 'timeout'
 class Terraspace::CLI
   class Init < Base
     def initialize(options={})
-      # Original calling command. Can be from Commander which is a terraform command. IE: terraform apply
-      # Or can be from terraspace cloud setup. Which will be cloud-setup.
-      @calling_command = options[:calling_command]
-      super(options)
+      # terraform init output goes to default Terraspace.logger.info which is stderr
+      # Unless the logger has been overridden.
+      super(options.merge(log_to_stderr: true))
     end
 
     def run
@@ -29,7 +28,11 @@ class Terraspace::CLI
     end
 
     def sync_cloud
-      Terraspace::Terraform::Cloud::Sync.new(@options).run if %w[apply plan destroy cloud-setup].include?(@calling_command)
+      Terraspace::Terraform::Tfc::Sync.new(@options).run if sync_cloud?
+    end
+
+    def sync_cloud?
+       %w[apply down plan up].include?(calling_command)
     end
 
     # Currently only handles remote modules only one-level deep.
@@ -54,16 +57,21 @@ class Terraspace::CLI
 
     def auto?
       # command is only passed from CLI in the update specifically for this check
-      @options[:auto] && @calling_command == "apply"
+      @options[:auto] && calling_command == "up"
     end
   private
     def local_source?(s)
        s =~ %r{^\.} || s =~ %r{^/}
     end
 
+    def auto_init?
+      # terraspace commands not terraform commands. included some extra terraform commands here in case terrapace adds those later
+      commands = %w[all apply console down output plan providers refresh show state up validate]
+      commands.include?(calling_command)
+    end
+
     def run_init?
-      commands = %w[apply console destroy output plan providers refresh show validate cloud-setup]
-      return false unless commands.include?(@calling_command)
+      return false unless auto_init?
       mode = ENV['TS_INIT_MODE'] || Terraspace.config.init.mode
       case mode.to_sym
       when :auto
@@ -87,5 +95,10 @@ class Terraspace::CLI
       end
       !!provider
     end
+
+    # only top level command considered
+    def calling_command
+      ARGV[0]
+    end
   end
 end

data/lib/terraspace/cli/state.rb

@@ -0,0 +1,10 @@
+class Terraspace::CLI
+  class State < Base
+    def run
+      @name = "state #{@options[:subcommand]}" # command name. IE: state list
+      Terraspace::Builder.new(@options).run
+      Init.new(@options).run
+      Terraspace::Terraform::Runner.new(@name, @options).run
+    end
+  end
+end

data/lib/terraspace/cli/{cloud.rb → tfc.rb}

@@ -1,7 +1,7 @@
 class Terraspace::CLI
-  class Cloud < Terraspace::Command
-    Syncer = Terraspace::Terraform::Cloud::Syncer
-    Workspace = Terraspace::Terraform::Cloud::Workspace
+  class Tfc < Terraspace::Command
+    Syncer = Terraspace::Terraform::Tfc::Syncer
+    Workspace = Terraspace::Terraform::Tfc::Workspace
 
     yes_option = Proc.new {
       option :yes, aliases: :y, type: :boolean, desc: "bypass are you sure prompt"

data/lib/terraspace/cli/{cloud → tfc}/runs.rb

@@ -1,10 +1,10 @@
-class Terraspace::CLI::Cloud
+class Terraspace::CLI::Tfc
   class Runs < Terraspace::Command
     Help = Terraspace::CLI::Help
-    Runs = Terraspace::Terraform::Cloud::Runs
+    Runs = Terraspace::Terraform::Tfc::Runs
 
     desc "list STACK", "List runs."
-    long_desc Help.text("cloud:runs:list")
+    long_desc Help.text("tfc:runs:list")
     option :format, desc: "Output formats: #{CliFormat.formats.join(', ')}"
     option :status, default: %w[pending planned], type: :array, desc: "Filter by statuses: pending, planned, all"
     def list(mod)
@@ -12,7 +12,7 @@ class Terraspace::CLI::Cloud
     end
 
     desc "prune STACK", "Prune runs that are possible to cancel or discard."
-    long_desc Help.text("cloud:runs:prune")
+    long_desc Help.text("tfc:runs:prune")
     option :noop, type: :boolean, desc: "Shows what would be cancelled/discarded."
     option :yes, aliases: :y, type: :boolean, desc: "bypass are you sure prompt"
     def prune(mod)

data/lib/terraspace/cli/up.rb

@@ -1,10 +1,12 @@
+require 'securerandom'
+
 class Terraspace::CLI
   class Up < Base
     include TfcConcern
 
     def run
       build
-      if @options[:yes] && !tfc?
+      if @options[:yes] && !@options[:plan] && !tfc?
         plan
         Commander.new("apply", @options.merge(plan: plan_path)).run
       else
@@ -25,8 +27,8 @@ class Terraspace::CLI
     end
 
     def plan_path
-      @@timestamp ||= Time.now.utc.strftime("%Y%m%d%H%M%S")
-      "#{Terraspace.tmp_root}/plans/#{@mod.name}-#{@@timestamp}.plan"
+      @@random ||= SecureRandom.hex
+      "#{Terraspace.tmp_root}/plans/#{@mod.name}-#{@@random}.plan"
     end
   end
 end

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/dirs_concern.rb

@@ -23,6 +23,7 @@ module Terraspace::Compiler
       names, built = [], []
       local_paths(type_dir).each do |path|
         next unless File.directory?(path)
+        next unless select_stack?(type_dir, path)
         mod_name = File.basename(path)
         next if built.include?(mod_name) # ensures modules in app folder take higher precedence than vendor folder
         names << mod_name
@@ -31,6 +32,15 @@ module Terraspace::Compiler
     end
     memoize :mod_names
 
+    # Examples:
+    #   type_dir stacks
+    #   path     /home/ec2-user/environment/downloads/infra/app/stacks/demo
+    def select_stack?(type_dir, path)
+      return true unless type_dir == "stacks"
+      select = Terraspace::Compiler::Select.new(path)
+      select.selected?
+    end
+
     def local_paths(type_dir)
       dirs("app/#{type_dir}/*") + dirs("vendor/#{type_dir}/*")
     end
@@ -40,7 +50,7 @@ module Terraspace::Compiler
     end
 
     def stack_names
-      mod_names("stacks") - Terraspace.config.all.ignore_stacks
+      mod_names("stacks")
     end
     memoize :stack_names
   end

data/lib/terraspace/compiler/select.rb

@@ -0,0 +1,28 @@
+module Terraspace::Compiler
+  class Select
+    def initialize(path)
+      @path = path
+      @stack_name = extract_stack_name(path)
+    end
+
+    def selected?
+      all = Terraspace.config.all
+      # Key difference between include_stacks vs all.include_stacks option is that
+      # the option can be nil. The local variable is guaranteed to be an Array.
+      # This simplifies the logic.
+      include_stacks = all.include_stacks || []
+      ignore_stacks  = all.ignore_stacks  || []
+
+      if all.include_stacks.nil?
+        !ignore_stacks.include?(@stack_name)
+      else
+        stacks = include_stacks - ignore_stacks
+        stacks.include?(@stack_name)
+      end
+    end
+
+    def extract_stack_name(path)
+      path.sub(%r{.*(app|vendor)/stacks/}, '')
+    end
+  end
+end

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)