mux_tf 0.16.0 → 0.17.0

data/lib/mux_tf/plan_summary_handler.rb

@@ -17,7 +17,7 @@ module MuxTf
         if File.exist?("#{file}.json") && File.mtime("#{file}.json").to_f >= File.mtime(file).to_f
           JSON.parse(File.read("#{file}.json"))
         else
-          puts "Analyzing changes ..."
+          puts "Analyzing changes ... #{file}"
           result = tf_show(file, json: true)
           data = result.parsed_output
           File.write("#{file}.json", JSON.dump(data))
@@ -43,7 +43,7 @@ module MuxTf
           :red
         when "read"
           :cyan
-        when "import" # rubocop:disable Lint/DuplicateBranch
+        when "import", "forget" # rubocop:disable Lint/DuplicateBranch
           :cyan
         else
           :reset
@@ -68,6 +68,8 @@ module MuxTf
           "→"
         when "import-update"
           "↗︎"
+        when "forget"
+          "↺"
         else
           action
         end
@@ -99,6 +101,7 @@ module MuxTf
     end
 
     def initialize(data)
+      @data = data
       @parts = []
 
       data["output_changes"]&.each do |output_name, v|
@@ -193,6 +196,13 @@ module MuxTf
             address: v["address"],
             deps: find_deps(data, v["address"])
           }
+        when ["forget"]
+          parts << {
+            type: "resource",
+            action: "forget",
+            address: v["address"],
+            deps: find_deps(data, v["address"])
+          }
         else
           puts "[??] #{v['address']}"
           puts "UNKNOWN RESOURCE ACTIONS: #{v['change']['actions'].inspect}"
@@ -333,6 +343,10 @@ module MuxTf
       end
     end
 
+    def plan_text_output
+      PlanUtils.text_version_of_plan_show_from_data(@data)
+    end
+
     private
 
     attr_reader :parts

data/lib/mux_tf/plan_utils.rb

@@ -12,12 +12,17 @@ module MuxTf
     class << self
       def warning(message, binding_arg: binding)
         stack = binding_arg.send(:caller)
-        stack_line = stack[0].match(/^(?<path>.+):(?<ln>\d+):in `(?<method>.+)'$/).named_captures
-        stack_line["path"].gsub!(MuxTf::ROOT, pastel.gray("{mux_tf}"))
-        msg = [
-          "#{pastel.orange('WARNING')}: #{message}",
-          "at #{pastel.cyan(stack_line['path'])}:#{pastel.white(stack_line['ln'])}:in `#{pastel.cyan(stack_line['method'])}'"
-        ]
+        stack_match = stack[0].match(/^(?<path>.+):(?<ln>\d+):in [`'](?<method>.+)'$/)
+        msg = []
+        if stack_match
+          stack_line = stack_match.named_captures
+          stack_line["path"].gsub!(MuxTf::ROOT, pastel.gray("{mux_tf}"))
+          msg << "#{pastel.orange('WARNING')}: #{message}"
+          msg << "at #{pastel.cyan(stack_line['path'])}:#{pastel.white(stack_line['ln'])}:in `#{pastel.cyan(stack_line['method'])}'"
+        else
+          p [stack_match, stack[0]]
+          msg << "#{pastel.orange('WARNING')}: #{message}"
+        end
         puts msg.join(" - ")
       end
 
@@ -104,11 +109,11 @@ module MuxTf
         else
           false
         end
-      rescue Psych::DisallowedClass => e
-        ap e
+      rescue Psych::DisallowedClass => _e
+        # ap e
         false
-      rescue Psych::SyntaxError => e # rubocop:disable Lint/DuplicateBranch
-        ap e
+      rescue Psych::SyntaxError => _e # rubocop:disable Lint/DuplicateBranch
+        # ap e
         false
       end
 
@@ -122,6 +127,12 @@ module MuxTf
           pastel.red(symbol)
         when "?"
           pastel.orange(symbol)
+        when "±"
+          pastel.bright_red(symbol)
+        when ">"
+          pastel.blue(symbol)
+        when " "
+          symbol
         else
           warning "Unknown symbol: #{symbol.inspect}"
           symbol
@@ -230,32 +241,6 @@ module MuxTf
         format_value_diff(mode, value_arg)
       end
 
-      # def format_value(value_arg, symbol)
-      #   case value_arg
-      #   when Array
-      #     mode = :both
-      #     case symbol
-      #     when "+"
-      #       mode = :right
-      #     when "~"
-      #       mode = :both
-      #     else
-      #       warning "Unknown symbol: #{symbol.inspect}"
-      #     end
-
-      #     format_value_diff(mode, value_arg)
-      #   when Hash
-      #     if value_arg.keys.all? { |k| k.is_a?(Integer) }
-      #       # assuming its a hash notation of array keys changes
-      #       value_arg.keys.sort.map { |k| "[#{k}] #{format_value(value_arg[k], symbol)[0]}" }
-      #     else
-      #       [value_arg.inspect]
-      #     end
-      #   else
-      #     [value_arg.inspect]
-      #   end
-      # end
-
       def get_pretty_action_and_symbol(actions)
         case actions
         when ["delete"]
@@ -273,6 +258,9 @@ module MuxTf
         when ["read"]
           pretty_action = "read"
           symbol = ">"
+        when ["no-op"]
+          pretty_action = "no-op"
+          symbol = " "
         else
           warning "Unknown action: #{actions.inspect}"
           pretty_action = actions.inspect
@@ -311,44 +299,188 @@ module MuxTf
 
         output << ""
         output << "#{global_indent}#{pastel.bold("# #{resource['address']}")} will be #{pretty_action}"
+        output << "#{global_indent}  >> #{action_reason_to_text(resource['action_reason'])}" if resource["action_reason"]
         output << "#{global_indent}#{colorize_symbol(symbol)} resource \"#{resource['type']}\" \"#{resource['name']}\" {"
         diff = tf_show_json_resource_diff(resource)
         max_diff_key_length = diff.map { |change| change[1].length }.max
+
+        fields_which_caused_replacement = []
+
+        if resource["change"]["replace_paths"]
+          if resource["change"]["replace_paths"].length != 1
+            warning "Multiple replace paths found for resource #{resource['address']}: #{resource['change']['replace_paths'].inspect}"
+          elsif resource["change"]["replace_paths"][0].length != 1
+            warning "Multiple fields found to be replaced for resource #{resource['address']}: #{resource['change']['replace_paths'].inspect}"
+          else
+            fields_which_caused_replacement << resource["change"]["replace_paths"][0][0]
+          end
+        end
+
         diff.each do |change|
           change_symbol, key, *_values = change
           prefix = format("#{global_indent}  #{colorize_symbol(change_symbol)} %s = ", key.ljust(max_diff_key_length))
+          suffix = ""
+          suffix = " (forces replacement)" if fields_which_caused_replacement.include?(key)
           blank_prefix = " " * pastel.strip(prefix).length
           format_value(change).each_with_index do |line, index|
             output << if index.zero?
-                        "#{prefix}#{line}"
+                        "#{prefix}#{line}#{suffix}"
                       else
-                        "#{blank_prefix}#{line}"
+                        "#{blank_prefix}#{line}#{suffix}"
                       end
           end
         end
-        # max_diff_key_length = diff.keys.map(&:length).max
-        # diff.each do |key, value|
-        #   prefix = format("#{global_indent}  #{colorize_symbol(symbol)} %s = ", key.ljust(max_diff_key_length))
-        #   blank_prefix = " " * pastel.strip(prefix).length
-        #   format_value(value, symbol).each_with_index do |line, index|
-        #     output << if index.zero?
-        #                 "#{prefix}#{line}"
-        #               else
-        #                 "#{blank_prefix}#{line}"
-        #               end
-        #   end
-        # end
         output << "#{global_indent}}"
 
         output.join("\n")
       end
 
-      def text_version_of_plan_show(plan_filename)
-        result = tf_show(plan_filename, capture: true, json: true)
-        data = result.parsed_output
+      def format_output_value_diff(mode, value_arg)
+        case mode
+        when :both
+          vleft = in_display_representation(value_arg[0])
+          vright = in_display_representation(value_arg[1])
+          if [vleft, vright].any? { |v| v.is_a?(String) && v.include?("\n") }
+            if pastel.strip(vright) == KNOWN_AFTER_APPLY
+              "#{vleft} -> #{vright}".split("\n")
+            else
+              string_diff(pastel.strip(vleft), pastel.strip(vright))
+            end
+          else
+            "#{vleft} -> #{vright}".split("\n")
+          end
+        when :right
+          vright = in_display_representation(value_arg[1])
+          vright.split("\n")
+        when :left, :first
+          vleft = in_display_representation(value_arg[0])
+          vleft.split("\n")
+        end
+      end
+
+      def get_x_type(key, change)
+        return :hash if change[key].is_a?(Hash) || change["#{key}_sensitive"].is_a?(Hash) || change["#{key}_unknown"].is_a?(Hash)
+        return :array if change[key].is_a?(Array) || change["#{key}_sensitive"].is_a?(Array) || change["#{key}_unknown"].is_a?(Array)
+
+        :scalar
+      end
+
+      def get_value_type(change)
+        case change["actions"]
+        when ["create"]
+          get_x_type("after", change)
+        when ["delete"]
+          get_x_type("before", change)
+        when ["update"]
+          bt = get_x_type("before", change)
+          at = get_x_type("after", change)
+          raise "Type mismatch before vs after: #{bt} != #{at}" if bt != at
+
+          at
+        when ["no-op"]
+          :none
+        else
+          raise "Unknown action: #{change['actions'].inspect}"
+        end
+      end
+
+      def prep_before_after(change)
+        before = change["before"]
+        after = change["after"]
+        before = KNOWN_AFTER_APPLY if change["before_unknown"]
+        before = SENSITIVE if change["before_sensitive"]
+        after = KNOWN_AFTER_APPLY if change["after_unknown"]
+        after = SENSITIVE if change["after_sensitive"]
+
+        [before, after]
+      end
+
+      def tf_show_json_output(output_key, output_change, max_outer_key_length)
+        _pretty_action, symbol = get_pretty_action_and_symbol(output_change["actions"])
+
+        output = []
+
+        global_indent = " " * 2
+
+        value_type = get_value_type(output_change)
+
+        start_prefix = format("#{global_indent}#{colorize_symbol(symbol)} %s = ", output_key.ljust(max_outer_key_length))
+        blank_start_prefix = " " * pastel.strip(start_prefix).length
+        outer_mode = :both
+        outer_mode = :right if ["+"].include?(symbol)
+        outer_mode = :left if ["-"].include?(symbol)
+        outer_mode = :right if [" "].include?(symbol)
+
+        case value_type
+        when :hash
+          output << "#{start_prefix}{"
+
+          fake_resource = {
+            "change" => output_change
+          }
+          diff = tf_show_json_resource_diff(fake_resource)
+          max_diff_key_length = diff.map { |change| change[1].length }.max
+
+          diff.each do |change|
+            change_symbol, key, *_values = change
+            prefix = format("#{global_indent}    #{colorize_symbol(change_symbol)} %s = ", key.ljust(max_diff_key_length))
+            suffix = ""
+            blank_prefix = " " * pastel.strip(prefix).length
+            format_value(change).each_with_index do |line, index|
+              output << if index.zero?
+                          "#{prefix}#{line}#{suffix}"
+                        else
+                          "#{blank_prefix}#{line}#{suffix}"
+                        end
+            end
+          end
+
+          output << "#{global_indent}  }"
+        when :array, :scalar, :none
+          before, after = prep_before_after(output_change)
+          format_value_diff(outer_mode, [before, after]).each_with_index do |line, index|
+            output << if index.zero?
+                        "#{start_prefix}#{line}"
+                      else
+                        "#{blank_start_prefix}#{line}"
+                      end
+          end
+        else
+          raise "Unknown value type: #{value_type.inspect}"
+        end
+
+        output.join("\n")
+      end
 
-        # Plan: 0 to add, 1 to change, 0 to destroy.
+      # See https://developer.hashicorp.com/terraform/internals/json-format
+      def action_reason_to_text(action_reason)
+        case action_reason
+        when "replace_because_tainted"
+          "because the object is tainted in the prior state"
+        when "replace_because_cannot_update"
+          "because the provider does not support updating the object, or the changed attributes"
+        when "replace_by_request"
+          "because the user requested the object to be replaced"
+        when "delete_because_no_resource_config"
+          "because the object is no longer in the configuration"
+        when "delete_because_no_module"
+          "because the module this object belongs to is no longer in the configuration"
+        when "delete_because_wrong_repetition"
+          "because of the repetition mode has changed"
+        when "delete_because_count_index"
+          "because the repetition count has changed"
+        when "delete_because_each_key"
+          "because the repetition key has changed"
+        when "read_because_config_unknown"
+          "because reading this will only be possible during apply"
+        when "read_because_dependency_pending"
+          "because reading this will only be possible after a dependency is available"
+        else
+          "because #{action_reason}"
+        end
+      end
 
+      def text_version_of_plan_show_from_data(data)
         output = []
 
         output << "Terraform will perform the following actions:"
@@ -365,7 +497,18 @@ module MuxTf
           output << ""
           output << "Resource Changes:"
           data["resource_changes"].each do |resource|
-            output << tf_show_json_resource(resource) if resource["change"]["actions"] != ["no-op"]
+            next if resource["change"]["actions"] == ["no-op"]
+
+            output << tf_show_json_resource(resource)
+          end
+        end
+
+        if data["output_changes"]
+          output << ""
+          output << "Changes to Outputs:"
+          max_outer_key_length = data["output_changes"].keys.map(&:length).max || 0
+          data["output_changes"].each do |key, output_change|
+            output << tf_show_json_output(key, output_change, max_outer_key_length)
           end
         end
 

data/lib/mux_tf/stderr_line_handler.rb

@@ -60,7 +60,7 @@ module MuxTf
           transform_paths!(parsed_line, "msg")
           transform_paths!(parsed_line, "prefix")
           parsed_line["msg"].gsub!("#{Dir.getwd}/", "")
-          parsed_line["prefix"]&.strip!&.gsub!(/^\[/, "")&.gsub!(/\]$/, "")
+          parsed_line["prefix"]&.strip!&.gsub!(/^\[/, "")&.gsub!(/\]$/, "") # rubocop:disable Style/SafeNavigationChainLength
           parsed_line["prefix"]&.gsub!(Dir.getwd, "")
           if @operation == :plan
             handle_plan_json(parsed_line)

data/lib/mux_tf/terraform_helpers.rb

@@ -63,12 +63,13 @@ module MuxTf
       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_terraform(cmd, split_streams: true, &block)

data/lib/mux_tf/version.rb

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

data/lib/mux_tf/version_check.rb

@@ -25,6 +25,6 @@ module MuxTf
       @cache ||= YamlCache.new(File.expand_path("~/.mux_tf.yaml"), default_ttl: 1.hour)
     end
 
-    module_function :has_updates?, :latest_gem_version, :current_gem_version, :cache # rubocop:disable Style/AccessModifierDeclarations
+    module_function :has_updates?, :latest_gem_version, :current_gem_version, :cache
   end
 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/mux_tf.gemspec

@@ -40,9 +40,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dotenv"
   spec.add_dependency "hashdiff"
   spec.add_dependency "pastel"
-  spec.add_dependency "piotrb_cli_utils", "~> 0.1.1"
+  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.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Piotr Banasik
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,14 +141,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: stateful_parser
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +205,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-description:
+- !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:
@@ -228,8 +268,10 @@ files:
 - 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
@@ -249,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
@@ -264,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: []