terraspace 0.6.7 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 790cbc55c399a3130eaaaa9e1e3af636a2b182cb28c2ca008e14a48d75883e47
-  data.tar.gz: 72d05ffb527f163d2b3be47542b77764ddbc599858e6dde6381058e992bc531c
+  metadata.gz: ac0b4566fae8a6be4cfb7907e60d1d0ec3cdf4f7426989a68e5a7c22c55b4cc5
+  data.tar.gz: 66bd6807da803a3891ba2d78b5e21e5dcf0af2e8a1ed303ceb8c9e70c6916ea7
 SHA512:
-  metadata.gz: a598f6c5e693d42c113a5aac0f4d2e63c41821a2414095ed65415fa6b11ab1636ce48d6a98ada24557c6b685642f1ac420fc9850544bd1cbda80e3de91036d48
-  data.tar.gz: f0a0955bbc1f7846e855141514a69b0aaffc81283081a5a90384fb85e4ec7946a65f19fa1dc3ff5df0e7c9f656ac5563fecca2c8a1a1959c83fa29d9daeae4bd
+  metadata.gz: d14b3c79add9cf2075c27682ad466f4afeb474a21943868d3dc1260afd129d127387e0089fa44e08e695bb5c28080b6dcbfdcd6774c3fff244782a50dd8a4f7c
+  data.tar.gz: c54ed8c38625bccd2ce424a18b70b4ca9198a4921bf10a57e452e0c6d7b1f2ae500f9565ba123cbaa071d7fec9767fa1d263e8a315dc1427ea5d983c8309c790

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.6.8] - 2021-05-07
+- [#110](https://github.com/boltops-tools/terraspace/pull/110) fix popen deadlock with large amounts of output [#97](https://github.com/boltops-tools/terraspace/pull/97) Terraspace hangs when TF_LOG=TRACE environment variable exists #97
+
 ## [0.6.7] - 2021-05-05
 - [#108](https://github.com/boltops-tools/terraspace/pull/108) provide runner context to terraspace hook
 

data/lib/terraspace/hooks/runner.rb

@@ -30,16 +30,16 @@ module Terraspace::Hooks
         logger.warn "WARN: execute option not set for hook: #{@hook.inspect}"
       end
 
-      if executor
-        meth = executor.method(:call)
-        case meth.arity
-        when 0
-          executor.call # backwards compatibility
-        when 1
-          executor.call(self)
-        else
-          raise "The #{executor} call method definition has been more than 1 arguments and is not supported"
-        end
+      return unless executor
+
+      meth = executor.method(:call)
+      case meth.arity
+      when 0
+        executor.call # backwards compatibility
+      when 1
+        executor.call(self)
+      else
+        raise "The #{executor} call method definition has been more than 1 arguments and is not supported"
       end
     end
   end

data/lib/terraspace/shell.rb

@@ -29,70 +29,82 @@ module Terraspace
 
     def popen3(env)
       Open3.popen3(env, @command, chdir: @mod.cache_dir) do |stdin, stdout, stderr, wait_thread|
-        mimic_terraform_input(stdin, stdout)
-        while out = stdout.gets
-          terraform_to_stdout(out)
-        end
-
-        while err = stderr.gets
-          @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]
-            logger.error(err)
-          end
-        end
-
+        handle_streams(stdin, stdout, stderr)
         status = wait_thread.value.exitstatus
         exit_status(status)
       end
     end
 
-    def exit_status(status)
-      return if status == 0
+    BLOCK_SIZE = Integer(ENV['TS_BUFFER_BLOCK_SIZE'] || 102400)
+    BUFFER_TIMEOUT = Integer(ENV['TS_BUFFER_TIMEOUT'] || 3600) # 3600s = 1h
+    def handle_streams(stdin, stdout, stderr)
+      files = [stdout, stderr]
+      # note: t=0 and t=nil means no timeout. See: https://bit.ly/2PURlCX
+      t = BUFFER_TIMEOUT.to_i unless BUFFER_TIMEOUT.nil?
+      Timeout::timeout(t) do
+        until all_eof?(files) do
+          ready = IO.select(files, nil, nil, 0.1)
+          next unless ready
 
-      exit_on_fail = @options[:exit_on_fail].nil? ? true : @options[:exit_on_fail]
-      if @error && @error.known?
-        raise @error.instance
-      elsif exit_on_fail
-        logger.error "Error running command: #{@command}".color(:red)
-        exit status
+          readable = ready[0]
+          readable.each do |f|
+            buffer = f.read_nonblock(BLOCK_SIZE, exception: false)
+            next unless buffer
+
+            lines = buffer.split("\n")
+            lines.each do |line|
+              terraform_to_stdout(line)
+              handle_input(stdin, line)
+            end
+          end
+        end
       end
     end
 
+    def all_eof?(files)
+      files.find { |f| !f.eof }.nil?
+    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
+    def handle_input(stdin, line)
+      # stdout doesnt seem to flush and show "Enter a value: " look for earlier output
       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
-        terraform_to_stdout(out) unless shown && out.include?("Enter a value:")
-        shown = false if out.include?("Enter a value:") # reset shown in case of multiple input prompts
+      if patterns.any? { |pattern| line.include?(pattern) }
+        print "\n  Enter a value: ".bright
+        stdin.write_nonblock($stdin.gets)
+      end
+    end
 
-        # 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
+    def exit_status(status)
+      return if status == 0
+
+      exit_on_fail = @options[:exit_on_fail].nil? ? true : @options[:exit_on_fail]
+      if @error && @error.known?
+        raise @error.instance
+      elsif exit_on_fail
+        logger.error "Error running command: #{@command}".color(:red)
+        exit status
       end
     end
 
-    # Allows piping to jq. IE:
-    #   terraspace show demo --json | jq
-    def terraform_to_stdout(out)
-      # so terraform output goes stdout
+    def terraform_to_stdout(line)
+      prompted = line.include?('Enter a value')
+      @prompt_shown ||= prompted
+      return if @prompt_shown && prompted
+
+      # Terraspace logger has special stdout method so original terraform output
+      # can be piped to jq. IE:
+      #   terraspace show demo --json | jq
       if logger.respond_to?(:stdout) && !@options[:log_to_stderr]
-        logger.stdout(out)
+        logger.stdout(line)
       else
-        logger.info(out)
+        logger.info(line)
       end
     end
   end

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.6.7"
+  VERSION = "0.6.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport