terraspace 0.0.0 → 0.1.0

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

@@ -0,0 +1,59 @@
+require 'thor'
+
+class Terraspace::CLI::New
+  class Sequence < Thor::Group
+    include Thor::Actions
+    include Helper
+
+    def self.base_options
+      [
+        [:examples, type: :boolean, default: false, desc: "Also generate examples"],
+        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:lang, default: "hcl", desc: "Language to use: HCL/ERB or Ruby DSL"],
+        [:plugin, aliases: %w[p], default: "aws", desc: "Cloud Plugin. Supports: aws, google"],
+        [:test, default: !!ENV['TS_NEW_TEST'], type: :boolean, desc: "Whether or not to generate tests"],
+        [:plugin_gem, desc: "Use if provider gem name doesnt follow terraspace_plugin_XXX naming convention. Must specify both --plugin and --plugin-name option"],
+      ]
+    end
+
+    def self.component_options
+      [
+        [:project_name, desc: "Only used internally", hide: true],
+      ]
+    end
+
+    base_options.each { |args| class_option(*args) }
+
+    argument :name
+
+  private
+    def component_args(component_name, project_name)
+      args = [
+        component_name,
+        "--project-name", project_name,
+      ]
+
+      args += ["--lang", @options[:lang]] if @options[:lang]
+      args += ["--plugin", @options[:plugin]] if @options[:plugin]
+      args += ["--plugin-gem", @options[:plugin_gem]] if @options[:plugin_gem]
+      args += @options[:test] ? ["--test"] : ["--no-test"] # since test may be true by default
+      args += ["--examples"] if @options[:examples]
+      args += ["--force"] if @options[:force]
+      args
+    end
+
+    # friendly method
+    def plugin_template_source(template, type)
+      source = Source::Plugin.new(self, @options)
+      source.set_source_paths(template, type)
+    end
+
+    # A generator script hook to allow for further customizations
+    # The dest folder like app/modules/demo is provided as a first argument to the command.
+    def run_script(script, dest)
+      command = "#{script} #{dest}"
+      puts "Running: #{command}" unless ENV['TS_GENERATOR_MUTE']
+      system(command)
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+module Terraspace::CLI::New::Source
+  class Core
+    include Terraspace::CLI::New::Helper::PluginGem
+    include Terraspace::Util
+
+    def initialize(sequence, options)
+      @sequence, @options = sequence, options
+    end
+
+    def set_core_source(template, type=nil)
+      template_name = template_name(template, type)
+      template_path = File.expand_path("../../../../templates/#{template_name}", __dir__)
+      override_source_paths(template_path)
+    end
+
+    def template_name(template, type=nil)
+      [template, type].compact.join('/')
+    end
+
+    def require_gem(name)
+      begin
+        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)
+        puts "Are you sure you the plugin exists and you specified the right plugin option."
+        puts "You specified --plugin #{@options[:plugin]}"
+        exit 1
+      end
+    end
+
+    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
+      template_name = template_name(template, type)
+      template_path = File.expand_path("#{plugin.root}/lib/templates/#{template_name}")
+      override_source_paths(template_path)
+    end
+
+    def template_name(template, type)
+      if template == "test"
+        "#{template}/#{Terraspace.config.test_framework}/#{type}"
+      else
+        "#{template}/#{type}"       # IE: hcl/module
+      end
+    end
+
+    def override_source_paths(*paths)
+      # https://github.com/erikhuda/thor/blob/34df888d721ecaa8cf0cea97d51dc6c388002742/lib/thor/actions.rb#L128
+      @sequence.instance_variable_set(:@source_paths, nil) # unset instance variable cache
+      # Using string with instance_eval because block doesnt have access to path at runtime.
+      @sequence.class.instance_eval %{
+        def self.source_paths
+          #{paths.flatten.inspect}
+        end
+      }
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Terraspace::CLI::New::Source
+  class Plugin < Core
+    # different interface than Source::Test
+    #
+    #     template: base, hcl, ruby
+    #     type: module, project, stack
+    #
+    def set_source_paths(template, type)
+      # 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"
+        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/source/test.rb

@@ -0,0 +1,26 @@
+module Terraspace::CLI::New::Source
+  class Test < Core
+    # different interface than Source::Plugin
+    #
+    #     template: base, hcl, ruby
+    #     type: module, project, stack
+    #
+    def set_source_paths(template, type)
+      if @options[:examples]
+        set_plugin_gem_source("test", type)
+      else
+        set_test_framework_gem_source(type) # tester gem like rspec-terraspace has empty starter templates
+      end
+    end
+
+    def set_test_framework_gem_source(type)
+      test_gem_name = "rspec/terraspace"
+
+      require_gem(test_gem_name)
+      tester = Terraspace::Tester.find_with(framework: Terraspace.config.test_framework)
+
+      template_path = File.expand_path("#{tester.root}/lib/templates/#{type}")
+      override_source_paths(template_path)
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+class Terraspace::CLI::New
+  class Stack < Sequence
+    component_options.each { |args| class_option(*args) }
+
+    argument :name
+
+    def create_stack
+      plugin_template_source(@options[:lang], "stack") # IE: plugin_template_source("hcl", "stack")
+
+      puts "=> Creating new stack called #{name}."
+      dest = "app/stacks/#{name}"
+      dest = "#{@options[:project_name]}/#{dest}" if @options[:project_name]
+      directory ".", dest
+    end
+
+    def create_test
+      Test::Project.start(component_args(name, @options[:project_name]))
+    end
+
+    def run_generator_hook_script
+      script = ENV['TS_GENERATOR_STACK']
+      return unless script
+      run_script(script, "app/stacks/#{name}")
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Terraspace::CLI::New::Test
+  class Base < Thor::Group
+    include Thor::Actions
+    include Terraspace::CLI::New::Helper
+
+    # Reuse options form Sequence. Tried separting them out and it's not worth it.
+    # It introduced too much duplication.
+    Terraspace::CLI::New::Sequence.base_options.each { |args| class_option(*args) }
+    Terraspace::CLI::New::Sequence.component_options.each { |args| class_option(*args) }
+
+  private
+    def test_template_source(template, type)
+      source = Terraspace::CLI::New::Source::Test.new(self, @options)
+      source.set_source_paths(template, type)
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Terraspace::CLI::New::Test
+  class Bootstrap < Base
+    def self.options
+      [
+        [:dir, default: ".", desc: "directory to write to"],
+      ]
+    end
+
+    options.each { |args| class_option(*args) }
+
+    def create
+      return if @options[:test] == false
+      puts "=> Creating test bootstrap structure"
+      test_template_source(@options[:lang], "bootstrap")
+      directory ".", options[:dir]
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Terraspace::CLI::New::Test
+  class Module < Base
+    argument :name
+
+    def create
+      return if @options[:test] == false
+      test_template_source(@options[:lang], "module")
+
+      puts "=> Creating module test: #{name}"
+      dest = "app/modules/#{name}"
+      dest = "#{@options[:project_name]}/#{dest}" if @options[:project_name]
+      directory ".", dest
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Terraspace::CLI::New::Test
+  class Project < Base
+    argument :name
+
+    def create
+      return if @options[:test] == false
+      test_template_source(@options[:lang], "project")
+
+      puts "=> Creating project test: #{name}"
+      dest = "."
+      dest = "#{@options[:project_name]}/#{dest}" if @options[:project_name]
+      directory ".", dest
+    end
+  end
+end

data/lib/terraspace/cli/seed.rb

@@ -0,0 +1,9 @@
+class Terraspace::CLI
+  class Seed < Base
+    def run
+      puts "Seeding tfvar files for #{@mod.name}"
+      Terraspace::Builder.new(@options).run
+      Terraspace::Seeder.new(@mod, @options).seed
+    end
+  end
+end

data/lib/terraspace/cli/summary.rb

@@ -0,0 +1,61 @@
+require "hcl_parser"
+require "json"
+require "pathname"
+
+class Terraspace::CLI
+  class Summary
+    include Terraspace::Util::Logging
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def run
+      build
+      puts "Summary of resources based on backend storage statefiles"
+      backend_expr = '.terraspace-cache/**/backend.*'
+      backends = Dir.glob(backend_expr)
+      backends.each do |backend|
+        process(backend)
+      end
+    end
+
+    # Grab the last module and build that.
+    # Assume the backend key has the same prefix
+    def build
+      return if ENV['TS_SUMMARY_BUILD'] == '0'
+
+      mod = @options[:mod]
+      unless mod
+        mod_path = Dir.glob("{app,vendor}/{modules,stacks}/*").last
+        mod = File.basename(mod_path)
+      end
+      Build.new(@options.merge(mod: mod)).run # generate and init
+    end
+
+    def process(path)
+      ext = File.extname(path)
+      code = IO.read(path)
+      data = ext == ".tf" ? HclParser.load(code) : JSON.load(code)
+
+      backend = data['terraform']['backend']
+      name = backend.keys.first # backend name. IE: s3, gcs, azurerm
+
+      info = backend.values.first # structure within the s3 or gcs key
+      klass = summary_class(name)
+      summary = klass.new(info)
+      summary.call
+    end
+
+    def summary_class(name)
+      return unless name
+      # IE: TerraspacePluginAws::Interfaces::Summary
+      klass_name = Terraspace::Plugin.klass("Summary", backend: name)
+      klass_name.constantize if klass_name
+    rescue NameError => e
+      logger.error "#{e.class}: #{e.message}"
+      logger.error "ERROR: No summary class implementation provided by plugins installed for this backend: #{name}".color(:red)
+      exit 1
+    end
+  end
+end

data/lib/terraspace/cli/test.rb

@@ -0,0 +1,35 @@
+class Terraspace::CLI
+  class Test
+    def initialize(options={})
+      @options = options
+    end
+
+    def run
+      config = Terraspace.config
+      test_command = config.test_framework_command || config.test_framework
+      execute(test_command)
+    end
+
+    def execute(command)
+      command = adjust_command(command)
+      puts "=> #{command}"
+      Kernel.exec(command)
+    end
+
+    def adjust_command(command)
+      if cd_into_test?
+        command = "bundle exec #{command}" unless command.include?("bundle exec")
+        command = "cd test && #{command}"
+      else
+        command
+      end
+    end
+
+    # Automatically cd into the test folder in case running within the root of a module.
+    # Detect/guess that we're in a module folder vs the terraspace project
+    def cd_into_test?
+      !File.exist?("app") && File.exist?("test") &&
+      (File.exist?("main.tf") || File.exist?("main.rb"))
+    end
+  end
+end

data/lib/terraspace/command.rb

@@ -0,0 +1,100 @@
+require "thor"
+
+# Override thor's long_desc identation behavior
+# https://github.com/erikhuda/thor/issues/398
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        message = "\n#{message}" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+end
+
+# Gets rid of the c_l_i extra commands in the help menu. Seems like thor_classes_in is only used
+# for this purpose. More details: https://gist.github.com/tongueroo/ee92ec28a4d3eed301d88e8ccdd2fe10
+module ThorPrepend
+  module Util
+    def thor_classes_in(klass)
+      klass.name.include?("CLI") ? [] : super
+    end
+  end
+end
+Thor::Util.singleton_class.prepend(ThorPrepend::Util)
+
+module Terraspace
+  class Command < Thor
+    class << self
+      def dispatch(m, args, options, config)
+        # Allow calling for help via:
+        #   terraspace command help
+        #   terraspace command -h
+        #   terraspace command --help
+        #   terraspace command -D
+        #
+        # as well thor's normal way:
+        #
+        #   terraspace help command
+        help_flags = Thor::HELP_MAPPINGS + ["help"]
+        if args.length > 1 && !(args & help_flags).empty?
+          args -= help_flags
+          args.insert(-2, "help")
+        end
+
+        #   terraspace version
+        #   terraspace --version
+        #   terraspace -v
+        version_flags = ["--version", "-v"]
+        if args.length == 1 && !(args & version_flags).empty?
+          args = ["version"]
+        end
+
+        super
+      end
+
+      # Override command_help to include the description at the top of the
+      # long_description.
+      def command_help(shell, command_name)
+        meth = normalize_command_name(command_name)
+        command = all_commands[meth]
+        alter_command_description(command)
+        super
+      end
+
+      def alter_command_description(command)
+        return unless command
+
+        # Add description to beginning of long_description
+        long_desc = if command.long_description
+            "#{command.description}\n\n#{command.long_description}"
+          else
+            command.description
+          end
+
+        # add reference url to end of the long_description
+        unless website.empty?
+          full_command = [command.ancestor_name, command.name].compact.join('-')
+          url = "#{website}/reference/terraspace-#{full_command}"
+          long_desc += "\n\nHelp also available at: #{url}"
+        end
+
+        command.long_description = long_desc
+      end
+      private :alter_command_description
+
+      # meant to be overriden
+      def website
+        ""
+      end
+
+      # https://github.com/erikhuda/thor/issues/244
+      # Deprecation warning: Thor exit with status 0 on errors. To keep this behavior, you must define `exit_on_failure?` in `Lono::CLI`
+      # You can silence deprecations warning by setting the environment variable THOR_SILENCE_DEPRECATION.
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+end