mux_tf 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21e0e5f58ecc6d306e555902ffe4db396a624dcd238cffd4ffa9f601baa44f8a
-  data.tar.gz: 80cd848539404d195931669894311556df35b7a6949a3aaae61f5ee35c9c065b
+  metadata.gz: b79dc73fcdc056b82b415b35dbb624b69e70edf3bc6db7852d8e2ea06f95c1ce
+  data.tar.gz: 119261f6a5f86ff78319cf411d1f24ff35f2c13262a427d3dd3ec990bd4fbd09
 SHA512:
-  metadata.gz: 9be81dd55dcc793400fddffc83af284893d71f02ce7462f7f7f10203114ba9260619887ecbdf92aeb35175f26334c40fef84e7d91e1bc380d0bf976ed7ecd561
-  data.tar.gz: b16d3e6f1b3214912354ff6915e13c64542ed224b16e1ec7d40241218ab2effe292dda60bceb6b7ab8d71292e3cf99c057d14096b39628482e65430c704380f1
+  metadata.gz: dce2287920bef8ea5eafd6b8565b7c2a7b6799ceb4514739a3aa7d7dc5fe0bcb840275824faf824294309b929a40698dc6203ed2755071238ed9008409865277
+  data.tar.gz: 92da3b7540fee9234c8d2b9ecc2cb6b8a4027c8644549777417aff862a3babdb5f66deeb1bd815f7ef43abf256305f26602efe4c93308176a7023d92845125f2

data/exe/tf_current

@@ -8,7 +8,7 @@ begin
   require "mux_tf"
 
   MuxTf::Cli.run(:current, ARGV)
-rescue Exception => e
+rescue Exception => e # rubocop:disable Lint/RescueException
   warn e.full_message
   warn "<press enter>"
   $stdin.gets

data/exe/tf_mux

@@ -8,7 +8,7 @@ begin
   require "mux_tf"
 
   MuxTf::Cli.run(:mux, ARGV)
-rescue Exception => e
+rescue Exception => e # rubocop:disable Lint/RescueException
   warn e.full_message
   warn "<press enter>"
   $stdin.gets

data/exe/tf_plan_summary

@@ -8,7 +8,7 @@ begin
   require "mux_tf"
 
   MuxTf::Cli.run(:plan_summary, ARGV)
-rescue Exception => e
+rescue Exception => e # rubocop:disable Lint/RescueException
   warn e.full_message
   warn "<press enter>"
   $stdin.gets

data/lib/deps.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/inline"
 
 gemfile do

data/lib/mux_tf/cli/current.rb

@@ -10,8 +10,6 @@ module MuxTf
       extend PiotrbCliUtils::CriCommandSupport
       extend PiotrbCliUtils::CmdLoop
 
-      PLAN_FILENAME = "foo.tfplan"
-
       class << self
         def run(args)
           version_check
@@ -30,11 +28,11 @@ module MuxTf
           return launch_cmd_loop(:error) unless run_validate
 
           if ENV["TF_UPGRADE"]
-            upgrade_status, upgrade_meta = run_upgrade
+            upgrade_status, _upgrade_meta = run_upgrade
             return launch_cmd_loop(:error) unless upgrade_status == :ok
           end
 
-          plan_status, @plan_meta = create_plan(PLAN_FILENAME)
+          plan_status, @plan_meta = create_plan(plan_filename)
 
           case plan_status
           when :ok
@@ -44,7 +42,7 @@ module MuxTf
             launch_cmd_loop(plan_status)
           when :changes
             log "Printing Plan Summary ...", depth: 1
-            pretty_plan_summary(PLAN_FILENAME)
+            pretty_plan_summary(plan_filename)
             launch_cmd_loop(plan_status)
           when :unknown
             launch_cmd_loop(plan_status)
@@ -59,17 +57,21 @@ module MuxTf
           exit 1
         end
 
+        def plan_filename
+          PlanFilenameGenerator.for_path
+        end
+
         private
 
         def version_check
-          if VersionCheck.has_updates?
-            log Paint["=" * 80, :yellow]
-            log "New version of #{Paint["mux_tf", :cyan]} is available!"
-            log "You are currently on version: #{Paint[VersionCheck.current_gem_version, :yellow]}"
-            log "Latest version found is: #{Paint[VersionCheck.latest_gem_version, :green]}"
-            log "Run `#{Paint["gem install mux_tf", :green]}` to update!"
-            log Paint["=" * 80, :yellow]
-          end
+          return unless VersionCheck.has_updates?
+
+          log Paint["=" * 80, :yellow]
+          log "New version of #{Paint['mux_tf', :cyan]} is available!"
+          log "You are currently on version: #{Paint[VersionCheck.current_gem_version, :yellow]}"
+          log "Latest version found is: #{Paint[VersionCheck.latest_gem_version, :green]}"
+          log "Run `#{Paint['gem install mux_tf', :green]}` to update!"
+          log Paint["=" * 80, :yellow]
         end
 
         def run_validate
@@ -176,7 +178,7 @@ module MuxTf
 
         def apply_cmd
           define_cmd("apply", summary: "Apply the current plan") do |_opts, _args, _cmd|
-            status = tf_apply(filename: PLAN_FILENAME)
+            status = tf_apply(filename: plan_filename)
             if status.success?
               plan_status = run_plan
               throw :stop, :done if plan_status == :ok
@@ -190,7 +192,7 @@ module MuxTf
           define_cmd("shell", summary: "Open your default terminal in the current folder") do |_opts, _args, _cmd|
             log Paint["Launching shell ...", :yellow]
             log Paint["When it exits you will be back at this prompt.", :yellow]
-            system ENV["SHELL"]
+            system ENV.fetch("SHELL")
           end
         end
 
@@ -208,11 +210,11 @@ module MuxTf
 
             if @plan_meta && @plan_meta["error"] == "lock"
               done = catch(:abort) {
-                if @plan_meta["Operation"] != "OperationTypePlan"
-                  throw :abort unless prompt.yes?(
-                    "Are you sure you want to force unlock a lock for operation: #{@plan_meta["Operation"]}",
-                    default: false
-                  )
+                if @plan_meta["Operation"] != "OperationTypePlan" && !prompt.yes?(
+                  "Are you sure you want to force unlock a lock for operation: #{@plan_meta['Operation']}",
+                  default: false
+                )
+                  throw :abort
                 end
 
                 throw :abort unless prompt.yes?(
@@ -259,17 +261,15 @@ module MuxTf
 
         def interactive_cmd
           define_cmd("interactive", summary: "Apply interactively") do |_opts, _args, _cmd|
-            plan = PlanSummaryHandler.from_file(PLAN_FILENAME)
+            plan = PlanSummaryHandler.from_file(plan_filename)
             begin
-              abort_message = catch :abort do
-                plan.run_interactive
-              end
+              abort_message = catch(:abort) { plan.run_interactive }
               if abort_message
                 log Paint["Aborted: #{abort_message}", :red]
               else
                 run_plan
               end
-            rescue Exception => e
+            rescue Exception => e # rubocop:disable Lint/RescueException
               log e.full_message
               log "Interactive Apply Failed!"
             end
@@ -277,7 +277,7 @@ module MuxTf
         end
 
         def run_plan(targets: [])
-          plan_status, @plan_meta = create_plan(PLAN_FILENAME, targets: targets)
+          plan_status, @plan_meta = create_plan(plan_filename, targets: targets)
 
           case plan_status
           when :ok
@@ -286,7 +286,7 @@ module MuxTf
             log "something went wrong", depth: 1
           when :changes
             log "Printing Plan Summary ...", depth: 1
-            pretty_plan_summary(PLAN_FILENAME)
+            pretty_plan_summary(plan_filename)
           when :unknown
             # nothing
           end

data/lib/mux_tf/cli/mux.rb

@@ -13,7 +13,7 @@ module MuxTf
           backup = {}
           Bundler.with_original_env do
             ENV.keys.grep(/^(RBENV_|RUBYLIB)/).each do |key|
-              backup[key] = ENV[key]
+              backup[key] = ENV.fetch(key)
               ENV.delete(key)
             end
             yield
@@ -104,7 +104,7 @@ module MuxTf
           ignored += ENV["MUX_IGNORE"].split(",") if ENV["MUX_IGNORE"]
 
           dirs = Dir["**/.terraform.lock.hcl"].map { |f| File.dirname(f) }
-          dirs.reject! { |d| d.in?(ignored) }
+          dirs.reject! do |d| d.in?(ignored) end
 
           dirs
         end

data/lib/mux_tf/cli/plan_summary.rb

@@ -23,23 +23,17 @@ module MuxTf
             end
           }.parse!(args)
 
-          if options[:interactive]
-            raise "must specify plan file in interactive mode" if args[0].blank?
-          end
+          raise "must specify plan file in interactive mode" if options[:interactive] && args[0].blank?
 
           plan = if args[0]
-            PlanSummaryHandler.from_file(args[0])
-          else
-            PlanSummaryHandler.from_data(JSON.parse(STDIN.read))
-          end
+                   PlanSummaryHandler.from_file(args[0])
+                 else
+                   PlanSummaryHandler.from_data(JSON.parse($stdin.read))
+                 end
 
           if options[:interactive]
-            abort_message = catch :abort do
-              plan.run_interactive
-            end
-            if abort_message
-              log Paint["Aborted: #{abort_message}", :red]
-            end
+            abort_message = catch(:abort) { plan.run_interactive }
+            log Paint["Aborted: #{abort_message}", :red] if abort_message
           else
             if options[:hierarchy]
               plan.nested_summary.each do |line|

data/lib/mux_tf/once_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MuxTf
   class OnceHelper
     # once = OnceHelper.new
@@ -5,25 +7,21 @@ module MuxTf
 
     class StateEvaluator
       def initialize(once_helper, new_state)
-        if once_helper.state != new_state
+        if once_helper.state == new_state
+          @path = :otherwise
+        else
           once_helper.state = new_state
           @path = :once
-        else
-          @path = :otherwise
         end
       end
 
-      def once(&block)
-        if @path == :then
-          yield
-        end
+      def once
+        yield if @path == :then
         self
       end
 
-      def otherwise(&block)
-        if @path == :otherwise
-          yield
-        end
+      def otherwise
+        yield if @path == :otherwise
         self
       end
     end

data/lib/mux_tf/plan_filename_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module MuxTf
+  class PlanFilenameGenerator
+    def self.for_path(path = Dir.getwd)
+      folder_name = File.basename(path)
+      temp_dir = Dir.tmpdir
+      hash = Digest::MD5.hexdigest(path)
+      "#{temp_dir}/#{folder_name}-#{hash}.tfplan"
+    end
+  end
+end

data/lib/mux_tf/plan_formatter.rb

@@ -6,7 +6,7 @@ module MuxTf
     extend PiotrbCliUtils::Util
 
     class << self
-      def pretty_plan(filename, targets: [])
+      def pretty_plan(filename, targets: []) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         pastel = Pastel.new
 
         once = OnceHelper.new
@@ -15,11 +15,12 @@ module MuxTf
 
         parser = StatefulParser.new(normalizer: pastel.method(:strip))
         parser.state(:info, /^Acquiring state lock/)
-        parser.state(:error, /(╷|Error locking state|Error:)/, %i[none blank info reading])
-        parser.state(:reading, /: (Reading...|Read complete after)/, %i[none info reading])
+        parser.state(:error, /(╷|Error locking state|Error:)/, [:none, :blank, :info, :reading])
+        parser.state(:reading, /: (Reading...|Read complete after)/, [:none, :info, :reading])
         parser.state(:none, /^$/, [:reading])
-        parser.state(:refreshing, /^.+: Refreshing state... \[id=/, %i[none info reading])
-        parser.state(:refreshing, /Refreshing Terraform state in-memory prior to plan.../, %i[none blank info reading])
+        parser.state(:refreshing, /^.+: Refreshing state... \[id=/, [:none, :info, :reading])
+        parser.state(:refreshing, /Refreshing Terraform state in-memory prior to plan.../,
+                     [:none, :blank, :info, :reading])
         parser.state(:refresh_done, /^----------+$/, [:refreshing])
         parser.state(:refresh_done, /^$/, [:refreshing])
         parser.state(:plan_info, /Terraform will perform the following actions:/, [:refresh_done, :none])
@@ -31,7 +32,7 @@ module MuxTf
         parser.state(:error_lock_info, /Lock Info/, [:error])
         parser.state(:error, /^$/, [:error_lock_info])
 
-        parser.state(:plan_error, /^╷|Error: /, %i[refreshing refresh_done])
+        parser.state(:plan_error, /^╷|Error: /, [:refreshing, :refresh_done])
 
         status = tf_plan(out: filename, detailed_exitcode: true, compact_warnings: true, targets: targets) { |raw_line|
           parser.parse(raw_line.rstrip) do |state, line|
@@ -65,13 +66,11 @@ module MuxTf
               meta["error"] = "lock"
               log Paint[line, :red], depth: 2
             when :plan_error
-              once.for(state).once { puts }
+              once.for(state).once do puts end
               meta["error"] = "refresh"
               log Paint[line, :red], depth: 2
             when :error_lock_info
-              if line =~ /([A-Z]+[\S]+)+:\s+(.+)$/
-                meta[$LAST_MATCH_INFO[1]] = $LAST_MATCH_INFO[2]
-              end
+              meta[$LAST_MATCH_INFO[1]] = $LAST_MATCH_INFO[2] if line =~ /([A-Z]+\S+)+:\s+(.+)$/
               log Paint[line, :red], depth: 2
             when :refreshing
               once.for(state).once {
@@ -80,16 +79,16 @@ module MuxTf
                 print "."
               }
             when :plan_legend
-              once.for(state).once { puts }
+              once.for(state).once do puts end
               log line, depth: 2
             when :refresh_done
               once.for(state).once {
                 puts
               }.otherwise {
-                #nothing
+                # nothing
               }
-            when :plan_info
-              once.for(state).once { puts }
+            when :plan_info # rubocop:disable Lint/DuplicateBranch
+              once.for(state).once do puts end
               log line, depth: 2
             when :plan_summary
               log line, depth: 2
@@ -114,7 +113,7 @@ module MuxTf
         remedies
       end
 
-      def run_tf_init(upgrade: nil, reconfigure: nil)
+      def run_tf_init(upgrade: nil, reconfigure: nil) # rubocop:disable Metrics/MethodLength
         pastel = Pastel.new
 
         phase = :init
@@ -145,7 +144,7 @@ module MuxTf
               case stripped_line
               when /^Downloading (?<repo>[^ ]+) (?<version>[^ ]+) for (?<module>[^ ]+)\.\.\./
                 print "D"
-              when /^Downloading (?<repo>[^ ]+) for (?<module>[^ ]+)\.\.\./
+              when /^Downloading (?<repo>[^ ]+) for (?<module>[^ ]+)\.\.\./ # rubocop:disable Lint/DuplicateBranch
                 print "D"
               when /^- (?<module>[^ ]+) in (?<path>.+)$/
                 print "."
@@ -166,7 +165,7 @@ module MuxTf
                 print "."
               when /^Downloading (?<repo>[^ ]+) (?<version>[^ ]+) for (?<module>[^ ]+)\.\.\./
                 print "D"
-              when /^Downloading (?<repo>[^ ]+) for (?<module>[^ ]+)\.\.\./
+              when /^Downloading (?<repo>[^ ]+) for (?<module>[^ ]+)\.\.\./ # rubocop:disable Lint/DuplicateBranch
                 print "D"
               when ""
                 puts
@@ -183,7 +182,7 @@ module MuxTf
               case stripped_line
               when /^Successfully configured/
                 log line, depth: 2
-              when /unless the backend/
+              when /unless the backend/ # rubocop:disable Lint/DuplicateBranch
                 log line, depth: 2
               when ""
                 puts
@@ -205,28 +204,28 @@ module MuxTf
               case stripped_line
               when /^- Reusing previous version of (?<module>.+) from the dependency lock file$/
                 info = $LAST_MATCH_INFO.named_captures
-                log "- [FROM-LOCK] #{info["module"]}", depth: 2
+                log "- [FROM-LOCK] #{info['module']}", depth: 2
               when /^- (?<module>.+) is built in to Terraform$/
                 info = $LAST_MATCH_INFO.named_captures
-                log "- [BUILTIN] #{info["module"]}", depth: 2
+                log "- [BUILTIN] #{info['module']}", depth: 2
               when /^- Finding (?<module>[^ ]+) versions matching "(?<version>.+)"\.\.\./
                 info = $LAST_MATCH_INFO.named_captures
-                log "- [FIND] #{info["module"]} matching #{info["version"].inspect}", depth: 2
+                log "- [FIND] #{info['module']} matching #{info['version'].inspect}", depth: 2
               when /^- Finding latest version of (?<module>.+)\.\.\.$/
                 info = $LAST_MATCH_INFO.named_captures
-                log "- [FIND] #{info["module"]}", depth: 2
+                log "- [FIND] #{info['module']}", depth: 2
               when /^- Installing (?<module>[^ ]+) v(?<version>.+)\.\.\.$/
                 info = $LAST_MATCH_INFO.named_captures
-                log "- [INSTALLING] #{info["module"]} v#{info["version"]}", depth: 2
-              when /^- Installed (?<module>[^ ]+) v(?<version>.+) \(signed by( a)? (?<signed>.+)\)$/
+                log "- [INSTALLING] #{info['module']} v#{info['version']}", depth: 2
+              when /^- Installed (?<module>[^ ]+) v(?<version>.+) \(signed by(?: a)? (?<signed>.+)\)$/
                 info = $LAST_MATCH_INFO.named_captures
-                log "- [INSTALLED] #{info["module"]} v#{info["version"]} (#{info["signed"]})", depth: 2
+                log "- [INSTALLED] #{info['module']} v#{info['version']} (#{info['signed']})", depth: 2
               when /^- Using previously-installed (?<module>[^ ]+) v(?<version>.+)$/
                 info = $LAST_MATCH_INFO.named_captures
-                log "- [USING] #{info["module"]} v#{info["version"]}", depth: 2
+                log "- [USING] #{info['module']} v#{info['version']}", depth: 2
               when /^- Downloading plugin for provider "(?<provider>[^"]+)" \((?<provider_path>[^)]+)\) (?<version>.+)\.\.\.$/
                 info = $LAST_MATCH_INFO.named_captures
-                log "- #{info["provider"]} #{info["version"]}", depth: 2
+                log "- #{info['provider']} #{info['version']}", depth: 2
               when "- Checking for available provider plugins..."
                 # noop
               else
@@ -242,6 +241,7 @@ module MuxTf
               log Paint[line, :yellow], depth: 1
             when :none
               next if line == ""
+
               p [state, line]
             else
               p [state, line]
@@ -252,23 +252,21 @@ module MuxTf
         [status.status, meta]
       end
 
-      def process_validation(info)
+      def process_validation(info) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         remedies = Set.new
 
-        if info["error_count"] > 0 || info["warning_count"] > 0
-          log "Encountered #{Paint[info["error_count"], :red]} Errors and #{Paint[info["warning_count"], :yellow]} Warnings!", depth: 2
+        if (info["error_count"]).positive? || (info["warning_count"]).positive?
+          log "Encountered #{Paint[info['error_count'], :red]} Errors and #{Paint[info['warning_count'], :yellow]} Warnings!", depth: 2
           info["diagnostics"].each do |dinfo|
             color = dinfo["severity"] == "error" ? :red : :yellow
-            log "#{Paint[dinfo["severity"].capitalize, color]}: #{dinfo["summary"]}", depth: 3
+            log "#{Paint[dinfo['severity'].capitalize, color]}: #{dinfo['summary']}", depth: 3
             if dinfo["detail"]&.include?("terraform init")
               remedies << :init
-            elsif /there is no package for .+ cached in/.match?(dinfo["summary"])
+            elsif /there is no package for .+ cached in/.match?(dinfo["summary"]) # rubocop:disable Lint/DuplicateBranch
               remedies << :init
             else
               log dinfo["detail"], depth: 4 if dinfo["detail"]
-              if dinfo["range"]
-                log format_validation_range(dinfo["range"], color), depth: 4
-              end
+              log format_validation_range(dinfo["range"], color), depth: 4 if dinfo["range"]
 
               remedies << :unknown if dinfo["severity"] == "error"
             end
@@ -280,7 +278,7 @@ module MuxTf
 
       private
 
-      def format_validation_range(range, color)
+      def format_validation_range(range, color) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
         # filename: "../../../modules/pods/jane_pod/main.tf"
         # start:
         #   line: 151
@@ -299,12 +297,17 @@ module MuxTf
         # on ../../../modules/pods/jane_pod/main.tf line 151, in module "jane":
         # 151:   jane_resources_preset = var.jane_resources_presetx
         output = []
-        lines_info = lines.size == 1 ? "#{lines.first}:#{columns.first}" : "#{lines.first}:#{columns.first} to #{lines.last}:#{columns.last}"
-        output << "on: #{range["filename"]} line#{lines.size > 1 ? "s" : ""}: #{lines_info}"
+        lines_info = if lines.size == 1
+                       "#{lines.first}:#{columns.first}"
+                     else
+                       "#{lines.first}:#{columns.first} to #{lines.last}:#{columns.last}"
+                     end
+        output << "on: #{range['filename']} line#{lines.size > 1 ? 's' : ''}: #{lines_info}"
 
         if File.exist?(range["filename"])
           file_lines = File.read(range["filename"]).split("\n")
-          extract_range = ([lines.first - context_lines, 0].max)..([lines.last + context_lines, file_lines.length - 1].min)
+          extract_range = (([lines.first - context_lines,
+                             0].max)..([lines.last + context_lines, file_lines.length - 1].min))
           file_lines.each_with_index do |line, index|
             if extract_range.cover?(index + 1)
               if lines.cover?(index + 1)
@@ -316,7 +319,7 @@ module MuxTf
                   start_col = columns.last
                 end
                 painted_line = paint_line(line, color, start_col: start_col, end_col: end_col)
-                output << "#{Paint[">", color]} #{index + 1}: #{painted_line}"
+                output << "#{Paint['>', color]} #{index + 1}: #{painted_line}"
               else
                 output << "  #{index + 1}: #{line}"
               end
@@ -330,7 +333,7 @@ module MuxTf
       def paint_line(line, *paint_options, start_col: 1, end_col: :max)
         end_col = line.length if end_col == :max
         prefix = line[0, start_col - 1]
-        suffix = line[end_col..-1]
+        suffix = line[end_col..]
         middle = line[start_col - 1..end_col - 1]
         "#{prefix}#{Paint[middle, *paint_options]}#{suffix}"
       end