terraspace 0.0.0 → 0.2.1

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

@@ -0,0 +1,26 @@
+class Terraspace::CLI::New
+  class Module < Sequence
+    component_options.each { |args| class_option(*args) }
+
+    argument :name
+
+    def create_module
+      puts "=> Creating test for new module: #{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]
+      directory ".", dest
+    end
+
+    def create_test
+      args = component_args(name, @options[:project_name])
+      Test::Module.start(args)
+    end
+
+    def run_generator_hook_script
+      script = ENV['TS_GENERATOR_MODULE']
+      return unless script
+      run_script(script, "app/modules/#{name}")
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+class Terraspace::CLI::New
+  class Plugin < Sequence
+    include Helper
+
+    def self.options
+      [
+        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+      ]
+    end
+    options.each { |args| class_option(*args) }
+
+    argument :name
+
+    def create_plugin
+      puts "=> Creating new plugin: #{name}"
+      core_template_source("plugin")
+      directory ".", "terraspace_plugin_#{name}"
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+class Terraspace::CLI::New::Plugin
+  module Helper
+  private
+    # helper
+    def camel_name
+      name.camelize
+    end
+
+    # friendly method
+    def core_template_source(template)
+      source = Terraspace::CLI::New::Source::Core.new(self, @options)
+      source.set_core_source(template)
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+class Terraspace::CLI::New
+  class Project < Sequence
+    def self.project_options
+      [
+        [:bundle, type: :boolean, default: true, desc: "Runs bundle install on the project"],
+        [:config, type: :boolean, default: true, desc: "Whether or not to generate config files."],
+        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
+        [:test_structure, type: :boolean, desc: "Create project bootstrap test structure."]
+      ]
+    end
+
+    base_options.each { |args| class_option(*args) }
+    project_options.each { |args| class_option(*args) }
+
+    def creating_messaging
+      puts "=> Creating new project called #{name}."
+    end
+
+    def create_base
+      plugin_template_source("base", "project")
+      directory ".", "#{name}"
+    end
+
+    # Will generate config folder from
+    #
+    #     1. terraspace code lang templates or
+    #     2. example lang templates from provider gems
+    #
+    def create_project
+      plugin_template_source(@options[:lang], "project") # IE: plugin_template_source("hcl", "project")
+
+      options = @options[:config] == false ? {exclude_pattern: "config" } : {}
+      directory ".", "#{name}", options
+
+      if @options[:config] == false
+        empty_directory("#{name}/config")
+      end
+    end
+
+    def empty_dirs
+      return if @options[:examples]
+      empty_directory("#{name}/app/modules")
+      empty_directory("#{name}/app/stacks")
+    end
+
+    def create_starter_module
+      return unless @options[:examples]
+      Module.start(component_args("example", name))
+    end
+
+    def create_starter_stack
+      return unless @options[:examples]
+      Stack.start(component_args("demo", name))
+    end
+
+    def create_test
+      return if @options[:test_structure] == false
+      Test::Bootstrap.start(["--dir", name])
+    end
+
+    def bundle_install
+      return if @options[:bundle] == false
+      puts "=> Installing dependencies with: bundle install"
+      Bundler.with_unbundled_env do
+        system("BUNDLE_IGNORE_CONFIG=1 bundle install", chdir: name)
+      end
+    end
+
+    def welcome_message_examples
+      return unless options[:examples]
+      puts <<~EOL
+        #{"="*64}
+        Congrats! You have successfully created a terraspace project.
+        Check out the created files. Adjust to the examples and then deploy with:
+
+            cd #{name}
+            terraspace up demo -y   # to deploy
+            terraspace down demo -y # to destroy
+
+        More info: https://terraspace.cloud/
+      EOL
+    end
+
+    def welcome_message_no_examples
+      return if options[:examples]
+      puts <<~EOL
+        #{"="*64}
+        Congrats! You have successfully created a terraspace project.
+        Check out the created files.
+
+            cd #{name}
+
+        You can create starter modules and stacks with their generators:
+
+            terraspace new module example
+            terraspace new stack demo
+
+        Add your code to them, and deploy when you are ready:
+
+            terraspace up demo -y   # to deploy
+
+        Destroy with:
+
+            terraspace down demo -y # to destroy
+
+        More info: https://terraspace.cloud/
+      EOL
+    end
+  end
+end

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, 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/shim.rb

@@ -0,0 +1,58 @@
+class Terraspace::CLI::New
+  class Shim < Thor::Group
+    include Thor::Actions
+
+    def self.cli_options
+      [
+        [:path, aliases: %w[p], default: "/usr/local/bin/terraspace", desc: "path to save the shim script"],
+      ]
+    end
+    cli_options.each { |args| class_option(*args) }
+
+    def self.source_root
+      File.expand_path("../../../templates/base/shim", __dir__)
+    end
+
+    def set_vars
+      @path = @options[:path]
+    end
+
+    def create
+      return unless File.exist?(".git")
+      dest = @path
+      template "terraspace", dest
+      chmod dest, 0755
+    end
+
+    def message
+      dir = File.dirname(@path)
+      puts <<~EOL
+        A terraspace shim as been generated at #{@path}
+        Please make sure that it is found in the $PATH.
+
+        You can double check with:
+
+            which terraspace
+
+        You should see
+
+            $ which terraspace
+            #{@path}
+
+        If you do not, please add #{dir} to your PATH.
+        You can usually do so by adding this line to ~/.bash_profile and opening a new terminal to check.
+
+            export PATH=#{dir}:/$PATH
+
+      EOL
+    end
+
+  private
+    def switch_ruby_version_line
+      rbenv_installed = system("type rbenv 2>&1 > /dev/null")
+      if rbenv_installed
+        'eval "$(rbenv init -)"'
+      end
+    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