terraspace 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52456a8edcf3307ed3cbfca13ca35f7ff8fc133e77b4301057208bdcc2e52d26
-  data.tar.gz: 82cb0191a9fc43d77d68114a8b2f8d7bc80636ed16cee89c3f86f47ecf612d0e
+  metadata.gz: 6cfa0c4e6aa1aa9871bc8b1902b283f2b91f5392738a066fdc58efb56153bed1
+  data.tar.gz: 2219a5bbbd4dbad228e406d7ce586cf5bfdb8392868478e59e3adbd6dc4adda5
 SHA512:
-  metadata.gz: 5921b8059c8e5f8edabbe105e25c7342588267fdf387447c34c31dbb6c925eea6ded8f1f5101cfecb7e5006ec5137ecaa86bf0544643f7f7c8cabdb8c901b657
-  data.tar.gz: 34a89b19065b07c835c9601524ac7fac28094976b32cbc4f5e802c31623d6e8aaaa36eb5edf581a701c95bc253cf2b2c91b6607550e7658780593d7a1b3895b1
+  metadata.gz: f3bb558668074f2e278359a887e369c5182c95fd306973a9cae6c4bd7f95d9be653ce41b923e41e5470350c35234443a0ae3d4e16d5c8b35763feab9393a9c12
+  data.tar.gz: 24acaffec5e568152133e014697404cc9d80a2bd79d54b700584db93a5884ca184508544519d349e833a17f84ac1cc4f2d095a787ed5cdb5216f25b37f04fb50

data/CHANGELOG.md

@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.2.0]
+* #34 Terraform Cloud and Terraform Enterprise support added.
+* TFC Vars support: JSON and DSL. config.overwrite and config.overwrite_sensitive configs
+* Build all stacks with config/terraform files. Designed to support the TFC VCS-driven workflow.
+* Layer Interface module added. All latest provider plugins like terraspace\_plugin_aws make use of this module.
+* Backend pattern expansion auto-detects the provider bakcend. The `expansion` method replaces the `backend_expand` method. `backend_expand` is deprecated.
+* New expander variables: TYPE_INSTANCE, INSTANCE, CACHE_ROOT. Also added strip trailing - and / behavior.
+* Timeout for terraform init. The default timeout is 10m and will then print out the terraform init log.
+* Terraspace 0.2.x is compatible with terraspace\_plugin_aws 0.2.x, terraspace\_plugin_google 0.2.x, and terraspace\_plugin_azurerm 0.2.x
+* New commands: terraspace list, terraspace cloud list, terraspace cloud setup, terraspace cloud destroy, terraspace new shim, terraspace new git_hook
+* terraspace list: list of modules and stacks
+* terraspace cloud list: shows list of TFC workspaces
+* terraspace cloud setup: setups up TFC workspace for VCS-driven workflow. This automatically happens for the TFC CLI-driven workflow.
+* terraspace cloud destroy: destroys the TFC workspace associated with the stack. Can also use the `terraspace down demo --destroy-workspace` option.
+* terraspace new shim: An quick way to generate a terraspace shim.
+* terraspace new git_hook: An quick way to set up a git pre-push hook for the TFC VCS-driven workflow.
+* terraspace down: works even if there's no app/stacks folder. A fake stack is built.
+* terraspace build: terraspace build placeholder concept.
+* terraspace build: only builds now. auto bucket backend creation and terraform init is is still automatically called by terraform up, etc.
+* terraspace up: --reconfigure option. This is useful if upgrading Terraform version.
+
 ## [0.1.2]
 - #33 rspec-terraspace dependency added
 

data/lib/templates/base/git_hook/hook.sh

@@ -0,0 +1,5 @@
+#!/bin/bash -ex
+echo "Running: terraspace build placeholder"
+<%= terraspace_build_commands %>
+git add .terraspace-cache
+git commit -m 'update .terraspace-cache' || true

data/lib/templates/base/project/.gitignore

@@ -14,7 +14,6 @@ terraform.tfvars
 *.gem
 *.rbc
 .idea
-.terraspace-cache
 /.bundle
 /.config
 /.yardoc

data/lib/templates/base/shim/terraspace

@@ -0,0 +1,7 @@
+#!/bin/bash
+<%= switch_ruby_version_line %>
+if [ -f config/app.rb ]; then
+  exec bundle exec terraspace "$@"
+else
+  exec terraspace "$@"
+fi

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

@@ -3,8 +3,8 @@
 # terraform {
 #   backend "s3" {
 #     bucket         = "<%= options[:bucket] || "terraform-state-:ACCOUNT-:REGION-:ENV" %>"
-#     key            = "<%%= "s3", ":REGION/:ENV/:BUILD_DIR/terraform.tfstate" %> # IE: us-west-2/dev/ec2/modules/vpc/terraform.tfstate
-#     region         = "<%%= "s3", ":REGION" %>"
+#     key            = "<%%= expansion(":REGION/:ENV/:BUILD_DIR/terraform.tfstate") %> # IE: us-west-2/dev/ec2/modules/vpc/terraform.tfstate
+#     region         = "<%%= expansion(":REGION") %>"
 #     encrypt        = true
 #     dynamodb_table = "terraform_locks"
 #   }
@@ -13,6 +13,6 @@
 # terraform {
 #   backend "gcs" {
 #     bucket = "<%= options[:bucket] || "terraform-state-:PROJECT-:REGION-:ENV" %>"
-#     prefix = "<%%= backend_expand("gcs", ":REGION/:ENV/:BUILD_DIR") %>" # IE: us-central1/dev/modules/vm
+#     prefix = "<%%= expansion(":REGION/:ENV/:BUILD_DIR") %>" # IE: us-central1/dev/modules/vm
 #   }
 # }

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

@@ -1,6 +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
+    bucket = "<%%= expansion("terraform-state-REPLACE_ME-REPLACE_ME-:ENV") %>" # expanded by terraspace
+    prefix = "<%%= expansion("REPLACE_ME/:ENV/:BUILD_DIR") %>" # expanded by terraspace
   }
 }

data/lib/terraspace/app.rb

@@ -14,6 +14,12 @@ module Terraspace
       config.logger = Logger.new($stdout)
       config.logger.level = :info
       config.hooks = Hooks.new
+      config.cloud = ActiveSupport::OrderedOptions.new
+      config.cloud.overwrite = true
+      config.cloud.overwrite_sensitive = true
+      config.build = ActiveSupport::OrderedOptions.new
+      config.build.cache_root = nil # defaults to .terraspace-cache
+      config.build.cache_dir = ":CACHE_ROOT/:REGION/:ENV/:BUILD_DIR"
       config
     end
 

data/lib/terraspace/builder.rb

@@ -4,24 +4,15 @@ module Terraspace
       Terraspace::CLI::CheckSetup.check!
       @mod.root_module = true
       Compiler::Cleaner.new(@mod, @options).clean
-      build_dir = Util.pretty_path(@mod.cache_build_dir)
+      build_dir = Util.pretty_path(@mod.cache_dir)
       logger.info "Building #{build_dir}"
 
       build_all("modules") # build all modules and stacks as dependencies
       build_all("stacks")
-      build_root_module    # build root module at the end
-
-      auto_create_backend
-      Terraform::Runner.new("init", @options).run if !auto? && @options[:init] != false # will run on @options[:init].nil?
-      build_remote_dependencies # runs after terraform init, which downloads remote modules
+      build_root_module
       logger.info "Built in #{build_dir}"
     end
 
-    def auto?
-      # command is only passed from CLI in the update specifically for this check
-      @options[:auto] && @options[:command] == "update"
-    end
-
     def build_root_module
       Compiler::Builder.new(@mod).build
     end
@@ -35,22 +26,12 @@ module Terraspace
 
         consider_stacks = type_dir == "stacks"
         mod = Mod.new(mod_name, consider_stacks: consider_stacks)
-        next if root?(mod) # will build root module at the end
 
         Compiler::Builder.new(mod).build
         built << mod_name
       end
     end
 
-    def root?(mod)
-      mod.name == @mod.name && mod.type == @mod.type
-    end
-
-    def auto_create_backend
-      return unless @options[:command] == "update"
-      Compiler::Backend.new(@mod).create
-    end
-
     def local_paths(type_dir)
       dirs("app/#{type_dir}/*") + dirs("vendor/#{type_dir}/*")
     end
@@ -58,30 +39,5 @@ module Terraspace
     def dirs(path)
       Dir.glob("#{Terraspace.root}/#{path}")
     end
-
-    # Currently only handles remote modules only one-level deep.
-    def build_remote_dependencies
-      modules_json_path = "#{@mod.cache_build_dir}/.terraform/modules/modules.json"
-      return unless File.exist?(modules_json_path)
-
-      initialized_modules = JSON.load(IO.read(modules_json_path))
-      # For example of structure see spec/fixtures/initialized/modules.json
-      initialized_modules["Modules"].each do |meta|
-        build_remote_mod(meta)
-      end
-    end
-
-    def build_remote_mod(meta)
-      return if local_source?(meta["Source"])
-      return if meta['Dir'] == '.' # root is already built
-
-      remote_mod = Mod::Remote.new(meta, @mod)
-      Compiler::Builder.new(remote_mod).build
-    end
-
-  private
-    def local_source?(s)
-       s =~ %r{^\.} || s =~ %r{^/}
-    end
   end
 end

data/lib/terraspace/cli.rb

@@ -24,20 +24,25 @@ module Terraspace
     init_option = Proc.new {
       option :init, type: :boolean, default: true, desc: "Instance of stack"
     }
+    reconfigure_option = Proc.new {
+      option :reconfigure, type: :boolean, desc: "Add terraform -reconfigure option"
+    }
 
     desc "new SUBCOMMAND", "new subcommands"
     long_desc Help.text(:new)
     subcommand "new", New
 
-    desc "build MODULE", "build"
+    desc "cloud SUBCOMMAND", "cloud subcommands"
+    long_desc Help.text(:cloud)
+    subcommand "cloud", Cloud
+
+    desc "build STACK", "build"
     long_desc Help.text(:build)
     option :quiet, type: :boolean, default: true, desc: "quiet output"
-    auto_option.call
-    init_option.call
-    input_option.call
     instance_option.call
+    yes_option.call
     def build(mod)
-      Build.new(options.merge(mod: mod)).run
+      Terraspace::Builder.new(@options.merge(mod: mod)).run
     end
 
     desc "bundle", "bundle"
@@ -58,22 +63,25 @@ module Terraspace
       Clean.new(options).run
     end
 
-    desc "console", "console .terraspace-cache dir"
+    desc "console STACK", "console .terraspace-cache dir"
     long_desc Help.text(:console)
     instance_option.call
     def console(mod)
       Commander.new("console", options.merge(mod: mod)).run
     end
 
-    desc "down MODULE", "down"
+    desc "down STACK", "down"
     long_desc Help.text(:down)
     instance_option.call
     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)
-      Commander.new("destroy", options.merge(mod: mod)).run
+      Commander.new("destroy", options.merge(mod: mod, command: "down")).run
+      Terraspace::Terraform::Cloud::Workspace.new(options.merge(mod: mod)).destroy if @options[:destroy_workspace]
     end
 
-    desc "info MODULE", "info"
+    desc "info STACK", "info"
     long_desc Help.text(:info)
     format_option.call
     instance_option.call
@@ -81,31 +89,38 @@ module Terraspace
       Info.new(options.merge(mod: mod)).run
     end
 
-    desc "plan MODULE", "plan module"
+    desc "list", "list stacks and modules"
+    long_desc Help.text(:list)
+    def list
+      List.new(options).run
+    end
+
+    desc "plan STACK", "plan stack"
     long_desc Help.text(:plan)
     auto_option.call
     input_option.call
     instance_option.call
     out_option.call
+    reconfigure_option.call
     def plan(mod)
       Commander.new("plan", options.merge(mod: mod)).run
     end
 
-    desc "providers MODULE", "providers"
+    desc "providers STACK", "providers"
     long_desc Help.text(:providers)
     instance_option.call
     def providers(mod)
       Commander.new("providers", options.merge(mod: mod)).run
     end
 
-    desc "refresh", "refresh"
+    desc "refresh STACK", "refresh"
     long_desc Help.text(:refresh)
     instance_option.call
     def refresh(mod)
       Commander.new("refresh", options.merge(mod: mod)).run
     end
 
-    desc "seed MODULE", "seed"
+    desc "seed STACK", "seed"
     long_desc Help.text(:seed)
     option :yes, aliases: :y, type: :boolean, desc: "bypass prompts and force overwrite files"
     option :where, desc: "where to create file. either under app or seed folder structure. values: app or stack"
@@ -124,7 +139,7 @@ module Terraspace
       Summary.new(options).run
     end
 
-    desc "show MODULE", "show"
+    desc "show STACK", "show"
     long_desc Help.text(:show)
     instance_option.call
     def show(mod)
@@ -137,7 +152,7 @@ module Terraspace
       Test.new(options).run
     end
 
-    desc "output MODULE", "output"
+    desc "output STACK", "output"
     long_desc Help.text(:output)
     format_option.call
     instance_option.call
@@ -146,20 +161,21 @@ module Terraspace
       Commander.new("output", options.merge(mod: mod)).run
     end
 
-    desc "update MODULE", "Update infrasturcture. IE: apply plan"
+    desc "update STACK", "Update infrasturcture. IE: apply plan"
     long_desc Help.text(:update)
     auto_option.call
     init_option.call
     input_option.call
     instance_option.call
     yes_option.call
+    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 update(mod)
-      Commander.new("apply", options.merge(mod: mod, command: "update")).run
+      Commander.new("apply", options.merge(mod: mod)).run
     end
 
-    desc "validate MODULE", "validate"
+    desc "validate STACK", "validate"
     long_desc Help.text(:validate)
     instance_option.call
     def validate(mod)

data/lib/terraspace/cli/build/placeholder.rb

@@ -0,0 +1,40 @@
+# The placeholder stack is a special stack that is useful in case there are no app/stacks.
+# We build a placeholder back just so we have backend.tf to be used to grab info.
+# It's useful for the summary command.
+module Terraspace::CLI::Build
+  class Placeholder
+    include Terraspace::Util::Logging
+
+    def initialize(options={})
+      @options = options
+    end
+
+    # Grab the last module and build that.
+    # Assume the backend key has the same prefix
+    # Note: Tried building a empty "null" stack but with TFC a null space workspace is created, which is undesired.
+    def build
+      return if ENV['TS_SUMMARY_BUILD'] == '0'
+
+      mod = @options[:mod]
+      if !mod or mod == "placeholder"
+        logger.info "Building one of the modules to get backend.tf info"
+        mod = find_mod
+      end
+      Terraspace::Builder.new(@options.merge(mod: mod, init: false)).run # generate and init
+      Terraspace::Mod.new(mod, @options) # mod metadata
+    end
+
+    # Used by: terraspace build placeholder
+    def find_mod
+      mod_path = Dir.glob("{app,vendor}/{modules,stacks}/*").last
+      unless mod_path
+        logger.info <<~EOL
+          No modules or stacks found.
+          Unable to determine the backend state path without at least one module.
+        EOL
+        exit 0
+      end
+      File.basename(mod_path) # mod name
+    end
+  end
+end

data/lib/terraspace/cli/cloud.rb

@@ -0,0 +1,24 @@
+class Terraspace::CLI
+  class Cloud < Terraspace::Command
+    Workspace = Terraspace::Terraform::Cloud::Workspace
+
+    desc "list", "List workspaces"
+    long_desc Help.text("cloud:list")
+    def list
+      Workspace.new(options).list
+    end
+
+    desc "destroy", "Destroy workspace"
+    long_desc Help.text("cloud:destroy")
+    option :yes, aliases: :y, type: :boolean, desc: "bypass are you sure prompt"
+    def destroy(mod)
+      Workspace.new(options.merge(mod: mod)).destroy
+    end
+
+    desc "setup", "Setup workspace"
+    long_desc Help.text("cloud:setup")
+    def setup(mod)
+      Workspace.new(options.merge(mod: mod)).setup
+    end
+  end
+end

data/lib/terraspace/cli/commander.rb

@@ -7,8 +7,15 @@ class Terraspace::CLI
 
     # Commander always runs Build#run
     def run
-      Build.new(@options).run # generate and init
+      Terraspace::Builder.new(@options).run # generate and init
+      auto_create_backend
+      Init.new(@options.merge(calling_command: @name)).run
       Terraspace::Terraform::Runner.new(@name, @options).run
     end
+
+    def auto_create_backend
+      return unless @name == "apply"
+      Terraspace::Compiler::Backend.new(@mod).create
+    end
   end
 end

data/lib/terraspace/cli/init.rb

@@ -0,0 +1,67 @@
+require 'timeout'
+
+class Terraspace::CLI
+  class Init < Base
+    def initialize(options={})
+      # Original calling command. Can be from Commander which is a terraform command. IE: terraform apply
+      # Or can be from terraspace cloud setup. Which will be cloud-setup.
+      @calling_command = options[:calling_command]
+      super(options)
+    end
+
+    def run
+      init if init?
+      build_remote_dependencies # runs after terraform init, which downloads remote modules
+      sync_cloud
+    end
+
+    # Note the init will always create the Terraform Cloud Workspace
+    def init
+      # default init timeout is pretty generous in case of slow internet to download the provider plugins
+      init_timeout = Integer(ENV['TS_INIT_TIMEOUT'] || 600)
+      Timeout::timeout(init_timeout) do
+        Terraspace::Terraform::Runner.new("init", @options).run if !auto? && @options[:init] != false # will run on @options[:init].nil?
+      end
+    rescue Timeout::Error
+      logger.error "ERROR: It took too long to run terraform init.  Here is the output logs of terraform init:".color(:red)
+      logger.error IO.read(Terraspace::Terraform::Args::Default.terraform_init_log)
+    end
+
+    def sync_cloud
+      Terraspace::Terraform::Cloud.new(@options).run if %w[apply plan destroy cloud-setup].include?(@calling_command)
+    end
+
+    # Currently only handles remote modules only one-level deep.
+    def build_remote_dependencies
+      modules_json_path = "#{@mod.cache_dir}/.terraform/modules/modules.json"
+      return unless File.exist?(modules_json_path)
+
+      initialized_modules = JSON.load(IO.read(modules_json_path))
+      # For example of structure see spec/fixtures/initialized/modules.json
+      initialized_modules["Modules"].each do |meta|
+        build_remote_mod(meta)
+      end
+    end
+
+    def build_remote_mod(meta)
+      return if local_source?(meta["Source"])
+      return if meta['Dir'] == '.' # root is already built
+
+      remote_mod = Mod::Remote.new(meta, @mod)
+      Compiler::Builder.new(remote_mod).build
+    end
+
+    def auto?
+      # command is only passed from CLI in the update specifically for this check
+      @options[:auto] && @calling_command == "apply"
+    end
+  private
+    def local_source?(s)
+       s =~ %r{^\.} || s =~ %r{^/}
+    end
+
+    def init?
+      %w[apply console destroy output plan providers refresh show validate cloud-setup].include?(@calling_command)
+    end
+  end
+end