(PUP-11993) Style/NumericLiteralPrefix

AriaXLi · AriaXLi · commit 9b06446c1669 · 2024-02-27T00:17:30.000-08:00
This commit enables the Style/NumericLiteralPrefix cop and fixes
74 autocorrectable offenses.
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -629,12 +629,6 @@ Style/MultipleComparison:
 Style/MutableConstant:
   Enabled: false
 
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedOctalStyle.
-# SupportedOctalStyles: zero_with_o, zero_only
-Style/NumericLiteralPrefix:
-  Enabled: false
-
 # This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: Strict, AllowedNumbers.
 Style/NumericLiterals:
diff --git a/lib/puppet/daemon.rb b/lib/puppet/daemon.rb
@@ -68,7 +68,7 @@ def self.close_streams
       Puppet.debug("Finished closing streams for daemon mode")
     rescue => detail
       Puppet.err "Could not start #{Puppet.run_mode.name}: #{detail}"
-      Puppet::Util.replace_file("/tmp/daemonout", 0644) do |f|
+      Puppet::Util.replace_file("/tmp/daemonout", 0o644) do |f|
         f.puts "Could not start #{Puppet.run_mode.name}: #{detail}"
       end
       exit(12)
diff --git a/lib/puppet/file_bucket/dipper.rb b/lib/puppet/file_bucket/dipper.rb
@@ -139,7 +139,7 @@ def restore(file, sum)
         changed = nil
         if Puppet::FileSystem.exist?(file_handle) and !Puppet::FileSystem.writable?(file_handle)
           changed = Puppet::FileSystem.stat(file_handle).mode
-          ::File.chmod(changed | 0200, file)
+          ::File.chmod(changed | 0o200, file)
         end
         ::File.open(file, ::File::WRONLY | ::File::TRUNC | ::File::CREAT) { |of|
           of.binmode
diff --git a/lib/puppet/file_serving/metadata.rb b/lib/puppet/file_serving/metadata.rb
@@ -59,7 +59,7 @@ def group
     end
 
     def mode
-      @source_permissions_ignore ? 0644 : @stat.mode
+      @source_permissions_ignore ? 0o644 : @stat.mode
     end
 
     def_delegators :@stat, :ftype
@@ -78,7 +78,7 @@ def initialize(stat, path, source_permissions)
 
     { :owner => 'S-1-5-32-544',
       :group => 'S-1-0-0',
-      :mode => 0644 }.each do |method, default_value|
+      :mode => 0o644 }.each do |method, default_value|
       define_method method do
         return default_value
       end
@@ -107,7 +107,7 @@ def collect(source_permissions = nil)
     @ftype = stat.ftype
 
     # We have to mask the mode, yay.
-    @mode = stat.mode & 007777
+    @mode = stat.mode & 0o07777
 
     case stat.ftype
     when "file"
diff --git a/lib/puppet/file_system/file_impl.rb b/lib/puppet/file_system/file_impl.rb
@@ -163,9 +163,9 @@ def replace_file(path, mode = nil)
       stat = lstat(path)
       gid = stat.gid
       uid = stat.uid
-      mode ||= stat.mode & 07777
+      mode ||= stat.mode & 0o7777
     rescue Errno::ENOENT
-      mode ||= 0640
+      mode ||= 0o640
     end
 
     tempfile = Puppet::FileSystem::Uniquefile.new(Puppet::FileSystem.basename_string(path), Puppet::FileSystem.dir_string(path))
diff --git a/lib/puppet/file_system/uniquefile.rb b/lib/puppet/file_system/uniquefile.rb
@@ -29,7 +29,7 @@ def self.open_tmp(identifier)
   def initialize(basename, *rest)
     create_tmpname(basename, *rest) do |tmpname, _n, opts|
       mode = File::RDWR | File::CREAT | File::EXCL
-      perm = 0600
+      perm = 0o600
       if opts
         mode |= opts.delete(:mode) || 0
         opts[:perm] = perm
diff --git a/lib/puppet/file_system/windows.rb b/lib/puppet/file_system/windows.rb
@@ -136,11 +136,11 @@ def replace_file(path, mode = nil)
     current_sid = Puppet::Util::Windows::SID.name_to_sid(Puppet::Util::Windows::ADSI::User.current_sam_compatible_user_name) unless current_sid
 
     dacl = case mode
-           when 0644
+           when 0o644
              dacl = secure_dacl(current_sid)
              dacl.allow(Puppet::Util::Windows::SID::BuiltinUsers, FILE_READ)
              dacl
-           when 0660, 0640, 0600, 0440
+           when 0o660, 0o640, 0o600, 0o440
              secure_dacl(current_sid)
            when nil
              get_dacl_from_file(path) || secure_dacl(current_sid)
diff --git a/lib/puppet/indirector/file_bucket_file/file.rb b/lib/puppet/indirector/file_bucket_file/file.rb
@@ -125,7 +125,7 @@ def matches(paths_file, files_original_path)
       # given its possible that request.options[:bucket_path] or Puppet[:bucketdir]
       # contained characters in an encoding that are not represented the
       # same way when the bytes are decoded as UTF-8, continue using system encoding
-      Puppet::FileSystem.open(paths_file, 0640, 'a+:external') do |f|
+      Puppet::FileSystem.open(paths_file, 0o640, 'a+:external') do |f|
         path_match(f, files_original_path)
       end
     end
@@ -152,7 +152,7 @@ def path_match(file_handle, files_original_path)
     #   existing and new backup
     # @api private
     def save_to_disk(bucket_file, files_original_path, contents_file, paths_file)
-      Puppet::Util.withumask(0007) do
+      Puppet::Util.withumask(0o007) do
         unless Puppet::FileSystem.dir_exist?(paths_file)
           Puppet::FileSystem.dir_mkpath(paths_file)
         end
@@ -161,7 +161,7 @@ def save_to_disk(bucket_file, files_original_path, contents_file, paths_file)
         # given its possible that request.options[:bucket_path] or Puppet[:bucketdir]
         # contained characters in an encoding that are not represented the
         # same way when the bytes are decoded as UTF-8, continue using system encoding
-        Puppet::FileSystem.exclusive_open(paths_file, 0640, 'a+:external') do |f|
+        Puppet::FileSystem.exclusive_open(paths_file, 0o640, 'a+:external') do |f|
           if Puppet::FileSystem.exist?(contents_file)
             if verify_identical_file(contents_file, bucket_file)
               # TRANSLATORS "FileBucket" should not be translated
@@ -257,7 +257,7 @@ def contents_file_matches_checksum?(contents_file, expected_checksum_data, check
     # @return [void]
     # @api private
     def copy_bucket_file_to_contents_file(contents_file, bucket_file)
-      Puppet::FileSystem.replace_file(contents_file, 0440) do |of|
+      Puppet::FileSystem.replace_file(contents_file, 0o440) do |of|
         # PUP-1044 writes all of the contents
         bucket_file.stream() do |src|
           FileUtils.copy_stream(src, of)
diff --git a/lib/puppet/indirector/json.rb b/lib/puppet/indirector/json.rb
@@ -16,7 +16,7 @@ def save(request)
     filename = path(request.key)
     FileUtils.mkdir_p(File.dirname(filename))
 
-    Puppet::FileSystem.replace_file(filename, 0660) { |f| f.print to_json(request.instance).force_encoding(Encoding::BINARY) }
+    Puppet::FileSystem.replace_file(filename, 0o660) { |f| f.print to_json(request.instance).force_encoding(Encoding::BINARY) }
   rescue TypeError => detail
     Puppet.log_exception(detail, _("Could not save %{json} %{request}: %{detail}") % { json: self.name, request: request.key, detail: detail })
   end
diff --git a/lib/puppet/indirector/msgpack.rb b/lib/puppet/indirector/msgpack.rb
@@ -24,7 +24,7 @@ def save(request)
     filename = path(request.key)
     FileUtils.mkdir_p(File.dirname(filename))
 
-    Puppet::FileSystem.replace_file(filename, 0660) { |f| f.print to_msgpack(request.instance) }
+    Puppet::FileSystem.replace_file(filename, 0o660) { |f| f.print to_msgpack(request.instance) }
   rescue TypeError => detail
     Puppet.log_exception(detail, _("Could not save %{name} %{request}: %{detail}") % { name: self.name, request: request.key, detail: detail })
   end
diff --git a/lib/puppet/module_tool/tar/mini.rb b/lib/puppet/module_tool/tar/mini.rb
@@ -44,9 +44,9 @@ def pack(sourcedir, destfile)
 
   private
 
-  EXECUTABLE = 0755
-  NOT_EXECUTABLE = 0644
-  USER_EXECUTE = 0100
+  EXECUTABLE = 0o755
+  NOT_EXECUTABLE = 0o644
+  USER_EXECUTE = 0o100
 
   def set_dir_mode!(stats)
     if stats.key?(:mode)
diff --git a/lib/puppet/provider/file/posix.rb b/lib/puppet/provider/file/posix.rb
@@ -128,7 +128,7 @@ def group=(should)
   def mode
     stat = resource.stat
     if stat
-      return (stat.mode & 007777).to_s(8).rjust(4, '0')
+      return (stat.mode & 0o07777).to_s(8).rjust(4, '0')
     else
       return :absent
     end
diff --git a/lib/puppet/provider/service/bsd.rb b/lib/puppet/provider/service/bsd.rb
@@ -36,7 +36,7 @@ def enabled?
   def enable
     Dir.mkdir(rcconf_dir) unless Puppet::FileSystem.exist?(rcconf_dir)
     rcfile = File.join(rcconf_dir, @resource[:name])
-    File.open(rcfile, File::WRONLY | File::APPEND | File::CREAT, 0644) { |f|
+    File.open(rcfile, File::WRONLY | File::APPEND | File::CREAT, 0o644) { |f|
       f << "%s_enable=\"YES\"\n" % @resource[:name]
     }
   end
diff --git a/lib/puppet/provider/service/freebsd.rb b/lib/puppet/provider/service/freebsd.rb
@@ -89,7 +89,7 @@ def rc_add(service, rcvar, yesno)
     append = "\# Added by Puppet\n#{rcvar}_enable=\"#{yesno}\"\n"
     # First, try the one-file-per-service style
     if Puppet::FileSystem.exist?(rcconf_dir)
-      File.open(rcconf_dir + "/#{service}", File::WRONLY | File::APPEND | File::CREAT, 0644) { |f|
+      File.open(rcconf_dir + "/#{service}", File::WRONLY | File::APPEND | File::CREAT, 0o644) { |f|
         f << append
         self.debug("Appended to #{f.path}")
       }
@@ -101,7 +101,7 @@ def rc_add(service, rcvar, yesno)
       }
     else
       # At last use the standard rc.conf file
-      File.open(rcconf, File::WRONLY | File::APPEND | File::CREAT, 0644) { |f|
+      File.open(rcconf, File::WRONLY | File::APPEND | File::CREAT, 0o644) { |f|
         f << append
         self.debug("Appended to #{f.path}")
       }
diff --git a/lib/puppet/provider/service/rcng.rb b/lib/puppet/provider/service/rcng.rb
@@ -41,11 +41,11 @@ def enable
         end
         newcontents.push(line)
       end
-      Puppet::Util.replace_file(rcfile, 0644) do |f|
+      Puppet::Util.replace_file(rcfile, 0o644) do |f|
         f.puts newcontents
       end
     else
-      Puppet::Util.replace_file(rcfile, 0644) do |f|
+      Puppet::Util.replace_file(rcfile, 0o644) do |f|
         f.puts "%s=${%s:=YES}\n" % [@resource[:name], @resource[:name]]
       end
     end
diff --git a/lib/puppet/provider/service/upstart.rb b/lib/puppet/provider/service/upstart.rb
@@ -378,7 +378,7 @@ def read_script_from(filename)
   end
 
   def write_script_to(file, text)
-    Puppet::Util.replace_file(file, 0644) do |f|
+    Puppet::Util.replace_file(file, 0o644) do |f|
       f.write(text)
     end
   end
diff --git a/lib/puppet/provider/user/user_role_add.rb b/lib/puppet/provider/user/user_role_add.rb
@@ -227,7 +227,7 @@ def password=(cryptopw)
       # Go Mifune loves the race here where we can lose data because
       # /etc/shadow changed between reading it and writing it.
       # --daniel 2012-02-05
-      Puppet::Util.replace_file(target_file_path, 0640) do |fh|
+      Puppet::Util.replace_file(target_file_path, 0o640) do |fh|
         shadow.each_line do |line|
           line_arr = line.split(':')
           if line_arr[0] == @resource[:name]
diff --git a/lib/puppet/reports/store.rb b/lib/puppet/reports/store.rb
@@ -21,7 +21,7 @@ def process
 
     unless Puppet::FileSystem.exist?(dir)
       FileUtils.mkdir_p(dir)
-      FileUtils.chmod_R(0750, dir)
+      FileUtils.chmod_R(0o750, dir)
     end
 
     # Now store the report.
@@ -34,7 +34,7 @@ def process
     file = File.join(dir, name)
 
     begin
-      Puppet::FileSystem.replace_file(file, 0640) do |fh|
+      Puppet::FileSystem.replace_file(file, 0o640) do |fh|
         fh.print to_yaml
       end
     rescue => detail
diff --git a/lib/puppet/settings/file_setting.rb b/lib/puppet/settings/file_setting.rb
@@ -215,12 +215,12 @@ def controlled_access(&block)
 
     Puppet::Util::SUIDManager.asuser(*chown) do
       # Update the umask to make non-executable files
-      Puppet::Util.withumask(File.umask ^ 0111) do
+      Puppet::Util.withumask(File.umask ^ 0o111) do
         yielded_value = case self.mode
                         when String
                           self.mode.to_i(8)
                         when NilClass
-                          0640
+                          0o640
                         else
                           self.mode
                         end
diff --git a/lib/puppet/type/file.rb b/lib/puppet/type/file.rb
@@ -962,7 +962,7 @@ def write(property = nil)
         fail_if_checksum_is_wrong(property, file.path, content_checksum)
       end
     else
-      umask = mode ? 000 : 022
+      umask = mode ? 0o00 : 0o22
       Puppet::Util.withumask(umask) { ::File.open(self[:path], 'wb', mode_int) { |f| property.write(f) if property } }
     end
 
diff --git a/lib/puppet/type/file/ensure.rb b/lib/puppet/type/file/ensure.rb
@@ -87,8 +87,8 @@ module Puppet
               "Cannot create #{@resource[:path]}; parent directory #{parent} does not exist"
       end
       if mode
-        Puppet::Util.withumask(000) do
-          Dir.mkdir(@resource[:path], symbolic_mode_to_int(mode, 0755, true))
+        Puppet::Util.withumask(0o00) do
+          Dir.mkdir(@resource[:path], symbolic_mode_to_int(mode, 0o755, true))
         end
       else
         Dir.mkdir(@resource[:path])
diff --git a/lib/puppet/type/file/mode.rb b/lib/puppet/type/file/mode.rb
@@ -111,9 +111,9 @@ def desired_mode_from_current(desired, current)
     def dirmask(value)
       if FileTest.directory?(resource[:path]) and value =~ /^\d+$/ then
         value = value.to_i(8)
-        value |= 0100 if value & 0400 != 0
-        value |= 010 if value & 040 != 0
-        value |= 01 if value & 04 != 0
+        value |= 0o100 if value & 0o400 != 0
+        value |= 0o10 if value & 0o40 != 0
+        value |= 0o1 if value & 0o4 != 0
         value = value.to_s(8)
       end
 
@@ -163,7 +163,7 @@ def retrieve
     # don't have access to the calculated "desired" value here, or the
     # "current" value, only the "should" value we need to retrieve again.
     def sync
-      current = @resource.stat ? @resource.stat.mode : 0644
+      current = @resource.stat ? @resource.stat.mode : 0o644
       set(desired_mode_from_current(@should[0], current).to_s(8))
     end
 
diff --git a/lib/puppet/type/file/target.rb b/lib/puppet/type/file/target.rb
@@ -48,7 +48,7 @@ def mklink
         Puppet::Util::SUIDManager.asuser(@resource.asuser) do
           mode = @resource.should(:mode)
           if mode
-            Puppet::Util.withumask(000) do
+            Puppet::Util.withumask(0o00) do
               Puppet::FileSystem.symlink(target, @resource[:path])
             end
           else
diff --git a/lib/puppet/util.rb b/lib/puppet/util.rb
@@ -579,7 +579,7 @@ def self.format_puppetstack_frame(file_and_lineno)
   # The staging_location is a location to render the temporary file before
   # moving the file to it's final location.
 
-  DEFAULT_POSIX_MODE = 0644
+  DEFAULT_POSIX_MODE = 0o644
   DEFAULT_WINDOWS_MODE = nil
 
   def replace_file(file, default_mode, staging_location: nil, validate_callback: nil, &block)
@@ -626,7 +626,7 @@ def replace_file(file, default_mode, staging_location: nil, validate_callback: n
       if effective_mode
         # We only care about the bottom four slots, which make the real mode,
         # and not the rest of the platform stat call fluff and stuff.
-        tempfile.chmod(effective_mode & 07777)
+        tempfile.chmod(effective_mode & 0o7777)
       end
 
       # Now, make sure the data (which includes the mode) is safe on disk.
diff --git a/lib/puppet/util/log/destinations.rb b/lib/puppet/util/log/destinations.rb
@@ -72,7 +72,7 @@ def initialize(path)
     # We can't just use 'Config.use' here, because they've
     # specified a "special" destination.
     unless Puppet::FileSystem.exist?(Puppet::FileSystem.dir(path))
-      FileUtils.mkdir_p(File.dirname(path), :mode => 0755)
+      FileUtils.mkdir_p(File.dirname(path), :mode => 0o755)
       Puppet.info _("Creating log directory %{dir}") % { dir: File.dirname(path) }
     end
 
diff --git a/lib/puppet/util/selinux.rb b/lib/puppet/util/selinux.rb
@@ -14,9 +14,9 @@
 require 'pathname'
 
 module Puppet::Util::SELinux
-  S_IFREG = 0100000
-  S_IFDIR = 0040000
-  S_IFLNK = 0120000
+  S_IFREG = 0o100000
+  S_IFDIR = 0o040000
+  S_IFLNK = 0o120000
 
   def self.selinux_support?
     return false unless defined?(Selinux)
diff --git a/lib/puppet/util/symbolic_file_mode.rb b/lib/puppet/util/symbolic_file_mode.rb
@@ -60,12 +60,12 @@ def symbolic_mode_to_int(modification, to_mode = 0, is_a_directory = false)
     fail _("non-numeric current mode (%{mode})") % { mode: to_mode.inspect } unless to_mode.is_a?(Numeric)
 
     original_mode = {
-      's' => (to_mode & 07000) >> 9,
-      'u' => (to_mode & 00700) >> 6,
-      'g' => (to_mode & 00070) >> 3,
-      'o' => (to_mode & 00007) >> 0,
+      's' => (to_mode & 0o7000) >> 9,
+      'u' => (to_mode & 0o0700) >> 6,
+      'g' => (to_mode & 0o0070) >> 3,
+      'o' => (to_mode & 0o0007) >> 0,
       # Are there any execute bits set in the original mode?
-      'any x?' => (to_mode & 00111) != 0
+      'any x?' => (to_mode & 0o0111) != 0
     }
     final_mode = {
       's' => original_mode['s'],
diff --git a/lib/puppet/util/windows/security.rb b/lib/puppet/util/windows/security.rb
diff --git a/lib/puppet/util/yaml.rb b/lib/puppet/util/yaml.rb
diff --git a/lib/puppet/x509/pem_store.rb b/lib/puppet/x509/pem_store.rb
