terraspace 0.4.3 → 0.5.3

data/lib/terraspace/terraform/runner.rb

@@ -8,7 +8,6 @@ module Terraspace::Terraform
     def initialize(name, options={})
       @name = name
       super(options)
-      @retries = 1
     end
 
     def run
@@ -25,20 +24,13 @@ module Terraspace::Terraform
       run_hooks("terraform.rb", name) do
         Terraspace::Shell.new(@mod, command, @options.merge(env: custom.env_vars)).run
       end
-    rescue Terraspace::InitRequiredError => e
-      logger.info "Terraform reinitialization required detected. Will run `terraform init` and try again."
-      logger.debug "Retry attempt: #{@retries}"
-      logger.debug "#{e.class}"
-      Runner.new("init", @options).run
-      if @retries <= 3
-        backoff = 2 ** @retries # 2, 4, 8
-        logger.debug "Waiting #{backoff}s before retrying"
-        sleep(backoff)
-        @retries += 1
+    rescue Terraspace::SharedCacheError, Terraspace::InitRequiredError
+      @retryer ||= Retryer.new(@mod, @options, name, $!)
+      if @retryer.retry?
+        @retryer.run
         retry
       else
-        logger.info "ERROR: #{e.message}"
-        exit 1
+        exit(1)
       end
     end
 

data/lib/terraspace/terraform/runner/retryer.rb

@@ -0,0 +1,69 @@
+class Terraspace::Terraform::Runner
+  class Retryer
+    include Terraspace::Util::Logging
+    include Terraspace::Util::Pretty
+
+    def initialize(mod, options, command_name, exception)
+      @mod, @options, @command_name, @exception = mod, options, command_name, exception
+      @retries = 1
+    end
+
+    def retry?
+      if @retries <= 3 && !@stop_retrying
+        true # will retry
+      else
+        logger.info "ERROR: #{@exception.message}"
+        false # will not retry
+      end
+    end
+
+    def run
+      backoff = 2 ** @retries # 2, 4, 8
+      logger.debug "Waiting #{backoff}s before retrying"
+      sleep(backoff)
+      @retries += 1
+
+      case @exception
+      when Terraspace::SharedCacheError
+        shared_cache_error
+      when Terraspace::InitRequiredError
+        init_required_error
+      end
+    end
+
+    def shared_cache_error
+      logger.info "Terraform Shared Cache error detected. Will purge caches and run `terraform init` to try again."
+      logger.debug "Retry attempt: #{@retries}"
+      logger.debug "#{@exception.class}"
+      logger.debug "#{@exception.message}"
+      if Terraspace.config.terraform.plugin_cache.purge_on_error # Purging the cache "fixes" this terraform bug
+        purge_caches
+        reinit
+      else
+        @stop_retrying = true
+      end
+    end
+
+    def init_required_error
+      logger.info "Terraform reinitialization required detected. Will run `terraform init` and try again."
+      logger.debug "Retry attempt: #{@retries}"
+      logger.debug "#{@exception.class}"
+      reinit
+    end
+
+    def reinit
+      Terraspace::Terraform::Runner.new("init", @options).run unless @command_name == "init"
+    end
+
+    def purge_caches
+      dir = "#{@mod.cache_dir}/.terraform"
+      logger.info "Purging #{pretty_path(dir)}"
+      FileUtils.rm_rf(dir)
+
+      dir = "#{Terraspace.config.terraform.plugin_cache.dir}"
+      logger.info "Purging #{pretty_path(dir)}"
+      FileUtils.rm_rf(dir)
+      FileUtils.mkdir_p(dir) # need /tmp/terraspace/plugin_cache dir to exist
+    end
+  end
+end

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.4.3"
+  VERSION = "0.5.3"
 end

data/spec/terraspace/terraform/args/custom_spec.rb

@@ -10,17 +10,18 @@ describe Terraspace::Terraform::Args::Custom do
     let(:file) { fixture("terraform/args/single.rb") }
     let(:name) { "apply" }
     it "build creates the @commands structure" do
+      custom.evaluate_file(file)
       commands = custom.build
       expect(commands.keys).to include("apply")
     end
 
     it "args" do
-      custom.build
+      custom.evaluate_file(file)
       expect(custom.args).to eq(["-lock-timeout=20m"])
     end
 
     it "var_files" do
-      custom.build
+      custom.evaluate_file(file)
       allow(custom).to receive(:var_file_exist?).and_return(true)
       expect(custom.var_files).to eq(["-var-file=a.tfvars", "-var-file=b.tfvars"])
     end
@@ -30,17 +31,18 @@ describe Terraspace::Terraform::Args::Custom do
     let(:file) { fixture("terraform/args/multiple.rb") }
     let(:name) { "apply" }
     it "build creates the @commands structure" do
+      custom.evaluate_file(file)
       commands = custom.build
       expect(commands.keys).to include("apply")
     end
 
     it "args" do
-      custom.build
+      custom.evaluate_file(file)
       expect(custom.args).to eq(["-lock-timeout=20m"])
     end
 
     it "var_files" do
-      custom.build
+      custom.evaluate_file(file)
       allow(custom).to receive(:var_file_exist?).and_return(true)
       expect(custom.var_files).to eq([])
     end

data/terraspace.gemspec

@@ -34,10 +34,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "zeitwerk"
 
   # core baseline plugins
-  spec.add_dependency "terraspace_plugin_aws", "~> 0.2.0"
-  spec.add_dependency "terraspace_plugin_azurerm", "~> 0.2.0"
-  spec.add_dependency "terraspace_plugin_google", "~> 0.2.0"
-  spec.add_dependency "rspec-terraspace"
+  spec.add_dependency "terraspace_plugin_aws", "~> 0.3.0"
+  spec.add_dependency "terraspace_plugin_azurerm", "~> 0.3.0"
+  spec.add_dependency "terraspace_plugin_google", "~> 0.3.0"
+  spec.add_dependency "rspec-terraspace", "~> 0.2.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.3
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2020-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -212,56 +212,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: terraspace_plugin_azurerm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: terraspace_plugin_google
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rspec-terraspace
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -385,7 +385,10 @@ files:
 - README.md
 - Rakefile
 - exe/terraspace
+- lib/templates/base/arg/terraform.rb.tt
 - lib/templates/base/git_hook/hook.sh
+- lib/templates/base/helper/%name%_helper.rb.tt
+- lib/templates/base/hook/%kind%.rb.tt
 - lib/templates/base/project/.gitignore
 - lib/templates/base/project/Gemfile.tt
 - lib/templates/base/project/README.md
@@ -510,16 +513,17 @@ files:
 - lib/terraspace/cli/help/logs.md
 - lib/terraspace/cli/help/logs/remove.md
 - lib/terraspace/cli/help/logs/truncate.md
-- lib/terraspace/cli/help/new/bootstrap_test.md
+- lib/terraspace/cli/help/new/arg.md
 - lib/terraspace/cli/help/new/example.md
 - lib/terraspace/cli/help/new/git_hook.md
+- lib/terraspace/cli/help/new/helper.md
+- lib/terraspace/cli/help/new/hook.md
 - lib/terraspace/cli/help/new/module.md
-- lib/terraspace/cli/help/new/module_test.md
 - lib/terraspace/cli/help/new/plugin.md
 - lib/terraspace/cli/help/new/project.md
-- lib/terraspace/cli/help/new/project_test.md
 - lib/terraspace/cli/help/new/shim.md
 - lib/terraspace/cli/help/new/stack.md
+- lib/terraspace/cli/help/new/test.md
 - lib/terraspace/cli/help/output.md
 - lib/terraspace/cli/help/plan.md
 - lib/terraspace/cli/help/providers.md
@@ -536,9 +540,12 @@ files:
 - lib/terraspace/cli/logs.rb
 - lib/terraspace/cli/logs/concern.rb
 - lib/terraspace/cli/new.rb
+- lib/terraspace/cli/new/arg.rb
 - lib/terraspace/cli/new/git_hook.rb
 - lib/terraspace/cli/new/helper.rb
-- lib/terraspace/cli/new/helper/plugin_gem.rb
+- lib/terraspace/cli/new/helpers.rb
+- lib/terraspace/cli/new/helpers/plugin_gem.rb
+- lib/terraspace/cli/new/hook.rb
 - lib/terraspace/cli/new/module.rb
 - lib/terraspace/cli/new/plugin.rb
 - lib/terraspace/cli/new/plugin/helper.rb
@@ -549,10 +556,7 @@ files:
 - lib/terraspace/cli/new/source/plugin.rb
 - lib/terraspace/cli/new/source/test.rb
 - lib/terraspace/cli/new/stack.rb
-- lib/terraspace/cli/new/test/base.rb
-- lib/terraspace/cli/new/test/bootstrap.rb
-- lib/terraspace/cli/new/test/module.rb
-- lib/terraspace/cli/new/test/project.rb
+- lib/terraspace/cli/new/test.rb
 - lib/terraspace/cli/seed.rb
 - lib/terraspace/cli/summary.rb
 - lib/terraspace/cli/test.rb
@@ -590,6 +594,7 @@ files:
 - lib/terraspace/compiler/erb/helpers.rb
 - lib/terraspace/compiler/erb/render.rb
 - lib/terraspace/compiler/expander.rb
+- lib/terraspace/compiler/helper_extender.rb
 - lib/terraspace/compiler/strategy/abstract_base.rb
 - lib/terraspace/compiler/strategy/mod.rb
 - lib/terraspace/compiler/strategy/mod/base.rb
@@ -630,6 +635,7 @@ files:
 - lib/terraspace/plugin/expander/generic.rb
 - lib/terraspace/plugin/expander/interface.rb
 - lib/terraspace/plugin/finder.rb
+- lib/terraspace/plugin/helper/interface.rb
 - lib/terraspace/plugin/infer_provider.rb
 - lib/terraspace/plugin/layer/interface.rb
 - lib/terraspace/plugin/meta.rb
@@ -639,6 +645,7 @@ files:
 - lib/terraspace/seeder/content.rb
 - lib/terraspace/seeder/where.rb
 - lib/terraspace/shell.rb
+- lib/terraspace/shell/error.rb
 - lib/terraspace/terraform/api.rb
 - lib/terraspace/terraform/api/base.rb
 - lib/terraspace/terraform/api/client.rb
@@ -670,6 +677,7 @@ files:
 - lib/terraspace/terraform/remote_state/output_proxy.rb
 - lib/terraspace/terraform/remote_state/unresolved.rb
 - lib/terraspace/terraform/runner.rb
+- lib/terraspace/terraform/runner/retryer.rb
 - lib/terraspace/tester.rb
 - lib/terraspace/tester/finder.rb
 - lib/terraspace/tester/meta.rb
@@ -826,7 +834,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: 'Terraspace: The Terraspace Framework'

data/lib/terraspace/cli/help/new/bootstrap_test.md

@@ -1,8 +0,0 @@
-## Example
-
-    $ terraspace new bootstrap_test
-    => Creating test bootstrap structure
-           exist
-          create  .rspec
-          create  spec/spec_helper.rb
-    $

data/lib/terraspace/cli/help/new/module_test.md

@@ -1,12 +0,0 @@
-## Example
-
-    $ terraspace new module_test example
-    => Creating module test: example
-           exist  app/modules/example
-          create  app/modules/example/test/.rspec
-          create  app/modules/example/test/Gemfile
-          create  app/modules/example/test/spec/fixtures/stack/main.tf
-          create  app/modules/example/test/spec/fixtures/stack/outputs.tf
-          create  app/modules/example/test/spec/main_spec.rb
-          create  app/modules/example/test/spec/spec_helper.rb
-    $

data/lib/terraspace/cli/help/new/project_test.md

@@ -1,8 +0,0 @@
-## Example
-
-    $ terraspace new project_test demo
-    => Creating project test: demo
-           exist
-          create  spec/fixtures/tfvars/demo.tfvars
-          create  spec/stacks/demo/main_spec.rb
-    $

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

@@ -1,12 +0,0 @@
-module Terraspace::CLI::New::Helper
-  module PluginGem
-  private
-    def plugin_gem_name
-      if @options[:plugin_gem]
-        @options[:plugin_gem]
-      else
-        "terraspace_plugin_#{@options[:plugin]}"
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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