terraspace 0.6.5 → 0.6.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75c6662ef1dbdb9fc52cdde609425bf17c780b20989692491f30cae96f04a10d
-  data.tar.gz: 6f3723c71e6e895633f3108950afb0cabace1d927216661aad06416e588bfdd8
+  metadata.gz: 8105526fb9629b60b79887ca3208449e24179640bbc03eae6bc11885dc6392cb
+  data.tar.gz: b387682cd6e5c4111c7a21bbb540793a966476a61e04c719fab3cca71de4a909
 SHA512:
-  metadata.gz: dc9c700c27a5e725532c940955316c4cad16e724a094885df3ea419b40d26fb26d9be959af5131114602efa73a5329fd9fab60b1cd09e86856efcd4f4f0942c2
-  data.tar.gz: 5f2f327d1aebf535ad92864c9c2cf312b426bd0e814273e12e718351015bd8652487ba34978e0bc3aeab464fb3ebf7362dba08412f02ef83fd76d1ec9ea47d60
+  metadata.gz: 1b0cc4aa0d60d7c6cad2785dea6c0300ef9186c6235b67500e3a9eb86cdd419112a0004b4859bb6ba7b398ef9912f1c6e3eb5d21e8cebf00615f45e6f1ac2623
+  data.tar.gz: a4e99cb75568dcacff91ff641118431f8792fdbd977eb758fc77a5ff751f4d1a274ec5a9586a1c34ac50eb692aa98c155475b1cf539f3ee85697be7a82cd9447

data/CHANGELOG.md

@@ -3,6 +3,24 @@
 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.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
+- [#103](https://github.com/boltops-tools/terraspace/pull/103) config.build.pass_files with default files use pass strategy
+
 ## [0.6.5] - 2021-03-24
 - [#96](https://github.com/boltops-tools/terraspace/pull/96) terraspace fmt: ability to specific module or stack
 

data/lib/terraspace/all/runner.rb

@@ -104,7 +104,7 @@ module Terraspace::All
     def run_terraspace(mod_name)
       set_log_path!(mod_name)
       name = command_map(@command)
-      o = @options.merge(mod: mod_name, yes: true, build: false, input: false)
+      o = @options.merge(mod: mod_name, yes: true, build: false, input: false, log_to_stderr: true)
       o.merge!(quiet: false) if @command == "init" # noisy so can filter and summarize output
       case @command
       when "up"

data/lib/terraspace/app.rb

@@ -27,6 +27,8 @@ module Terraspace
       config.build.cache_dir = ":CACHE_ROOT/:REGION/:ENV/:BUILD_DIR"
       config.build.cache_root = nil # defaults to /full/path/to/.terraspace-cache
       config.build.clean_cache = nil # defaults to /full/path/to/.terraspace-cache
+      config.build.default_pass_files = ["/files/"]
+      config.build.pass_files = []
       config.bundle = ActiveSupport::OrderedOptions.new
       config.bundle.logger = ts_logger
       config.init = ActiveSupport::OrderedOptions.new

data/lib/terraspace/cli.rb

@@ -85,6 +85,13 @@ module Terraspace
       Down.new(options.merge(mod: mod)).run
     end
 
+    desc "force_unlock", "Calls terrform force-unlock"
+    long_desc Help.text(:force_unlock)
+    instance_option.call
+    def force_unlock(mod, lock_id)
+      Commander.new("force-unlock", options.merge(mod: mod, lock_id: lock_id)).run
+    end
+
     desc "fmt", "Run terraform fmt"
     long_desc Help.text(:fmt)
     type_option.call

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/cli/help/force_unlock.md

@@ -0,0 +1,7 @@
+## Example
+
+    terraspace force_unlock demo ab7f3469-2a5f-07b9-29c5-dec1537ec8b0
+
+Instance option:
+
+    terraspace force_unlock demo -i 2 ab7f3469-2a5f-07b9-29c5-dec1537ec8b0

data/lib/terraspace/compiler/strategy/mod.rb

@@ -1,14 +1,15 @@
 module Terraspace::Compiler::Strategy
   class Mod < AbstractBase
     def run
-      ext = File.extname(@src_path).sub('.','')
-      klass = strategy_class(ext)
+      klass = strategy_class(@src_path)
       strategy = klass.new(@mod, @src_path) # IE: Terraspace::Compiler::Strategy::Mod::Rb.new
       strategy.run
     end
 
-    def strategy_class(ext)
+    def strategy_class(path)
+      ext = File.extname(path).sub('.','')
       return Mod::Pass if ext.empty? # infinite loop without this
+      return Mod::Pass if Terraspace.pass_file?(path)
       "Terraspace::Compiler::Strategy::Mod::#{ext.camelize}".constantize rescue Mod::Pass
     end
   end

data/lib/terraspace/compiler/writer.rb

@@ -10,11 +10,17 @@ module Terraspace::Compiler
     end
 
     def dest_path
-      name = @dest_name || @src_path.sub('.rb','.tf.json')
+      name = get_name
       name = basename(name)
       "#{dest_dir}/#{name}"
     end
 
+    def get_name
+      return @dest_name if @dest_name
+      return @src_path if Terraspace.pass_file?(@src_path)
+      @src_path.sub('.rb','.tf.json')
+    end
+
     def dest_dir
       if @mod.is_a?(Terraspace::Mod::Remote)
         File.dirname(@src_path) # for Mod::Remote src is dest

data/lib/terraspace/core.rb

@@ -51,5 +51,12 @@ module Terraspace
     def logger=(v)
       @@logger = v
     end
+
+    def pass_file?(path)
+      pass_files = config.build.pass_files + config.build.default_pass_files
+      pass_files.uniq.detect do |i|
+        i.is_a?(Regexp) ? path =~ i : path.include?(i)
+      end
+    end
   end
 end

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/terraform/args/default.rb

@@ -3,7 +3,7 @@ require "tempfile"
 module Terraspace::Terraform::Args
   class Default
     def initialize(mod, name, options={})
-      @mod, @name, @options = mod, name, options
+      @mod, @name, @options = mod, name.underscore, options
       @quiet = @options[:quiet].nil? ? true : @options[:quiet]
     end
 
@@ -11,14 +11,18 @@ module Terraspace::Terraform::Args
       # https://terraspace.cloud/docs/ci-automation/
       ENV['TF_IN_AUTOMATION'] = '1' if @options[:auto]
 
-      if %w[apply destroy init output plan show].include?(@name)
-        meth = "#{@name}_args"
-        send(meth)
+      args_meth = "#{@name}_args"
+      if respond_to?(args_meth)
+        send(args_meth)
       else
         []
       end
     end
 
+    def force_unlock_args
+      [" -force #{@options[:lock_id]}"]
+    end
+
     def apply_args
       args = auto_approve_arg
       var_files = @options[:var_files]

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.6.5"
+  VERSION = "0.6.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.10
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -508,6 +508,7 @@ files:
 - lib/terraspace/cli/help/console.md
 - lib/terraspace/cli/help/down.md
 - lib/terraspace/cli/help/fmt.md
+- lib/terraspace/cli/help/force_unlock.md
 - lib/terraspace/cli/help/info.md
 - lib/terraspace/cli/help/init.md
 - lib/terraspace/cli/help/list.md