puppet 4.10.1 → 4.10.4

data/ext/project_data.yaml

@@ -7,7 +7,7 @@ summary: 'Puppet, an automated configuration management tool'
 description: 'Puppet, an automated configuration management tool'
 version_file: 'lib/puppet/version.rb'
 # files and gem_files are space separated lists
-files: '[A-Z]* install.rb bin lib conf man examples ext tasks spec'
+files: '[A-Z]* install.rb bin lib conf man examples ext tasks spec locales'
 # The gem specification bits only work on Puppet >= 3.0rc, NOT 2.7.x and earlier
 gem_files: '[A-Z]* install.rb bin lib conf man examples ext tasks spec locales'
 gem_test_files: 'spec/**/*'

data/lib/puppet.rb

@@ -1,6 +1,6 @@
 require 'puppet/version'
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("1.9.3")
+if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new("1.9.3")
   raise LoadError, "Puppet #{Puppet.version} requires ruby 1.9.3 or greater."
 end
 
@@ -27,14 +27,46 @@ require 'puppet/external/pson/pure'
 begin
   require 'gettext-setup'
   require 'locale'
+
+  # e.g. ~/code/puppet/locales. Also when running as a gem.
+  local_locale_path = File.absolute_path('../locales', File.dirname(__FILE__))
+  # e.g. /opt/puppetlabs/puppet/share/locale
+  posix_system_locale_path = File.absolute_path('../../../share/locale', File.dirname(__FILE__))
+  # e.g. C:\Program Files\Puppet Labs\Puppet\puppet\share\locale
+  win32_system_locale_path = File.absolute_path('../../../../../puppet/share/locale', File.dirname(__FILE__))
+
+  if File.exist?(local_locale_path)
+    locale_path = local_locale_path
+  elsif Puppet::Util::Platform.windows? && File.exist?(win32_system_locale_path)
+    locale_path = win32_system_locale_path
+  elsif !Puppet::Util::Platform.windows? && File.exist?(posix_system_locale_path)
+    locale_path = posix_system_locale_path
+  else
+    # We couldn't load our locale data.
+    raise LoadError, "could not find locale data, skipping Gettext initialization"
+  end
+
+  Puppet::LOCALE_PATH = locale_path
   Puppet::GETTEXT_AVAILABLE = true
 rescue LoadError
   def _(msg)
     msg
   end
+
+  def n_(*args, &block)
+    # assume two string args (singular and plural English form) and the count
+    # to pluralize on
+    plural = args[2] == 1 ? args[0] : args[1]
+    # if a block is passed, prefer that over the string selection above
+    block ? block.call : plural
+  end
+
+  Puppet::LOCALE_PATH = nil
   Puppet::GETTEXT_AVAILABLE = false
 end
 
+
+
 #------------------------------------------------------------
 # the top-level module
 #
@@ -53,34 +85,14 @@ module Puppet
   require 'puppet/environments'
 
   class << self
-    if Puppet::GETTEXT_AVAILABLE
-      # e.g. ~/code/puppet/locales. Also when running as a gem.
-      local_locale_path = File.absolute_path('../locales', File.dirname(__FILE__))
-      # e.g. /opt/puppetlabs/puppet/share/locale
-      posix_system_locale_path = File.absolute_path('../../../share/locale', File.dirname(__FILE__))
-      # e.g. C:\Program Files\Puppet Labs\Puppet\puppet\share\locale
-      win32_system_locale_path = File.absolute_path('../../../../../puppet/share/locale', File.dirname(__FILE__))
-
-      if File.exist?(local_locale_path)
-        locale_path = local_locale_path
-      elsif File.exist?(win32_system_locale_path)
-        locale_path = win32_system_locale_path
-      elsif File.exist?(posix_system_locale_path)
-        locale_path = posix_system_locale_path
+    if Puppet::GETTEXT_AVAILABLE && Puppet::LOCALE_PATH
+      if GettextSetup.method(:initialize).parameters.count == 1
+        # Will load translations from PO files only
+        GettextSetup.initialize(Puppet::LOCALE_PATH)
       else
-        # We couldn't load our locale data.
-        locale_path = nil
-      end
-
-      if locale_path
-        if Gem.loaded_specs['gettext-setup'].version < Gem::Version.new('0.8')
-          # Will load translations from PO files only
-          GettextSetup.initialize(locale_path)
-        else
-          GettextSetup.initialize(locale_path, :file_format => :mo)
-        end
-        FastGettext.locale = GettextSetup.negotiate_locale(Locale.current.language)
+        GettextSetup.initialize(Puppet::LOCALE_PATH, :file_format => :mo)
       end
+      FastGettext.locale = GettextSetup.negotiate_locale(Locale.current.language)
     end
 
     include Puppet::Util
@@ -164,7 +176,7 @@ module Puppet
 
   # Now that settings are loaded we have the code loaded to be able to issue
   # deprecation warnings. Warn if we're on a deprecated ruby version.
-  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new(Puppet::OLDEST_RECOMMENDED_RUBY_VERSION)
+  if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new(Puppet::OLDEST_RECOMMENDED_RUBY_VERSION)
     Puppet.deprecation_warning("Support for ruby version #{RUBY_VERSION} is deprecated and will be removed in a future release. See https://docs.puppet.com/puppet/latest/system_requirements.html#ruby for a list of supported ruby versions.")
   end
 

data/lib/puppet/application/agent.rb

@@ -309,7 +309,7 @@ Luke Kanies
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     HELP
   end

data/lib/puppet/application/apply.rb

@@ -152,7 +152,7 @@ Luke Kanies
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     HELP
   end

data/lib/puppet/application/cert.rb

@@ -250,7 +250,7 @@ Luke Kanies
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     HELP
   end

data/lib/puppet/application/describe.rb

@@ -226,7 +226,7 @@ David Lutterkort
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     HELP
   end

data/lib/puppet/application/device.rb

@@ -155,7 +155,7 @@ Brice Figureau
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC
+Copyright (c) 2011 Puppet Inc., LLC
 Licensed under the Apache 2.0 License
       HELP
     end

data/lib/puppet/application/doc.rb

@@ -57,7 +57,7 @@ puppet-doc(8) -- Generate Puppet references
 SYNOPSIS
 --------
 Generates a reference for all Puppet types. Largely meant for internal
-Puppet Labs use. (Deprecated)
+Puppet Inc. use. (Deprecated)
 
 
 USAGE
@@ -71,7 +71,7 @@ DESCRIPTION
 This deprecated command generates a Markdown document to stdout
 describing all installed Puppet types or all allowable arguments to
 puppet executables. It is largely meant for internal use and is used to
-generate the reference document available on the Puppet Labs web site.
+generate the reference document available on the Puppet Inc. web site.
 
 For Puppet module documentation (and all other use cases) this command
 has been superseded by the "puppet-strings"
@@ -104,7 +104,7 @@ Luke Kanies
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
 HELP
   end

data/lib/puppet/application/filebucket.rb

@@ -146,7 +146,7 @@ Luke Kanies
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     HELP
   end

data/lib/puppet/application/inspect.rb

@@ -64,12 +64,12 @@ the full list of acceptable settings.
 AUTHOR
 ------
 
-Puppet Labs
+Puppet Inc.
 
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     HELP
   end

data/lib/puppet/application/lookup.rb

@@ -230,7 +230,7 @@ EXAMPLE
 
 COPYRIGHT
 ---------
-Copyright (c) 2015 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
 
     HELP

data/lib/puppet/application/master.rb

@@ -130,7 +130,7 @@ Luke Kanies
 
 COPYRIGHT
 ---------
-Copyright (c) 2012 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2012 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     HELP
   end

data/lib/puppet/application/resource.rb

@@ -123,7 +123,7 @@ Luke Kanies
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     HELP
   end
@@ -136,14 +136,14 @@ Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
     resources = find_or_save_resources(type, name, params)
 
     if options[:to_yaml]
-      text = resources.
-        map { |resource| resource.prune_parameters(:parameters_to_include => @extra_params).to_hierayaml }.
-        join("\n")
+      text = resources.map do |resource|
+        resource.prune_parameters(:parameters_to_include => @extra_params).to_hierayaml.force_encoding(Encoding.default_external)
+      end.join("\n")
       text.prepend("#{type.downcase}:\n")
     else
-      text = resources.
-        map { |resource| resource.prune_parameters(:parameters_to_include => @extra_params).to_manifest }.
-        join("\n")
+      text = resources.map do |resource|
+        resource.prune_parameters(:parameters_to_include => @extra_params).to_manifest.force_encoding(Encoding.default_external)
+      end.join("\n")
     end
 
     options[:edit] ?

data/lib/puppet/defaults.rb

@@ -1976,7 +1976,7 @@ EOT
     :default => false,
     :type => :boolean,
     :desc => <<-'EOT'
-      Makes the parser raise errors when referencing unknown variables. (This does not affect
+      Causes an evaluation error when referencing unknown variables. (This does not affect
       referencing variables that are explicitly set to undef).
     EOT
     }

data/lib/puppet/etc.rb

@@ -2,11 +2,36 @@ require 'puppet/util/character_encoding'
 # Wrapper around Ruby Etc module allowing us to manage encoding in a single
 # place.
 # This represents a subset of Ruby's Etc module, only the methods required by Puppet.
-# Etc returns strings in variable encoding depending on
-# environment. For Puppet we specifically want UTF-8 as our input from the Etc
-# module - which is our input for many resource instance 'is' values. The
-# associated 'should' value will basically always be coming from Puppet in
-# UTF-8. Etc is defined for Windows but calls to it return nil.
+
+# On Ruby 2.1.0 and later, Etc returns strings in variable encoding depending on
+# environment. The string returned will be labeled with the environment's
+# encoding (Encoding.default_external), with one exception: If the environment
+# encoding is 7-bit ASCII, and any individual character bit representation is
+# equal to or greater than 128 - \x80 - 0b10000000 - signifying the smallest
+# 8-bit big-endian value, the returned string will be in BINARY encoding instead
+# of environment encoding.
+#
+# Barring that exception, the returned string will be labeled as encoding
+# Encoding.default_external, regardless of validity or byte-width. For example,
+# ruby will label a string containing a four-byte characters such as "\u{2070E}"
+# as EUC_KR even though EUC_KR is a two-byte width encoding.
+#
+# On Ruby 2.0.x and earlier, Etc will always return string values in BINARY,
+# ignoring encoding altogether.
+#
+# For Puppet we specifically want UTF-8 as our input from the Etc module - which
+# is our input for many resource instance 'is' values. The associated 'should'
+# value will basically always be coming from Puppet in UTF-8 - and written to
+# disk as UTF-8. Etc is defined for Windows but the majority calls to it return
+# nil and Puppet does not use it.
+#
+# That being said, we have cause to retain the original, pre-override string
+# values. `puppet resource user`
+# (Puppet::Resource::User.indirection.search('User', {})) uses self.instances to
+# query for user(s) and then iterates over the results of that query again to
+# obtain state for each user. If we've overridden the original user name and not
+# retained the original, we've lost the ability to query the system for it
+# later. Hence the Puppet::Etc::Passwd and Puppet::Etc::Group structs.
 #
 # We only use Etc for retrieving existing property values from the system. For
 # setting property values, providers leverage system tools (i.e., `useradd`)
@@ -14,11 +39,12 @@ require 'puppet/util/character_encoding'
 # @api private
 module Puppet::Etc
   class << self
+
     # Etc::getgrent returns an Etc::Group struct object
     # On first call opens /etc/group and returns parse of first entry. Each subsquent call
     # returns new struct the next entry or nil if EOF. Call ::endgrent to close file.
     def getgrent
-      convert_field_values_to_utf8!(::Etc.getgrent)
+      override_field_values_to_utf8(::Etc.getgrent)
     end
 
     # closes handle to /etc/group file
@@ -35,7 +61,7 @@ module Puppet::Etc
     # On first call opens /etc/passwd and returns parse of first entry. Each subsquent call
     # returns new struct for the next entry or nil if EOF. Call ::endgrent to close file.
     def getpwent
-      convert_field_values_to_utf8!(::Etc.getpwent)
+      override_field_values_to_utf8(::Etc.getpwent)
     end
 
     # closes handle to /etc/passwd file
@@ -53,70 +79,80 @@ module Puppet::Etc
     # returns an Etc::Passwd struct corresponding to the entry or raises
     # ArgumentError if none
     def getpwnam(username)
-      convert_field_values_to_utf8!(::Etc.getpwnam(username))
+      override_field_values_to_utf8(::Etc.getpwnam(username))
     end
 
     # Etc::getgrnam searches /etc/group file for an entry corresponding to groupname.
     # returns an Etc::Group struct corresponding to the entry or raises
     # ArgumentError if none
     def getgrnam(groupname)
-      convert_field_values_to_utf8!(::Etc.getgrnam(groupname))
+      override_field_values_to_utf8(::Etc.getgrnam(groupname))
     end
 
     # Etc::getgrid searches /etc/group file for an entry corresponding to id.
     # returns an Etc::Group struct corresponding to the entry or raises
     # ArgumentError if none
     def getgrgid(id)
-      convert_field_values_to_utf8!(::Etc.getgrgid(id))
+      override_field_values_to_utf8(::Etc.getgrgid(id))
     end
 
     # Etc::getpwuid searches /etc/passwd file for an entry corresponding to id.
     # returns an Etc::Passwd struct corresponding to the entry or raises
     # ArgumentError if none
     def getpwuid(id)
-      convert_field_values_to_utf8!(::Etc.getpwuid(id))
+      override_field_values_to_utf8(::Etc.getpwuid(id))
     end
 
     private
-    # Utility method for converting the String values of a struct returned by
+
+    # @api private
+    # Defines Puppet::Etc::Passwd struct class. Contains all of the original
+    # member fields of Etc::Passwd, and additional "canonical_" versions of
+    # these fields as well. API compatible with Etc::Passwd. Because Struct.new
+    # defines a new Class object, we memozie to avoid superfluous extra Class
+    # instantiations.
+    def puppet_etc_passwd_class
+      @password_class ||= Struct.new(*Etc::Passwd.members, *Etc::Passwd.members.map { |member| "canonical_#{member}".to_sym })
+    end
+
+    # @api private
+    # Defines Puppet::Etc::Group struct class. Contains all of the original
+    # member fields of Etc::Group, and additional "canonical_" versions of these
+    # fields as well. API compatible with Etc::Group. Because Struct.new
+    # defines a new Class object, we memoize to avoid superfluous extra Class
+    # instantiations.
+    def puppet_etc_group_class
+      @group_class ||= Struct.new(*Etc::Group.members, *Etc::Group.members.map { |member| "canonical_#{member}".to_sym })
+    end
+
+    # Utility method for overriding the String values of a struct returned by
     # the Etc module to UTF-8. Structs returned by the ruby Etc module contain
     # members with fields of type String, Integer, or Array of Strings, so we
     # handle these types. Otherwise ignore fields.
     #
-    # NOTE: If a string cannot be converted to UTF-8, this leaves the original
-    # string string intact in the Struct.
-    #
-    # Warning! This is a destructive method - the struct passed is modified!
-    #
     # @api private
     # @param [Etc::Passwd or Etc::Group struct]
-    # @return [Etc::Passwd or Etc::Group struct] the original struct with values
-    #   converted to UTF-8 if possible, or the original value intact if not
-    def convert_field_values_to_utf8!(struct)
+    # @return [Puppet::Etc::Passwd or Puppet::Etc::Group struct] a new struct
+    #   object with the original struct values overidden to UTF-8, if valid. For
+    #   invalid values originating in UTF-8, invalid characters are replaced with
+    #   '?'. For each member the struct also contains a corresponding
+    #   :canonical_<member name> struct member.
+    def override_field_values_to_utf8(struct)
       return nil if struct.nil?
-      struct.each_with_index do |value, index|
+      new_struct = struct.is_a?(Etc::Passwd) ? puppet_etc_passwd_class.new : puppet_etc_group_class.new
+      struct.each_pair do |member, value|
         if value.is_a?(String)
-            converted = Puppet::Util::CharacterEncoding.convert_to_utf_8!(value)
-            struct[index] = converted if !converted.nil?
+          new_struct["canonical_#{member}".to_sym] = value.dup
+          new_struct[member] = Puppet::Util::CharacterEncoding.scrub(Puppet::Util::CharacterEncoding.override_encoding_to_utf_8(value))
         elsif value.is_a?(Array)
-          struct[index] = convert_array_values_to_utf8!(value)
+          new_struct["canonical_#{member}".to_sym] = value.inject([]) { |acc, elem| acc << elem.dup }
+          new_struct[member] = value.inject([]) { |acc, elem| acc << Puppet::Util::CharacterEncoding.scrub(Puppet::Util::CharacterEncoding.override_encoding_to_utf_8(elem)) }
+        else
+          new_struct["canonical_#{member}".to_sym] = value
+          new_struct[member] = value
         end
       end
-    end
-
-    # Helper method for ::convert_field_values_to_utf8!
-    #
-    # Warning! This is a destructive method - the array passed is modified!
-    #
-    # @api private
-    # @param [Array] object containing String values to convert to UTF-8
-    # @return [Array] original Array with String values converted to UTF-8 if
-    #   convertible, or original, unmodified values if not.
-    def convert_array_values_to_utf8!(string_array)
-      string_array.map! do |elem|
-        converted = Puppet::Util::CharacterEncoding.convert_to_utf_8!(elem)
-        converted.nil? ? elem : converted
-      end
+      new_struct
     end
   end
 end