puppet 5.3.1 → 5.3.2

data/lib/puppet/defaults.rb

@@ -126,6 +126,19 @@ module Puppet
         munge(value)
         value.to_sym
       end
+    },
+    :disable_i18n => {
+      :default => false,
+      :type    => :boolean,
+      :desc    => "If true, turns off all translations of Puppet and module
+        log messages, which affects error, warning, and info log messages,
+        as well as any translations in the report and CLI.",
+      :hook    => proc do |value|
+        if value
+          require 'puppet/gettext/stubs'
+          Puppet::GettextConfig.disable_gettext
+        end
+      end
     }
   )
 

data/lib/puppet/gettext/config.rb

@@ -1,18 +1,36 @@
 require 'puppet/util/platform'
+require 'puppet/file_system'
 
 module Puppet::GettextConfig
   LOCAL_PATH = File.absolute_path('../../../locales', File.dirname(__FILE__))
   POSIX_PATH = File.absolute_path('../../../../../share/locale', File.dirname(__FILE__))
   WINDOWS_PATH = File.absolute_path('../../../../../../../puppet/share/locale', File.dirname(__FILE__))
 
+  # Load gettext helpers and track whether they're available.
+  # Used instead of features because we initialize gettext before features is available.
+  # Stubbing gettext if unavailable is handled in puppet.rb.
+  begin
+    require 'gettext-setup'
+    require 'locale'
+    @gettext_loaded = true
+  rescue LoadError
+    @gettext_loaded = false
+  end
+
+  # Whether we were able to require gettext-setup and locale
+  # @return [Boolean] true if gettext-setup was successfully loaded
+  def self.gettext_loaded?
+    @gettext_loaded
+  end
+
   # Search for puppet gettext config files
   # @return [String] path to the config, or nil if not found
   def self.puppet_locale_path
-    if File.exist?(LOCAL_PATH)
+    if Puppet::FileSystem.exist?(LOCAL_PATH)
       return LOCAL_PATH
-    elsif Puppet::Util::Platform.windows? && File.exist?(WINDOWS_PATH)
+    elsif Puppet::Util::Platform.windows? && Puppet::FileSystem.exist?(WINDOWS_PATH)
       return WINDOWS_PATH
-    elsif !Puppet::Util::Platform.windows? && File.exist?(POSIX_PATH)
+    elsif !Puppet::Util::Platform.windows? && Puppet::FileSystem.exist?(POSIX_PATH)
       return POSIX_PATH
     else
       nil
@@ -30,40 +48,43 @@ module Puppet::GettextConfig
     end
   end
 
+  # Prevent future gettext initializations
+  def self.disable_gettext
+    @gettext_disabled = true
+  end
+
   # Attempt to initialize the gettext-setup gem
   # @param path [String] to gettext config file
   # @param file_format [Symbol] translation file format to use, either :po or :mo
   # @return true if initialization succeeded, false otherwise
-  def self.initialize(conf_file_location, file_format)
+  def self.initialize(conf_file_dir, file_format)
+    return false if @gettext_disabled || !@gettext_loaded
+
     unless file_format == :po || file_format == :mo
       raise Puppet::Error, "Unsupported translation file format #{file_format}; please use :po or :mo"
     end
 
-    begin
-      require 'gettext-setup'
-      require 'locale'
+    return false if conf_file_dir.nil?
 
-      if conf_file_location && File.exists?(conf_file_location)
-        if GettextSetup.method(:initialize).parameters.count == 1
-          # For use with old gettext-setup gem versions, will load PO files only
-          GettextSetup.initialize(conf_file_location)
-        else
-          GettextSetup.initialize(conf_file_location, :file_format => file_format)
-        end
-        # Only change this once.
-        # Because negotiate_locales will only return a non-default locale if
-        # the system locale matches a translation set actually available for the
-        # given gettext project, we don't want this to get set back to default if
-        # we load a module that doesn't have translations, but Puppet does have
-        # translations for the user's locale.
-        if FastGettext.locale == GettextSetup.default_locale
-          FastGettext.locale = GettextSetup.negotiate_locale(Locale.current.language)
-        end
-        true
+    conf_file = File.join(conf_file_dir, "config.yaml")
+    if Puppet::FileSystem.exist?(conf_file)
+      if GettextSetup.method(:initialize).parameters.count == 1
+        # For use with old gettext-setup gem versions, will load PO files only
+        GettextSetup.initialize(conf_file_dir)
       else
-        false
+        GettextSetup.initialize(conf_file_dir, :file_format => file_format)
       end
-    rescue LoadError
+      # Only change this once.
+      # Because negotiate_locales will only return a non-default locale if
+      # the system locale matches a translation set actually available for the
+      # given gettext project, we don't want this to get set back to default if
+      # we load a module that doesn't have translations, but Puppet does have
+      # translations for the user's locale.
+      if FastGettext.locale == GettextSetup.default_locale
+        FastGettext.locale = GettextSetup.negotiate_locale(Locale.current.language)
+      end
+      true
+    else
       false
     end
   end

data/lib/puppet/module.rb

@@ -98,7 +98,7 @@ class Puppet::Module
     @absolute_path_to_manifests = Puppet::FileSystem::PathPattern.absolute(manifests)
 
     # i18n initialization for modules
-    initialize_i18n
+    initialize_i18n unless Puppet[:disable_i18n]
   end
 
   # @deprecated The puppetversion module metadata field is no longer used.
@@ -428,22 +428,24 @@ class Puppet::Module
 
     locales_path = File.absolute_path('locales', path)
 
-    begin
-      Puppet::GettextConfig.initialize(locales_path, :po)
+    if Puppet::GettextConfig.initialize(locales_path, :po)
       Puppet.debug "#{module_name} initialized for i18n: #{GettextSetup.translation_repositories[module_name]}"
-    rescue
-      config_path = File.absolute_path('config.yaml', locales_path)
-      Puppet.debug "Could not find locales configuration file for #{module_name} at #{config_path}. Skipping i18n initialization."
+    else if Puppet::GettextConfig.gettext_loaded?
+        config_path = File.absolute_path('config.yaml', locales_path)
+        Puppet.debug "Could not find locales configuration file for #{module_name} at #{config_path}. Skipping i18n initialization."
+    else
+        Puppet.debug "No gettext library found, skipping i18n initialization."
+      end
     end
   end
 
   private
 
   def i18n_initialized?(module_name)
-    begin
+    if Puppet::GettextConfig.gettext_loaded?
       GettextSetup.translation_repositories.has_key? module_name
-    rescue NameError
-      # GettextSetup not yet initialized
+    else
+      # GettextSetup not yet initialized or not found
       false
     end
   end

data/lib/puppet/version.rb

@@ -6,7 +6,7 @@
 # Raketasks and such to set the version based on the output of `git describe`
 
 module Puppet
-  PUPPETVERSION = '5.3.1'
+  PUPPETVERSION = '5.3.2'
 
   ##
   # version is a public API method intended to always provide a fast and

data/spec/unit/module_spec.rb

@@ -225,7 +225,10 @@ describe Puppet::Module do
         mod_dir = "#{@modpath}/#{mod_name}"
         metadata_file = "#{mod_dir}/metadata.json"
         tasks_dir = "#{mod_dir}/tasks"
+        locale_config = "#{mod_dir}/locales/config.yaml"
         Puppet::FileSystem.stubs(:exist?).with(metadata_file).returns true
+        # Skip checking for translation config file
+        Puppet::FileSystem.stubs(:exist?).with(locale_config).returns false
       end
       mod = PuppetSpec::Modules.create(
         'test_gte_req',
@@ -448,19 +451,21 @@ describe Puppet::Module do
     let(:modpath) { tmpdir('modpath') }
     let(:modname) { 'puppetlabs-i18n'}
     let(:modroot) { "#{modpath}/#{modname}/" }
-    let(:config_path) { "#{modroot}/locales/config.yaml" }
+    let(:locale_dir) { "#{modroot}locales" }
+    let(:config_path) { "#{locale_dir}/config.yaml" }
     let(:mod_obj) { PuppetSpec::Modules.create( modname, modpath, :metadata => { :dependencies => [] }, :env => env ) }
 
     it "is expected to initialize an un-initialized module" do
       expect(GettextSetup.translation_repositories.has_key? modname).to be false
 
-      FileUtils.mkdir_p("#{mod_obj.path}/locales")
+      FileUtils.mkdir_p(locale_dir)
       config = {
         "gettext" => {
           "project_name" => modname
         }
       }
       File.open(config_path, 'w') { |file| file.write(config.to_yaml) }
+      Puppet::FileSystem.stubs(:exist?).with(config_path).returns(true)
 
       mod_obj.initialize_i18n
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 5.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-30 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: facter