puppet 8.5.1 → 8.7.0

data/lib/puppet/provider/package/windows.rb

@@ -39,11 +39,9 @@ Puppet::Type.type(:package).provide(:windows, :parent => Puppet::Provider::Packa
 
   def self.post_resource_eval
     @paths.each do |path|
-      begin
-        Puppet::FileSystem.unlink(path)
-      rescue => detail
-        raise Puppet::Error.new(_("Error when unlinking %{path}: %{detail}") % { path: path, detail: detail.message }, detail)
-      end
+      Puppet::FileSystem.unlink(path)
+    rescue => detail
+      raise Puppet::Error.new(_("Error when unlinking %{path}: %{detail}") % { path: path, detail: detail.message }, detail)
     end if @paths
   end
 

data/lib/puppet/provider/package/xbps.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative "../../../puppet/provider/package"
+
+Puppet::Type.type(:package).provide :xbps, :parent => Puppet::Provider::Package do
+  desc "Support for the Package Manager Utility (xbps) used in VoidLinux.
+
+  This provider supports the `install_options` attribute, which allows command-line flags to be passed to xbps-install.
+  These options should be specified as an array where each element is either a string or a hash."
+
+  commands :xbps_install => "/usr/bin/xbps-install"
+  commands :xbps_remove => "/usr/bin/xbps-remove"
+  commands :xbps_query => "/usr/bin/xbps-query"
+  commands :xbps_pkgdb => "/usr/bin/xbps-pkgdb"
+
+  confine 'os.name' => :void
+  defaultfor 'os.name' => :void
+  has_feature :install_options, :uninstall_options, :upgradeable, :holdable, :virtual_packages
+
+  def self.defaultto_allow_virtual
+    false
+  end
+
+  # Fetch the list of packages that are currently installed on the system.
+  def self.instances
+    packages = []
+    execpipe([command(:xbps_query), "-l"]) do |pipe|
+      # xbps-query -l output is 'ii package-name-version     desc'
+      regex = /^\S+\s(\S+)-(\S+)\s+\S+/
+      pipe.each_line do |line|
+        match = regex.match(line.chomp)
+        if match
+          packages << new({ name: match.captures[0], ensure: match.captures[1], provider: name })
+        else
+          warning(_("Failed to match line '%{line}'") % { line: line })
+        end
+      end
+    end
+
+    packages
+  rescue Puppet::ExecutionFailure
+    fail(_("Error getting installed packages"))
+  end
+
+  # Install a package quietly (without confirmation or progress bar) using 'xbps-install'.
+  def install
+    resource_name = @resource[:name]
+    resource_source = @resource[:source]
+
+    cmd = %w[-S -y]
+    cmd += install_options if @resource[:install_options]
+    cmd << "--repository=#{resource_source}" if resource_source
+    cmd << resource_name
+
+    unhold if properties[:mark] == :hold
+    begin
+      xbps_install(*cmd)
+    ensure
+      hold if @resource[:mark] == :hold
+    end
+  end
+
+  # Because Voidlinux is a rolling release based distro, installing a package
+  # should always result in the newest release.
+  def update
+    install
+  end
+
+  # Removes a package from the system.
+  def uninstall
+    resource_name = @resource[:name]
+
+    cmd = %w[-R -y]
+    cmd += uninstall_options if @resource[:uninstall_options]
+    cmd << resource_name
+
+    xbps_remove(*cmd)
+  end
+
+  # The latest version of a given package
+  def latest
+    query&.[] :ensure
+  end
+
+  # Queries information for a package
+  def query
+    resource_name = @resource[:name]
+    installed_packages = self.class.instances
+
+    installed_packages.each do |pkg|
+      return pkg.properties if @resource[:name].casecmp(pkg.name).zero?
+    end
+
+    return nil unless @resource.allow_virtual?
+
+    # Search for virtual package
+    output = xbps_query("-Rs", resource_name).chomp
+
+    # xbps-query -Rs output is '[*] package-name-version     description'
+    regex = /^\[\*\]+\s(\S+)-(\S+)\s+\S+/
+    match = regex.match(output)
+
+    return nil unless match
+
+    { name: match.captures[0], ensure: match.captures[1], provider: self.class.name }
+  end
+
+  # Puts a package on hold, so it doesn't update by itself on system update
+  def hold
+    xbps_pkgdb("-m", "hold", @resource[:name])
+  end
+
+  # Puts a package out of hold
+  def unhold
+    xbps_pkgdb("-m", "unhold", @resource[:name])
+  end
+
+  private
+
+  def install_options
+    join_options(@resource[:install_options])
+  end
+
+  def uninstall_options
+    join_options(@resource[:uninstall_options])
+  end
+end

data/lib/puppet/provider/package/yum.rb

@@ -59,12 +59,10 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do
       end
 
       is.split(self.class::MULTIVERSION_SEPARATOR).any? do |version|
-        begin
-          is_version = RPM_VERSION.parse(version)
-          should_version.include?(is_version)
-        rescue RPM_VERSION::ValidationFailure
-          Puppet.debug("Cannot parse #{is} as a RPM version")
-        end
+        is_version = RPM_VERSION.parse(version)
+        should_version.include?(is_version)
+      rescue RPM_VERSION::ValidationFailure
+        Puppet.debug("Cannot parse #{is} as a RPM version")
       end
     end
   end
@@ -126,9 +124,9 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do
     when 100
       updates = parse_updates(output)
     when 0
-      self.debug "#{command(:cmd)} check-update exited with 0; no package updates available."
+      debug "#{command(:cmd)} check-update exited with 0; no package updates available."
     else
-      self.warning _("Could not check for updates, '%{cmd} check-update' exited with %{status}") % { cmd: command(:cmd), status: output.exitstatus }
+      warning _("Could not check for updates, '%{cmd} check-update' exited with %{status}") % { cmd: command(:cmd), status: output.exitstatus }
     end
     updates
   end
@@ -213,15 +211,13 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do
       end
       versions = []
       available_versions(@resource[:name], disablerepo, enablerepo, disableexcludes).each do |version|
-        begin
-          rpm_version = RPM_VERSION.parse(version)
-          versions << rpm_version if should_range.include?(rpm_version)
-        rescue RPM_VERSION::ValidationFailure
-          Puppet.debug("Cannot parse #{version} as a RPM version")
-        end
+        rpm_version = RPM_VERSION.parse(version)
+        versions << rpm_version if should_range.include?(rpm_version)
+      rescue RPM_VERSION::ValidationFailure
+        Puppet.debug("Cannot parse #{version} as a RPM version")
       end
 
-      version = versions.sort.last if versions.any?
+      version = versions.max if versions.any?
 
       if version
         version = version.to_s.sub(/^\d+:/, '')
@@ -255,17 +251,17 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do
     end
 
     should = @resource.should(:ensure)
-    self.debug "Ensuring => #{should}"
+    debug "Ensuring => #{should}"
     operation = :install
 
     case should
     when :latest
-      current_package = self.query
+      current_package = query
       if current_package && !current_package[:ensure].to_s.empty?
         operation = update_command
-        self.debug "Ensuring latest, so using #{operation}"
+        debug "Ensuring latest, so using #{operation}"
       else
-        self.debug "Ensuring latest, but package is absent, so using install"
+        debug "Ensuring latest, but package is absent, so using install"
         operation = :install
       end
       should = nil
@@ -274,7 +270,7 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do
       # version feed it to yum directly
       if @resource[:source]
         wanted = @resource[:source]
-        self.debug "Installing directly from #{wanted}"
+        debug "Installing directly from #{wanted}"
       end
       should = nil
     when false, :absent
@@ -286,26 +282,26 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do
         # version, and also supplying the path to a package that supplies that
         # version.
         wanted = @resource[:source]
-        self.debug "Installing directly from #{wanted}"
+        debug "Installing directly from #{wanted}"
       else
         # No explicit source was specified, so add the package version
         should = best_version(should)
         wanted += "-#{should}"
         if wanted.scan(self.class::ARCH_REGEX)
-          self.debug "Detected Arch argument in package! - Moving arch to end of version string"
+          debug "Detected Arch argument in package! - Moving arch to end of version string"
           wanted.gsub!(/(.+)(#{self.class::ARCH_REGEX})(.+)/, '\1\3\2')
         end
       end
-      current_package = self.query
+      current_package = query
       if current_package
         if @resource[:install_only]
-          self.debug "Updating package #{@resource[:name]} from version #{current_package[:ensure]} to #{should} as install_only packages are never downgraded"
+          debug "Updating package #{@resource[:name]} from version #{current_package[:ensure]} to #{should} as install_only packages are never downgraded"
           operation = update_command
         elsif rpm_compare_evr(should, current_package[:ensure]) < 0
-          self.debug "Downgrading package #{@resource[:name]} from version #{current_package[:ensure]} to #{should}"
+          debug "Downgrading package #{@resource[:name]} from version #{current_package[:ensure]} to #{should}"
           operation = :downgrade
         elsif rpm_compare_evr(should, current_package[:ensure]) > 0
-          self.debug "Upgrading package #{@resource[:name]} from version #{current_package[:ensure]} to #{should}"
+          debug "Upgrading package #{@resource[:name]} from version #{current_package[:ensure]} to #{should}"
           operation = update_command
         end
       end
@@ -313,7 +309,7 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do
 
     # Yum on el-4 and el-5 returns exit status 0 when trying to install a package it doesn't recognize;
     # ensure we capture output to check for errors.
-    no_debug = if Puppet.runtime[:facter].value('os.release.major').to_i > 5 then ["-d", "0"] else [] end
+    no_debug = Puppet.runtime[:facter].value('os.release.major').to_i > 5 ? ["-d", "0"] : []
     command = [command(:cmd)] + no_debug + ["-e", error_level, "-y", install_options, operation, wanted].compact
     output = execute(command)
 
@@ -323,8 +319,8 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do
 
     # If a version was specified, query again to see if it is a matching version
     if should
-      is = self.query
-      raise Puppet::Error, _("Could not find package %{name}") % { name: self.name } unless is
+      is = query
+      raise Puppet::Error, _("Could not find package %{name}") % { name: name } unless is
 
       version = is[:ensure]
       # FIXME: Should we raise an exception even if should == :latest
@@ -337,23 +333,23 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do
   # What's the latest package version available?
   def latest
     upd = self.class.latest_package_version(@resource[:name], disablerepo, enablerepo, disableexcludes)
-    unless upd.nil?
-      # FIXME: there could be more than one update for a package
-      # because of multiarch
-      return "#{upd[:epoch]}:#{upd[:version]}-#{upd[:release]}"
-    else
+    if upd.nil?
       # Yum didn't find updates, pretend the current version is the latest
-      self.debug "Yum didn't find updates, current version (#{properties[:ensure]}) is the latest"
+      debug "Yum didn't find updates, current version (#{properties[:ensure]}) is the latest"
       version = properties[:ensure]
       raise Puppet::DevError, _("Tried to get latest on a missing package") if version == :absent || version == :purged
 
-      return version
+      version
+    else
+      # FIXME: there could be more than one update for a package
+      # because of multiarch
+      "#{upd[:epoch]}:#{upd[:version]}-#{upd[:release]}"
     end
   end
 
   def update
     # Install in yum can be used for update, too
-    self.install
+    install
   end
 
   def purge

data/lib/puppet/provider/package/zypper.rb

@@ -82,7 +82,7 @@ Puppet::Type.type(:package).provide :zypper, :parent => :rpm, :source => :rpm do
         end
       end
 
-      return versions.sort.last if versions.any?
+      return versions.max if versions.any?
 
       Puppet.debug("No available version for package #{@resource[:name]} is included in range #{should_range}")
       should
@@ -92,7 +92,7 @@ Puppet::Type.type(:package).provide :zypper, :parent => :rpm, :source => :rpm do
   # Install a package using 'zypper'.
   def install
     should = @resource.should(:ensure)
-    self.debug "Ensuring => #{should}"
+    debug "Ensuring => #{should}"
     wanted = @resource[:name]
 
     # XXX: We don't actually deal with epochs here.
@@ -112,8 +112,8 @@ Puppet::Type.type(:package).provide :zypper, :parent => :rpm, :source => :rpm do
     # Assume that this will work on newer zypper versions
 
     # extract version numbers and convert to integers
-    major, minor, patch = zypper_version.scan(/\d+/).map { |x| x.to_i }
-    self.debug "Detected zypper version #{major}.#{minor}.#{patch}"
+    major, minor, patch = zypper_version.scan(/\d+/).map(&:to_i)
+    debug "Detected zypper version #{major}.#{minor}.#{patch}"
 
     # zypper version < 1.0 does not support --quiet flag
     if major < 1
@@ -144,29 +144,27 @@ Puppet::Type.type(:package).provide :zypper, :parent => :rpm, :source => :rpm do
 
     zypper(*options)
 
-    unless self.query
-      raise Puppet::ExecutionFailure.new(
-        _("Could not find package %{name}") % { name: self.name }
-      )
+    unless query
+      raise Puppet::ExecutionFailure, _("Could not find package %{name}") % { name: name }
     end
   end
 
   # What's the latest package version available?
   def latest
-    return self.class.latest_package_version(@resource[:name]) ||
-           # zypper didn't find updates, pretend the current
-           # version is the latest
-           @property_hash[:ensure]
+    self.class.latest_package_version(@resource[:name]) ||
+      # zypper didn't find updates, pretend the current
+      # version is the latest
+      @property_hash[:ensure]
   end
 
   def update
     # zypper install can be used for update, too
-    self.install
+    install
   end
 
   def uninstall
     # extract version numbers and convert to integers
-    major, minor, _ = zypper_version.scan(/\d+/).map { |x| x.to_i }
+    major, minor, _ = zypper_version.scan(/\d+/).map(&:to_i)
 
     if major < 1
       super

data/lib/puppet/provider/package.rb

@@ -25,7 +25,7 @@ class Puppet::Provider::Package < Puppet::Provider
       # Purged is the "most uninstalled" a package can be, so a purged package will be in-sync with
       # either `ensure => absent` or `ensure => purged`; an absent package will be out of sync with `ensure => purged`.
       default_status = self.class.feature?(:purgeable) ? :purged : :absent
-      @property_hash = query || { :ensure => (default_status) }
+      @property_hash = query || { :ensure => default_status }
       @property_hash[:ensure] = default_status if @property_hash.empty?
     end
     @property_hash.dup

data/lib/puppet/provider/package_targetable.rb

@@ -34,7 +34,7 @@ class Puppet::Provider::Package::Targetable < Puppet::Provider::Package
         catalog_packages.each do |catalog_package|
           if catalog_package[:name] == instance.name && catalog_package.original_parameters[:command] == command
             catalog_package.provider = instance
-            self.debug "Prefetched instance: %{name} via command: %{cmd}" % { name: instance.name, cmd: (command || :default) }
+            debug "Prefetched instance: %{name} via command: %{cmd}" % { name: instance.name, cmd: command || :default }
           end
         end
       end

data/lib/puppet/provider/parsedfile.rb

@@ -116,9 +116,9 @@ class Puppet::Provider::ParsedFile < Puppet::Provider
   # Return the header placed at the top of each generated file, warning
   # users that modifying this file manually is probably a bad idea.
   def self.header
-    %{# HEADER: This file was autogenerated at #{Time.now}
+    %(# HEADER: This file was autogenerated at #{Time.now}
 # HEADER: by puppet.  While it can still be managed manually, it
-# HEADER: is definitely not recommended.\n}
+# HEADER: is definitely not recommended.\n)
   end
 
   # An optional regular expression matched by third party headers.
@@ -282,7 +282,7 @@ class Puppet::Provider::ParsedFile < Puppet::Provider
     begin
       target_records = retrieve(target)
       unless target_records
-        raise Puppet::DevError, _("Prefetching %{target} for provider %{name} returned nil") % { target: target, name: self.name }
+        raise Puppet::DevError, _("Prefetching %{target} for provider %{name} returned nil") % { target: target, name: name }
       end
     rescue Puppet::Util::FileType::FileReadError => detail
       if @raise_prefetch_errors
@@ -292,7 +292,7 @@ class Puppet::Provider::ParsedFile < Puppet::Provider
         @failed_prefetch_targets[target] = detail.to_s
       else
         puts detail.backtrace if Puppet[:trace]
-        Puppet.err _("Could not prefetch %{resource} provider '%{name}' target '%{target}': %{detail}. Treating as empty") % { resource: self.resource_type.name, name: self.name, target: target, detail: detail }
+        Puppet.err _("Could not prefetch %{resource} provider '%{name}' target '%{target}': %{detail}. Treating as empty") % { resource: resource_type.name, name: name, target: target, detail: detail }
       end
 
       target_records = []
@@ -306,7 +306,7 @@ class Puppet::Provider::ParsedFile < Puppet::Provider
 
     target_records = prefetch_hook(target_records) if respond_to?(:prefetch_hook)
 
-    raise Puppet::DevError, _("Prefetching %{target} for provider %{name} returned nil") % { target: target, name: self.name } unless target_records
+    raise Puppet::DevError, _("Prefetching %{target} for provider %{name} returned nil") % { target: target, name: name } unless target_records
 
     target_records
   end
@@ -325,13 +325,13 @@ class Puppet::Provider::ParsedFile < Puppet::Provider
     text = target_object(path).read
     if text.nil? or text == ""
       # there is no file
-      return []
+      []
     else
       # Set the target, for logging.
       old = @target
       begin
         @target = path
-        return self.parse(text)
+        parse(text)
       rescue Puppet::Error => detail
         detail.file = @target if detail.respond_to?(:file=)
         raise detail
@@ -380,9 +380,9 @@ class Puppet::Provider::ParsedFile < Puppet::Provider
   def self.targets(resources = nil)
     targets = []
     # First get the default target
-    raise Puppet::DevError, _("Parsed Providers must define a default target") unless self.default_target
+    raise Puppet::DevError, _("Parsed Providers must define a default target") unless default_target
 
-    targets << self.default_target
+    targets << default_target
 
     # Then get each of the file objects
     targets += @target_objects.keys

data/lib/puppet/provider/service/base.rb

@@ -35,7 +35,7 @@ Puppet::Type.type(:service).provide :base, :parent => :service do
     regex = Regexp.new(@resource[:pattern])
     ps = getps
 
-    self.debug "Executing '#{ps}'"
+    debug "Executing '#{ps}'"
     table = Puppet::Util::Execution.execute(ps)
 
     # The output of the PS command can be a mashup of several different
@@ -51,11 +51,11 @@ Puppet::Type.type(:service).provide :base, :parent => :service do
     table = table.scrub unless table.valid_encoding?
 
     table.each_line { |line|
-      if regex.match(line)
-        self.debug "Process matched: #{line}"
-        ary = line.sub(/^[[:space:]]+/u, '').split(/[[:space:]]+/u)
-        return ary[1]
-      end
+      next unless regex.match(line)
+
+      debug "Process matched: #{line}"
+      ary = line.sub(/^[[:space:]]+/u, '').split(/[[:space:]]+/u)
+      return ary[1]
     }
 
     nil
@@ -74,17 +74,17 @@ Puppet::Type.type(:service).provide :base, :parent => :service do
 
       # Explicitly calling exitstatus to facilitate testing
       if status.exitstatus == 0
-        return :running
+        :running
       else
-        return :stopped
+        :stopped
       end
     else
       pid = getpid
       if pid
-        self.debug "PID is #{pid}"
-        return :running
+        debug "PID is #{pid}"
+        :running
       else
-        return :stopped
+        :stopped
       end
     end
   end
@@ -102,12 +102,7 @@ Puppet::Type.type(:service).provide :base, :parent => :service do
   # The command used to start.  Generated if the 'binary' argument
   # is passed.
   def startcmd
-    if @resource[:binary]
-      return @resource[:binary]
-    else
-      raise Puppet::Error,
-            "Services must specify a start command or a binary"
-    end
+    @resource[:binary] || raise(Puppet::Error, "Services must specify a start command or a binary")
   end
 
   # Stop the service.  If a 'stop' parameter is specified, it
@@ -122,15 +117,15 @@ Puppet::Type.type(:service).provide :base, :parent => :service do
     else
       pid = getpid
       unless pid
-        self.info _("%{name} is not running") % { name: self.name }
+        info _("%{name} is not running") % { name: name }
         return false
       end
       begin
         output = kill pid
-      rescue Puppet::ExecutionFailure
-        @resource.fail Puppet::Error, "Could not kill #{self.name}, PID #{pid}: #{output}", $!
+      rescue Puppet::ExecutionFailure => e
+        @resource.fail Puppet::Error, "Could not kill #{name}, PID #{pid}: #{output}", e
       end
-      return true
+      true
     end
   end
 

data/lib/puppet/provider/service/bsd.rb

@@ -34,9 +34,9 @@ Puppet::Type.type(:service).provide :bsd, :parent => :init do
   # enable service by creating a service file under rc.conf.d with the
   # proper contents
   def enable
-    Dir.mkdir(rcconf_dir) if not Puppet::FileSystem.exist?(rcconf_dir)
+    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
@@ -44,10 +44,10 @@ Puppet::Type.type(:service).provide :bsd, :parent => :init do
   # Override stop/start commands to use one<cmd>'s and the avoid race condition
   # where provider tries to stop/start the service before it is enabled
   def startcmd
-    [self.initscript, :onestart]
+    [initscript, :onestart]
   end
 
   def stopcmd
-    [self.initscript, :onestop]
+    [initscript, :onestop]
   end
 end