(PUP-11993) Style/SpecialGlobalVars

AriaXLi · AriaXLi · commit e08ba15a149c · 2024-03-07T15:23:30.000-08:00
This commit enables the Style/SpecialGlobalVars cop and fixes
41 (unsafe) autocorrectable offenses. Additionally, this commit
includes =&gt; e when rescuing so there is a local reference to the
exception and ERROR_INFO is not needed.
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -693,12 +693,6 @@ Style/SingleLineMethods:
 Style/SoleNestedConditional:
   Enabled: false
 
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: RequireEnglish, EnforcedStyle.
-# SupportedStyles: use_perl_names, use_english_names, use_builtin_english_names
-Style/SpecialGlobalVars:
-  Enabled: false
-
 # This cop supports safe auto-correction (--auto-correct).
 Style/StderrPuts:
   Exclude:
diff --git a/ext/windows/service/daemon.rb b/ext/windows/service/daemon.rb
@@ -207,6 +207,6 @@ def load_env(base_dir)
   end
 end
 
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
   WindowsDaemon.mainloop
 end
diff --git a/lib/puppet/daemon.rb b/lib/puppet/daemon.rb
@@ -83,7 +83,7 @@ def close_streams
   def reexec
     raise Puppet::DevError, _("Cannot reexec unless ARGV arguments are set") unless argv
 
-    command = $0 + " " + argv.join(" ")
+    command = $PROGRAM_NAME + " " + argv.join(" ")
     Puppet.notice "Restarting with '#{command}'"
     stop(:exit => false)
     exec(command)
diff --git a/lib/puppet/file_serving/fileset.rb b/lib/puppet/file_serving/fileset.rb
@@ -104,8 +104,8 @@ def initialize_from_hash(options)
       method = option.to_s + "="
       begin
         send(method, value)
-      rescue NoMethodError
-        raise ArgumentError, _("Invalid option '%{option}'") % { option: option }, $!.backtrace
+      rescue NoMethodError => e
+        raise ArgumentError, _("Invalid option '%{option}'") % { option: option }, e.backtrace
       end
     end
   end
diff --git a/lib/puppet/file_system/uniquefile.rb b/lib/puppet/file_system/uniquefile.rb
@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'English'
 require_relative '../../puppet/file_system'
 require 'delegate'
 require 'tmpdir'
@@ -110,7 +111,7 @@ def make_tmpname(prefix_suffix, n)
       raise ArgumentError, _("unexpected prefix_suffix: %{value}") % { value: prefix_suffix.inspect }
     end
     t = Time.now.strftime("%Y%m%d")
-    path = "#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+    path = "#{prefix}#{t}-#{$PROCESS_ID}-#{rand(0x100000000).to_s(36)}"
     path << "-#{n}" if n
     path << suffix
   end
diff --git a/lib/puppet/provider/package/ports.rb b/lib/puppet/provider/package/ports.rb
@@ -29,8 +29,8 @@ def latest
 
     begin
       output = portversion(*cmd)
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new(output, $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new(output, e)
     end
     line = output.split("\n").pop
 
diff --git a/lib/puppet/provider/package/portupgrade.rb b/lib/puppet/provider/package/portupgrade.rb
@@ -46,8 +46,8 @@ def self.instances
     cmdline = ["-aoQ"]
     begin
       output = portinfo(*cmdline)
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new(output, $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new(output, e)
     end
 
     # split output and match it and populate temp hash
@@ -88,8 +88,8 @@ def install
     # FIXME: it's possible that portinstall prompts for data so locks up.
     begin
       output = portinstall(*cmdline)
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new(output, $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new(output, e)
     end
 
     if output =~ /\*\* No such /
@@ -111,8 +111,8 @@ def latest
 
     begin
       output = portversion(*cmdline)
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new(output, $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new(output, e)
     end
 
     # Check: output format.
@@ -166,8 +166,8 @@ def query
     cmdline = ["-qO", @resource[:name]]
     begin
       output = portinfo(*cmdline)
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new(output, $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new(output, e)
     end
 
     # Check: if output isn't in the right format, return nil
@@ -196,8 +196,8 @@ def uninstall
     cmdline = ["-qO", @resource[:name]]
     begin
       output = portinfo(*cmdline)
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new(output, $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new(output, e)
     end
 
     if output =~ /^(\S+)/
@@ -214,17 +214,17 @@ def update
     cmdline = ["-qO", @resource[:name]]
     begin
       output = portinfo(*cmdline)
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new(output, $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new(output, e)
     end
 
     if output =~ /^(\S+)/
       # output matches, so upgrade the software
       cmdline = ["-M BATCH=yes", Regexp.last_match(1)]
       begin
         output = portupgrade(*cmdline)
-      rescue Puppet::ExecutionFailure
-        raise Puppet::Error.new(output, $!)
+      rescue Puppet::ExecutionFailure => e
+        raise Puppet::Error.new(output, e)
       end
     end
   end
diff --git a/lib/puppet/provider/package/puppetserver_gem.rb b/lib/puppet/provider/package/puppetserver_gem.rb
@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'English'
 unless Puppet::Util::Platform.jruby_fips?
   require 'rubygems/commands/list_command'
 end
@@ -158,7 +159,7 @@ def self.execute_rubygems_list_command(command_options)
       gem_env['GEM_HOME'] = puppetserver_conf['jruby-puppet'].key?('gem-home') ? puppetserver_conf['jruby-puppet']['gem-home'] : puppetserver_default_gem_home
       gem_env['GEM_PATH'] = puppetserver_conf['jruby-puppet'].key?('gem-path') ? puppetserver_conf['jruby-puppet']['gem-path'].join(':') : puppetserver_default_gem_path
     end
-    gem_env['GEM_SPEC_CACHE'] = "/tmp/#{$$}"
+    gem_env['GEM_SPEC_CACHE'] = "/tmp/#{$PROCESS_ID}"
 
     # Remove the 'gem' from the command_options
     command_options.shift
diff --git a/lib/puppet/provider/package/rpm.rb b/lib/puppet/provider/package/rpm.rb
@@ -71,8 +71,8 @@ def self.instances
         # now turn each returned line into a package object
         nevra_to_multiversion_hash(process).each { |hash| packages << new(hash) }
       }
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error, _("Failed to list packages"), $!.backtrace
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error, _("Failed to list packages"), e.backtrace
     end
 
     packages
diff --git a/lib/puppet/provider/service/base.rb b/lib/puppet/provider/service/base.rb
@@ -122,8 +122,8 @@ def stop
       end
       begin
         output = kill pid
-      rescue Puppet::ExecutionFailure
-        @resource.fail Puppet::Error, "Could not kill #{name}, PID #{pid}: #{output}", $!
+      rescue Puppet::ExecutionFailure => e
+        @resource.fail Puppet::Error, "Could not kill #{name}, PID #{pid}: #{output}", e
       end
       true
     end
diff --git a/lib/puppet/provider/service/daemontools.rb b/lib/puppet/provider/service/daemontools.rb
@@ -159,8 +159,8 @@ def enable
         Puppet::FileSystem.symlink(daemon, service)
       end
     end
-  rescue Puppet::ExecutionFailure
-    raise Puppet::Error.new("No daemon directory found for #{service}", $!)
+  rescue Puppet::ExecutionFailure => e
+    raise Puppet::Error.new("No daemon directory found for #{service}", e)
   end
 
   def disable
@@ -175,8 +175,8 @@ def disable
           Puppet::FileSystem.unlink(service)
         end
       end
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new("No daemon directory found for #{service}", $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new("No daemon directory found for #{service}", e)
     end
     stop
   end
diff --git a/lib/puppet/provider/service/gentoo.rb b/lib/puppet/provider/service/gentoo.rb
@@ -16,8 +16,8 @@
 
   def disable
     output = update :del, @resource[:name], :default
-  rescue Puppet::ExecutionFailure
-    raise Puppet::Error, "Could not disable #{name}: #{output}", $!.backtrace
+  rescue Puppet::ExecutionFailure => e
+    raise Puppet::Error, "Could not disable #{name}: #{output}", e.backtrace
   end
 
   def enabled?
@@ -41,7 +41,7 @@ def enabled?
 
   def enable
     output = update :add, @resource[:name], :default
-  rescue Puppet::ExecutionFailure
-    raise Puppet::Error, "Could not enable #{name}: #{output}", $!.backtrace
+  rescue Puppet::ExecutionFailure => e
+    raise Puppet::Error, "Could not enable #{name}: #{output}", e.backtrace
   end
 end
diff --git a/lib/puppet/provider/service/launchd.rb b/lib/puppet/provider/service/launchd.rb
@@ -192,8 +192,8 @@ def self.job_list
       output.split("\n").each do |line|
         @job_list[line.split(/\s/).last] = :running
       end
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new("Unable to determine status of #{resource[:name]}", $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new("Unable to determine status of #{resource[:name]}", e)
     end
     @job_list
   end
@@ -287,8 +287,8 @@ def start
     cmds << job_path
     begin
       execute(cmds)
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new("Unable to start service: #{resource[:name]} at path: #{job_path}", $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new("Unable to start service: #{resource[:name]} at path: #{job_path}", e)
     end
     # As load -w clears the Disabled flag, we need to add it in after
     disable if did_enable_job and resource[:enable] == :false
@@ -310,8 +310,8 @@ def stop
     cmds << job_path
     begin
       execute(cmds)
-    rescue Puppet::ExecutionFailure
-      raise Puppet::Error.new("Unable to stop service: #{resource[:name]} at path: #{job_path}", $!)
+    rescue Puppet::ExecutionFailure => e
+      raise Puppet::Error.new("Unable to stop service: #{resource[:name]} at path: #{job_path}", e)
     end
     # As unload -w sets the Disabled flag, we need to add it in after
     enable if did_disable_job and resource[:enable] == :true
diff --git a/lib/puppet/provider/service/smf.rb b/lib/puppet/provider/service/smf.rb
@@ -208,9 +208,9 @@ def status
       # use that for the state comparison.
       states = service_states
       state = states[:next] || states[:current]
-    rescue Puppet::ExecutionFailure
+    rescue Puppet::ExecutionFailure => e
       # TODO (PUP-8957): Should this be set back to INFO ?
-      debug "Could not get status on service #{name} #{$!}"
+      debug "Could not get status on service #{name} #{e}"
       return :stopped
     end
 
diff --git a/lib/puppet/provider/service/systemd.rb b/lib/puppet/provider/service/systemd.rb
@@ -72,8 +72,8 @@ def enabled_insync?(current)
   # @param action [String,Symbol] One of 'enable', 'disable', 'mask' or 'unmask'
   def systemctl_change_enable(action)
     output = systemctl(action, '--', @resource[:name])
-  rescue
-    raise Puppet::Error, "Could not #{action} #{name}: #{output}", $!.backtrace
+  rescue => e
+    raise Puppet::Error, "Could not #{action} #{name}: #{output}", e.backtrace
   ensure
     @cached_enabled = nil
   end
diff --git a/lib/puppet/type/exec.rb b/lib/puppet/type/exec.rb
@@ -155,8 +155,8 @@ def sync
               sleep try_sleep
             end
           end
-        rescue Timeout::Error
-          self.fail Puppet::Error, _("Command exceeded timeout"), $!
+        rescue Timeout::Error => e
+          self.fail Puppet::Error, _("Command exceeded timeout"), e
         end
 
         log = @resource[:logoutput]
@@ -336,8 +336,8 @@ def value=(*values)
         value = value.shift if value.is_a?(Array)
         begin
           value = Float(value)
-        rescue ArgumentError
-          raise ArgumentError, _("The timeout must be a number."), $!.backtrace
+        rescue ArgumentError => e
+          raise ArgumentError, _("The timeout must be a number."), e.backtrace
         end
         [value, 0.0].max
       end
diff --git a/lib/puppet/util/command_line.rb b/lib/puppet/util/command_line.rb
@@ -31,7 +31,7 @@ class CommandLine
       # @param zero [String] the name of the executable
       # @param argv [Array<String>] the arguments passed on the command line
       # @param stdin [IO] (unused)
-      def initialize(zero = $0, argv = ARGV, stdin = STDIN)
+      def initialize(zero = $PROGRAM_NAME, argv = ARGV, stdin = STDIN)
         @command = File.basename(zero, '.rb')
         @argv = argv
       end
diff --git a/lib/puppet/util/command_line/trollop.rb b/lib/puppet/util/command_line/trollop.rb
@@ -459,8 +459,8 @@ def parse_date_parameter param, arg # :nodoc:
         # chronic is not available
       end
       time ? Date.new(time.year, time.month, time.day) : Date.parse(param)
-    rescue ArgumentError
-      raise CommandlineError, _("option '%{arg}' needs a date") % { arg: arg }, $!.backtrace
+    rescue ArgumentError => e
+      raise CommandlineError, _("option '%{arg}' needs a date") % { arg: arg }, e.backtrace
     end
 
     ## Print the help message to +stream+.
diff --git a/lib/puppet/util/log/destinations.rb b/lib/puppet/util/log/destinations.rb
@@ -19,8 +19,8 @@ def initialize
     str = Puppet[:syslogfacility]
     begin
       facility = Syslog.const_get("LOG_#{str.upcase}")
-    rescue NameError
-      raise Puppet::Error, _("Invalid syslog facility %{str}") % { str: str }, $!.backtrace
+    rescue NameError => e
+      raise Puppet::Error, _("Invalid syslog facility %{str}") % { str: str }, e.backtrace
     end
 
     @syslog = Syslog.open(name, options, facility)
diff --git a/lib/puppet/util/monkey_patches.rb b/lib/puppet/util/monkey_patches.rb
@@ -17,7 +17,7 @@ module RDoc
   def self.caller(skip = nil)
     in_gem_wrapper = false
     Kernel.caller.reject { |call|
-      in_gem_wrapper ||= call =~ /#{Regexp.escape $0}:\d+:in `load'/
+      in_gem_wrapper ||= call =~ /#{Regexp.escape $PROGRAM_NAME}:\d+:in `load'/
     }
   end
 end
diff --git a/lib/puppet/util/rpm_compare.rb b/lib/puppet/util/rpm_compare.rb
@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'English'
 module Puppet::Util::RpmCompare
   ARCH_LIST = %w[
     noarch i386 i686 ppc ppc64 armv3l armv4b armv4l armv4tl armv5tel
@@ -52,29 +53,29 @@ def rpmvercmp(str1, str2)
       # if the first char of str1 is a digit, grab the chunk of continuous digits from each string
       if str1 =~ /^[0-9]+/
         if str1 =~ /^[0-9]+/
-          segment1 = $~.to_s
-          str1 = $~.post_match
+          segment1 = $LAST_MATCH_INFO.to_s
+          str1 = $LAST_MATCH_INFO.post_match
         else
           segment1 = ''
         end
         if str2 =~ /^[0-9]+/
-          segment2 = $~.to_s
-          str2 = $~.post_match
+          segment2 = $LAST_MATCH_INFO.to_s
+          str2 = $LAST_MATCH_INFO.post_match
         else
           segment2 = ''
         end
         isnum = true
       # else grab the chunk of continuous alphas from each string (which may be '')
       else
         if str1 =~ /^[A-Za-z]+/
-          segment1 = $~.to_s
-          str1 = $~.post_match
+          segment1 = $LAST_MATCH_INFO.to_s
+          str1 = $LAST_MATCH_INFO.post_match
         else
           segment1 = ''
         end
         if str2 =~ /^[A-Za-z]+/
-          segment2 = $~.to_s
-          str2 = $~.post_match
+          segment2 = $LAST_MATCH_INFO.to_s
+          str2 = $LAST_MATCH_INFO.post_match
         else
           segment2 = ''
         end
diff --git a/lib/puppet/util/windows/registry.rb b/lib/puppet/util/windows/registry.rb
@@ -21,8 +21,8 @@ module Registry
 
     def root(name)
       Win32::Registry.const_get(name)
-    rescue NameError
-      raise Puppet::Error, _("Invalid registry key '%{name}'") % { name: name }, $!.backtrace
+    rescue NameError => e
+      raise Puppet::Error, _("Invalid registry key '%{name}'") % { name: name }, e.backtrace
     end
 
     def open(name, path, mode = KEY_READ | KEY64, &block)
diff --git a/util/rspec_grouper b/util/rspec_grouper
diff --git a/util/rspec_runner b/util/rspec_runner
