terraspace 0.0.0 → 0.1.0

data/lib/templates/plugin/README.md.tt

@@ -0,0 +1,34 @@
+# Terraspace <%= name %> Cloud Plugin
+
+<%= name %> Cloud support for [terraspace](https://terraspace.cloud/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'terraspace_plugin_<%= name %>'
+```
+
+## Configure
+
+Optionally configure the plugin. Here's an example `<%= name %>.rb` for your terraspace project.
+
+config/plugins/<%= name %>.rb
+
+```ruby
+TerraspacePlugin<%= name %>.configure do |config|
+  config.resource.property = "value"
+end
+```
+
+By default:
+
+* Item 1
+* Item 2
+
+The settings generally only apply if the resource does not yet exist yet and is created for the first time.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/USERNAME/terraspace_plugin_<%= name %>.

data/lib/templates/plugin/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/{bin/console → lib/templates/plugin/bin/console.tt}

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "terraspace"
+require "terraspace_plugin_<%= name %>"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/templates/plugin/lib/templates/hcl/module/main.tf

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/hcl/module/outputs.tf

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/hcl/module/variables.tf

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/hcl/project/config/terraform/backend.tf.tt

@@ -0,0 +1,6 @@
+terraform {
+  backend "PROVIDER_BACKEND" {
+    bucket = "<%%= backend_expand("PROVIDER_BACKEND", "terraform-state-REPLACE_ME-REPLACE_ME-:ENV") %>" # expanded by terraspace
+    prefix = "<%%= backend_expand("PROVIDER_BACKEND", "REPLACE_ME/:ENV/:BUILD_DIR") %>" # expanded by terraspace
+  }
+}

data/lib/templates/plugin/lib/templates/hcl/project/config/terraform/provider.tf

@@ -0,0 +1,3 @@
+# This is where you put an example
+provider "<%= NAME %>" {
+}

data/lib/templates/plugin/lib/templates/hcl/stack/main.tf

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/hcl/stack/outputs.tf

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/hcl/stack/variables.tf

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/ruby/module/main.rb

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/ruby/module/outputs.rb

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/ruby/module/variables.rb

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/ruby/project/config/terraform/backend.rb.tt

@@ -0,0 +1,4 @@
+backend("PROVIDER_BACKEND",
+  bucket: "terraform-state-REPLACE_ME-REPLACE_ME-:ENV", # expanded by terraspace IE: terraform-state-project-us-central1-dev
+  prefix: "REPLACE_ME/:ENV/:BUILD_DIR", # expanded by terraspace IE: us-central1/dev/modules/vm
+)

data/lib/templates/plugin/lib/templates/ruby/project/config/terraform/provider.rb

@@ -0,0 +1,3 @@
+# This is where you put an example
+provider("<%= NAME %>",
+)

data/lib/templates/plugin/lib/templates/ruby/stack/main.rb

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/ruby/stack/outputs.rb

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/ruby/stack/variables.rb

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/test/rspec/module/test/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/lib/templates/plugin/lib/templates/test/rspec/module/test/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+<%=
+build_gemfile(
+  "terraspace",
+  "rspec-terraspace",
+  plugin_gem_name,
+)
+%>

data/lib/templates/plugin/lib/templates/test/rspec/module/test/spec/fixtures/stack/main.tf

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/test/rspec/module/test/spec/fixtures/stack/outputs.tf

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/test/rspec/module/test/spec/fixtures/stack/variables.tf

@@ -0,0 +1 @@
+# This is where you put an example

data/lib/templates/plugin/lib/templates/test/rspec/module/test/spec/main_spec.rb

@@ -0,0 +1,29 @@
+# This starter example of a spec that creates a test harness and provisions a real s3 bucket.
+# The test harness will be created at:
+#
+#    /tmp/terraspace-test-harnesses/<%= @name %>
+#
+# It's recommended to run this on a test AWS account.
+#
+describe "main" do
+  before(:all) do
+    mod_path = File.expand_path("../..", __dir__)
+    terraspace.build_test_harness(
+      name: "<%= @name %>",
+      modules: {example: mod_path},
+      stacks:  {example: "#{mod_path}/test/spec/fixtures/stack"},
+    )
+    terraspace.up("example")
+  end
+  after(:all) do
+    terraspace.down("example")
+  end
+
+  it "successful deploy" do
+    # Replace with your actual test
+    expect(true).to be true
+    # Example:
+    # some_output = terraspace.output("example", "some_output")
+    # expect(some_output).to include("output_value)
+  end
+end

data/lib/templates/plugin/lib/templates/test/rspec/module/test/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+ENV["TS_ENV"] = "test"
+
+require "terraspace"
+require "rspec/terraspace"
+
+module Helper
+  # Add your helpers here
+end
+
+RSpec.configure do |c|
+  c.include RSpec::Terraspace::Helpers
+  c.include Helper
+end

data/lib/templates/plugin/lib/terraspace_plugin_%name%.rb.tt

@@ -0,0 +1,36 @@
+lib = File.expand_path("../../../", __FILE__)
+$:.unshift(lib)
+
+require "memoist"
+require "terraspace" # for interface
+
+require "terraspace_plugin_<%= name %>/version"
+require "terraspace_plugin_<%= name %>/autoloader"
+TerraspacePlugin<%= camel_name %>::Autoloader.setup
+
+module TerraspacePlugin<%= camel_name %>
+  class Error < StandardError; end
+
+  # Friendlier method for config/plugins/<%= name %>.rb. Example:
+  #
+  #     TerraspacePlugin<%= camel_name %>.configure do |config|
+  #       config.resource.property = "value"
+  #     end
+  #
+  def configure(&block)
+    Interfaces::Config.instance.configure(&block)
+  end
+
+  def config
+    Interfaces::Config.instance.config
+  end
+
+  extend self
+end
+
+Terraspace::Plugin.register("<%= name %>",
+  backend: "PROVIDER_BACKEND",
+  config_class: TerraspacePlugin<%= camel_name %>::Interfaces::Config,
+  layer_class: TerraspacePlugin<%= camel_name %>::Interfaces::Layer,
+  root: File.dirname(__dir__),
+)

data/lib/templates/plugin/lib/terraspace_plugin_%name%/autoloader.rb.tt

@@ -0,0 +1,23 @@
+require "zeitwerk"
+
+module TerraspacePlugin<%= camel_name %>
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = { cli: "CLI", version: "VERSION" }
+        map[basename.to_sym] || super
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        lib = File.expand_path("../", __dir__)
+        loader.push_dir(lib)
+        # loader.ignore("#{lib}/special-cases.rb")
+        loader.setup
+      end
+    end
+  end
+end

data/lib/templates/plugin/lib/terraspace_plugin_%name%/clients.rb.tt

@@ -0,0 +1,14 @@
+# Example:
+# require "client_library"
+
+module TerraspacePlugin<%= camel_name %>
+  module Clients
+    extend Memoist
+
+    # Example:
+    # def client_resource
+    #   ClientResource.new
+    # end
+    # memoize :client_resource
+  end
+end

data/lib/templates/plugin/lib/terraspace_plugin_%name%/interfaces/backend.rb.tt

@@ -0,0 +1,12 @@
+module TerraspacePlugin<%= camel_name %>::Interfaces
+  class Backend
+    include Terraspace::Plugin::Backend::Interface
+    include TerraspacePlugin<%= camel_name %>::Clients
+
+    # interface method
+    def call
+      # @info hash is available from the interface module
+      # It contains the backend struture.
+    end
+  end
+end

data/lib/templates/plugin/lib/terraspace_plugin_%name%/interfaces/config.rb.tt

@@ -0,0 +1,18 @@
+module TerraspacePlugin<%= camel_name %>::Interfaces
+  class Config
+    include Terraspace::Plugin::Config::Interface
+    include Singleton # Config class must be a Singleton with the class .instance method
+
+    def provider
+      "<%= name %>"
+    end
+
+    # interface method
+    # must return an ActiveSupport::OrderedOptions
+    def defaults
+      c = ActiveSupport::OrderedOptions.new
+      # c.some_default = "value"
+      c
+    end
+  end
+end

data/lib/templates/plugin/lib/terraspace_plugin_%name%/interfaces/expander.rb.tt

@@ -0,0 +1,15 @@
+# This is where you define variable substitions for the Terraspace expander.
+# Methods are available as variables.  For example:
+#
+#    variable | method
+#    ---------|--------
+#    :ACCOUNT | account
+#    :REGION  | region
+#
+module TerraspacePlugin<%= camel_name %>::Interfaces
+  class Expander
+    include Terraspace::Plugin::Expander::Interface
+
+    # define methods here
+  end
+end

data/lib/templates/plugin/lib/terraspace_plugin_%name%/interfaces/layer.rb.tt

@@ -0,0 +1,20 @@
+module TerraspacePlugin<%= camel_name %>::Interfaces
+  class Layer
+    extend Memoist
+
+    # interface method
+    def namespace
+      # define me
+    end
+
+    # interface method
+    def region
+      # define me
+    end
+
+    # interface method
+    def provider
+      "<%= name %>"
+    end
+  end
+end

data/lib/templates/plugin/lib/terraspace_plugin_%name%/version.rb.tt

@@ -0,0 +1,3 @@
+module TerraspacePlugin<%= camel_name %>
+  VERSION = "0.0.0"
+end

data/lib/templates/plugin/spec/spec_helper.rb.tt

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "terraspace_plugin_<%= name %>"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/lib/templates/plugin/spec/terraspace_provider_%name%_spec.rb.tt

@@ -0,0 +1,5 @@
+RSpec.describe TerraspacePlugin<%= camel_name %> do
+  it "has a version number" do
+    expect(TerraspacePlugin<%= camel_name %>::VERSION).not_to be nil
+  end
+end

data/lib/templates/plugin/terraspace_plugin_%name%.gemspec.tt

@@ -0,0 +1,27 @@
+require_relative 'lib/terraspace_plugin_<%= name %>/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "terraspace_plugin_<%= name %>"
+  spec.version       = TerraspacePlugin<%= camel_name %>::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tung@boltops.com"]
+
+  spec.summary       = "Terraspace <%= camel_name %> Cloud Plugin"
+  spec.homepage      = "https://github.com/USERNAME/terraspace_plugin_<%= name %>"
+  spec.license       = "Apache2.0"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "memoist"
+  spec.add_dependency "zeitwerk"
+end

data/lib/templates/ruby/module/main.rb

@@ -0,0 +1 @@
+# This is where you put your resource declaration

data/lib/templates/ruby/module/outputs.rb

@@ -0,0 +1 @@
+# This is where you put your outputs declaration

data/lib/templates/ruby/module/variables.rb

@@ -0,0 +1 @@
+# This is where you put your variables declaration

data/lib/templates/ruby/project/config/terraform/backend.rb.tt

@@ -0,0 +1,9 @@
+# This is where you put your backend declaration. Here are some examples:
+#
+# backend("s3",
+#   bucket:         "<%= options[:bucket] || "terraform-state-:ACCOUNT-:REGION-:ENV" %>",
+#   key:            ":REGION/:ENV/:BUILD_DIR/terraform.tfstate", # variable notation expanded by terraspace IE: us-west-2/dev/modules/vm/terraform.tfstate
+#   region:         ":REGION",
+#   encrypt:        true,
+#   dynamodb_table: "terraform_locks"
+# )

data/lib/templates/ruby/project/config/terraform/provider.rb

@@ -0,0 +1,7 @@
+# This is where you put your provider declaration. Here are some examples:
+#
+# Docs: https://www.terraform.io/docs/providers/aws/index.html
+#
+# provider "aws" {
+#   region = "<%= ENV['AWS_REGION'] || 'us-east-1' %>"
+# }

data/lib/templates/ruby/stack/main.rb

@@ -0,0 +1 @@
+# This is where you put your resource declaration

data/lib/templates/ruby/stack/outputs.rb

@@ -0,0 +1 @@
+# This is where you put your outputs declaration

data/lib/templates/ruby/stack/variables.rb

@@ -0,0 +1 @@
+# This is where you put your variables declaration

data/lib/terraspace.rb

@@ -1,6 +1,27 @@
+$stdout.sync = true unless ENV["TS_STDOUT_SYNC"] == "0"
+
+$:.unshift(File.expand_path("../", __FILE__))
+require "active_support/core_ext/class"
+require "active_support/core_ext/hash"
+require "active_support/core_ext/string"
+require "active_support/ordered_options"
+require "dsl_evaluator"
+require "fileutils"
+require "json"
+require "memoist"
+require "rainbow/ext/string"
+require "render_me_pretty"
+require "terraspace/ext"
 require "terraspace/version"
 
+require "terraspace/autoloader"
+Terraspace::Autoloader.setup
+
+DslEvaluator.backtrace_reject = "lib/terraspace"
+
 module Terraspace
+  extend Core # for Terraspace.root
   class Error < StandardError; end
-  # Your code goes here...
 end
+
+Terraspace::Booter.boot