terraspace 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 471e59d4e8478c78dd4de1190397e89548e68646fa6fcec02748442ecf9b282e
-  data.tar.gz: 65250fbef38cef2731688e9c75877747a2a567ecd0d9ba40ce30b2c86c5c73e6
+  metadata.gz: e4501185815eeebafbdadd49e8afac52af4fc1c6b8d6d297269614482a38df47
+  data.tar.gz: b532e32f8c4a2a34e14b528649ff313041610adb7fc89349f7f97336a4c767d0
 SHA512:
-  metadata.gz: 400b78be5d433399119713533a7b56fd7b143b253cae7e96d344273d74784ba9fe877a2a92293f237cec9f0642694256bd04c0b0ad0bef73050d205603884f92
-  data.tar.gz: eac5b2042f655964d08454d7b5ea3ba40012145fed1c560bf116757c91857479ef7430cd1b7a2be661e828dbaf12a7cd0323014fb847a13299ef8fdc01cc8125
+  metadata.gz: b8e949cadb19e163b961bebc40cc8e31bfba8e6ccefb07e28cdabb88a6cf0696a7a8a62b7f4c5f73ab1ae420c9b1956f38d2916f65ad0bfae3ee4e64ba885de5
+  data.tar.gz: 0f0ef1edc6432743dc6f3535449c880615057038a4e097ca03227660d7dd39270da8186675c26315f86636344635017d16f4c60fef580dfb6188bd0c785e92ab

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 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.3.3]
+* #41 fix `terraspace build` and `terraspace seed` when bucket doesnt exist yet and there are dependenices defined.
+
 ## [0.3.2]
 * #40 fix backend auto creation
 

data/README.md

@@ -88,7 +88,7 @@ When you use the all command, the dependency graph is calculated and the stacks
 * [Config Structure](https://terraspace.cloud/docs/config/): A common config structure that gets materializes with the deployed module. Configs can be dynamically controlled to keep your code DRY. You can override the settings if needed, like for using existing backends. See: [Existing Backends](https://terraspace.cloud/docs/state/existing/).
 * [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/dependencies/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/).
+* [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/).
 * [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.
 * [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,6 +26,7 @@ module Terraspace
   extend Core # for Terraspace.root
   class Error < StandardError; end
   class InitRequiredError < Error; end
+  class BucketNotFoundError < Error; end
 end
 
 Terraspace::Booter.boot

data/lib/terraspace/builder.rb

@@ -1,6 +1,7 @@
 module Terraspace
   class Builder < Terraspace::CLI::Base
     include Compiler::DirsConcern
+    include Compiler::CommandsConcern
 
     attr_reader :graph
 
@@ -58,16 +59,10 @@ module Terraspace
     # Auto create after build_unresolved since will need to run state pull for dependencies
     def auto_create_backend
       return if Terraspace.config.auto_create_backend == false
-      return unless create_backend?
+      return unless requires_backend?
       Terraspace::Compiler::Backend.new(@mod).create
     end
 
-    def create_backend?
-      commands = %w[down init output plan providers refresh show up validate]
-      commands.include?(ARGV[0]) ||                  # IE: terraspace up
-      ARGV[0] == "all" && commands.include?(ARGV[1]) # IE: terraspace all up
-    end
-
     def clean
       Compiler::Cleaner.new(@mod, @options).clean if clean?
     end

data/lib/terraspace/cli.rb

@@ -110,7 +110,7 @@ module Terraspace
       List.new(options).run
     end
 
-    desc "log [ACTION] [STACK]", "The all log command allows you to view multiple logs."
+    desc "log [ACTION] [STACK]", "The log command allows you to view multiple logs."
     long_desc Help.text("log")
     option :timestamps, aliases: %w[t], type: :boolean, desc: "Whether or not to show the leading timestamp. Defaults to timestamps for multiple logs, and no timestamp if a single log is specified. Note: In follow mode, timestamp always shown"
     option :follow, aliases: %w[f], type: :boolean, desc: "Follow the log in live tail fashion. Must specify a stack if using this option."

data/lib/terraspace/cli/help/cloud/runs/prune.md

@@ -1,4 +1,4 @@
-This leaves the to most recent run alone. The top run will immediately start planning. Runs that are also in "Needs Confirmation" will be cancelled.
+This leaves the top run alone. The top run usually starts immediately planning once the other runs are pruned. Runs that are also in "Needs Confirmation" will be cancelled.
 
 ## Examples
 

data/lib/terraspace/cli/help/log.md

@@ -23,7 +23,7 @@ To show all logs, use the `-a` option.
 
     terraspace log up -a
 
-Note, if both an action and stack is specified, then it defaults to showing all logs. If you want to not show all logs in thta case, then you can use `--no-all`.
+Note, if both an action and stack is specified, then it defaults to showing all logs. If you want not to show all logs, use `--no-all`.
 
 ## Tail Logs
 
@@ -36,7 +36,11 @@ To tail logs, use the `-f` option.
 
 ## Timestamps
 
-The timestamps are shown by default when you are looking for multiple files.  When you specify a both the action and stack for a single log file, then timestamps are not shown.
+The timestamps are shown by default when you are looking for multiple files.  When you specify both the action and stack for a single log file, then timestamps are not shown.
 
     terraspace log up         # timestamps will be shown in this case
     terraspace log up network # timestamps not be shown in this case
+
+To show timestamps:
+
+    terraspace up up network --timestamps

data/lib/terraspace/compiler/backend.rb

@@ -6,7 +6,13 @@ module Terraspace::Compiler
       @mod = mod
     end
 
+    @@created = {}
     def create
+      return if @@created[cache_key]
+      # set immediately, since local storage wont reach bottom.
+      # if fail for other backends, there will be an exception anyway
+      @@created[cache_key] = true
+
       klass = backend_interface(backend_name)
       return unless klass # in case auto-creation is not supported for specific backend
 
@@ -14,6 +20,10 @@ module Terraspace::Compiler
       interface.call
     end
 
+    def cache_key
+      @mod.build_dir
+    end
+
     def backend_name
       backend.keys.first # IE: s3, gcs, etc
     end

data/lib/terraspace/compiler/builder.rb

@@ -1,5 +1,6 @@
 module Terraspace::Compiler
   class Builder
+    include CommandsConcern
     include Basename
 
     def initialize(mod)
@@ -9,7 +10,7 @@ module Terraspace::Compiler
     def build
       build_config
       build_module if @mod.resolved
-      build_tfvars
+      build_tfvars unless command_is?(:seed) #  avoid dependencies being built and erroring when backend bucket doesnt exist
     end
 
     # build common config files: provider and backend for the root module

data/lib/terraspace/compiler/commands_concern.rb

@@ -0,0 +1,18 @@
+module Terraspace::Compiler
+  module CommandsConcern
+    def requires_backend?
+      command_is?(requires_backend_commands)
+    end
+
+    def requires_backend_commands
+      %w[down init output plan providers refresh show up validate]
+    end
+
+    def command_is?(*commands)
+      commands.flatten!
+      commands.map!(&:to_s)
+      commands.include?(ARGV[0]) ||                  # IE: terraspace up
+      ARGV[0] == "all" && commands.include?(ARGV[1]) # IE: terraspace all up
+    end
+  end
+end

data/lib/terraspace/shell.rb

@@ -6,7 +6,7 @@ module Terraspace
 
     def initialize(mod, command, options={})
       @mod, @command, @options = mod, command, options
-      @init_required, @init_messages = false, ''
+      @error_type, @error_messages = nil, ''
     end
 
     # requires @mod to be set
@@ -22,10 +22,13 @@ 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
-          @init_required ||= reinitialization_required?(err)
-          if @init_required
-            @init_messages << err
+          @error_type ||= known_error_type(err)
+          if @error_type
+            @error_messages << err
           else
+            # 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]
             logger.error(err)
           end
         end
@@ -35,24 +38,39 @@ module Terraspace
       end
     end
 
+    def known_error_type(err)
+      if reinitialization_required?(err)
+        :reinitialization_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 reinitialization_required?(err)
+      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 @init_required
-        raise InitRequiredError.new(@init_messages)
+      if @error_type == :reinitialization_required
+        raise InitRequiredError.new(@error_messages)
+      elsif @error_type == :bucket_not_found
+        raise BucketNotFoundError.new(@error_messages)
       elsif exit_on_fail
         logger.error "Error running command: #{@command}".color(:red)
         exit status
       end
     end
 
-    def reinitialization_required?(err)
-      err.include?("reinitialization required") ||
-      err.include?("terraform init") ||
-      err.include?("require reinitialization")
-    end
-
     # Terraform doesnt seem to stream the line that prompts with "Enter a value:" when using Open3.popen3
     # Hack around it by mimicking the "Enter a value:" prompt
     #

data/lib/terraspace/terraform/remote_state/fetcher.rb

@@ -1,6 +1,7 @@
 module Terraspace::Terraform::RemoteState
   class Fetcher
     extend Memoist
+    include Terraspace::Compiler::CommandsConcern
     include Terraspace::Util::Logging
 
     def initialize(parent, identifier, options={})
@@ -10,7 +11,7 @@ module Terraspace::Terraform::RemoteState
     end
 
     def run
-      validate!
+      validate! # check child stack exists
       pull
       load
     end
@@ -22,7 +23,8 @@ module Terraspace::Terraform::RemoteState
         error = output_error(:key_not_found) unless @outputs.key?(@output_key)
         OutputProxy.new(value, @options.merge(error: error))
       else
-        error = output_error(:state_not_found)
+        @error_type ||= :state_not_found # could be set to :bucket_not_found by bucket_not_found_error
+        error = output_error(@error_type)
         OutputProxy.new(nil, @options.merge(error: error))
       end
     end
@@ -39,6 +41,8 @@ module Terraspace::Terraform::RemoteState
         "Output #{@output_key} was not found for the #{@parent.name} tfvars file. Either #{@child.name} stack has not been deployed yet or it does not have this output: #{@output_key}"
       when :state_not_found
         "Output #{@output_key} could not be looked up for the #{@parent.name} tfvars file. #{@child.name} stack needs to be deployed"
+      when :bucket_not_found
+        "The bucket for the backend could not be found"
       end
       msg = "(#{msg})"
       log_message(msg)
@@ -52,7 +56,10 @@ module Terraspace::Terraform::RemoteState
       logger.info "Downloading tfstate files for dependencies defined in tfvars..." unless @@download_shown || @options[:quiet]
       @@download_shown = true
       logger.debug "Downloading tfstate for stack: #{@child.name}"
-      Terraspace::CLI::Init.new(mod: @child.name, calling_command: "apply", quiet: true).init # init not run, so only init
+
+      success = init # init not yet run. only run .init directly, not .run. init can completely error and early exit.
+      return unless success
+
       FileUtils.mkdir_p(File.dirname(state_path))
       command = "cd #{@child.cache_dir} && terraform state pull > #{state_path}"
       logger.debug "=> #{command}"
@@ -67,6 +74,20 @@ module Terraspace::Terraform::RemoteState
       @@pull_successes[cache_key] = success
     end
 
+    def init
+      Terraspace::CLI::Init.new(mod: @child.name, calling_command: "apply", quiet: true, suppress_error_color: true).init
+      true
+    rescue Terraspace::BucketNotFoundError # from Terraspace::Shell
+      bucket_not_found_error
+      false
+    end
+
+    # mimic pull error
+    def bucket_not_found_error
+      @@pull_successes[cache_key] = false
+      @error_type = :bucket_not_found
+    end
+
     def load
       return self unless pull_success?
 

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Tung Nguyen
@@ -520,6 +520,7 @@ files:
 - lib/terraspace/compiler/builder.rb
 - lib/terraspace/compiler/cleaner.rb
 - lib/terraspace/compiler/cleaner/backend_change.rb
+- lib/terraspace/compiler/commands_concern.rb
 - lib/terraspace/compiler/dirs_concern.rb
 - lib/terraspace/compiler/dsl/base.rb
 - lib/terraspace/compiler/dsl/meta/local.rb