puppet 4.8.2 → 4.9.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODE5NjAxYjc5N2M2NzRkYWFjODBjMTM1N2E4NmNiYTBmYzViNTViYw==
+  data.tar.gz: !binary |-
+    OGMzYmYzZjRkYjY3NzE2NTIxZjkwYWNmMGQ3NGZkYWVmYTM3MjJjYw==
+SHA512:
+  metadata.gz: !binary |-
+    NGU3MDcwODM4NWY4Y2Q5NzNkMGI1ODNlMWU3M2Y3YjkzNTA4NmU0OGFhNzky
+    MzY4NWI5M2YzMzgxYmYwOGZiM2ZlZjE0YjVlNGIwYjc4NjY0Mzg3MTQ2Zjgw
+    ZTJhODFiOWM4MDE0ODRlNzM5ODc1YjU0ZTA4ODg0ZGM1YWEzZDA=
+  data.tar.gz: !binary |-
+    Zjk5ZTAxYjE2NjBmNDcxNDc4YTEzNWI1MjNmNDBhYjRiNDlhOGYzZjIwNDNk
+    MmVkMGYwZjVkNDdjYzI1NWIyZDBhNTQzZmQ2M2VjYjhiNmRhNWJkYzUwNmNl
+    NDg2NzA0YzExMjk3OWRjYjYyZTllNGVjNWNkNTgzYWRmZTkwYzQ=

data/CONTRIBUTING.md

@@ -104,13 +104,37 @@ a ticket number.
 * After feedback has been given we expect responses within two weeks. After two
   weeks we may close the pull request if it isn't showing any activity.
 
+## Revert Policy
+By running tests in advance and by engaging with peer review for prospective
+changes, your contributions have a high probability of becoming long lived
+parts of the the project. After being merged, the code will run through a
+series of testing pipelines on a large number of operating system
+environments. These pipelines can reveal incompatibilities that are difficult
+to detect in advance.
+
+If the code change results in a test failure, we will make our best effort to
+correct the error. If a fix cannot be determined and committed within 24 hours
+of its discovery, the commit(s) responsible _may_ be reverted, at the
+discretion of the committer and Puppet maintainers. This action would be taken
+to help maintain passing states in our testing pipelines.
+
+The original contributor will be notified of the revert in the Jira ticket
+associated with the change. A reference to the test(s) and operating system(s)
+that failed as a result of the code change will also be added to the Jira
+ticket. This test(s) should be used to check future submissions of the code to
+ensure the issue has been resolved.
+
+### Summary
+* Changes resulting in test pipeline failures will be reverted if they cannot
+  be resolved within one business day.
+
 # Additional Resources
 
 * [Puppet community guidelines](https://docs.puppet.com/community/community_guidelines.html)
 * [Bug tracker (Jira)](https://tickets.puppetlabs.com)
 * [Contributor License Agreement](http://links.puppet.com/cla)
 * [General GitHub documentation](https://help.github.com/)
-* [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
+* [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/)
 * #puppet-dev IRC channel on freenode.org ([Archive](https://botbot.me/freenode/puppet-dev/))
 * [puppet-dev mailing list](https://groups.google.com/forum/#!forum/puppet-dev)
 * [Community PR Triage notes](https://github.com/puppet-community/community-triage/tree/master/core/notes)

data/Gemfile

@@ -26,10 +26,15 @@ end
 gem "puppet", :path => File.dirname(__FILE__), :require => false
 gem "facter", *location_for(ENV['FACTER_LOCATION'] || ['> 2.0', '< 4'])
 gem "hiera", *location_for(ENV['HIERA_LOCATION'] || ['>= 2.0', '< 4'])
+# PUP-7115 - return to a gem dependency in Puppet 5
+# gem "semantic_puppet", *location_for(ENV['SEMANTIC_PUPPET_LOCATION'] || ['>= 0.1.3', '< 2'])
 gem "rake", "10.1.1", :require => false
 # Hiera has an unbound dependency on json_pure
 # json_pure 2.0.2+ officially requires Ruby >= 2.0, but should have specified that in 2.0
 gem 'json_pure', '~> 1.8', :require => false
+# i18n support (gettext-setup and dependencies)
+gem 'gettext-setup', '>= 0.10', '< 1.0', :require => false
+gem 'locale', '~> 2.1', :require => false
 
 group(:development, :test) do
   gem "rspec", "~> 3.1", :require => false
@@ -58,6 +63,7 @@ group(:development, :test) do
   gem 'addressable', '< 2.5.0'
   gem 'webmock', '~> 1.24'
   gem 'vcr', '~> 2.9'
+  gem "hocon", :require => false
 end
 
 group(:development) do

data/Rakefile

@@ -103,3 +103,4 @@ task(:commits) do
     puts "...passed"
   end
 end
+

data/ext/project_data.yaml

@@ -9,7 +9,7 @@ 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'
 # 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'
+gem_files: '[A-Z]* install.rb bin lib conf man examples ext tasks spec locales'
 gem_test_files: 'spec/**/*'
 gem_executables: 'puppet'
 gem_default_executables: 'puppet'
@@ -20,6 +20,10 @@ gem_runtime_dependencies:
   facter: ['> 2.0', '< 4']
   hiera: ['>= 2.0', '< 4']
   json_pure: '~> 1.8'
+  # PUP-7115 - return to a gem dependency in Puppet 5
+  # semantic_puppet: ['>= 0.1.3', '< 2']
+  gettext-setup: ['>= 0.10', '< 1']
+  locale: '~> 2.1'
 gem_rdoc_options:
   - --title
   - "Puppet - Configuration Management"

data/ext/windows/service/daemon.rb

@@ -123,7 +123,8 @@ class WindowsDaemon < Win32::Daemon
   def log(msg, level)
     if LEVELS.index(level) >= @loglevel
       if (@LOG_TO_FILE)
-        File.open(LOG_FILE, 'a') { |f| f.puts("#{Time.now} Puppet (#{level}): #{msg}") }
+        # without this change its possible that we get Encoding errors trying to write UTF-8 messages in current codepage
+        File.open(LOG_FILE, 'a:UTF-8') { |f| f.puts("#{Time.now} Puppet (#{level}): #{msg}") }
       end
 
       case level

data/install.rb

@@ -108,9 +108,24 @@ def do_man(man, strip = 'man/')
     FileUtils.makedirs(om, {:mode => 0755, :verbose => true})
     FileUtils.chmod(0755, om)
     FileUtils.install(mf, omf, {:mode => 0644, :preserve => true, :verbose => true})
-    gzip = %x{which gzip}
-    gzip.chomp!
-    %x{#{gzip} -f #{omf}}
+    # Solaris does not support gzipped man pages. When called with
+    # --no-check-prereqs/without facter the default gzip behavior still applies
+    unless $operatingsystem == "Solaris"
+      gzip = %x{which gzip}
+      gzip.chomp!
+      %x{#{gzip} -f #{omf}}
+    end
+  end
+end
+
+def do_locales(locale, strip = 'locales/')
+  locale.each do |lf|
+    next if File.directory? lf
+    olf = File.join(InstallOptions.locale_dir, lf.sub(/^#{strip}/, ''))
+    op = File.dirname(olf)
+    FileUtils.makedirs(op, {:mode => 0755, :verbose => true})
+    FileUtils.chmod(0755, op)
+    FileUtils.install(lf, olf, {:mode => 0644, :preserve => true, :verbose => true})
   end
 end
 
@@ -190,6 +205,9 @@ def prepare_installation
     opts.on('--bindir[=OPTIONAL]', 'Installation directory for binaries', 'overrides RbConfig::CONFIG["bindir"]') do |bindir|
       InstallOptions.bindir = bindir
     end
+    opts.on('--localedir[=OPTIONAL]', 'Installation directory for locale information', 'Default /opt/puppetlabs/puppet/share/locale') do |localedir|
+      InstallOptions.localedir = localedir
+    end
     opts.on('--ruby[=OPTIONAL]', 'Ruby interpreter to use with installation', 'overrides ruby used to call install.rb') do |ruby|
       InstallOptions.ruby = ruby
     end
@@ -242,15 +260,19 @@ def prepare_installation
     $operatingsystem = Facter.value :operatingsystem
   end
 
-  if not InstallOptions.configdir.nil?
-    configdir = InstallOptions.configdir
-  elsif $operatingsystem == "windows"
+  if $operatingsystem == "windows"
     begin
+      # populates constants used to specify default Windows directories
       require 'win32/dir'
     rescue LoadError => e
       puts "Cannot run on Microsoft Windows without the win32-process, win32-dir & win32-service gems: #{e}"
       exit -1
     end
+  end
+
+  if not InstallOptions.configdir.nil?
+    configdir = InstallOptions.configdir
+  elsif $operatingsystem == "windows"
     configdir = File.join(Dir::COMMON_APPDATA, "PuppetLabs", "puppet", "etc")
   else
     configdir = "/etc/puppetlabs/puppet"
@@ -294,6 +316,16 @@ def prepare_installation
     bindir = RbConfig::CONFIG['bindir']
   end
 
+  if not InstallOptions.localedir.nil?
+    localedir = InstallOptions.localedir
+  else
+    if $operatingsystem == "windows"
+      localedir = File.join(Dir::PROGRAM_FILES, "Puppet Labs", "Puppet", "puppet", "share", "locale")
+    else
+      localedir = "/opt/puppetlabs/puppet/share/locale"
+    end
+  end
+
   if not InstallOptions.sitelibdir.nil?
     sitelibdir = InstallOptions.sitelibdir
   else
@@ -331,6 +363,7 @@ def prepare_installation
   rundir = join(destdir, rundir)
   logdir = join(destdir, logdir)
   bindir = join(destdir, bindir)
+  localedir = join(destdir, localedir)
   mandir = join(destdir, mandir)
   sitelibdir = join(destdir, sitelibdir)
 
@@ -342,6 +375,7 @@ def prepare_installation
   FileUtils.makedirs(vardir)
   FileUtils.makedirs(rundir)
   FileUtils.makedirs(logdir)
+  FileUtils.makedirs(localedir)
 
   InstallOptions.site_dir = sitelibdir
   InstallOptions.codedir = codedir
@@ -352,6 +386,7 @@ def prepare_installation
   InstallOptions.var_dir = vardir
   InstallOptions.run_dir = rundir
   InstallOptions.log_dir = logdir
+  InstallOptions.locale_dir = localedir
 end
 
 ##
@@ -464,6 +499,7 @@ FileUtils.cd File.dirname(__FILE__) do
   ri    = glob(%w{bin/*.rb lib/**/*.rb}).reject { |e| e=~ /\.(bat|cmd)$/ }
   man   = glob(%w{man/man[0-9]/*})
   libs  = glob(%w{lib/**/*})
+  locales = glob(%w{locales/**/*})
 
   prepare_installation
 
@@ -477,5 +513,6 @@ FileUtils.cd File.dirname(__FILE__) do
   do_bins(bins, InstallOptions.bin_dir)
   do_bins(windows_bins, InstallOptions.bin_dir, 'ext/windows/') if $operatingsystem == "windows" && InstallOptions.batch_files
   do_libs(libs)
+  do_locales(locales)
   do_man(man) unless $operatingsystem == "windows"
 end

data/lib/hiera/puppet_function.rb

@@ -43,37 +43,35 @@ class Hiera::PuppetFunction < Puppet::Functions::InternalFunction
   end
 
   def hiera_no_default(scope, key)
-    post_lookup(scope, key, lookup(scope, key, nil, nil))
+    post_lookup(scope, key, lookup(scope, key, nil, false, nil))
   end
 
   def hiera_with_default(scope, key, default, override = nil)
-    undefined = (@@undefined_value ||= Object.new)
-    result = lookup(scope, key, undefined, override)
-    post_lookup(scope, key, result.equal?(undefined) ? default : result)
+    post_lookup(scope, key, lookup(scope, key, default, true, override))
   end
 
   def hiera_block1(scope, key, &default_block)
-    common(scope, key, nil, default_block)
+    post_lookup(scope, key, lookup(scope, key, nil, false, nil, &default_block))
   end
 
   def hiera_block2(scope, key, override, &default_block)
-    common(scope, key, override, default_block)
+    post_lookup(scope, key, lookup(scope, key, nil, false, override, &default_block))
   end
 
-  def common(scope, key, override, default_block)
-    undefined = (@@undefined_value ||= Object.new)
-    result = lookup(scope, key, undefined, override)
-    post_lookup(scope, key, result.equal?(undefined) ? default_block.call(key) : result)
-  end
-
-  private :common
-
-  def lookup(scope, key, default, override)
-    HieraPuppet.lookup(key, default, scope, override, merge_type)
+  def lookup(scope, key, default, has_default, override, &default_block)
+    unless Puppet[:strict] == :off
+      Puppet.warn_once(:deprecation, self.class.name,
+        "The function '#{self.class.name}' is deprecated in favor of using 'lookup'. See https://docs.puppet.com/puppet/#{Puppet.version}/reference/deprecated_language.html")
+    end
+    lookup_invocation = Puppet::Pops::Lookup::Invocation.new(scope, {}, {})
+    adapter = lookup_invocation.lookup_adapter
+    lookup_invocation.set_global_only unless adapter.global_only? || adapter.has_environment_data_provider?(lookup_invocation)
+    lookup_invocation.set_hiera_v3_location_overrides(override) unless override.nil? || override.is_a?(Array) && override.empty?
+    Puppet::Pops::Lookup.lookup(key, nil, default, has_default, merge_type, lookup_invocation, &default_block)
   end
 
   def merge_type
-    :priority
+    :first
   end
 
   def post_lookup(scope, key, result)

data/lib/hiera/scope.rb

@@ -1,9 +1,12 @@
 class Hiera
   class Scope
-    CALLING_CLASS = "calling_class"
-    CALLING_CLASS_PATH = "calling_class_path"
-    CALLING_MODULE = "calling_module"
-    MODULE_NAME = "module_name"
+    CALLING_CLASS = 'calling_class'.freeze
+    CALLING_CLASS_PATH = 'calling_class_path'.freeze
+    CALLING_MODULE = 'calling_module'.freeze
+    MODULE_NAME = 'module_name'.freeze
+
+    CALLING_KEYS = [CALLING_CLASS, CALLING_CLASS_PATH, CALLING_MODULE].freeze
+    EMPTY_STRING = ''.freeze
 
     attr_reader :real
 
@@ -21,20 +24,15 @@ class Hiera
       else
         ans = @real.lookupvar(key)
       end
+      ans == EMPTY_STRING ? nil : ans
+    end
 
-      if ans.nil? or ans == ""
-        nil
-      else
-        ans
-      end
+    def exist?(key)
+      CALLING_KEYS.include?(key) || @real.exist?(key)
     end
 
     def include?(key)
-      if [CALLING_CLASS, CALLING_CLASS_PATH, CALLING_MODULE].include? key
-        true
-      else
-        @real.exist?(key)
-      end
+      CALLING_KEYS.include?(key) || @real.include?(key)
     end
 
     def catalog

data/lib/puppet.rb

@@ -4,6 +4,8 @@ if RUBY_VERSION < "1.9.3"
   raise LoadError, "Puppet #{Puppet.version} requires ruby 1.9.3 or greater."
 end
 
+Puppet::OLDEST_RECOMMENDED_RUBY_VERSION = '2.1.0'
+
 # see the bottom of the file for further inclusions
 # Also see the new Vendor support - towards the end
 #
@@ -19,6 +21,20 @@ require 'puppet/external/pson/common'
 require 'puppet/external/pson/version'
 require 'puppet/external/pson/pure'
 
+# When running within puppetserver, the gettext-setup gem might not be available, so
+# we need to skip initializing i18n functionality and stub out methods normally
+# supplied by gettext-setup. Can be removed in Puppet 5. See PUP-7116.
+begin
+  require 'gettext-setup'
+  require 'locale'
+  Puppet::GETTEXT_AVAILABLE = true
+rescue LoadError
+  def _(msg)
+    msg
+  end
+  Puppet::GETTEXT_AVAILABLE = false
+end
+
 #------------------------------------------------------------
 # the top-level module
 #
@@ -36,6 +52,36 @@ 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
+      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)
+      end
+    end
+
     include Puppet::Util
     attr_reader :features
   end
@@ -115,6 +161,12 @@ module Puppet
   # Load all of the settings.
   require 'puppet/defaults'
 
+  # 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 RUBY_VERSION < 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
+
   # Initialize puppet's settings. This is intended only for use by external tools that are not
   #  built off of the Faces API or the Puppet::Util::Application class. It may also be used
   #  to initialize state so that a Face may be used programatically, rather than as a stand-alone

data/lib/puppet/application/face_base.rb

@@ -245,6 +245,10 @@ class Puppet::Application::FaceBase < Puppet::Application
       end
     end
 
+    if @face.deprecated?
+      Puppet.deprecation_warning("'puppet #{@face.name}' is deprecated and will be removed in a future release")
+    end
+
     result = @face.send(@action.name, *arguments)
     puts render(result, arguments) unless result.nil?
     status = true

data/lib/puppet/application/lookup.rb

@@ -297,11 +297,13 @@ Copyright (c) 2015 Puppet Labs, LLC Licensed under the Apache 2.0 License
         type = options.include?(:type) ? Puppet::Pops::Types::TypeParser.singleton.parse(options[:type], scope) : nil
         result = Puppet::Pops::Lookup.lookup(keys, type, options[:default_value], use_default_value, merge_options, lookup_invocation)
         puts renderer.render(result) unless explain
-      rescue Puppet::DataBinding::LookupError
+      rescue Puppet::DataBinding::LookupError => e
+        lookup_invocation.report_text { e.message }
         exit(1) unless explain
       end
-      puts format == :s ? lookup_invocation.explainer.to_s : renderer.render(lookup_invocation.explainer.to_hash) if explain
+      puts format == :s ? lookup_invocation.explainer.explain : renderer.render(lookup_invocation.explainer.to_hash) if explain
     end
+    exit(0)
   end
 
   def generate_scope

data/lib/puppet/application/resource.rb

@@ -166,7 +166,7 @@ Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
     require 'tempfile'
     # Prefer the current directory, which is more likely to be secure
     # and, in the case of interactive use, accessible to the user.
-    tmpfile = Tempfile.new('x2puppet', Dir.pwd)
+    tmpfile = Tempfile.new('x2puppet', Dir.pwd, :encoding => Encoding::UTF_8)
     begin
       # sync write, so nothing buffers before we invoke the editor.
       tmpfile.sync = true

data/lib/puppet/data_providers.rb

@@ -1,11 +1,11 @@
+# TODO: API 5.0, remove this module
 # @api private
+# @deprecated
 module Puppet::DataProviders
 
   def self.assert_loaded
     unless @loaded
       require 'puppet/pops'
-      require 'puppet/data_providers/data_adapter'
-      require 'puppet/data_providers/lookup_adapter'
     end
     @loaded = true
   end
@@ -25,7 +25,10 @@ module Puppet::DataProviders
   end
 
   def self.lookup_adapter(lookup_invocation)
+    unless Puppet[:strict] == :off
+      Puppet.deprecation_warning('The method Puppet::DataProviders.lookup_adapter is deprecated and will be removed in the next major release of Puppet.')
+    end
     assert_loaded()
-    LookupAdapter.adapt(lookup_invocation.scope.compiler)
+    Puppet::Pops::Lookup::LookupAdapter.adapt(lookup_invocation.scope.compiler)
   end
 end