terraspace 0.6.20 → 0.7.0

data/lib/terraspace/core.rb

@@ -68,5 +68,15 @@ module Terraspace
     def argv
       @@argv
     end
+
+    @@check_project = true
+    def check_project
+      @@check_project
+    end
+
+    # allow testing frameworks to disable
+    def check_project=(v)
+      @@check_project = v
+    end
   end
 end

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

@@ -4,6 +4,7 @@ module Terraspace::Plugin::Expander
     #   Terraspace::Compiler::Strategy::Tfvar::Layer
     #   Terraspace::Plugin::Expander::Interface
     def friendly_name(name)
+      return '' if name.nil?
       Terraspace.config.layering.names[name.to_sym] || name
     end
   end

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

@@ -70,12 +70,15 @@ module Terraspace::Plugin::Expander
     #
     def strip(string)
       string.sub(/^-+/,'').sub(/-+$/,'') # remove leading and trailing -
-            .sub(%r{/+$},'') # only remove trailing / or else /home/ec2-user => home/ec2-user
+            .sub(%r{/+$},'')  # only remove trailing / or else /home/ec2-user => home/ec2-user
+            .sub(/:\/\//, 'TMP_KEEP_HTTP') # so we can keep ://. IE: https:// or http://
+            .gsub(%r{/+},'/') # remove double slashes are more. IE: // -> / Useful of region is '' in generic expander
+            .sub('TMP_KEEP_HTTP', '://')   # restore :// IE: https:// or http://
     end
 
     def var_value(name)
       name = name.sub(':','').downcase
-      value = send(name)
+      value = send(name).to_s
       if name == "namespace" && Terraspace.config.layering.enable_names.expansion
         value = friendly_name(value)
       end
@@ -102,5 +105,13 @@ module Terraspace::Plugin::Expander
     def cache_root
       Terraspace.cache_root
     end
+
+    # So default config works:
+    #    config.cache_dir = ":CACHE_ROOT/:REGION/:ENV/:BUILD_DIR"
+    # For when folks configure it with the http backend for non-cloud providers
+    # The double slash // will be replace with a single slash in expander/interface.rb
+    def region
+      ''
+    end
   end
 end

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

@@ -16,7 +16,7 @@ class Terraspace::Terraform::Api
 
     # backend may be overridden in classes including this Concern
     def backend
-      Terraspace::Compiler::Backend::Parser.new(@mod).result
+      Terraspace::Terraform::Runner::Backend::Parser.new(@mod).result
     end
     memoize :backend
 

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

@@ -18,23 +18,28 @@ module Terraspace::Terraform::Args
     memoize :build
 
     def args
+      terraform_args + var_file_args
+    end
+
+    def env_vars
+      build
+      dig("env", {})
+    end
+
+  private
+    def terraform_args
       build
       args = dig("args")
       args.compact.flatten
     end
 
-    def var_files
+    def var_file_args
       build
       var_files = dig("var_files")
       var_files.select! { |f| var_file_exist?(f) }
       var_files.map { |f| "-var-file=#{f}" }
     end
 
-    def env_vars
-      build
-      dig("env", {})
-    end
-
     def var_file_exist?(var_file)
       File.exist?("#{@mod.cache_dir}/#{var_file}")
     end

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

@@ -0,0 +1,110 @@
+module Terraspace::Terraform::Args
+  class Pass
+    def initialize(mod, name, options={})
+      @mod, @name, @options = mod, name.underscore, options
+    end
+
+    # map to terraform options and only allow valid terraform options
+    # Arg Examples:
+    #   -refresh-only
+    #   -refresh=false
+    #   -var 'foo=bar'
+    def args
+      args = pass_args.select do |arg|
+        arg_name = get_arg_name(arg)
+        terraform_arg_types.include?(arg_name)
+      end
+
+      args.map { |arg| "-#{arg}" } # add back in the leading single dash (-)
+    end
+
+  private
+    def pass_args
+      args = (@options[:args] || []).map do |o|
+        o.sub(/^-{1,2}/,'') # strips the - or --
+      end
+      reconstruct_hash_args(args)
+    end
+
+    # Thor parses CLI args -var 'foo=bar'
+    # as:
+    #    ["-var", "foo=bar"]
+    # instead of:
+    #    ["-var 'foo=bar'"]
+    #
+    # So reconstruct it to what works with terraform CLI args
+    def reconstruct_hash_args(args)
+      result = []
+      flatten = []
+      skip = false
+      args.each do |arg|
+        arg_type = terraform_arg_types[arg]
+        if arg_type == :hash || skip
+          skip = true
+          if flatten.size == 1
+            flatten << "'#{arg}'" # surround hash value with single quotes
+          else
+            flatten << arg
+          end
+          if flatten.size == 2 # time to grab value and end skipping
+            result << flatten.join(' ')
+            # reset flags
+            skip = false
+            flatten = []
+          end
+          next if skip
+        else
+          result << arg # boolean (-no-color) or assignment (-refresh=false)
+        end
+      end
+      result
+    end
+
+    # Parses terraform COMMAND -help output for arg types.
+    # Return Example:
+    #
+    #     {
+    #       destroy: :boolean,
+    #       refresh: :assignment,
+    #       var: :hash,
+    #     }
+    #
+    def terraform_arg_types
+      out = terraform_help(@name)
+      lines = out.split("\n")
+      lines.select! do |line|
+        line =~ /^  -/
+      end
+      lines.inject({}) do |result, line|
+        # in:  "  -replace=resource   Force replacement of a particular resource instance using",
+        # out: "-replace=resource   Force replacement of a particular resource instance using",
+        line.sub!('  -', '') # remove leading whitespace and -
+
+        # in:  "  -var 'foo=bar'      Set a value for one of the input variables in the root",
+        # out: "var"
+        # in:  "  -refresh=false      Skip checking for external changes to remote objects",
+        # out: "refresh"
+        arg_name = get_arg_name(line)
+
+        if line.match(/'\w+=\w+'/)  # hash. IE: -var 'foo=bar'
+          result[arg_name] = :hash
+        elsif line.match(/\w+=/)    # value IE: -refresh=false
+          result[arg_name] = :assignment # can include string and numeric values
+        else                        # boolean    IE: -refresh-only
+          result[arg_name] = :boolean
+        end
+        result
+      end
+    end
+
+    def get_arg_name(line)
+      line.sub(/\s+.*/,'').split('=').first # strips everything except arg name only
+    end
+
+    @@terraform_help = {}
+    def terraform_help(name)
+      @@terraform_help[name] ||= `terraform #{name} -help`
+    end
+  end
+end
+

data/lib/terraspace/terraform/args/{default.rb → thor.rb}

@@ -1,7 +1,7 @@
 require "tempfile"
 
 module Terraspace::Terraform::Args
-  class Default
+  class Thor
     def initialize(mod, name, options={})
       @mod, @name, @options = mod, name.underscore, options
       @quiet = @options[:quiet].nil? ? true : @options[:quiet]
@@ -81,7 +81,6 @@ module Terraspace::Terraform::Args
 
     def output_args
       args = []
-      args << "-json" if @options[:format] == "json"
       args << "> #{expanded_out}" if @options[:out]
       args
     end
@@ -98,7 +97,6 @@ module Terraspace::Terraform::Args
 
     def show_args
       args = []
-      args << " -json" if @options[:json]
       plan = @options[:plan]
       if plan
         copy_to_cache(@options[:plan])

data/lib/terraspace/{compiler → terraform/runner}/backend/parser.rb

@@ -1,6 +1,6 @@
 require "hcl_parser"
 
-class Terraspace::Compiler::Backend
+class Terraspace::Terraform::Runner::Backend
   class Parser
     extend Memoist
 

data/lib/terraspace/{compiler → terraform/runner}/backend.rb

@@ -1,6 +1,7 @@
-module Terraspace::Compiler
+class Terraspace::Terraform::Runner
   class Backend
     extend Memoist
+    include Terraspace::Compiler::CommandsConcern
 
     def initialize(mod)
       @mod = mod
@@ -9,6 +10,9 @@ module Terraspace::Compiler
     @@created = {}
     def create
       return if @@created[cache_key]
+      return if Terraspace.config.auto_create_backend == false
+      return unless requires_backend?
+
       # set immediately, since local storage wont reach bottom.
       # if fail for other backends, there will be an exception anyway
       @@created[cache_key] = true
@@ -16,6 +20,7 @@ module Terraspace::Compiler
       klass = backend_interface(backend_name)
       return unless klass # in case auto-creation is not supported for specific backend
 
+      # IE: TerraspacePluginAws::Interfaces::Backend.new
       interface = klass.new(backend_info)
       interface.call
     end
@@ -44,5 +49,13 @@ module Terraspace::Compiler
       klass_name.constantize if klass_name
     rescue NameError
     end
+
+    def requires_backend?
+      command_is?(requires_backend_commands)
+    end
+
+    def requires_backend_commands
+      %w[down init output plan providers refresh show up validate]
+    end
   end
 end

data/lib/terraspace/terraform/runner/retryer.rb

@@ -9,7 +9,7 @@ class Terraspace::Terraform::Runner
     end
 
     def retry?
-      max_retries = ENV['TS_MAX_RETRIES'] ? ENV['TS_MAX_RETRIES'].to_i : 3
+      max_retries = ENV['TS_MAX_RETRIES'] ? ENV['TS_MAX_RETRIES'].to_i : 1
       if @retries <= max_retries && !@stop_retrying
         true # will retry
       else

data/lib/terraspace/terraform/runner.rb

@@ -16,12 +16,37 @@ module Terraspace::Terraform
       end
     end
 
+    # default at end in case of redirection. IE: terraform output > /path
+    def args
+      args = custom.args + thor.args + pass.args
+      args.uniq
+    end
+
+    # From config/args/terraform.rb https://terraspace.cloud/docs/config/args/terraform/
+    def custom
+      Args::Custom.new(@mod, @name)
+    end
+    memoize :custom
+
+    # From Thor defined/managed cli @options
+    def thor
+      Args::Thor.new(@mod, @name, @options)
+    end
+    memoize :thor
+
+    # From Thor passthrough cli @options[:args]
+    def pass
+      Args::Pass.new(@mod, @name, @options)
+    end
+    memoize :pass
+
     def terraform(name, *args)
       current_dir_message # only show once
 
       params = args.flatten.join(' ')
       command = "terraform #{name} #{params}".squish
       run_hooks("terraform.rb", name) do
+        Backend.new(@mod).create
         run_internal_hook(:before, name)
         Terraspace::Shell.new(@mod, command, @options.merge(env: custom.env_vars)).run
         run_internal_hook(:after, name)
@@ -58,21 +83,6 @@ module Terraspace::Terraform
       @options[:quiet] ? logger.debug(msg) : logger.info(msg)
     end
 
-    def args
-      # base at end in case of redirection. IE: terraform output > /path
-      custom.args + custom.var_files + default.args
-    end
-
-    def custom
-      Args::Custom.new(@mod, @name)
-    end
-    memoize :custom
-
-    def default
-      Args::Default.new(@mod, @name, @options)
-    end
-    memoize :default
-
   private
     def time_took
       t1 = Time.now

data/lib/terraspace/terraform/tfc/sync.rb

@@ -35,7 +35,7 @@ module Terraspace::Terraform::Tfc
 
     # already memoized in Api::Client
     def backend
-      Terraspace::Compiler::Backend::Parser.new(@mod).result
+      Terraspace::Terraform::Runner::Backend::Parser.new(@mod).result
     end
   end
 end

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.6.20"
+  VERSION = "0.7.0"
 end

data/lib/terraspace.rb

@@ -5,6 +5,7 @@ $:.unshift(File.expand_path("../", __FILE__))
 require "terraspace/autoloader"
 Terraspace::Autoloader.setup
 
+require "active_support"
 require "active_support/concern"
 require "active_support/core_ext/class"
 require "active_support/core_ext/hash"

data/spec/terraspace/seeder/content_spec.rb

@@ -37,8 +37,8 @@ describe Terraspace::Seeder::Content do
       result = content.build
       expected =<<~EOL
         # Required variables:
-        name    = "string"
-        azs     = [...] # list(string)
+        name      = "string"
+        azs       = [...] # list(string)
 
         # Optional variables:
         # project = "project-name"

data/spec/terraspace/terraform/args/custom_spec.rb

@@ -20,10 +20,10 @@ describe Terraspace::Terraform::Args::Custom do
       expect(custom.args).to eq(["-lock-timeout=20m"])
     end
 
-    it "var_files" do
+    it "var_file_args" do
       custom.evaluate_file(file)
       allow(custom).to receive(:var_file_exist?).and_return(true)
-      expect(custom.var_files).to eq(["-var-file=a.tfvars", "-var-file=b.tfvars"])
+      expect(custom.send(:var_file_args)).to eq(["-var-file=a.tfvars", "-var-file=b.tfvars"])
     end
   end
 
@@ -41,10 +41,10 @@ describe Terraspace::Terraform::Args::Custom do
       expect(custom.args).to eq(["-lock-timeout=20m"])
     end
 
-    it "var_files" do
+    it "var_file_args" do
       custom.evaluate_file(file)
       allow(custom).to receive(:var_file_exist?).and_return(true)
-      expect(custom.var_files).to eq([])
+      expect(custom.send(:var_file_args)).to eq([])
     end
   end
 end

data/spec/terraspace/terraform/args/pass_spec.rb

@@ -0,0 +1,101 @@
+describe Terraspace::Terraform::Args::Pass do
+  let(:pass) do
+    described_class.new(mod, name, options)
+  end
+  let(:mod) { double(:mod).as_null_object }
+  let(:options) { {args: args} }
+  # defaults
+  let(:name) { "plan" }
+  let(:args) { [] }
+
+  context "boolean flag" do
+    let(:args) { ["-refresh-only"] }
+    it "pass through args" do
+      args = pass.args
+      expect(args).to eq ["-refresh-only"]
+    end
+  end
+
+  context "assignment arg" do
+    context "-refresh=false" do
+      let(:args) { ["-refresh=false"] }
+      it "pass through args" do
+        args = pass.args
+        expect(args).to eq ["-refresh=false"]
+      end
+    end
+
+    context "-lock-timeout=5s" do
+      let(:args) { ["-lock-timeout=5s"] }
+      it "pass through args" do
+        args = pass.args
+        expect(args).to eq ["-lock-timeout=5s"]
+      end
+    end
+
+    context "-var-file=filename -lock-timeout=5s" do
+      let(:args) { ["-var-file=filename', '-lock-timeout=5s"] }
+      it "pass through args" do
+        args = pass.args
+        expect(args).to eq ["-var-file=filename', '-lock-timeout=5s"]
+      end
+    end
+
+    # normalizes -- to -
+    context "--var-file=filename --lock-timeout=5s" do
+      let(:args) { ["--var-file=filename", "--lock-timeout=5s"] }
+      it "pass through args" do
+        args = pass.args
+        expect(args).to eq ["-var-file=filename", "-lock-timeout=5s"]
+      end
+    end
+  end
+
+  context "hash arg" do
+    context "-var 'foo=bar'" do
+      let(:args) { ["-var 'foo=bar'"] }
+      it "pass through args" do
+        args = pass.args
+        expect(args).to eq ["-var 'foo=bar'"]
+      end
+    end
+
+    context "['-var', 'foo=bar'] improperly passed due to Thor CLI parsing" do
+      let(:args) { ["-var", "foo=bar"] }
+      it "reconstruct to work with terraform cli" do
+        args = pass.send(:pass_args)
+        expect(args).to eq ["var 'foo=bar'"]
+      end
+    end
+  end
+
+  # Works at the parsing level. Also works at Thor CLI parsing level. To test:
+  #
+  #     terraspace plan demo -refresh=false -no-color -var 'foo=bar' -var 'foo2=bar2'
+  #
+  # Results in:
+  #
+  #     terraform plan -input=false -refresh=false -no-color -var 'foo=bar' -var 'foo2=bar2'
+  #
+  context "multiple hash arg" do
+    context "-var 'foo=bar' -var 'foo2=bar2'" do
+      let(:args) { ["-var 'foo=bar'", "-var 'foo2=bar2'"] }
+      it "pass through args" do
+        args = pass.args
+        expect(args).to eq ["-var 'foo=bar'", "-var 'foo2=bar2'"]
+      end
+    end
+  end
+
+  # Could mock out Pass#terraform_help with fixtures,
+  # but will call out to terraform in specs so to see breakage more quickly.
+  context "terraform_arg_types" do
+    it "parses help output to determine arg types" do
+      args = pass.send(:terraform_arg_types)
+      # checking specific keys so spec is more robust to terraform cli changes
+      expect(args['destroy']).to eq(:boolean)
+      expect(args['refresh']).to eq(:assignment)
+      expect(args['var']).to eq(:hash)
+    end
+  end
+end

data/terraspace.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
+  spec.add_dependency "bundler"
   spec.add_dependency "cli-format"
   spec.add_dependency "deep_merge"
   spec.add_dependency "dsl_evaluator"
@@ -28,15 +29,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency "memoist"
   spec.add_dependency "rainbow"
   spec.add_dependency "render_me_pretty"
-  spec.add_dependency "terraspace-bundler", "~> 0.4.0"
+  spec.add_dependency "rexml"
+  spec.add_dependency "terraspace-bundler", "~> 0.4.4"
   spec.add_dependency "thor"
   spec.add_dependency "tty-tree"
   spec.add_dependency "zeitwerk"
 
   # core baseline plugins
-  spec.add_dependency "terraspace_plugin_aws", "~> 0.3.0"
-  spec.add_dependency "terraspace_plugin_azurerm", "~> 0.3.0"
-  spec.add_dependency "terraspace_plugin_google", "~> 0.3.0"
   spec.add_dependency "rspec-terraspace", "~> 0.3.0"
 
   spec.add_development_dependency "bundler"