terraspace 0.6.6 → 0.6.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d5645441169b979490b844b27b8a6752b2ddddc05ed058c0b2681e34569a899
-  data.tar.gz: 2ce13fabc90ca45ba8b7ff89b452d2c210e12420b7ffbbc1c54ee5403d484a81
+  metadata.gz: 8aff7c57d034f741f93405653b027fa5f6fc7cd149bb705401777c46d9d784ce
+  data.tar.gz: 108a8ba1f3945df8a2aa682df18715952462182fc79a0ee2387c83c969f5d683
 SHA512:
-  metadata.gz: 7230e3a06fba98b04a487f9005c6ab635560ac912f48489e35b78883908f83194cf83f567a71a6d928aba6a72498d9ebc37e56c0fdeb3b9564b2794b0d0c2e2d
-  data.tar.gz: 880d907e3366bf7e5af1cd2e2add2646bb44edaf153ee2742cd2f8fc0c3aeb09aed3105d531da0f9aeaa7cbbedf03ae7376e692fca20ca43cebcdf356bc97414
+  metadata.gz: 05bfd0234b175533d1f8e477aaa3fffd6c1397d5c3640bde82217f18ec339e02698b37dabcf79e800f57f2c148fc6923f06c697e740fbd58561abaac5bbe903b
+  data.tar.gz: f9c2ff7ae00c5495c30da0b9db1d7f7c6dcc73045dcb6396d8df284e3d79e5c3a6607723629bae7d5d09446e3296ea1e27f9cefdb5cfd6ade419f429bb0ea5da

data/CHANGELOG.md

@@ -3,6 +3,22 @@
 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.11] - 2021-06-22
+- [#120](https://github.com/boltops-tools/terraspace/pull/120) version check handles a major change
+
+## [0.6.10] - 2021-06-01
+- [#117](https://github.com/boltops-tools/terraspace/pull/117) fix terraspace fmt -t all
+- clean up IO select call
+
+## [0.6.9] - 2021-05-07
+- [#112](https://github.com/boltops-tools/terraspace/pull/112) fix smart auto retry
+
+## [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
+
 ## [0.6.6] - 2021-04-15
 - [#101](https://github.com/boltops-tools/terraspace/pull/101) terraspace force-unlock command
 - [#102](https://github.com/boltops-tools/terraspace/pull/102) fix terraspace all summarized logging

data/lib/terraspace/cli/check_setup.rb

@@ -58,6 +58,7 @@ class Terraspace::CLI
       end
       major, minor, _ = version.split('.')
       required_major, required_minor = REQUIRED_TERRAFORM_VERSION.split('.')
+      return true if major.to_i > required_major.to_i
       x = major.to_i >= required_major.to_i
       y = minor.to_i >= required_minor.to_i
       x && y

data/lib/terraspace/cli/fmt.rb

@@ -30,7 +30,7 @@ class Terraspace::CLI
 
     def type_dirs
       type = @options[:type]
-      if type
+      if type && type != "all"
         app_source_dirs.select { |p| p.include?("/#{type.pluralize}/") }
       else
         app_source_dirs

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

@@ -14,9 +14,13 @@ Format all source files.
 Format specific module or stack.
 
     $ terraspace fmt stack1
-    $ terraspace fmt module1
+    $ terraspace fmt module1 -t module
 
 Format scoping to module or stack types. In case there's a module and stack with the same name.
 
     $ terraspace fmt example -t module
-    $ terraspace fmt demo -t stacke
+    $ terraspace fmt demo -t stack
+
+Format all, so both modules and stacks:
+
+    $ terraspace fmt -t all

data/lib/terraspace/hooks/runner.rb

@@ -2,6 +2,17 @@ module Terraspace::Hooks
   class Runner
     include Terraspace::Util
 
+    # exposing mod and hook so terraspace hooks have access to them via runner context. IE:
+    #
+    #     class EnvExporter
+    #       def call(runner)
+    #         puts "runner.hook #{runner.hook}"
+    #       end
+    #     end
+    #
+    # Docs: http://terraspace.cloud/docs/config/hooks/ruby/#method-argument
+    #
+    attr_reader :mod, :hook
     def initialize(mod, hook)
       @mod, @hook = mod, hook
       @execute = @hook["execute"]
@@ -12,12 +23,24 @@ module Terraspace::Hooks
       when String
         Terraspace::Shell.new(@mod, @execute, exit_on_fail: @hook["exit_on_fail"]).run
       when -> (e) { e.respond_to?(:public_instance_methods) && e.public_instance_methods.include?(:call) }
-        @execute.new.call
+        executor = @execute.new
       when -> (e) { e.respond_to?(:call) }
-        @execute.call
+        executor = @execute
       else
         logger.warn "WARN: execute option not set for hook: #{@hook.inspect}"
       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
 end

data/lib/terraspace/shell.rb

@@ -29,70 +29,98 @@ 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)
+      # 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
+        files = [stdout, stderr]
+        until all_eof?(files) do
+          ready = IO.select(files)
+          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|
+              if f.fileno == stdout.fileno
+                handle_stdout(line)
+                handle_input(stdin, line)
+              else
+                handle_stderr(line)
+              end
+            end
+          end
+        end
       end
     end
 
+    def handle_stderr(line)
+      @error ||= Error.new
+      @error.lines << line # aggregate all error lines
+
+      return if @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"
+      return if line == "\e[31m\n" && @options[:suppress_error_color]
+
+      logger.error(line)
+    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
-
-        # 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
+      if patterns.any? { |pattern| line.include?(pattern) }
+        print "\n  Enter a value: ".bright
+        stdin.write_nonblock($stdin.gets)
+      end
+    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 handle_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.6"
+  VERSION = "0.6.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.6.11
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport