puppet 5.5.14 → 5.5.16

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

@@ -1,11 +1,10 @@
 # Puppet package provider for Python's `pip` package management frontend.
 # <http://pip.pypa.io/>
 
-require 'puppet/provider/package'
+require 'puppet/provider/package_targetable'
 require 'puppet/util/http_proxy'
 
-Puppet::Type.type(:package).provide :pip,
-  :parent => ::Puppet::Provider::Package do
+Puppet::Type.type(:package).provide :pip, :parent => ::Puppet::Provider::Package::Targetable do
 
   desc "Python packages via `pip`.
 
@@ -13,43 +12,24 @@ Puppet::Type.type(:package).provide :pip,
   These options should be specified as a string (e.g. '--flag'), a hash (e.g. {'--flag' => 'value'}),
   or an array where each element is either a string or a hash."
 
-  has_feature :installable, :uninstallable, :upgradeable, :versionable, :install_options
+  has_feature :installable, :uninstallable, :upgradeable, :versionable, :install_options, :targetable
 
-  # Parse lines of output from `pip freeze`, which are structured as
-  # _package_==_version_.
-  def self.parse(line)
-    if line.chomp =~ /^([^=]+)==([^=]+)$/
-      {:ensure => $2, :name => $1, :provider => name}
-    else
-      nil
-    end
-  end
+  # Override the specificity method to return 1 if pip is not set as default provider
+  def self.specificity
+    match = default_match
+    length = match ? match.length : 0
 
-  # Return an array of structured information about every installed package
-  # that's managed by `pip` or an empty array if `pip` is not available.
-  def self.instances
-    packages = []
-    pip_cmd = self.pip_cmd
-    return [] unless pip_cmd
-    command = [pip_cmd, 'freeze']
-    if Puppet::Util::Package.versioncmp(self.pip_version, '8.1.0') >= 0 # a >= b
-      command << '--all'
-    end
-    execpipe command do |process|
-      process.collect do |line|
-        next unless options = parse(line)
-        packages << new(options)
-      end
-    end
+    return 1 if length == 0
 
-    # Pip can also upgrade pip, but it's not listed in freeze so need to special case it
-    # Pip list would also show pip installed version, but "pip list" doesn't exist for older versions of pip (E.G v1.0)
-    # Not needed when "pip freeze --all" is available
-    if Puppet::Util::Package.versioncmp(self.pip_version, '8.1.0') == -1 && version = self.pip_version
-      packages << new({:ensure => version, :name => File.basename(pip_cmd), :provider => name})
-    end
+    super
+  end
 
-    packages
+  # Define the default provider package command name when the provider is targetable.
+  # Required by Puppet::Provider::Package::Targetable::resource_or_provider_command
+
+  def self.provider_command
+    # Ensure pip can upgrade pip, which usually puts pip into a new path /usr/local/bin/pip (compared to /usr/bin/pip)
+    self.cmd.map { |c| which(c) }.find { |c| c != nil }
   end
 
   def self.cmd
@@ -60,104 +40,95 @@ Puppet::Type.type(:package).provide :pip,
     end
   end
 
-  def self.pip_cmd
-    self.cmd.map { |c| which(c) }.find { |c| c != nil }
-  end
-
-  def self.pip_version
-    pip_cmd = self.pip_cmd
-    return nil unless pip_cmd
-
-    execpipe [pip_cmd, '--version'] do |process|
+  def self.pip_version(command)
+    execpipe [command, '--version'] do |process|
       process.collect do |line|
         return line.strip.match(/^pip (\d+\.\d+\.?\d*).*$/)[1]
       end
     end
   end
 
-  # Return structured information about a particular package or `nil` if
-  # it is not installed or `pip` itself is not available.
-  def query
-    self.class.instances.each do |provider_pip|
-      return provider_pip.properties if @resource[:name].downcase == provider_pip.name.downcase
+  # Return an array of structured information about every installed package
+  # that's managed by `pip` or an empty array if `pip` is not available.
+
+  def self.instances(target_command = nil)
+    if target_command
+      command = target_command
+      self.validate_command(command)
+    else
+      command = provider_command
     end
-    return nil
-  end
 
-  # Use pip CLI to look up versions from PyPI repositories, honoring local pip config such as custom repositories
-  def latest
-    return nil unless self.class.pip_cmd
-    if Puppet::Util::Package.versioncmp(self.class.pip_version, '1.5.4') == -1 # a < b
-      return latest_with_old_pip
+    packages = []
+    return packages unless command
+
+    command_options = ['freeze']
+    command_version = self.pip_version(command)
+    if Puppet::Util::Package.versioncmp(command_version, '8.1.0') >= 0
+      command_options << '--all'
     end
-    latest_with_new_pip
-  end
 
-  # Install a package.  The ensure parameter may specify installed,
-  # latest, a version number, or, in conjunction with the source
-  # parameter, an SCM revision.  In that case, the source parameter
-  # gives the fully-qualified URL to the repository.
-  def install
-    args = %w{install -q}
-    args +=  install_options if @resource[:install_options]
-    if @resource[:source]
-      if String === @resource[:ensure]
-        args << "#{@resource[:source]}@#{@resource[:ensure]}#egg=#{
-          @resource[:name]}"
-      else
-        args << "#{@resource[:source]}#egg=#{@resource[:name]}"
-      end
-    else
-      case @resource[:ensure]
-      when String
-        args << "#{@resource[:name]}==#{@resource[:ensure]}"
-      when :latest
-        args << "--upgrade" << @resource[:name]
-      else
-        args << @resource[:name]
+    execpipe [command, command_options] do |process|
+      process.collect do |line|
+        next unless pkg = parse(line)
+        pkg[:command] = command
+        packages << new(pkg)
       end
     end
-    lazy_pip(*args)
-  end
 
-  # Uninstall a package.  Uninstall won't work reliably on Debian/Ubuntu
-  # unless this issue gets fixed.
-  # <http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=562544>
-  def uninstall
-    lazy_pip "uninstall", "-y", "-q", @resource[:name]
+    # Pip can also upgrade pip, but it's not listed in freeze so need to special case it
+    # Pip list would also show pip installed version, but "pip list" doesn't exist for older versions of pip (E.G v1.0)
+    # Not needed when "pip freeze --all" is available.
+    if Puppet::Util::Package.versioncmp(command_version, '8.1.0') == -1
+      packages << new({:ensure => command_version, :name => File.basename(command), :provider => name, :command => command})
+    end
+
+    packages
   end
 
-  def update
-    install
+  # Parse lines of output from `pip freeze`, which are structured as:
+  # _package_==_version_
+
+  def self.parse(line)
+    if line.chomp =~ /^([^=]+)==([^=]+)$/
+      {:ensure => $2, :name => $1, :provider => name}
+    end
   end
 
-  # Execute a `pip` command.  If Puppet doesn't yet know how to do so,
-  # try to teach it and if even that fails, raise the error.
-  private
-  def lazy_pip(*args)
-    pip(*args)
-  rescue NoMethodError => e
-    # Ensure pip can upgrade pip, which usually puts pip into a new path /usr/local/bin/pip (compared to /usr/bin/pip)
-    # The path to pip needs to be looked up again in the subsequent request. Using the preferred approach as noted
-    # in provider.rb ensures this (copied below for reference)
-    #
-    # @note From provider.rb; It is preferred if the commands are not entered with absolute paths as this allows puppet
-    # to search for them using the PATH variable.
-    if pathname = self.class.cmd.map { |c| which(c) }.find { |c| c != nil }
-      self.class.commands :pip => File.basename(pathname)
-      pip(*args)
-    else
-      raise e, "Could not locate command #{self.class.cmd.join(' and ')}.", e.backtrace
+  # Return structured information about a particular package or `nil`
+  # if the package is not installed or `pip` itself is not available.
+
+  def query
+    command = resource_or_provider_command
+    self.class.validate_command(command)
+
+    self.class.instances(command).each do |pkg|
+      return pkg.properties if @resource[:name].downcase == pkg.name.downcase
     end
+    return nil
   end
 
-  def install_options
-    join_options(@resource[:install_options])
+  # Use pip CLI to look up versions from PyPI repositories,
+  # honoring local pip config such as custom repositories.
+
+  def latest
+    command = resource_or_provider_command
+    self.class.validate_command(command)
+
+    command_version = self.class.pip_version(command)
+    if Puppet::Util::Package.versioncmp(command_version, '1.5.4') == -1
+      latest_with_old_pip
+    else
+      latest_with_new_pip
+    end
   end
 
   def latest_with_new_pip
+    command = resource_or_provider_command
+    self.class.validate_command(command)
+
     # Less resource intensive approach for pip version 1.5.4 and above
-    execpipe ["#{self.class.pip_cmd}", "install", "#{@resource[:name]}==versionplease"] do |process|
+    execpipe [command, "install", "#{@resource[:name]}==versionplease"] do |process|
       process.collect do |line|
         # PIP OUTPUT: Could not find a version that satisfies the requirement Django==versionplease (from versions: 1.1.3, 1.8rc1)
         if line =~ /from versions: /
@@ -173,8 +144,11 @@ Puppet::Type.type(:package).provide :pip,
   end
 
   def latest_with_old_pip
+    command = resource_or_provider_command
+    self.class.validate_command(command)
+
     Dir.mktmpdir("puppet_pip") do |dir|
-      execpipe ["#{self.class.pip_cmd}", "install", "#{@resource[:name]}", "-d", "#{dir}", "-v"] do |process|
+      execpipe [command, "install", "#{@resource[:name]}", "-d", "#{dir}", "-v"] do |process|
         process.collect do |line|
           # PIP OUTPUT: Using version 0.10.1 (newest of versions: 0.10.1, 0.10, 0.9, 0.8.1, 0.8, 0.7.2, 0.7.1, 0.7, 0.6.1, 0.6, 0.5.2, 0.5.1, 0.5, 0.4, 0.3.1, 0.3, 0.2, 0.1)
           if line =~ /Using version (.+?) \(newest of versions/
@@ -185,4 +159,55 @@ Puppet::Type.type(:package).provide :pip,
       end
     end
   end
+
+  # Install a package.  The ensure parameter may specify installed,
+  # latest, a version number, or, in conjunction with the source
+  # parameter, an SCM revision.  In that case, the source parameter
+  # gives the fully-qualified URL to the repository.
+
+  def install
+    command = resource_or_provider_command
+    self.class.validate_command(command)
+
+    command_options = %w{install -q}
+    command_options +=  install_options if @resource[:install_options]
+    if @resource[:source]
+      if String === @resource[:ensure]
+        command_options << "#{@resource[:source]}@#{@resource[:ensure]}#egg=#{@resource[:name]}"
+      else
+        command_options << "#{@resource[:source]}#egg=#{@resource[:name]}"
+      end
+    else
+      case @resource[:ensure]
+      when String
+        command_options << "#{@resource[:name]}==#{@resource[:ensure]}"
+      when :latest
+        command_options << "--upgrade" << @resource[:name]
+      else
+        command_options << @resource[:name]
+      end
+    end
+
+    execute([command, command_options])
+  end
+
+  # Uninstall a package. Uninstall won't work reliably on Debian/Ubuntu unless this issue gets fixed.
+  # http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=562544
+
+  def uninstall
+    command = resource_or_provider_command
+    self.class.validate_command(command)
+
+    command_options = ["uninstall", "-y", "-q", @resource[:name]]
+
+    execute([command, command_options])
+  end
+
+  def update
+    install
+  end
+
+  def install_options
+    join_options(@resource[:install_options])
+  end
 end

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

@@ -12,7 +12,7 @@ Puppet::Type.type(:package).provide :pip3,
   These options should be specified as a string (e.g. '--flag'), a hash (e.g. {'--flag' => 'value'}),
   or an array where each element is either a string or a hash."
 
-  has_feature :installable, :uninstallable, :upgradeable, :versionable, :install_options
+  has_feature :installable, :uninstallable, :upgradeable, :versionable, :install_options, :targetable
 
   def self.cmd
     ["pip3"]

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

@@ -1,4 +1,4 @@
-require 'puppet/provider/package'
+require 'puppet/provider/package/gem'
 
 Puppet::Type.type(:package).provide :puppet_gem, :parent => :gem do
   desc "Puppet Ruby Gem support. This provider is useful for managing

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

@@ -155,28 +155,39 @@ Puppet::Type.type(:package).provide :rpm, :source => :rpm, :parent => Puppet::Pr
   end
 
   def uninstall
-    query if get(:arch) == :absent
-    nvr = "#{get(:name)}-#{get(:version)}-#{get(:release)}"
-    arch = ".#{get(:arch)}"
-    # If they specified an arch in the manifest, erase that Otherwise,
-    # erase the arch we got back from the query. If multiple arches are
-    # installed and only the package name is specified (without the
-    # arch), this will uninstall all of them on successive runs of the
-    # client, one after the other
-
-    # version of RPM prior to 4.2.1 can't accept the architecture as
-    # part of the package name.
-    unless Puppet::Util::Package.versioncmp(self.class.current_version, '4.2.1') < 0
-      if @resource[:name][-arch.size, arch.size] == arch
-        nvr += arch
+    query
+    # If version and release (or only version) is specified in the resource,
+    # uninstall using them, otherwise uninstall using only the name of the package.
+    name    = get(:name)
+    version = get(:version)
+    release = get(:release)
+    nav = "#{name}-#{version}"
+    nvr = "#{nav}-#{release}"
+    if @resource[:name].start_with? nvr
+      identifier = nvr
+    else
+      if @resource[:name].start_with? nav
+        identifier = nav
       else
-        nvr += ".#{get(:arch)}"
+        identifier = name
+      end
+    end
+    # If an arch is specified in the resource, uninstall that arch,
+    # otherwise uninstall the arch returned by query.
+    # If multiple arches are installed and arch is not specified,
+    # this will uninstall all of them after successive runs.
+    #
+    # rpm prior to 4.2.1 cannot accept architecture as part of the package name.
+    unless Puppet::Util::Package.versioncmp(self.class.current_version, '4.2.1') < 0
+      arch = ".#{get(:arch)}"
+      if @resource[:name].end_with? arch
+        identifier += arch
       end
     end
 
     flag = ['-e']
     flag += uninstall_options if resource[:uninstall_options]
-    rpm flag, nvr
+    rpm flag, identifier
   end
 
   def update

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

@@ -107,7 +107,7 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do
   end
 
   def self.update_to_hash(pkgname, pkgversion)
-    
+
     # The pkgname string has two parts: name, and architecture. Architecture
     # is the portion of the string following the last "." character. All
     # characters preceding the final dot are the package name. Parse out

data/lib/puppet/provider/package_targetable.rb

@@ -0,0 +1,68 @@
+# Targetable package providers implement a `command` attribute.
+#
+# The `packages` hash passed to `Puppet::Provider::Package::prefetch` is deduplicated,
+# as it is keyed only by name in `Puppet::Transaction::prefetch_if_necessary`.
+#
+# (The `packages` hash passed to ``Puppet::Provider::Package::prefetch`` should be keyed by all namevars,
+# possibly via a `prefetchV2` method that could take a better data structure.)
+#
+# In addition, `Puppet::Provider::Package::properties` calls `query` in the provider.
+require 'puppet/provider/package'
+
+# But `query` in the provider depends upon whether a `command` attribute is defined for the resource.
+# This is a Catch-22.
+#
+# Instead ...
+#
+# Inspect any package to access the catalog (every package includes a reference to the catalog).
+# Inspect the catalog to find all of the `command` attributes for all of the packages of this class.
+# Find all of the package instances using each package `command`, including the default provider command.
+# Assign each instance's `provider` by selecting it from the `packages` hash passed to `prefetch`, based upon `name` and `command`.
+#
+# The original `command` parameter in the catalog is not populated by the default (`:default`) for the parameter in type/package.rb.
+# Rather, the result of the `original_parameters` is `nil` when the `command` parameter is undefined in the catalog.
+
+class Puppet::Provider::Package::Targetable < Puppet::Provider::Package
+  # Prefetch our package list, yo.
+  def self.prefetch(packages)
+    catalog_packages = packages.first[1]::catalog::resources.select{ |p| p.provider.class == self }
+    package_commands = catalog_packages.map { |catalog_package| catalog_package::original_parameters[:command] }.uniq
+    package_commands.each do |command|
+      instances(command).each do |instance|
+        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: %{command}" % { name: instance.name, cmd: (command || :default)}
+          end
+        end
+      end
+    end
+  end
+
+  # Returns the resource command or provider command.
+
+  def resource_or_provider_command
+    resource::original_parameters[:command] || self.class.provider_command
+  end
+
+  # Targetable providers use has_command/is_optional to defer validation of provider suitability.
+  # Evaluate provider suitability here and now by validating that the command is defined and exists.
+  #
+  # cmd: the full path to the package command.
+
+  def self.validate_command(cmd)
+    unless cmd
+      raise Puppet::Error, _("Provider %{name} package command is not functional on this host") % { name: name }
+    end
+    unless File.file?(cmd)
+      raise Puppet::Error, _("Provider %{name} package command '%{cmd}' does not exist on this host") % { name: name, cmd: cmd }
+    end
+  end
+
+  # Return information about the package, its provider, and its (optional) command.
+
+  def to_s
+    cmd = resource[:command] || :default
+    "#{@resource}(provider=#{self.class.name})(command=#{cmd})"
+  end
+end