puppet 5.0.0 → 6.0.0

data/lib/puppet/provider/user/useradd.rb

@@ -16,6 +16,7 @@ Puppet::Type.type(:user).provide :useradd, :parent => Puppet::Provider::NameServ
   options :groups, :flag => "-G"
   options :password_min_age, :flag => "-m", :method => :sp_min
   options :password_max_age, :flag => "-M", :method => :sp_max
+  options :password_warn_days, :flag => "-W", :method => :sp_warn
   options :password, :method => :sp_pwdp
   options :expiry, :method => :sp_expire,
     :munge => proc { |value|
@@ -41,7 +42,7 @@ Puppet::Type.type(:user).provide :useradd, :parent => Puppet::Provider::NameServ
       end
     }
 
-  optional_commands :localadd => "luseradd"
+  optional_commands :localadd => "luseradd", :localdelete => "luserdel", :localmodify => "lusermod", :localpassword => "lchage"
   has_feature :libuser if Puppet.features.libuser?
 
   def exists?
@@ -156,7 +157,7 @@ Puppet::Type.type(:user).provide :useradd, :parent => Puppet::Provider::NameServ
     # sort them to have a predictable command line in tests
     Puppet::Type.type(:user).validproperties.sort.each do |property|
       next if property == :ensure
-      next if property.to_s =~ /password_.+_age/
+      next if property_manages_password_age?(property)
       next if property == :groups and @resource.forcelocal?
       next if property == :expiry and @resource.forcelocal?
       # the value needs to be quoted, mostly because -c might
@@ -185,22 +186,51 @@ Puppet::Type.type(:user).provide :useradd, :parent => Puppet::Provider::NameServ
     cmd << @resource[:name]
   end
 
+  def modifycmd(param, value)
+    if @resource.forcelocal?
+      if param == :groups
+        cmd = [command(:modify)]
+      else
+        cmd = [command(property_manages_password_age?(param) ? :localpassword : :localmodify)]
+      end
+      @custom_environment = Puppet::Util::Libuser.getenv
+    else
+      cmd = [command(property_manages_password_age?(param) ? :password : :modify)]
+    end
+    cmd << flag(param) << value
+    cmd += check_allow_dup if param == :uid
+    cmd << @resource[:name]
+
+    cmd
+  end
+
   def deletecmd
-    cmd = [command(:delete)]
+    if @resource.forcelocal?
+      cmd = [command(:localdelete)]
+      @custom_environment = Puppet::Util::Libuser.getenv
+    else
+      cmd = [command(:delete)]
+    end
     cmd += @resource.managehome? ? ['-r'] : []
     cmd << @resource[:name]
   end
 
   def passcmd
-    age_limits = [:password_min_age, :password_max_age].select { |property| @resource.should(property) }
+    if @resource.forcelocal?
+      cmd = command(:localpassword)
+      @custom_environment = Puppet::Util::Libuser.getenv
+    else
+      cmd = command(:password)
+    end
+    age_limits = [:password_min_age, :password_max_age, :password_warn_days].select { |property| @resource.should(property) }
     if age_limits.empty?
       nil
     else
-      [command(:password),age_limits.collect { |property| [flag(property), @resource.should(property)]}, @resource[:name]].flatten
+      [cmd, age_limits.collect { |property| [flag(property), @resource.should(property)]}, @resource[:name]].flatten
     end
   end
 
-  [:expiry, :password_min_age, :password_max_age, :password].each do |shadow_property|
+  [:expiry, :password_min_age, :password_max_age, :password_warn_days, :password].each do |shadow_property|
     define_method(shadow_property) do
       if Puppet.features.libshadow?
         if ent = Shadow::Passwd.getspnam(@canonical_name)
@@ -228,4 +258,8 @@ Puppet::Type.type(:user).provide :useradd, :parent => Puppet::Provider::NameServ
   def groups?
     !!@resource[:groups]
   end
+
+  def property_manages_password_age?(property)
+    property.to_s =~ /password_.+_age|password_warn_days/
+  end
 end

data/lib/puppet/provider/user/windows_adsi.rb

@@ -52,7 +52,7 @@ Puppet::Type.type(:user).provide :windows_adsi do
   def groups_to_s(groups)
     return '' if groups.nil? || !groups.kind_of?(Array)
     groups = groups.map do |group_name|
-      sid = Puppet::Util::Windows::SID.name_to_sid_object(group_name)
+      sid = Puppet::Util::Windows::SID.name_to_principal(group_name)
       if sid.account =~ /\\/
         account, _ = Puppet::Util::Windows::ADSI::Group.parse_name(sid.account)
       else

data/lib/puppet/provider.rb

@@ -143,7 +143,7 @@ class Puppet::Provider
     elsif superclass.respond_to? :command and command = superclass.command(name)
       # nothing
     else
-      raise Puppet::DevError, "No command #{name} defined for provider #{self.name}"
+      raise Puppet::DevError, _("No command %{command} defined for provider %{provider}") % { command: name, provider: self.name }
     end
 
     which(command)
@@ -278,7 +278,12 @@ class Puppet::Provider
   # @see Provider.defaultfor
   # @api private
   def self.default_match
-    @defaults.find do |default|
+    return nil if some_default_match(@notdefaults) # Blacklist means this provider cannot be a default
+    some_default_match(@defaults)
+  end
+
+  def self.some_default_match(defaultlist)
+    defaultlist.find do |default|
       default.all? do |key, values|
         case key
           when :feature
@@ -290,16 +295,26 @@ class Puppet::Provider
     end
   end
 
+  # Compare a fact value against one or more supplied value
+  # @param [Symbol] fact a fact to query to match against one of the given values
+  # @param [Array, Regexp, String] values one or more values to compare to the
+  #   value of the given fact
+  # @return [Boolean] whether or not the fact value matches one of the supplied
+  #   values. Given one or more Regexp instances, fact is compared via the basic
+  #   pattern-matching operator.
   def self.fact_match(fact, values)
-    values = [values] unless values.is_a? Array
-    values.map! { |v| v.to_s.downcase.intern }
-
-    if fval = Facter.value(fact).to_s and fval != ""
-      fval = fval.to_s.downcase.intern
-
-      values.include?(fval)
+    fact_val = Facter.value(fact).to_s.downcase
+    if fact_val.empty?
+      return false
     else
-      false
+      values = [values] unless values.is_a?(Array)
+      values.any? do |value|
+        if value.is_a?(Regexp)
+          fact_val =~ value
+        else
+          fact_val.intern == value.to_s.downcase.intern
+        end
+      end
     end
   end
 
@@ -319,6 +334,10 @@ class Puppet::Provider
     @defaults << hash
   end
 
+  def self.notdefaultfor(hash)
+    @notdefaults << hash
+  end
+
   # @return [Integer] Returns a numeric specificity for this provider based on how many requirements it has
   #  and number of _ancestors_. The higher the number the more specific the provider.
   # The number of requirements is based on the hash size of the matching {Provider.defaultfor}.
@@ -336,6 +355,7 @@ class Puppet::Provider
     # complexity of a provider).
     match = default_match
     length = match ? match.length : 0
+
     (length * 100) + ancestors.select { |a| a.is_a? Class }.length
   end
 
@@ -343,6 +363,7 @@ class Puppet::Provider
   # @return [void]
   def self.initvars
     @defaults = []
+    @notdefaults = []
     @commands = {}
   end
 
@@ -374,7 +395,7 @@ class Puppet::Provider
   # @raise [Puppet::DevError] Error indicating that the method should have been implemented by subclass.
   # @see prefetch
   def self.instances
-    raise Puppet::DevError, "Provider #{self.name} has not defined the 'instances' class method"
+    raise Puppet::DevError, _("Provider %{provider} has not defined the 'instances' class method") % { provider: self.name }
   end
 
   # Creates getter- and setter- methods for each property supported by the resource type.
@@ -446,7 +467,7 @@ class Puppet::Provider
       klass = param
     else
       unless klass = resource_type.attrclass(param)
-        raise Puppet::DevError, "'#{param}' is not a valid parameter for #{resource_type.name}"
+        raise Puppet::DevError, _("'%{parameter_name}' is not a valid parameter for %{resource_type}") % { parameter_name: param, resource_type: resource_type.name }
       end
     end
     return true unless features = klass.required_features
@@ -530,7 +551,7 @@ class Puppet::Provider
     elsif self.resource
       resource.name
     else
-      raise Puppet::DevError, "No resource and no name in property hash in #{self.class.name} instance"
+      raise Puppet::DevError, _("No resource and no name in property hash in %{class_name} instance") % { class_name: self.class.name }
     end
   end
 

data/lib/puppet/reference/configuration.rb

@@ -34,6 +34,8 @@ config = Puppet::Util::Reference.newreference(:configuration, :depth => 1, :doc
       val = 'Unix/Linux: /var/log/puppetlabs/puppet -- Windows: C:\ProgramData\PuppetLabs\puppet\var\log -- Non-root user: ~/.puppetlabs/var/log'
     elsif name.to_s == 'hiera_config'
       val = '$confdir/hiera.yaml. However, if a file exists at $codedir/hiera.yaml, Puppet uses that instead.'
+    elsif name.to_s == 'certname'
+      val = "the Host's fully qualified domain name, as determined by facter"
     end
 
     # Leave out the section information; it was apparently confusing people.
@@ -48,10 +50,16 @@ config = Puppet::Util::Reference.newreference(:configuration, :depth => 1, :doc
 end
 
 config.header = <<EOT
-## Configuration Settings
+## Configuration settings
 
 * Each of these settings can be specified in `puppet.conf` or on the
   command line.
+* Puppet Enterprise (PE) and open source Puppet share the configuration settings
+  that are documented here. However, PE defaults for some settings differ from
+  the open source Puppet defaults. Some examples of settings that have different
+  PE defaults include `disable18n`, `environment_timeout`, `always_retry_plugins`,
+  and the Puppet Server JRuby `max-active-instances` setting. To verify PE
+  configuration defaults, check the `puppet.conf` file after installation.
 * When using boolean settings on the command line, use `--setting` and
   `--no-setting` instead of `--setting (true|false)`. (Using `--setting false`
   results in "Error: Could not parse application options: needless argument".)
@@ -67,6 +75,8 @@ config.header = <<EOT
   combined with other units, and defaults to seconds when omitted. Examples are
   '3600' which is equivalent to '1h' (one hour), and '1825d' which is equivalent
   to '5y' (5 years).
+* If you use the `splay` setting, note that the period that it waits changes
+  each time the Puppet agent is restarted.
 * Settings that take a single file or directory can optionally set the owner,
   group, and mode for their value: `rundir = $vardir/run { owner = puppet,
   group = puppet, mode = 644 }`
@@ -75,7 +85,7 @@ config.header = <<EOT
 
 See the [configuration guide][confguide] for more details.
 
-[confguide]: http://docs.puppetlabs.com/puppet/latest/reference/config_about_settings.html
+[confguide]: https://puppet.com/docs/puppet/latest/config_about_settings.html
 
 * * *
 

data/lib/puppet/reference/providers.rb

@@ -90,7 +90,7 @@ providers = Puppet::Util::Reference.newreference :providers, :title => "Provider
 
     ret << markdown_header(type.name.to_s + "_", 2)
 
-    ret << "[#{type.name}](https://docs.puppetlabs.com/puppet/latest/reference/type.html##{type.name})\n\n"
+    ret << "[#{type.name}](https://puppet.com/docs/puppet/latest/type.html##{type.name})\n\n"
     ret << option("Default provider", default)
     ret << doctable(headers, table_data)
 

data/lib/puppet/reference/report.rb

@@ -14,7 +14,7 @@ Puppet master and Puppet apply will handle every report with a set of report
 processors, configurable with the `reports` setting in puppet.conf. This page
 documents the built-in report processors.
 
-See [About Reporting](https://docs.puppetlabs.com/puppet/latest/reference/reporting_about.html)
+See [About Reporting](https://puppet.com/docs/puppet/latest/reporting_about.html)
 for more details.
 
 "

data/lib/puppet/reference/type.rb

@@ -47,25 +47,25 @@ Puppet::Util::Reference.newreference :type, :doc => "All Puppet resource types a
   Resource types define features they can use, and providers can be tested to see
   which features they provide.
 
-    }
+  }
 
-    types.sort { |a,b|
-      a.to_s <=> b.to_s
-    }.each { |name,type|
+  types.sort { |a,b|
+    a.to_s <=> b.to_s
+  }.each { |name,type|
 
-      str << "
+    str << "
 
 ----------------
 
 "
 
-  str << markdown_header(name, 3)
-  str << scrub(type.doc) + "\n\n"
+    str << markdown_header(name, 3)
+    str << scrub(type.doc) + "\n\n"
 
-  # Handle the feature docs.
-  if featuredocs = type.featuredocs
-    str << markdown_header("Features", 4)
-    str << featuredocs
+    # Handle the feature docs.
+    if featuredocs = type.featuredocs
+      str << markdown_header("Features", 4)
+      str << featuredocs
     end
 
     docs = {}
@@ -79,7 +79,6 @@ Puppet::Util::Reference.newreference :type, :doc => "All Puppet resource types a
 
       raise _("Could not retrieve property %{sname} on type %{type_name}") % { sname: sname, type_name: type.name } unless property
 
-      doc = nil
       unless doc = property.doc
         $stderr.puts _("No docs for %{type}[%{sname}]") % { type: type, sname: sname }
         next

data/lib/puppet/relationship.rb

@@ -30,7 +30,8 @@ class Puppet::Relationship
   end
 
   def event=(event)
-    raise ArgumentError, "You must pass a callback for non-NONE events" if event != :NONE and ! callback
+    #TRANSLATORS 'NONE' should not be translated
+    raise ArgumentError, _("You must pass a callback for non-NONE events") if event != :NONE and ! callback
     @event = event
   end
 

data/lib/puppet/reports/http.rb

@@ -6,8 +6,10 @@ Puppet::Reports.register_report(:http) do
 
   desc <<-DESC
     Send reports via HTTP or HTTPS. This report processor submits reports as
-    POST requests to the address in the `reporturl` setting. The body of each POST
-    request is the YAML dump of a Puppet::Transaction::Report object, and the
+    POST requests to the address in the `reporturl` setting. When a HTTPS URL
+    is used, the remote server must present a certificate issued by the Puppet
+    CA or the connection will fail validation. The body of each POST request
+    is the YAML dump of a Puppet::Transaction::Report object, and the
     Content-Type is set as `application/x-yaml`.
   DESC
 

data/lib/puppet/reports/store.rb

@@ -61,7 +61,7 @@ Puppet::Reports.register_report(:store) do
 
   def validate_host(host)
     if host =~ Regexp.union(/[#{SEPARATOR}]/, /\A\.\.?\Z/)
-      raise ArgumentError, "Invalid node name #{host.inspect}"
+      raise ArgumentError, _("Invalid node name %{host}") % { host: host.inspect }
     end
   end
   module_function :validate_host

data/lib/puppet/reports.rb

@@ -73,7 +73,7 @@ class Puppet::Reports
     docs = ""
 
     # Use this method so they all get loaded
-    instance_loader(:report).loadall
+    instance_loader(:report).loadall(Puppet.lookup(:current_environment))
     loaded_instances(:report).sort { |a,b| a.to_s <=> b.to_s }.each do |name|
       mod = self.report(name)
       docs << "#{name}\n#{"-" * name.to_s.length}\n"
@@ -87,7 +87,7 @@ class Puppet::Reports
   # Lists each of the reports.
   # @api private
   def self.reports
-    instance_loader(:report).loadall
+    instance_loader(:report).loadall(Puppet.lookup(:current_environment))
     loaded_instances(:report)
   end
 end

data/lib/puppet/resource/capability_finder.rb

@@ -7,7 +7,7 @@
 
 require 'net/http'
 require 'cgi'
-require 'json'
+require 'puppet/util/json'
 
 # @api private
 module Puppet::Resource::CapabilityFinder
@@ -19,11 +19,12 @@ module Puppet::Resource::CapabilityFinder
   #
   # @param environment [String] environment name
   # @param code_id [String,nil] code_id of the catalog
-  # @param cap [Puppet::Type] the capability resource type instance
+  # @param cap [Puppet::Resource] the capability resource type instance
   # @return [Puppet::Resource,nil] The found capability resource or `nil` if it could not be found
   def self.find(environment, code_id, cap)
     unless Puppet::Util.const_defined?('Puppetdb')
-      raise Puppet::DevError, 'PuppetDB is not available'
+      #TRANSLATOR PuppetDB is a product name and should not be translated
+      raise Puppet::DevError, _('PuppetDB is not available')
     end
 
     resources = search(nil, nil, cap)
@@ -33,24 +34,23 @@ module Puppet::Resource::CapabilityFinder
       resources = resources.select { |r| r['tags'].any? { |t| t == "producer:#{environment}" } }
     end
 
-    if resources.size > 1 && code_id
-      Puppet.debug "Found multiple resources when looking up capability #{cap}, filtering by code id #{code_id}"
-      resources = search(environment, code_id, cap)
-    end
-
-    if resources.size > 1
-      raise Puppet::DevError,
-        "Unexpected response from PuppetDB when looking up #{cap}:\n" \
-        "expected exactly one resource but got #{resources.size};\n" \
-        "returned data is:\n#{resources.inspect}"
+    if resources.empty?
+      Puppet.debug "Could not find capability resource #{cap} in PuppetDB"
+    elsif resources.size == 1
+      resource_hash = resources.first
+    elsif code_id_resource = disambiguate_by_code_id(environment, code_id, cap)
+      resource_hash = code_id_resource
+    else
+      #TRANSLATOR PuppetDB is a product name and should not be translated
+      message = _("Unexpected response from PuppetDB when looking up %{capability}:") % { capability: cap }
+      message += "\n" + _("expected exactly one resource but got %{count};") % { count: resources.size }
+      message += "\n" + _("returned data is:\n%{resources}") % { resources: resources.inspect }
+      raise Puppet::DevError, message
     end
 
-    if resource_hash = resources.first
+    if resource_hash
       resource_hash['type'] = cap.resource_type
       instantiate_resource(resource_hash)
-    else
-      Puppet.debug "Could not find capability resource #{cap} in PuppetDB"
-      nil
     end
   end
 
@@ -74,7 +74,8 @@ module Puppet::Resource::CapabilityFinder
             ['=', 'code_id', code_id]]]]
     end
 
-    Puppet.notice _("Looking up capability %{cap} in PuppetDB: %{query_terms}") % { cap: cap, query_terms: query_terms }
+    #TRANSLATOR PuppetDB is a product name and should not be translated
+    Puppet.notice _("Looking up capability %{capability} in PuppetDB: %{query_terms}") % { capability: cap, query_terms: query_terms }
 
     query_puppetdb(query_terms)
   end
@@ -91,25 +92,45 @@ module Puppet::Resource::CapabilityFinder
         response = Puppet::Util::Puppetdb::Http.action(url) do |conn, uri|
           conn.get(uri, { 'Accept' => 'application/json'})
         end
-        JSON.parse(response.body)
+        Puppet::Util::Json.load(response.body)
       end
 
       # The format of the response body is documented at
-      #   http://docs.puppetlabs.com/puppetdb/3.0/api/query/v4/resources.html#response-format
+      #   https://puppet.com/docs/puppetdb/3.0/api/query/v4/resources.html#response-format
       unless result.is_a?(Array)
-        raise Puppet::DevError,
-        "Unexpected response from PuppetDB when looking up #{cap}: " \
-          "expected an Array but got #{result.inspect}"
+        #TRANSLATOR PuppetDB is a product name and should not be translated
+        raise Puppet::DevError, _("Unexpected response from PuppetDB when looking up %{capability}: expected an Array but got %{result}") %
+            { capability: cap, result: result.inspect }
       end
 
       result
-    rescue JSON::JSONError => e
-      raise Puppet::DevError,
-        "Invalid JSON from PuppetDB when looking up #{cap}\n#{e}"
+    rescue Puppet::Util::Json::ParseError => e
+      #TRANSLATOR PuppetDB is a product name and should not be translated
+      raise Puppet::DevError, _("Invalid JSON from PuppetDB when looking up %{capability}\n%{detail}") % { capability: cap, detail: e }
     end
   end
 
-  private
+  # Find a distinct copy of the given capability resource by searching for only
+  # resources matching the given code_id. Returns `nil` if no code_id is
+  # supplied or if there isn't exactly one matching resource.
+  #
+  # @param environment [String] environment name
+  # @param code_id [String,nil] code_id of the catalog
+  # @param cap [Puppet::Resource] the capability resource type instance
+  def self.disambiguate_by_code_id(environment, code_id, cap)
+    if code_id
+      Puppet.debug "Found multiple resources when looking up capability #{cap}, filtering by code id #{code_id}"
+      resources = search(environment, code_id, cap)
+
+      if resources.size > 1
+        Puppet.debug "Found multiple resources matching code id #{code_id} when looking up #{cap}"
+        nil
+      else
+        resources.first
+      end
+    end
+  end
+  private_class_method :disambiguate_by_code_id
 
   def self.instantiate_resource(resource_hash)
     real_type = resource_hash['type']
@@ -125,4 +146,5 @@ module Puppet::Resource::CapabilityFinder
     end
     return resource
   end
+  private_class_method :instantiate_resource
 end