terraspace 0.6.20 → 0.7.0

data/lib/terraspace/cli/new/example.rb

@@ -0,0 +1,36 @@
+class Terraspace::CLI::New
+  class Example < Thor::Group
+    include Thor::Actions
+
+    # only stack name is configurable
+    argument :name, default: "demo"
+
+    def self.options
+      # default is nil for autodetection
+      [
+        [:force, aliases: %w[f], type: :boolean, desc: "Force overwrite"],
+        [:lang, default: "hcl", desc: "Language to use: HCL/ERB or Ruby DSL"],
+        [:plugin, aliases: %w[p], default: nil, type: :string],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+    def create
+      Module.start(["example", "--examples"] + cli_args)
+      Stack.start([name, "--examples"] + cli_args)
+    end
+
+  private
+    def cli_args
+      plugin = @options[:plugin] || Terraspace::Autodetect.new.plugin
+      args = if plugin
+        ['--plugin', plugin]
+      else
+        ['--plugin', 'none'] # override default of aws
+      end
+      args << "--force" if @options[:force]
+      args += ["--lang", @options[:lang]] if @options[:lang]
+      args
+    end
+  end
+end

data/lib/terraspace/cli/new/helpers/plugin_gem.rb

@@ -5,20 +5,8 @@ module Terraspace::CLI::New::Helpers
       if @options[:plugin_gem]
         @options[:plugin_gem]
       else
-        plugin = @options[:plugin] || autodetect_provider
-        "terraspace_plugin_#{plugin}"
-      end
-    end
-
-    def autodetect_provider
-      providers = Terraspace::Plugin.meta.keys
-      if providers.size == 1
-        providers.first
-      else
-        precedence = %w[aws azurerm google]
-        precedence.find do |p|
-          providers.include?(p)
-        end
+        plugin = @options[:plugin] || Terraspace::Autodetect.new.plugin
+        "terraspace_plugin_#{plugin}" if plugin and plugin != "none"
       end
     end
   end

data/lib/terraspace/cli/new/helpers.rb

@@ -5,7 +5,7 @@ class Terraspace::CLI::New
   private
     def build_gemfile(*list)
       lines = []
-      list.each do |name|
+      list.compact.each do |name|
         lines << gem_line(name)
       end
       lines.join("\n")

data/lib/terraspace/cli/new/module.rb

@@ -5,7 +5,7 @@ class Terraspace::CLI::New
     argument :name
 
     def create_module
-      puts "=> Creating test for new module: #{name}"
+      puts "=> Creating new module called #{name}"
       plugin_template_source(@options[:lang], "module") # IE: plugin_template_source("hcl", "module")
       dest = "app/modules/#{name}"
       dest = "#{@options[:project_name]}/#{dest}" if @options[:project_name]

data/lib/terraspace/cli/new/plugin/helper.rb

@@ -1,5 +1,5 @@
 class Terraspace::CLI::New::Plugin
-  module Helpers
+  module Helper
   private
     # helper
     def camel_name

data/lib/terraspace/cli/new/plugin.rb

@@ -1,6 +1,6 @@
 class Terraspace::CLI::New
   class Plugin < Sequence
-    include Helpers
+    include Helper
 
     argument :name
 

data/lib/terraspace/cli/new/project.rb

@@ -6,7 +6,6 @@ class Terraspace::CLI::New
         [:config, type: :boolean, default: true, desc: "Whether or not to generate config files."],
         [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
         [:quiet, type: :boolean, desc: "Quiet output."],
-        [:test_structure, type: :boolean, desc: "Create project bootstrap test structure."],
       ]
     end
 
@@ -20,7 +19,7 @@ class Terraspace::CLI::New
 
   public
     def creating_messaging
-      log "=> Creating new project called #{name}."
+      log "=> Creating new project called #{name}"
     end
 
     def create_base
@@ -28,6 +27,16 @@ class Terraspace::CLI::New
       directory ".", "#{name}"
     end
 
+    def bundle_install
+      return if @options[:bundle] == false
+      log "=> Installing dependencies with: bundle install"
+      Bundler.with_unbundled_env do
+        bundle = "BUNDLE_IGNORE_CONFIG=1 bundle install"
+        bundle << " > /dev/null 2>&1" if @options[:quiet]
+        system(bundle, chdir: name)
+      end
+    end
+
     # Will generate config folder from
     #
     #     1. terraspace code lang templates or
@@ -60,21 +69,6 @@ class Terraspace::CLI::New
       Stack.start(component_args("demo", name))
     end
 
-    def create_test
-      return unless @options[:test_structure]
-      Test::Bootstrap.start(["--dir", name])
-    end
-
-    def bundle_install
-      return if @options[:bundle] == false
-      log "=> Installing dependencies with: bundle install"
-      Bundler.with_unbundled_env do
-        bundle = "BUNDLE_IGNORE_CONFIG=1 bundle install"
-        bundle << " > /dev/null 2>&1" if @options[:quiet]
-        system(bundle, chdir: name)
-      end
-    end
-
     def welcome_message_examples
       return unless options[:examples]
       log <<~EOL

data/lib/terraspace/cli/new/sequence.rb

@@ -28,7 +28,7 @@ class Terraspace::CLI::New
     argument :name
 
   private
-    def component_args(component_name, project_name)
+    def component_args(component_name, project_name=nil)
       args = [
         component_name,
         "--project-name", project_name,

data/lib/terraspace/cli/new/source/core.rb

@@ -9,7 +9,8 @@ module Terraspace::CLI::New::Source
 
     def set_core_source(template, type=nil)
       template_name = template_name(template, type)
-      template_path = File.expand_path("../../../../templates/#{template_name}", __dir__)
+      folder = @options[:examples] && type != "project" ? "examples/#{template_name}" : template_name
+      template_path = File.expand_path("../../../../templates/#{folder}", __dir__)
       override_source_paths(template_path)
     end
 
@@ -18,11 +19,14 @@ module Terraspace::CLI::New::Source
     end
 
     def require_gem(name)
+      return unless name # can be passed in name=nil with rspec test harness
       begin
+        # Need to clear gem paths since installing plugins like terraspace_plugin_aws as part of terraspace new project
+        Gem.clear_paths
         require name # require plugin for the templates, this registers the plugin
       rescue LoadError => e
         puts "#{e.class}: #{e.message}".color(:red)
-        logger.error "ERROR: Unable to require plugin #{name}.".color(:red)
+        logger.error "ERROR: Unable to require plugin #{name}".color(:red)
         puts "Are you sure you the plugin exists and you specified the right plugin option."
         puts "You specified --plugin #{@options[:plugin]}"
         exit 1
@@ -32,10 +36,7 @@ module Terraspace::CLI::New::Source
     def set_plugin_gem_source(template, type)
       require_gem(plugin_gem_name)
       plugin = Terraspace::Plugin.find_with(plugin: @options[:plugin])
-      unless plugin
-        puts "ERROR: Unable to a find plugin for #{@options[:plugin]}. Are you sure the gem for the plugin is correct?".color(:red)
-        exit 1
-      end
+      return unless plugin # can be passed in name=nil with rspec test harness
       template_name = template_name(template, type)
       template_path = File.expand_path("#{plugin.root}/lib/templates/#{template_name}")
       override_source_paths(template_path)

data/lib/terraspace/cli/new/source/plugin.rb

@@ -9,12 +9,12 @@ module Terraspace::CLI::New::Source
       # project always uses the examples from the provider gem for configs
       # base always uses terraspace core templates
       # examples option always use examples from provider gems
-      if (type == "project" || @options[:examples]) && template != "base"
+      if (type == "project" || @options[:examples]) && template != "base" &&
+         (@options[:plugin] != "none" && !@options[:plugin].nil?)
         set_plugin_gem_source(template, type)   # provider gems has examples
       else
         set_core_source(template, type)  # terraspace core has empty starter files
       end
     end
-
   end
 end

data/lib/terraspace/cli/new/stack.rb

@@ -2,10 +2,11 @@ class Terraspace::CLI::New
   class Stack < Sequence
     component_options.each { |args| class_option(*args) }
 
-    argument :name
+    # default so terraspace new example works without a Thor warning
+    argument :name, default: "demo"
 
     def create_stack
-      puts "=> Creating new stack called #{name}."
+      puts "=> Creating new stack called #{name}"
       plugin_template_source(@options[:lang], "stack") # IE: plugin_template_source("hcl", "stack")
       dest = "app/stacks/#{name}"
       dest = "#{@options[:project_name]}/#{dest}" if @options[:project_name]

data/lib/terraspace/cli/new/test.rb

@@ -3,13 +3,13 @@ class Terraspace::CLI::New
     include Thor::Actions
     include Terraspace::CLI::New::Helpers
 
-    argument :name
+    argument :name, required: false
 
     def self.options
       [
         [:force, aliases: %w[y], type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
         [:test_name, desc: "Test name. Defaults to the project, module or stack name"],
-        [:type, default: "project", desc: "project, stack or module"],
+        [:type, default: "stack", desc: "project, stack or module"],
       ]
     end
     options.each { |args| class_option(*args) }
@@ -42,9 +42,19 @@ class Terraspace::CLI::New
   public
 
     def create
+      if type != 'project' && name.nil?
+        puts "ERROR: require NAME for type stack and module".color(:red)
+        exit 1
+      end
       test_template_source(@options[:lang], type)
       puts "=> Creating #{type} test: #{name}"
       directory ".", dest
     end
+
+    # Used in ERB template
+    # rspec-terraspace/lib/templates/stack/test/spec/fixtures/config/terraform/provider.tf.tt
+    def autodetect_provider
+      Terraspace::Autodetect.new.plugin
+    end
   end
 end

data/lib/terraspace/cli/new.rb

@@ -42,5 +42,9 @@ class Terraspace::CLI
     long_desc Help.text("new/test")
     Test.options.each { |args| option(*args) }
     register(Test, "test", "test NAME", "Generates new test.")
+
+    long_desc Help.text("new/example")
+    Example.options.each { |args| option(*args) }
+    register(Example, "example", "example [NAME]", "Generates new example.")
   end
 end

data/lib/terraspace/cli/{check_setup.rb → setup/check.rb}

@@ -1,5 +1,5 @@
-class Terraspace::CLI
-  class CheckSetup
+class Terraspace::CLI::Setup
+  class Check
     extend Memoist
 
     # Terraspace requires at least this version of terraform
@@ -83,7 +83,9 @@ class Terraspace::CLI
     #
     # Note: The -json option is only available in v0.13+
     def terraform_version_message
-      `terraform --version`.split("\n").find { |l| l =~ /^Terraform / }.strip
+      out = `terraform --version`
+      version = out.split("\n").find { |l| l =~ /^Terraform / }
+      version.strip if version
     end
     memoize :terraform_version_message
 

data/lib/terraspace/cli/setup.rb

@@ -0,0 +1,9 @@
+class Terraspace::CLI
+  class Setup < Terraspace::Command
+    desc "check", "Check setup is ok"
+    long_desc Help.text("setup/check")
+    def check
+      Check.new(options).run
+    end
+  end
+end

data/lib/terraspace/cli/tfc_concern.rb

@@ -7,7 +7,7 @@ class Terraspace::CLI
     end
 
     def backend
-      Terraspace::Compiler::Backend::Parser.new(@mod).result
+      Terraspace::Terraform::Runner::Backend::Parser.new(@mod).result
     end
     memoize :backend
   end

data/lib/terraspace/cli.rb

@@ -1,14 +1,13 @@
 module Terraspace
   class CLI < Command
+    include Concern
+
     class_option :verbose, type: :boolean
     class_option :noop, type: :boolean
 
     yes_option = Proc.new {
       option :yes, aliases: :y, type: :boolean, desc: "-auto-approve the terraform apply"
     }
-    format_option = Proc.new {
-      option :format, desc: "output formats: json, text"
-    }
     out_option = Proc.new {
       option :out, aliases: :o, desc: "Write the output to path"
     }
@@ -43,6 +42,10 @@ module Terraspace
     long_desc Help.text(:new)
     subcommand "new", New
 
+    desc "setup SUBCOMMAND", "setup subcommands"
+    long_desc Help.text(:setup)
+    subcommand "setup", Setup
+
     desc "tfc SUBCOMMAND", "tfc subcommands"
     long_desc Help.text(:tfc)
     subcommand "tfc", Tfc
@@ -62,17 +65,23 @@ module Terraspace
       Bundle.new(options.merge(args: args)).run
     end
 
-    desc "check_setup", "Check setup."
+    desc "check_setup", "Check setup.", hide: true
     long_desc Help.text(:check_setup)
     def check_setup
-      CheckSetup.new(options).run
+      puts <<~EOL
+        DEPRECATED: The terraspace check_setup command is deprecated. Instead use:
+
+            terraspace setup check
+
+      EOL
+      Setup::Check.new(options).run
     end
 
     desc "console STACK", "Run console in built terraform project."
     long_desc Help.text(:console)
     instance_option.call
-    def console(mod)
-      Commander.new("console", options.merge(mod: mod, shell: "system")).run
+    def console(mod, *args)
+      Commander.new("console", options.merge(mod: mod, args: args, shell: "system")).run
     end
 
     desc "down STACK", "Destroy infrastructure stack."
@@ -81,8 +90,8 @@ module Terraspace
     yes_option.call
     reconfigure_option.call
     option :destroy_workspace, type: :boolean, desc: "Also destroy the Cloud workspace. Only applies when using Terraform Cloud remote backend."
-    def down(mod)
-      Down.new(options.merge(mod: mod)).run
+    def down(mod, *args)
+      Down.new(options.merge(mod: mod, args: args)).run
     end
 
     desc "force_unlock", "Calls terrform force-unlock"
@@ -111,8 +120,8 @@ module Terraspace
     desc "init STACK", "Run init in built terraform project."
     long_desc Help.text(:init)
     instance_option.call
-    def init(mod)
-      Commander.new("init", options.merge(mod: mod, quiet: false)).run
+    def init(mod, *args)
+      Commander.new("init", options.merge(mod: mod, args: args, quiet: false)).run
     end
 
     desc "list", "List stacks and modules."
@@ -141,22 +150,22 @@ module Terraspace
     out_option.call
     reconfigure_option.call
     option :copy_to_root, type: :boolean, default: true, desc: "Copy plan file generated in the cache folder back to project root"
-    def plan(mod)
-      Commander.new("plan", options.merge(mod: mod)).run
+    def plan(mod, *args)
+      Commander.new("plan", options.merge(mod: mod, args: args)).run
     end
 
     desc "providers STACK", "Show providers."
     long_desc Help.text(:providers)
     instance_option.call
-    def providers(mod)
-      Commander.new("providers", options.merge(mod: mod)).run
+    def providers(mod, *args)
+      Commander.new("providers", options.merge(mod: mod, args: args)).run
     end
 
     desc "refresh STACK", "Run refresh."
     long_desc Help.text(:refresh)
     instance_option.call
-    def refresh(mod)
-      Commander.new("refresh", options.merge(mod: mod)).run
+    def refresh(mod, *args)
+      Commander.new("refresh", options.merge(mod: mod, args: args)).run
     end
 
     desc "seed STACK", "Build starer seed tfvars file."
@@ -182,9 +191,8 @@ module Terraspace
     long_desc Help.text(:show)
     instance_option.call
     option :plan, desc: "path to created.plan"
-    option :json, type: :boolean, desc: "show plan in json format"
-    def show(mod)
-      Commander.new("show", options.merge(mod: mod)).run
+    def show(mod, *args)
+      Commander.new("show", options.merge(mod: mod, args: args)).run
     end
 
     desc "state SUBCOMMAND STACK", "Run state."
@@ -201,11 +209,10 @@ module Terraspace
 
     desc "output STACK", "Run output."
     long_desc Help.text(:output)
-    format_option.call
     instance_option.call
     out_option.call
-    def output(mod)
-      Commander.new("output", options.merge(mod: mod)).run
+    def output(mod, *args)
+      Commander.new("output", options.merge(mod: mod, args: args)).run
     end
 
     desc "up STACK", "Deploy infrastructure stack."
@@ -218,15 +225,15 @@ module Terraspace
     reconfigure_option.call
     option :plan, desc: "Execution plan that can be used to only execute a pre-determined set of actions."
     option :var_files, type: :array, desc: "list of var files"
-    def up(mod)
-      Up.new(options.merge(mod: mod)).run
+    def up(mod, *args)
+      Up.new(options.merge(mod: mod, args: args)).run
     end
 
     desc "validate STACK", "Validate stack."
     long_desc Help.text(:validate)
     instance_option.call
-    def validate(mod)
-      Commander.new("validate", options.merge(mod: mod)).run
+    def validate(mod, *args)
+      Commander.new("validate", options.merge(mod: mod, args: args)).run
     end
 
     desc "completion *PARAMS", "Prints words for auto-completion."

data/lib/terraspace/command.rb

@@ -71,7 +71,7 @@ module Terraspace
         version_manager = "rvm" if rvm?
         version_manager = "rbenv" if rbenv?
         if rbenv? || rvm?
-          puts <<~EOL.color(:yellow)
+          $stderr.puts <<~EOL.color(:yellow)
             WARN: It looks like a standalone Terraspace install and #{version_manager} is also in use.
             Different gems from the standalone Terraspace install and #{version_manager} can cause all kinds of trouble.
             Please install Terraspace as a gem instead and remove the standalone Terraspace /opt/terraspace installation.
@@ -102,8 +102,9 @@ module Terraspace
         return if subcommand?
         return if command_name.nil?
         return if help_flags.include?(Terraspace.argv.last) # IE: -h help
-        return if %w[-h -v check_setup completion completion_script help new test version].include?(command_name)
+        return if %w[-h -v --version check_setup completion completion_script help new setup test version].include?(command_name)
         return if File.exist?("#{Terraspace.root}/config/app.rb")
+        return unless Terraspace.check_project
         logger.error "ERROR: It doesnt look like this is a terraspace project. Are you sure you are in a terraspace project?".color(:red)
         ENV['TS_TEST'] ? raise : exit(1)
       end

data/lib/terraspace/compiler/commands_concern.rb

@@ -1,13 +1,5 @@
 module Terraspace::Compiler
   module CommandsConcern
-    def requires_backend?
-      command_is?(requires_backend_commands)
-    end
-
-    def requires_backend_commands
-      %w[down init output plan providers refresh show up validate]
-    end
-
     def command_is?(*commands)
       commands.flatten!
       commands.map!(&:to_s)

data/lib/terraspace/compiler/expander/backend.rb

@@ -0,0 +1,44 @@
+# Simpler than Terraspace::Terraform::Runner::Backend::Parser because
+# Terraspace::Compiler::Expander autodetect backend super early on.
+# It's so early that don't want helper methods like <%= expansion(...) %> to be called.
+# Calling the expansion helper itself results in Terraspace autodetecting a concrete
+# Terraspace Plugin Expander, which creates an infinite loop.
+# This simple detection class avoids calling ERB and avoids the infinite loop.
+class Terraspace::Compiler::Expander
+  class Backend
+    extend Memoist
+
+    def initialize(mod)
+      @mod = mod
+    end
+
+    COMMENT = /^\s+#/
+    # Works for both backend.rb DSL and backend.tf ERB
+    def detect
+      return nil unless src_path # no backend file. returning nil means a local backend
+      lines = IO.readlines(src_path)
+      backend_line = lines.find { |l| l.include?("backend") && l !~ COMMENT }
+      md = backend_line.match(/['"](.*)['"]/)
+      md[1] if md
+    end
+
+  private
+    # Use original unrendered source as wont know the
+    # @mod.cache_dir = ":CACHE_ROOT/:REGION/:ENV/:BUILD_DIR"
+    # Until the concrete Terraspace Plugin Expander has been autodetected.
+    # Follow same precedence rules as rest of Terraspace.
+    def src_path
+      exprs = [
+        "app/stacks/#{@mod.build_dir}/backend.*",
+        "app/modules/#{@mod.build_dir}/backend.*",
+        "vendor/stacks/#{@mod.build_dir}/backend.*",
+        "vendor/modules/#{@mod.build_dir}/backend.*",
+        "config/terraform/backend.*",
+      ]
+      path = nil
+      exprs.find { |expr| path = Dir.glob(expr).first }
+      path
+    end
+    memoize :src_path
+  end
+end

data/lib/terraspace/compiler/expander.rb

@@ -1,17 +1,21 @@
 module Terraspace::Compiler
   class Expander
+    extend Memoist
     delegate :expand, :expansion, to: :expander
 
-    attr_reader :expander
     def initialize(mod, name)
       @mod, @name = mod, name
-      @expander = expander_class.new(@mod)
     end
 
+    def expander
+      expander_class.new(@mod)
+    end
+    memoize :expander
+
     def expander_class
       # IE: TerraspacePluginAws::Interfaces::Expander
       klass_name = Terraspace::Plugin.klass("Expander", backend: @name)
-      klass_name.constantize if klass_name
+      klass_name ? klass_name.constantize : Terraspace::Plugin::Expander::Generic
     rescue NameError
       Terraspace::Plugin::Expander::Generic
     end
@@ -20,27 +24,15 @@ module Terraspace::Compiler
       extend Memoist
 
       def autodetect(mod, opts={})
-        backend = opts[:backend]
-        unless backend
-          plugin = find_plugin
-          backend = plugin[:backend]
-        end
+        backend = opts[:backend] || find_backend(mod)
         new(mod, backend)
       end
       memoize :autodetect
 
-      def find_plugin
-        plugins = Terraspace::Plugin.meta
-        if plugins.size == 1
-          plugins.first[1]
-        else
-          precedence = %w[aws azurerm google]
-          plugin = precedence.find do |provider|
-            plugins[provider]
-          end
-          plugins[plugin]
-        end
+      def find_backend(mod)
+        Backend.new(mod).detect
       end
+      memoize :find_backend
     end
   end
 end

data/lib/terraspace/compiler/strategy/mod/text_file.rb

@@ -0,0 +1,35 @@
+require "open3"
+
+class Terraspace::Compiler::Strategy::Mod
+  class TextFile
+    include Terraspace::Util::Logging
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    @@already_reported = false
+    def check
+      unless file_installed?
+        return true if @@already_reported
+        logger.warn <<~EOL.color(:yellow)
+          WARN: The command 'file' is not installed.
+          Unable to check if files are text or binary files as a part of the Terraspace compile processing.
+          Assuming all files are not binary file.
+
+          Please install the file command to remove this warning message.
+        EOL
+        @@already_reported = true
+        return true
+      end
+      # Thanks: https://stackoverflow.com/questions/2355866/ruby-how-to-determine-if-file-being-read-is-binary-or-text
+      file_type, status = Open3.capture2e("file", @filename)
+      status.success? && file_type.include?("text")
+    end
+
+  private
+    def file_installed?
+      system("type file > /dev/null 2>&1")
+    end
+  end
+end

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

@@ -1,5 +1,3 @@
-require "open3"
-
 module Terraspace::Compiler::Strategy
   class Mod < AbstractBase
     def run
@@ -16,10 +14,9 @@ module Terraspace::Compiler::Strategy
       "Terraspace::Compiler::Strategy::Mod::#{ext.camelize}".constantize rescue Mod::Pass
     end
 
-    # Thanks: https://stackoverflow.com/questions/2355866/ruby-how-to-determine-if-file-being-read-is-binary-or-text
+  private
     def text_file?(filename)
-      file_type, status = Open3.capture2e("file", filename)
-      status.success? && file_type.include?("text")
+      TextFile.new(filename).check
     end
   end
 end