terraspace 0.2.3 → 0.3.3

data/lib/terraspace/dependency/node.rb

@@ -0,0 +1,38 @@
+module Terraspace::Dependency
+  class Node
+    attr_reader :name
+    attr_accessor :children, :parents, :filtered
+    def initialize(name)
+      @name = name
+      @children, @parents = Set.new, Set.new
+    end
+
+    def highlighted?
+      @filtered
+    end
+
+    def inspect
+      @name
+    end
+
+    def parent!(parent)
+      @parents << parent
+      parent.children << self
+    end
+
+    class << self
+      @@nodes = []
+      def find_or_create_by(name:)
+        node = find_by(name: name)
+        return node if node
+        node = Node.new(name)
+        @@nodes << node
+        node
+      end
+
+      def find_by(name:)
+        @@nodes.find { |n| n.name == name }
+      end
+    end
+  end
+end

data/lib/terraspace/dependency/registry.rb

@@ -0,0 +1,11 @@
+module Terraspace::Dependency
+  class Registry
+    cattr_accessor :data, default: Set.new
+
+    class << self
+      def register(parent_name, child_name)
+        @@data << "#{parent_name}:#{child_name}"
+      end
+    end
+  end
+end

data/lib/terraspace/logger.rb

@@ -2,25 +2,13 @@ require 'logger'
 
 module Terraspace
   class Logger < ::Logger
-    # Only need to override the add method as the other calls all lead to it.
-    def add(severity, message = nil, progname = nil)
-      # Taken from Logger#add source
-      # https://ruby-doc.org/stdlib-2.5.1/libdoc/logger/rdoc/Logger.html#method-i-add
-      if message.nil?
-        if block_given?
-          message = yield
-        else
-          message = progname
-          progname = @progname
-        end
+    def format_message(severity, datetime, progname, msg)
+      line = if @logdev.dev == $stdout || @logdev.dev == $stderr
+        msg # super simple format if stdout
+      else
+        super # use the configured formatter
       end
-
-      super # original logic
-    end
-
-    # plain formatting
-    def format_message(severity, timestamp, progname, msg)
-      "#{msg}\n"
+      line =~ /\n$/ ? line : "#{line}\n"
     end
   end
 end

data/lib/terraspace/logger/formatter.rb

@@ -0,0 +1,13 @@
+class Terraspace::Logger
+  class Formatter < ::Logger::Formatter
+    def call(severity, time, progname, msg)
+      # careful changing the format. All::Summary uses a regexp on this format to remove the timestamp
+      "[#{format_datetime(time)} ##{Process.pid} #{progname}]: #{msg}"
+    end
+
+  private
+    def format_datetime(time)
+      time.strftime("%Y-%m-%dT%H:%M:%S")
+    end
+  end
+end

data/lib/terraspace/mod.rb

@@ -10,6 +10,7 @@ module Terraspace
     include Terraspace::Util
 
     attr_reader :name, :consider_stacks, :instance, :options
+    attr_accessor :resolved # dependencies resolved
     def initialize(name, options={})
       @name, @options = placeholder(name), options
       @consider_stacks = options[:consider_stacks].nil? ? true : options[:consider_stacks]
@@ -74,6 +75,10 @@ module Terraspace
       end
     end
 
+    def exist?
+      !!root
+    end
+
     # Relative folder path without app or vendor. For example, the actual location can be found in a couple of places
     #
     #     app/modules/vpc
@@ -86,8 +91,9 @@ module Terraspace
     #     modules/vpc
     #
     def build_dir(disable_instance: false)
-      if !disable_instance && !@instance.nil?
+      if !@instance.nil? && type_dir == "stacks" && !disable_instance
         # add _ in front so instance doesnt collide with other default stacks
+        # never add for app/modules sources
         instance_name = [name, @instance].compact.join('.')
       else
         instance_name = name

data/lib/terraspace/seeder/where.rb

@@ -20,11 +20,15 @@ class Terraspace::Seeder
     end
 
     def app_path
-      "#{Terraspace.root}/app/#{@mod.build_dir}/tfvars/#{Terraspace.env}.tfvars"
+      "#{Terraspace.root}/app/#{@mod.build_dir}/tfvars/#{seed_file}.tfvars"
     end
 
     def seed_path
-      "#{Terraspace.root}/seed/tfvars/#{@mod.build_dir}/#{Terraspace.env}.tfvars"
+      "#{Terraspace.root}/seed/tfvars/#{@mod.build_dir}/#{seed_file}.tfvars"
+    end
+
+    def seed_file
+      @options[:instance] || Terraspace.env
     end
   end
 end

data/lib/terraspace/shell.rb

@@ -0,0 +1,97 @@
+require 'open3'
+
+module Terraspace
+  class Shell
+    include Util::Logging
+
+    def initialize(mod, command, options={})
+      @mod, @command, @options = mod, command, options
+      @error_type, @error_messages = nil, ''
+    end
+
+    # requires @mod to be set
+    def run
+      env = @options[:env] || {}
+      env.stringify_keys!
+
+      # quiet useful for RemoteState::Fetcher
+      msg = "=> #{@command}"
+      @options[:quiet] ? logger.debug(msg) : logger.info(msg)
+      return if ENV['TS_TEST']
+
+      Open3.popen3(env, @command, chdir: @mod.cache_dir) do |stdin, stdout, stderr, wait_thread|
+        mimic_terraform_input(stdin, stdout)
+        while err = stderr.gets
+          @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
+
+        status = wait_thread.value.exitstatus
+        exit_status(status)
+      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 @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
+
+    # 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
+    #
+    # Note: system does stream the prompt but using Open3.popen3 so we can capture output to save to logs.
+    def mimic_terraform_input(stdin, stdout)
+      shown = false
+      patterns = [
+        "Only 'yes' will be accepted", # prompt for apply. can happen on apply
+        "\e[0m\e[1mvar.", # prompts for variable input. can happen on plan or apply. looking for bold marker also in case "var." shows up somewhere else
+      ]
+      while out = stdout.gets
+        logger.info(out) unless shown && out.include?("Enter a value:")
+        shown = false if out.include?("Enter a value:") # reset shown in case of multiple input prompts
+
+        # Sometimes stdout doesnt flush and show "Enter a value: ", so mimic it
+        if patterns.any? { |pattern| out.include?(pattern) }
+          print "  Enter a value: ".bright
+          shown = true
+          stdin.write_nonblock($stdin.gets)
+        end
+      end
+    end
+  end
+end

data/lib/terraspace/terraform/api.rb

@@ -1,58 +1,20 @@
 module Terraspace::Terraform
   class Api
     extend Memoist
-    include Client
-    include Terraspace::Util::Logging
 
     def initialize(mod, remote)
-      @mod = mod
-      @organization = remote['organization']
-      @workspace_name = remote['workspaces']['name']
+      @mod, @remote = mod, remote
     end
 
-    # Docs: https://www.terraform.io/docs/cloud/api/workspaces.html
-    def set_working_dir
-      return if working_directory == workspace['attributes']['working-directory']
-
-      payload = {
-        data: {
-          attributes: {
-            "working-directory": working_directory
-          },
-          type: "workspaces"
-        }
-      }
-      http.patch("organizations/#{@organization}/workspaces/#{@workspace_name}", payload)
-    end
-
-    def working_directory
-      cache_dir = @mod.cache_dir.sub("#{Terraspace.root}/", '')
-      relative_root = Terraspace.config.cloud.relative_root # prepended to TFC Working Directory
-      relative_root ? "#{relative_root}/#{cache_dir}" : cache_dir
-    end
-
-    def set_env_vars
-      Vars.new(@mod, workspace).run
-    end
-
-    def workspace(options={})
-      payload = http.get("organizations/#{@organization}/workspaces/#{@workspace_name}")
-      # Note only way to get here is to bypass init. Example:
-      #
-      #     terraspace up demo --no-init
-      #
-      unless payload || options[:exit_on_fail] == false
-        logger.error "ERROR: Unable to find the workspace. The workspace may not exist. Or the Terraform token may be invalid. Please double check your Terraform token.".color(:red)
-        exit 1
-      end
-      return unless payload
-      payload['data']
+    def workspace
+      Workspace.new(@mod, @remote['organization'], @remote['workspaces']['name'])
     end
     memoize :workspace
 
-    def destroy_workspace
-      # resp payload from delete operation is nil
-      http.delete("/organizations/#{@organization}/workspaces/#{@workspace_name}")
+    def runs
+      workspace_id = workspace.details['id']
+      Runs.new(workspace_id)
     end
+    memoize :runs
   end
 end

data/lib/terraspace/terraform/api/base.rb

@@ -0,0 +1,7 @@
+class Terraspace::Terraform::Api
+  class Base
+    extend Memoist
+    include Http::Concern
+    include Terraspace::Util::Logging
+  end
+end

data/lib/terraspace/terraform/api/client.rb

@@ -1,10 +1,30 @@
 class Terraspace::Terraform::Api
   module Client
     extend Memoist
+    def remote
+      backend["remote"]
+    end
+
+    def workspace_name
+      remote['workspaces']['name']
+    end
+
+    def build
+      Terraspace::Builder.new(@options).run
+    end
+    memoize :build
+
+    # backend may be overridden in classes including this Concern
+    def backend
+      Terraspace::Compiler::Backend::Parser.new(@mod).result
+    end
+    memoize :backend
 
-    def http
-      Http.new
+    # api may be overridden in classes including this Concern
+    def api
+      return unless backend.dig('remote','workspaces') # in case called by terraspace down demo -y --destroy-workspace with a non-remote backend
+      Terraspace::Terraform::Api.new(@mod, remote)
     end
-    memoize :http
+    memoize :api
   end
 end

data/lib/terraspace/terraform/api/http.rb

@@ -2,10 +2,10 @@ require 'net/http'
 
 class Terraspace::Terraform::Api
   class Http
-    include Terraspace::Util::Logging
-
     API = ENV['TERRAFORM_API'] || 'https://app.terraform.io/api/v2'
+
     extend Memoist
+    include Terraspace::Util::Logging
 
     def get(path)
       request(Net::HTTP::Get, path)
@@ -63,44 +63,24 @@ class Terraspace::Terraform::Api
     end
 
     def load_json(res)
-      if res.code == "200"
+      if ok?(res.code)
         JSON.load(res.body)
       else
-        if ENV['TERRASPACE_DEBUG_API']
-          puts "Error: Non-successful http response status code: #{res.code}"
-          puts "headers: #{res.each_header.to_h.inspect}"
-        end
-        nil
+        logger.info "Error: Non-successful http response status code: #{res.code}"
+        logger.info "headers: #{res.each_header.to_h.inspect}"
+        raise "TFC API called failed"
       end
     end
 
-    def token
-      token ||= ENV['TERRAFORM_TOKEN']
-      return token if token
-
-      creds_path = "#{ENV['HOME']}/.terraform.d/credentials.tfrc.json"
-      if File.exist?(creds_path)
-        data = JSON.load(IO.read(creds_path))
-        token = data.dig('credentials', 'app.terraform.io', 'token')
-      end
-
-      # Note only way to get here is to bypass init. Example:
-      #
-      #     terraspace up demo --no-init
-      #
-      unless token
-        logger.error "ERROR: Unable to not find a Terraform token. A Terraform token is needed for Terraspace to call the Terraform API.".color(:red)
-        logger.error <<~EOL
-          Here are some ways to provide the Terraform token:
-
-              1. By running: terraform login
-              2. With an env variable: export TERRAFORM_TOKEN=xxx
+    # Note: 422 is Unprocessable Entity. This means an invalid data payload was sent.
+    # We want that to error and raise
+    def ok?(http_code)
+      http_code =~ /^20/ ||
+      http_code =~ /^40/
+    end
 
-          Please configure a Terraform token and try again.
-        EOL
-        exit 1
-      end
-      token
+    def token
+      Token.get
     end
   end
 end

data/lib/terraspace/terraform/api/http/concern.rb

@@ -0,0 +1,10 @@
+class Terraspace::Terraform::Api::Http
+  module Concern
+    extend Memoist
+
+    def http
+      Terraspace::Terraform::Api::Http.new
+    end
+    memoize :http
+  end
+end

data/lib/terraspace/terraform/api/runs.rb

@@ -0,0 +1,28 @@
+class Terraspace::Terraform::Api
+  class Runs < Base
+    extend Memoist
+
+    attr_reader :workspace_id
+    def initialize(workspace_id)
+      @workspace_id = workspace_id
+    end
+
+    def list
+      payload = http.get("workspaces/#{@workspace_id}/runs")
+      payload['data'] if payload
+    end
+
+    def discard(id)
+      action("discard", id)
+    end
+
+    def cancel(id)
+      action("cancel", id)
+    end
+
+    def action(action, id)
+      payload = http.post("runs/#{id}/actions/#{action}")
+      payload['data'] if payload
+    end
+  end
+end