mux_tf 0.15.0 → 0.17.0

data/lib/mux_tf/stderr_line_handler.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "English"
+module MuxTf
+  class StderrLineHandler
+    include PiotrbCliUtils::Util
+    include Coloring
+
+    include ErrorHandlingMethods
+
+    attr_reader :meta
+
+    def initialize(operation: nil)
+      @operation = operation
+      @held_messages = []
+      @parser = StatefulParser.new(normalizer: pastel.method(:strip))
+      @meta = {}
+      setup_error_handling(@parser, from_states: [:none])
+    end
+
+    def transform_paths!(hash, key)
+      return unless hash[key]
+
+      if key == "prefix"
+        hash[key].strip!
+        hash[key].gsub!(/^\[/, "")
+        hash[key].gsub!(/\]$/, "")
+      end
+
+      hash[key].gsub!("#{Dir.getwd}/", "")
+      hash[key].gsub!(Dir.getwd, "")
+
+      hash[key].gsub!($LAST_MATCH_INFO[1], "<cache>/") if hash[key].match(%r{(\.terragrunt-cache/[^/]+/[^/]+/)})
+
+      hash
+    end
+
+    def handle(raw_line)
+      return if raw_line.strip.empty?
+
+      if raw_line =~ /Error when retrieving token from sso: Token has expired and refresh failed/
+        log "#{pastel.red('error')}: SSO Session expired.", depth: 2
+        return
+      end
+
+      # [✘] error when retrieving credentials from custom process. please login using 'granted sso login --sso-start-url https://janeapp.awsapps.com/start --sso-region us-east-1'
+      if raw_line =~ /error when retrieving credentials from custom process. please login using '([^']+)'/
+        unless @sso_expired
+          @sso_expired = true
+          log "#{pastel.red('error')}: SSO Session expired.", depth: 2
+          log "#{pastel.red('error')}: Run: #{$LAST_MATCH_INFO[1]}", depth: 2
+        end
+        return
+      end
+
+      if raw_line.strip[0] == "{" && raw_line.strip[-1] == "}"
+        begin
+          # assuming that stderr is JSON and TG logs
+          parsed_line = JSON.parse(raw_line)
+          transform_paths!(parsed_line, "msg")
+          transform_paths!(parsed_line, "prefix")
+          parsed_line["msg"].gsub!("#{Dir.getwd}/", "")
+          parsed_line["prefix"]&.strip!&.gsub!(/^\[/, "")&.gsub!(/\]$/, "") # rubocop:disable Style/SafeNavigationChainLength
+          parsed_line["prefix"]&.gsub!(Dir.getwd, "")
+          if @operation == :plan
+            handle_plan_json(parsed_line)
+          else
+            log format_tg_log_line(parsed_line), depth: 2
+          end
+        rescue JSON::ParserError => e
+          log "#{pastel.red('error')}: failed to parse JSON: #{e.message}", depth: 2
+          log raw_line.rstrip, depth: 2
+        end
+      else
+        @parser.parse(raw_line.rstrip) do |state, line|
+          # log raw_line.rstrip, depth: 2
+          log_unhandled_line(state, line, reason: "unexpected state in StderrLineHandler") unless handle_error_states(@meta, state, line)
+        end
+      end
+    end
+
+    def handle_plan_json(parsed_line)
+      if parsed_line["msg"] =~ /terraform invocation failed in/
+        @held_messages << format_tg_log_line(parsed_line)
+      elsif parsed_line["msg"] =~ /1 error occurred/ && parsed_line["msg"] =~ /exit status 2\n/
+        # 2 = Succeeded with non-empty diff (changes present)
+        # clear the held messages and swallow up this message too
+        @held_messages = []
+      else
+        # flush
+        log format_tg_log_line(parsed_line), depth: 2
+      end
+    end
+
+    def flush
+      @held_messages.each do |msg|
+        log msg, depth: 2
+      end
+      @held_messages = []
+    end
+
+    def do_print_errors
+      print_errors(@meta) if @meta[:errors] && !@meta[:errors].empty?
+    end
+
+    def merge_meta_into(other_meta)
+      [:errors, :warnings].each do |type|
+        if @meta[type]
+          other_meta[type] ||= []
+          other_meta[type] += @meta[type]
+        end
+      end
+
+      extra_keys = @meta.keys - [:errors, :warnings]
+      return unless extra_keys.any?
+
+      log "Unhandled keys in stderr_handler.meta: #{extra_keys.inspect}"
+      log @meta.inspect
+    end
+
+    private
+
+    def format_tg_log_line(line_data)
+      # {
+      #   "level"=>"error",
+      #   "msg"=>"terraform invocation failed in /Users/piotr/Work/janepods/accounts/eks-dev/unstable-1/kluster/.terragrunt-cache/Gqer3b7TGI4swB-Nw7Pe5DUIrus/JkQqfrQedXyGMwcl4yYfGocMcvk/modules/kluster",
+      #   "prefix"=>"[/Users/piotr/Work/janepods/accounts/eks-dev/unstable-1/kluster] ",
+      #   "time"=>"2024-02-28T16:14:28-08:00"
+      # }
+
+      msg = ""
+      msg += case line_data["level"]
+             when "info"
+               pastel.cyan(line_data["level"])
+             when "error"
+               pastel.red(line_data["level"])
+             else
+               pastel.orange(line_data["level"])
+             end
+      msg += ": #{line_data['msg']}"
+      msg += " [#{line_data['prefix']}]" if line_data["prefix"] && !line_data["prefix"].empty?
+      msg
+    end
+  end
+end

data/lib/mux_tf/terraform_helpers.rb

@@ -11,6 +11,30 @@ module MuxTf
       run_terraform(tf_prepare_command(["force-unlock", "-force", id], need_auth: true))
     end
 
+    def tf_stream_helper(cmd, operation:, echo_stdout: false, &block)
+      # stdout = ""
+
+      stderr_handler = StderrLineHandler.new(operation: operation)
+
+      result_struct = stream_terraform(cmd, split_streams: true) { |(stream, raw_line)|
+        case stream
+        when :command
+          log "Running command: #{raw_line.strip} ...", depth: 2
+        when :stdout
+          # stdout += raw_line
+          print raw_line if echo_stdout
+          block&.call(:stdout, raw_line)
+        when :stderr
+          stderr_handler.handle(raw_line)
+        end
+      }
+
+      stderr_handler.flush
+      stderr_handler.do_print_errors
+
+      result_struct
+    end
+
     def tf_apply(filename: nil, targets: [])
       args = []
       args << filename if filename
@@ -21,26 +45,38 @@ module MuxTf
       end
 
       cmd = tf_prepare_command(["apply", *args], need_auth: true)
-      run_terraform(cmd)
+
+      tf_stream_helper(cmd, operation: :apply, echo_stdout: true)
     end
 
     def tf_validate
       cmd = tf_prepare_command(["validate", "-json"], need_auth: true)
-      capture_terraform(cmd, json: true)
+
+      stdout = ""
+
+      tf_stream_helper(cmd, operation: :validate) do |stream, raw_line|
+        stdout += raw_line if stream == :stdout
+      end
+
+      throw :abort, false if stdout.strip.empty?
+
+      JSON.parse(stdout)
     end
 
-    def tf_init(input: nil, upgrade: nil, reconfigure: nil, color: true, &block)
+    def tf_init(input: nil, upgrade: nil, reconfigure: nil, color: true, json: false, &block)
       args = []
       args << "-input=#{input.inspect}" unless input.nil?
       args << "-upgrade" unless upgrade.nil?
       args << "-reconfigure" unless reconfigure.nil?
       args << "-no-color" unless color
+      args << "-json" if json
 
       cmd = tf_prepare_command(["init", *args], need_auth: true)
-      stream_or_run_terraform(cmd, &block)
+      stream_terraform(cmd, split_streams: true, &block)
     end
 
-    def tf_plan(out:, color: true, detailed_exitcode: nil, compact_warnings: false, input: nil, targets: [], json: false, &block) # rubocop:disable Metrics/CyclomaticComplexity
+    def tf_plan(out:, color: true, detailed_exitcode: nil, compact_warnings: false, input: nil, targets: [], json: false, split_streams: false,
+                &block)
       args = []
       args += ["-out", out]
       args << "-input=#{input.inspect}" unless input.nil?
@@ -55,7 +91,7 @@ module MuxTf
       end
 
       cmd = tf_prepare_command(["plan", *args], need_auth: true)
-      stream_or_run_terraform(cmd, split_streams: json, &block)
+      stream_or_run_terraform(cmd, split_streams: json || split_streams, &block)
     end
 
     def tf_show(file, json: false, capture: false)
@@ -132,7 +168,10 @@ module MuxTf
           stderr_thread.join
           output_queue.close
         end
-        yield(output_queue.pop) until output_queue.closed?
+        until output_queue.closed? && output_queue.empty?
+          value = output_queue.pop
+          yield(value) unless value.nil?
+        end
         wait_thr.value # Process::Status object returned.
       end
     end

data/lib/mux_tf/tmux.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "shellwords"
+require "open3"
 
 module MuxTf
   module Tmux
@@ -23,6 +24,13 @@ module MuxTf
         panes.find { |pane| pane[:name] == name }
       end
 
+      def list_panes
+        `tmux list-panes -F "\#{pane_id},\#{pane_index},\#{pane_title}"`.strip.split("\n").map do |row|
+          x = row.split(",")
+          { id: x[0], index: x[1], name: x[2] }
+        end
+      end
+
       def list_windows
         `tmux list-windows -F "\#{window_id},\#{window_index},\#{window_name}"`.strip.split("\n").map do |row|
           x = row.split(",")
@@ -30,8 +38,15 @@ module MuxTf
         end
       end
 
-      def new_session(name)
-        tmux %(new-session -s #{name.inspect} -d)
+      def new_session(name, cwd: nil, cmd: nil)
+        parts = [
+          "new-session",
+          "-s #{name.inspect}",
+          "-d",
+          cwd ? "-c #{cwd}" : nil,
+          cmd&.inspect
+        ].compact
+        tmux parts.join(" ")
       end
 
       def select_pane(name)
@@ -50,8 +65,23 @@ module MuxTf
         tmux "select-layout tiled"
       end
 
-      def attach(name, cc: false)
-        tmux %(#{(cc && '-CC') || ''} attach -t #{name.inspect}), raise_on_error: false
+      def attach_control(name, on_line:, on_spawn:)
+        parts = [
+          "-C",
+          "attach",
+          "-t #{name.inspect}"
+        ].compact
+        tmux parts.join(" "), raise_on_error: false, mode: :popen, on_line: on_line, on_spawn: on_spawn
+      end
+
+      def attach(name, cc: false, control: false)
+        parts = [
+          cc ? "-CC" : nil,
+          control ? "-C" : nil,
+          "attach",
+          "-t #{name.inspect}"
+        ].compact
+        tmux parts.join(" "), raise_on_error: false
       end
 
       def kill_pane(pane_id)
@@ -75,7 +105,7 @@ module MuxTf
 
         parts = [
           "split-window",
-          cwd && "-c #{cwd}",
+          cwd ? "-c #{cwd}" : nil,
           mode_part,
           "-t #{target_pane.inspect}",
           cmd&.inspect
@@ -89,7 +119,7 @@ module MuxTf
         @tmux_bin ||= `which tmux`.strip
       end
 
-      def tmux(cmd, raise_on_error: true, mode: :system)
+      def tmux(cmd, raise_on_error: true, mode: :system, on_line: nil, on_spawn: nil)
         case mode
         when :system
           # puts " => tmux #{cmd}"
@@ -102,6 +132,25 @@ module MuxTf
           true
         when :exec
           exec tmux_bin, *Shellwords.shellwords(cmd)
+        when :popen
+          Open3.popen3(tmux_bin, *Shellwords.shellwords(cmd)) do |stdin, stdout, stderr, wait_thr|
+            on_spawn&.call(stdin, wait_thr)
+            Thread.new do
+              until stdout.closed? || stdout.eof?
+                line = stdout.gets
+                on_line&.call(:stdout, line)
+              end
+            end
+            Thread.new do
+              until stderr.closed? || stderr.eof?
+                line = stderr.gets
+                on_line&.call(:stderr, line)
+              end
+            end
+            # pid = wait_thr.pid
+            exit_status = wait_thr.value
+            fail_with("`tmux #{cmd}' failed with code: #{exit_status}") if raise_on_error && exit_status != 0
+          end
         end
       end
     end

data/lib/mux_tf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MuxTf
-  VERSION = "0.15.0"
+  VERSION = "0.17.0"
 end

data/lib/mux_tf/yaml_cache.rb

@@ -3,46 +3,63 @@
 require "yaml/store"
 
 # Ruby 2.7's YAML doesn't have a :unsafe_load method .. so we skip all that
-if YAML.singleton_methods.include?(:unsafe_load)
-  module YAML
-    # Explaination from @h4xnoodle:
-    #
-    # Since ruby 3+ and psych 4+, the yaml loading became extra safe so the
-    # expired_at timestamp in the yaml cache is no longer parsing for whatever reason.
-    #
-    # Attempts were made with
-    #
-    # `@store = YAML::Store.new path`
-    # =>
-    # `@store = YAML::Store.new(path, { aliases: true, permitted_classes: [Time] })`
-    # to get it to work but that didn't help, so decided to just bypass the safe
-    # loading, since the file is controlled by us for the version checking.
-    #
-    # This is to override the way that psych seems to be loading YAML.
-    # Instead of using 'load' which needs work to permit the 'Time' class
-    # (which from above I tried that and it wasn't working so I decided to just
-    # bypass and use what it was doing before).
-    # This brings us back to the equivalent that was working before in that unsafe
-    # load was used before the psych upgrade.
-    #
-    # This change: https://my.diffend.io/gems/psych/3.3.2/4.0.0
-    # is the changes that 'cause the problem' and so I'm 'fixing it' by using the old equivalent.
-    #
-    # Maybe the yaml cache needs more work to have
-    # `YAML::Store.new(path, { aliases: true, permitted_classes: [Time] }) work.`
-    #
-    class << self
-      undef load # avoid a warning about the next line redefining load
-      alias load unsafe_load
+# if YAML.singleton_methods.include?(:unsafe_load)
+#   module YAML
+#     # Explaination from @h4xnoodle:
+#     #
+#     # Since ruby 3+ and psych 4+, the yaml loading became extra safe so the
+#     # expired_at timestamp in the yaml cache is no longer parsing for whatever reason.
+#     #
+#     # Attempts were made with
+#     #
+#     # `@store = YAML::Store.new path`
+#     # =>
+#     # `@store = YAML::Store.new(path, { aliases: true, permitted_classes: [Time] })`
+#     # to get it to work but that didn't help, so decided to just bypass the safe
+#     # loading, since the file is controlled by us for the version checking.
+#     #
+#     # This is to override the way that psych seems to be loading YAML.
+#     # Instead of using 'load' which needs work to permit the 'Time' class
+#     # (which from above I tried that and it wasn't working so I decided to just
+#     # bypass and use what it was doing before).
+#     # This brings us back to the equivalent that was working before in that unsafe
+#     # load was used before the psych upgrade.
+#     #
+#     # This change: https://my.diffend.io/gems/psych/3.3.2/4.0.0
+#     # is the changes that 'cause the problem' and so I'm 'fixing it' by using the old equivalent.
+#     #
+#     # Maybe the yaml cache needs more work to have
+#     # `YAML::Store.new(path, { aliases: true, permitted_classes: [Time] }) work.`
+#     #
+#     class << self
+#       undef load # avoid a warning about the next line redefining load
+#       alias load unsafe_load
+#     end
+#   end
+# end
+
+module MuxTf
+  class UnsafeYamlStore < YAML::Store
+    def initialize(*args)
+      super
+      @opt[:permitted_classes] ||= [Symbol]
+    end
+
+    # basically have to override the whole load method, since it doesn't allow customization of the allowed classes ..
+    def load(content)
+      table = YAML.safe_load(content, **@opt)
+      if [false, nil].include?(table)
+        {}
+      else
+        table
+      end
     end
   end
-end
 
-module MuxTf
   class YamlCache
     def initialize(path, default_ttl:)
       @default_ttl = default_ttl
-      @store = YAML::Store.new path
+      @store = UnsafeYamlStore.new path, { aliases: true, permitted_classes: [Symbol, Time] }
     end
 
     def set(key, value, ttl: @default_ttl)

data/lib/mux_tf.rb

@@ -26,19 +26,13 @@ require "diff/lcs"
 require "diff/lcs/string"
 require "diff/lcs/hunk"
 
-require_relative "mux_tf/version"
-require_relative "mux_tf/coloring"
-require_relative "mux_tf/plan_filename_generator"
-require_relative "mux_tf/resource_tokenizer"
-require_relative "mux_tf/cli"
-require_relative "mux_tf/tmux"
-require_relative "mux_tf/terraform_helpers"
-require_relative "mux_tf/plan_formatter"
-require_relative "mux_tf/version_check"
-require_relative "mux_tf/yaml_cache"
-require_relative "mux_tf/plan_summary_handler"
-require_relative "mux_tf/plan_utils"
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/deps.rb")
+loader.setup
 
 module MuxTf
   ROOT = File.expand_path(File.join(__dir__, ".."))
 end
+
+loader.eager_load

data/mux_tf.gemspec

@@ -29,14 +29,25 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  # below activesupport are deps which cause warnings in ruby 3.3
   spec.add_dependency "activesupport", "< 7.0.0"
+  spec.add_dependency "base64"
+  spec.add_dependency "bigdecimal"
+  spec.add_dependency "mutex_m"
+
   spec.add_dependency "awesome_print"
   spec.add_dependency "diff-lcs"
   spec.add_dependency "dotenv"
   spec.add_dependency "hashdiff"
   spec.add_dependency "pastel"
-  spec.add_dependency "piotrb_cli_utils", "~> 0.1.0"
+  spec.add_dependency "piotrb_cli_utils", "~> 0.2.0"
   spec.add_dependency "stateful_parser", "~> 0.1.1"
   spec.add_dependency "tty-prompt"
   spec.add_dependency "tty-table"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+
+  # stdlib suff
+  spec.add_dependency "benchmark"
+  spec.add_dependency "ostruct"
+  spec.add_dependency "pstore"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mux_tf
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Piotr Banasik
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2025-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +23,48 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +141,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: stateful_parser
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +191,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pstore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 email:
 - piotr@jane.app
 executables:
@@ -167,14 +263,21 @@ files:
 - lib/mux_tf.rb
 - lib/mux_tf/cli.rb
 - lib/mux_tf/cli/current.rb
+- lib/mux_tf/cli/current/plan_command.rb
 - lib/mux_tf/cli/mux.rb
 - lib/mux_tf/cli/plan_summary.rb
 - lib/mux_tf/coloring.rb
+- lib/mux_tf/error_handling_methods.rb
+- lib/mux_tf/formatter_common.rb
+- lib/mux_tf/handlers.rb
+- lib/mux_tf/handlers/plan_handler.rb
+- lib/mux_tf/init_formatter.rb
 - lib/mux_tf/plan_filename_generator.rb
 - lib/mux_tf/plan_formatter.rb
 - lib/mux_tf/plan_summary_handler.rb
 - lib/mux_tf/plan_utils.rb
 - lib/mux_tf/resource_tokenizer.rb
+- lib/mux_tf/stderr_line_handler.rb
 - lib/mux_tf/terraform_helpers.rb
 - lib/mux_tf/tmux.rb
 - lib/mux_tf/version.rb
@@ -188,7 +291,6 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/piotrb/mux_tf
   source_code_uri: https://github.com/piotrb/mux_tf
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -203,8 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Terraform Multiplexing Scripts
 test_files: []