terraspace 0.6.3 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9b4a9918ee0ab0e10c6c4d2d0ed1a88851fda09b7a6b1475db084c6f7cb1699
-  data.tar.gz: 2b66a6e8be57c94aaf24334a073943c28e11fbcd77f1d7853cf0885e9e87ec9e
+  metadata.gz: ac0b4566fae8a6be4cfb7907e60d1d0ec3cdf4f7426989a68e5a7c22c55b4cc5
+  data.tar.gz: 66bd6807da803a3891ba2d78b5e21e5dcf0af2e8a1ed303ceb8c9e70c6916ea7
 SHA512:
-  metadata.gz: dcabae82c7a30ddcc364a13ce85f73ce461307cde54ab95fd2fb1d2c21558c03123058c8d282e339ae4f47f0fd927061eee12d74ba71f403cc6b7cb9f7fd8e3e
-  data.tar.gz: f8c625671745fccdb13139efcd13c737b6f4a2ee0161badc75677bdedc544a94566c0eb8e865c2c68635bab7c648232d7275b88f20d0f9a8677d74b74c95c75f
+  metadata.gz: d14b3c79add9cf2075c27682ad466f4afeb474a21943868d3dc1260afd129d127387e0089fa44e08e695bb5c28080b6dcbfdcd6774c3fff244782a50dd8a4f7c
+  data.tar.gz: c54ed8c38625bccd2ce424a18b70b4ca9198a4921bf10a57e452e0c6d7b1f2ae500f9565ba123cbaa071d7fec9767fa1d263e8a315dc1427ea5d983c8309c790

data/CHANGELOG.md

@@ -3,6 +3,23 @@
 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
+
+## [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
+
+## [0.6.4] - 2021-03-22
+- [#94](https://github.com/boltops-tools/terraspace/pull/94) terraspace fmt command
+
 ## [0.6.3] - 2021-03-12
 - [#91](https://github.com/boltops-tools/terraspace/pull/91) Camelcase
 - [#92](https://github.com/boltops-tools/terraspace/pull/92) disable terraform.plugin_cache by default

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

@@ -27,6 +27,9 @@ module Terraspace
     reconfigure_option = Proc.new {
       option :reconfigure, type: :boolean, desc: "Add terraform -reconfigure option"
     }
+    type_option = Proc.new {
+      option :type, default: "stack", aliases: %w[t], desc: "Type: stack, module, or all"
+    }
 
     desc "all SUBCOMMAND", "all subcommands"
     long_desc Help.text(:all)
@@ -82,6 +85,20 @@ 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
+    def fmt(mod=nil)
+      Fmt.new(options.merge(mod: mod)).run
+    end
+
     desc "info STACK", "Get info about stack."
     long_desc Help.text(:info)
     instance_option.call
@@ -100,7 +117,7 @@ module Terraspace
 
     desc "list", "List stacks and modules."
     long_desc Help.text(:list)
-    option :type, default: "stack", aliases: %w[t], desc: "Type: stack, module, or all"
+    type_option.call
     def list
       List.new(options).run
     end

data/lib/terraspace/cli/concerns/source_dirs.rb

@@ -0,0 +1,13 @@
+module Terraspace::CLI::Concerns
+  module SourceDirs
+    # used by list
+    def source_dirs
+      Dir.glob("{app,vendor}/{modules,stacks}/*").select { |p| File.directory?(p) }.sort
+    end
+
+    # dont include vendor: used by fmt
+    def app_source_dirs
+      Dir.glob("{app}/{modules,stacks}/*").select { |p| File.directory?(p) }.sort
+    end
+  end
+end

data/lib/terraspace/cli/fmt.rb

@@ -0,0 +1,40 @@
+class Terraspace::CLI
+  class Fmt
+    include Concerns::SourceDirs
+    include Terraspace::Util::Logging
+
+    def initialize(options={})
+      @options = options
+      @mod_name = options[:mod]
+    end
+
+    def run
+      logger.info "Formating terraform files"
+      dirs.each do |dir|
+        format(dir)
+      end
+    end
+
+    def format(dir)
+      Runner.new(dir).format!
+    end
+
+  private
+    def dirs
+      if @mod_name
+        type_dirs.select { |p| p.include?(@mod_name) }
+      else
+        type_dirs
+      end
+    end
+
+    def type_dirs
+      type = @options[:type]
+      if type
+        app_source_dirs.select { |p| p.include?("/#{type.pluralize}/") }
+      else
+        app_source_dirs
+      end
+    end
+  end
+end

data/lib/terraspace/cli/fmt/runner.rb

@@ -0,0 +1,64 @@
+class Terraspace::CLI::Fmt
+  class Runner
+    include Terraspace::CLI::Concerns::SourceDirs
+    include Terraspace::Util::Logging
+    SKIP_PATTERN = /\.skip$/
+
+    def initialize(dir)
+      @dir = dir
+    end
+
+    def format!
+      logger.info @dir.color(:green)
+      Dir.chdir(@dir) do
+        skip_rename
+        begin
+          terraform_fmt
+        ensure
+          restore_rename
+        end
+      end
+    end
+
+    def skip_rename
+      tf_files.each do |path|
+        if !skip?(path) && erb?(path)
+          FileUtils.mv(path, "#{path}.skip")
+        end
+      end
+    end
+
+    def terraform_fmt
+      sh "terraform fmt"
+    end
+
+    def sh(command)
+      logger.debug("=> #{command}")
+      success = system(command)
+      return if success
+      logger.info "WARN: There were some errors running terraform fmt for files in #{@dir}:".color(:yellow)
+      logger.info "The errors are shown above"
+    end
+
+    def restore_rename
+      tf_files.each do |path|
+        if skip?(path) && erb?(path)
+          FileUtils.mv(path, path.sub(SKIP_PATTERN, '')) # original name
+        end
+      end
+    end
+
+  private
+    def skip?(path)
+      !!(path =~ SKIP_PATTERN)
+    end
+
+    def erb?(path)
+      IO.readlines(path).detect { |l| l.include?('<%') }
+    end
+
+    def tf_files
+      Dir.glob("#{Terraspace.root}/#{@dir}/**/*.{tf,skip}").select { |p| File.file?(p) }
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+## Example
+
+Format all source files.
+
+    $ terraspace fmt
+    Formating terraform files
+    app/modules/example
+    main.tf
+    outputs.tf
+    variables.tf
+    app/stacks/demo
+    main.tf
+
+Format specific module or stack.
+
+    $ terraspace fmt stack1
+    $ terraspace fmt module1
+
+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

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/cli/list.rb

@@ -1,13 +1,14 @@
 class Terraspace::CLI
   class List
+    include Concerns::SourceDirs
+
     def initialize(options={})
       @options = options
       @type_dir = normalized_type
     end
 
     def run
-      dirs = Dir.glob("{app,vendor}/{modules,stacks}/*").select { |p| File.directory?(p) }
-      dirs.sort.each do |path|
+      source_dirs.each do |path|
         if @type_dir
           puts path if path.include?("/#{@type_dir}/")
         else

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,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/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.3"
+  VERSION = "0.6.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.8
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -482,7 +482,10 @@ files:
 - lib/terraspace/cli/completer.rb
 - lib/terraspace/cli/completer/script.rb
 - lib/terraspace/cli/completer/script.sh
+- lib/terraspace/cli/concerns/source_dirs.rb
 - lib/terraspace/cli/down.rb
+- lib/terraspace/cli/fmt.rb
+- lib/terraspace/cli/fmt/runner.rb
 - lib/terraspace/cli/help.rb
 - lib/terraspace/cli/help/all/down.md
 - lib/terraspace/cli/help/all/graph.md
@@ -504,6 +507,8 @@ files:
 - lib/terraspace/cli/help/completion_script.md
 - 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