terraspace 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09ac4834cd477fb90ceb545d7dc08fdbacbb42231d51c6e0b27698c37ddc2946'
-  data.tar.gz: 29a223281b24965c0f33096b180f7a49e5f62e7bd74718e71f16e5fdd072ba1c
+  metadata.gz: bae908fcf2dc448dc5b0d2bba463eedd9487c428a296b74955975b66e2faa7c3
+  data.tar.gz: bef0979ecaeab8eca50387da95a119719696a759ecff7de55659ff0d8cbac322
 SHA512:
-  metadata.gz: 4436cab7ed69ab13e3bda23349c49b3f9e6d3a2fba04b160aba229593aa764f8a7f411c617c1f8892581f4a453a2dcc7c9eb427a976722f40489f518642c0c4a
-  data.tar.gz: b2f7aded9d6ba98b290d35e02629cb0119eb30a31a22baaa25f44aef94d11fa7a724b534dd9df9d4e918f142d0990743f67e1f49a3412d1df2caf5f08a6819a6
+  metadata.gz: 882b9a94cf48af9399a66540385dcd7dbcdbb8118df046c6af833e053f265e57dfeb0a3692f32e315b6a13bb59334c51cfc856db0fc68a067cee4800bc1a3a32
+  data.tar.gz: 720aa71881469e415445a1ff83e853c1ece6d71873830111eb1de59c121e9408e478ddaabdd30e6c29e2d48d39b1ec1c96c739e16ca682b3e13e129253594d44

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 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.4.4]
+- #50 retry logic for shared cache error
+- #51 fix cloud sync: call build first
+
 ## [0.4.3]
 * #49 add info --path option
 

data/README.md

@@ -107,8 +107,8 @@ To install modules:
 * [Generators](https://terraspace.cloud/docs/generators/): Built-in generators to quickly create the starter module. Focus on code instead of boilerplate structure.
 * [Tfvars](https://terraspace.cloud/docs/tfvars/) & [Layering](https://terraspace.cloud/docs/tfvars/layering/): Use the same code with different tfvars to create multiple environments. Terraspace conventionally loads tfvars from the `tfvars` folder. Rich layering support allows you to build different environments like dev and prod with the same code.  Examples are in [Full Layering](https://terraspace.cloud/docs/tfvars/full-layering/).
 * [Deploy Multiple Stacks](https://terraspace.cloud/docs/intro/deploy-all/): The ability to deploy multiple stacks with a single command. Terraspace calculates the [dependency graph](https://terraspace.cloud/docs/dependencies/) and deploys stacks in the right order. You can also target specific stacks and deploy [subgraphs](https://terraspace.cloud/docs/dependencies/subgraphs/).
-* [Terrafile](https://terraspace.cloud/docs/terrafile/}): Terraspace makes it easy to use Terraform modules sourced from your own git repositories, other git repositories, or the Terraform Registry. The git repos can be private or public. This is an incredibly powerful feature of Terraspace because it opens up a world of modules for you to use.  Use any module you want.
-* [Configurable CLI](https://terraspace.cloud/docs/cli/): Configurable [CLI Hooks](https://terraspace.cloud/docs/cli/hooks/) and [CLI Args](https://terraspace.cloud/docs/cli/args/) allow you to adjust the underlying terraform command.
+* [Terrafile](https://terraspace.cloud/docs/terrafile/): Terraspace makes it easy to use Terraform modules sourced from your own git repositories, other git repositories, or the Terraform Registry. The git repos can be private or public. This is an incredibly powerful feature of Terraspace because it opens up a world of modules for you to use.  Use any module you want.
+* [Configurable CLI](https://terraspace.cloud/docs/config/args/): Configurable [CLI Hooks](https://terraspace.cloud/docs/config/hooks/) and [CLI Args](https://terraspace.cloud/docs/config/args/) allow you to adjust the underlying terraform command.
 * [Testing](https://terraspace.cloud/docs/testing/): A testing framework that allows you to create test harnesses, deploy real-resources, and have higher confidence that your code works.
 * [Terraform Cloud and Terraform Enterprise Support](https://terraspace.cloud/docs/cloud/): TFC and TFE are both supported. Terraspace adds additional conveniences to make working with Terraform Cloud Workspaces easier.
 

data/lib/terraspace.rb

@@ -26,8 +26,10 @@ DslEvaluator.backtrace_reject = "lib/terraspace"
 module Terraspace
   extend Core # for Terraspace.root
   class Error < StandardError; end
-  class InitRequiredError < Error; end
+
   class BucketNotFoundError < Error; end
+  class InitRequiredError < Error; end
+  class SharedCacheError < Error; end
 end
 
 Terraspace::Booter.boot

data/lib/terraspace/cli/cloud.rb

@@ -16,6 +16,7 @@ class Terraspace::CLI
 
     desc "destroy STACK", "Destroy workspace by specifying the stack"
     long_desc Help.text("cloud:destroy")
+    yes_option.call
     def destroy(mod)
       Workspace.new(options.merge(mod: mod)).destroy
     end
@@ -24,6 +25,7 @@ class Terraspace::CLI
     long_desc Help.text("cloud:sync")
     yes_option.call
     def sync(*stacks)
+      Terraspace::CLI::Build::Placeholder.new(options).build
       Syncer.new(options.merge(stacks: stacks, override_auto_sync: true)).run
     end
 

data/lib/terraspace/shell.rb

@@ -6,8 +6,6 @@ module Terraspace
 
     def initialize(mod, command, options={})
       @mod, @command, @options = mod, command, options
-      # error_messages holds aggregation of all error lines
-      @known_error, @error_messages = nil, ''
     end
 
     # requires @mod to be set
@@ -33,9 +31,9 @@ module Terraspace
       Open3.popen3(env, @command, chdir: @mod.cache_dir) do |stdin, stdout, stderr, wait_thread|
         mimic_terraform_input(stdin, stdout)
         while err = stderr.gets
-          @error_messages << err # aggregate all error lines
-          @known_error ||= known_error_type(err)
-          unless @known_error
+          @error ||= Error.new
+          @error.lines << err # aggregate all error lines
+          unless @error.known?
             # Sometimes may print a "\e[31m\n" which like during dependencies fetcher init
             # suppress it so dont get a bunch of annoying "newlines"
             next if err == "\e[31m\n" && @options[:suppress_error_color]
@@ -48,38 +46,12 @@ module Terraspace
       end
     end
 
-    def known_error_type(err)
-      if reinit_required?(err)
-        :reinit_required
-      elsif bucket_not_found?(err)
-        :bucket_not_found
-      end
-    end
-
-    def bucket_not_found?(err)
-      # Message is included in aws, azurerm, and google. See: https://bit.ly/3iOKDri
-      err.include?("Failed to get existing workspaces")
-    end
-
-    def reinit_required?(err)
-      # Example error: https://gist.github.com/tongueroo/f7e0a44b64f0a2e533089b18f331c21e
-      squeezed = @error_messages.gsub("\n", ' ').squeeze(' ') # remove double whitespaces and newlines
-      general_check = squeezed.include?("terraform init") && squeezed.include?("Error:")
-
-      general_check ||
-      err.include?("reinitialization required") ||
-      err.include?("terraform init") ||
-      err.include?("require reinitialization")
-    end
-
     def exit_status(status)
       return if status == 0
 
       exit_on_fail = @options[:exit_on_fail].nil? ? true : @options[:exit_on_fail]
-      if @known_error == :reinit_required
-        raise InitRequiredError.new(@error_messages)
-      elsif @known_error == :bucket_not_found
-        raise BucketNotFoundError.new(@error_messages)
+      if @error && @error.known?
+        raise @error.instance
       elsif exit_on_fail
         logger.error "Error running command: #{@command}".color(:red)
         exit status

data/lib/terraspace/shell/error.rb

@@ -0,0 +1,46 @@
+class Terraspace::Shell
+  class Error
+    attr_accessor :lines
+    def initialize
+      @lines = '' # holds aggregation of all error lines
+    end
+
+    def known?
+      !!instance
+    end
+
+    def instance
+      if reinit_required?
+        Terraspace::InitRequiredError.new(@lines)
+      elsif bucket_not_found?
+        Terraspace::BucketNotFound.new(@lines)
+      elsif shared_cache_error?
+        Terraspace::SharedCacheError.new(@lines)
+      end
+    end
+
+    def bucket_not_found?
+      # Message is included in aws, azurerm, and google. See: https://bit.ly/3iOKDri
+      message.include?("Failed to get existing workspaces")
+    end
+
+    def reinit_required?
+      # Example error: https://gist.github.com/tongueroo/f7e0a44b64f0a2e533089b18f331c21e
+      general_check = message.include?("terraform init") && message.include?("Error:")
+      general_check ||
+      message.include?("reinitialization required") ||
+      message.include?("terraform init") ||
+      message.include?("require reinitialization")
+    end
+
+    def message
+      @lines.gsub("\n", ' ').squeeze(' ') # remove double whitespaces and newlines
+    end
+
+    def shared_cache_error?
+      # Example: https://gist.github.com/tongueroo/4f2c925709d21f5810229ce9ca482560
+      message.include?("Failed to install provider from shared cache") ||
+      message.include?("Failed to validate installed provider")
+    end
+  end
+end

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,65 @@
+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
+        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}"
+      purge_caches # Purging the cache "fixes" this terraform bug
+      reinit
+    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.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -639,6 +639,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 +671,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