puppet 4.8.2-x86-mingw32 → 4.9.0-x86-mingw32

data/lib/puppet/face/help/face.erb

@@ -1,4 +1,7 @@
 <%# encoding: UTF-8%>
+<% if face.deprecated? -%>
+<%= "Warning: 'puppet #{face.name}' is deprecated and will be removed in a future release." %>
+<% end %>
 <% if face.synopsis -%>
 USAGE: <%= face.synopsis %>
 

data/lib/puppet/face/key.rb

@@ -12,4 +12,5 @@ Puppet::Indirector::Face.define(:key, '0.0.1') do
     subcommand directly.
   EOT
 
+  deprecate
 end

data/lib/puppet/face/man.rb

@@ -76,11 +76,13 @@ Puppet::Face.define(:man, '0.0.1') do
         if pager then ENV['PAGER'] = pager end
 
         args  = "--man --manual='Puppet Manual' --organization='Puppet Labs, LLC'"
-        IO.popen("#{ronn} #{args}", 'w') do |fh| fh.write text end
+        # manual pages could contain UTF-8 text
+        IO.popen("#{ronn} #{args}", 'w:UTF-8') do |fh| fh.write text end
 
         ''                      # suppress local output, neh?
       elsif pager then
-        IO.popen(pager, 'w') do |fh| fh.write text end
+        # manual pages could contain UTF-8 text
+        IO.popen(pager, 'w:UTF-8') do |fh| fh.write text end
         ''
       else
         text

data/lib/puppet/face/module/generate.rb

@@ -236,7 +236,7 @@ module Puppet::ModuleTool::Generate
         content = block[path.read, binding]
 
         target = path.parent + path.basename(".#{type}")
-        target.open('w') { |f| f.write(content) }
+        target.open('w:UTF-8') { |f| f.write(content) }
         path.unlink
       end
     end

data/lib/puppet/face/status.rb

@@ -45,4 +45,6 @@ Puppet::Indirector::Face.define(:status, '0.0.1') do
 
     $ puppet status find --terminus rest
   EOT
+  
+  deprecate
 end

data/lib/puppet/feature/base.rb

@@ -17,8 +17,15 @@ end
 Puppet.features.add(:microsoft_windows) do
   begin
     # ruby
-    require 'Win32API'          # case matters in this require!
-    require 'win32ole'
+    require 'Win32API' # case matters in this require!
+
+    # Note: Setting codepage here globally ensures all strings returned via
+    # WIN32OLE (Ruby's late-bound COM support) are encoded in Encoding::UTF_8
+    #
+    # Also, this does not modify the value of WIN32OLE.locale - which defaults
+    # to 2048 (at least on US English Windows) and is not listed in the MS
+    # locales table, here: https://msdn.microsoft.com/en-us/library/ms912047(v=winembedded.10).aspx
+    require 'win32ole' ; WIN32OLE.codepage = WIN32OLE::CP_UTF8
     # gems
     require 'win32/process'
     require 'win32/dir'

data/lib/puppet/feature/hocon.rb

@@ -0,0 +1,3 @@
+require 'puppet/util/feature'
+
+Puppet.features.add(:hocon, :libs => ['hocon'])

data/lib/puppet/file_system.rb

@@ -32,6 +32,15 @@ module Puppet::FileSystem
 
   # Opens the given path with given mode, and options and optionally yields it to the given block.
   #
+  # @param path [String, Pathname] the path to the file to operate on
+  # @param mode [Integer] The mode to apply to the file if it is created
+  # @param options [String] Extra file operation mode information to use
+  #   This is the standard mechanism Ruby uses in the IO class, and therefore
+  #   encoding may be specified explicitly as fmode : encoding or fmode : "BOM|UTF-*"
+  #   for example, a:ASCII or w+:UTF-8
+  # @yield The file handle, in the mode given by options, else read-write mode
+  # @return [Void]
+  #
   # @api public
   #
   def self.open(path, mode, options, &block)
@@ -98,10 +107,13 @@ module Puppet::FileSystem
   #
   # @param path [Pathname] the path to the file to operate on
   # @param mode [Integer] The mode to apply to the file if it is created
-  # @param options [Integer] Extra file operation mode information to use
-  #   (defaults to read-only mode)
+  # @param options [String] Extra file operation mode information to use
+  #   (defaults to read-only mode 'r')
+  #   This is the standard mechanism Ruby uses in the IO class, and therefore
+  #   encoding may be specified explicitly as fmode : encoding or fmode : "BOM|UTF-*"
+  #   for example, a:ASCII or w+:UTF-8
   # @param timeout [Integer] Number of seconds to wait for the lock (defaults to 300)
-  # @yield The file handle, in read-write mode
+  # @yield The file handle, in the mode given by options, else read-write mode
   # @return [Void]
   # @raise [Timeout::Error] If the timeout is exceeded while waiting to acquire the lock
   #

data/lib/puppet/file_system/windows.rb

@@ -3,6 +3,14 @@ require 'puppet/util/windows'
 
 class Puppet::FileSystem::Windows < Puppet::FileSystem::Posix
 
+  def open(path, mode, options, &block)
+    # PUP-6959 mode is explicitly ignored until it can be implemented
+    # Ruby on Windows uses mode for setting file attributes like read-only and
+    # archived, not for setting permissions like POSIX
+    raise TypeError.new('mode must be specified as an Integer') if mode && !mode.is_a?(Numeric)
+    ::File.open(path, options, nil, &block)
+  end
+
   def expand_path(path, dir_string = nil)
     # ensure `nil` values behave like underlying File.expand_path
     string_path = ::File.expand_path(path.nil? ? nil : path_string(path), dir_string)

data/lib/puppet/forge.rb

@@ -6,9 +6,9 @@ require 'tempfile'
 require 'uri'
 require 'pathname'
 require 'json'
-require 'semantic'
+require 'semantic_puppet'
 
-class Puppet::Forge < Semantic::Dependency::Source
+class Puppet::Forge < SemanticPuppet::Dependency::Source
   require 'puppet/forge/cache'
   require 'puppet/forge/repository'
   require 'puppet/forge/errors'
@@ -83,9 +83,9 @@ class Puppet::Forge < Semantic::Dependency::Source
   # Fetches {ModuleRelease} entries for each release of the named module.
   #
   # @param input [String] the module name to look up
-  # @return [Array<Semantic::Dependency::ModuleRelease>] a list of releases for
+  # @return [Array<SemanticPuppet::Dependency::ModuleRelease>] a list of releases for
   #         the given name
-  # @see Semantic::Dependency::Source#fetch
+  # @see SemanticPuppet::Dependency::Source#fetch
   def fetch(input)
     name = input.tr('/', '-')
     uri = "/v3/releases?module=#{name}"
@@ -114,7 +114,7 @@ class Puppet::Forge < Semantic::Dependency::Source
     @repository.make_http_request(*args)
   end
 
-  class ModuleRelease < Semantic::Dependency::ModuleRelease
+  class ModuleRelease < SemanticPuppet::Dependency::ModuleRelease
     attr_reader :install_dir, :metadata
 
     def initialize(source, data)
@@ -122,7 +122,7 @@ class Puppet::Forge < Semantic::Dependency::Source
       @metadata = meta = data['metadata']
 
       name = meta['name'].tr('/', '-')
-      version = Semantic::Version.parse(meta['version'])
+      version = SemanticPuppet::Version.parse(meta['version'])
       release = "#{name}@#{version}"
 
       if meta['dependencies']

data/lib/puppet/forge/repository.rb

@@ -147,8 +147,7 @@ class Puppet::Forge
     def user_agent
       @user_agent ||= [
         @agent,
-        "Puppet/#{Puppet.version}",
-        "Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} (#{RUBY_PLATFORM})",
+        Puppet[:http_user_agent]
       ].join(' ').freeze
     end
   end

data/lib/puppet/functions/binary_file.rb

@@ -10,16 +10,10 @@ Puppet::Functions.create_function(:binary_file, Puppet::Functions::InternalFunct
   end
 
   def binary_file(scope, unresolved_path)
-    path = nil
-    found = Puppet::Parser::Files.find_file(unresolved_path, scope.compiler.environment)
-    if found && Puppet::FileSystem.exist?(found)
-      path = found
-    end
-
-    if path
-      Puppet::Pops::Types::PBinaryType::Binary.from_binary_string(Puppet::FileSystem.binread(path))
-    else
-      raise Puppet::ParseError, "binary_file(): The given file '#{path}' does not exist"
+    path = Puppet::Parser::Files.find_file(unresolved_path, scope.compiler.environment)
+    unless path && Puppet::FileSystem.exist?(path)
+      raise Puppet::ParseError, "binary_file(): The given file '#{unresolved_path}' does not exist"
     end
+    Puppet::Pops::Types::PBinaryType::Binary.from_binary_string(Puppet::FileSystem.binread(path))
   end
 end

data/lib/puppet/functions/hiera_array.rb

@@ -69,6 +69,6 @@ Puppet::Functions.create_function(:hiera_array, Hiera::PuppetFunction) do
   init_dispatch
 
   def merge_type
-    :array
+    :unique
   end
 end

data/lib/puppet/functions/hiera_include.rb

@@ -80,7 +80,7 @@ Puppet::Functions.create_function(:hiera_include, Hiera::PuppetFunction) do
   init_dispatch
 
   def merge_type
-    :array
+    :unique
   end
 
   def post_lookup(scope, key, value)

data/lib/puppet/functions/hocon_data.rb

@@ -0,0 +1,24 @@
+# @since 4.9.0
+#
+Puppet::Functions.create_function(:hocon_data) do
+  unless Puppet.features.hocon?
+    raise Puppet::DataBinding::LookupError, 'Lookup using Hocon data_hash function is not supported without hocon library'
+  end
+
+  require 'hocon'
+  require 'hocon/config_error'
+
+  dispatch :hocon_data do
+    param 'Struct[{path=>String[1]}]', :options
+    param 'Puppet::LookupContext', :context
+  end
+
+  def hocon_data(options, context)
+    path = options['path']
+    begin
+      Hocon.parse(Puppet::FileSystem.read(path, :encoding => 'utf-8'))
+    rescue Hocon::ConfigError => ex
+      raise Puppet::DataBinding::LookupError, "Unable to parse (#{path}): #{ex.message}"
+    end
+  end
+end

data/lib/puppet/functions/json_data.rb

@@ -0,0 +1,18 @@
+# @since 4.8.0
+#
+Puppet::Functions.create_function(:json_data) do
+  dispatch :json_data do
+    param 'Struct[{path=>String[1]}]', :options
+    param 'Puppet::LookupContext', :context
+  end
+
+  def json_data(options, context)
+    path = options['path']
+    begin
+      JSON.parse(Puppet::FileSystem.read(path, :encoding => 'utf-8'))
+    rescue JSON::ParserError => ex
+      # Filename not included in message, so we add it here.
+      raise Puppet::DataBinding::LookupError, "Unable to parse (#{path}): #{ex.message}"
+    end
+  end
+end

data/lib/puppet/functions/yaml_data.rb

@@ -0,0 +1,21 @@
+# @since 4.8.0
+#
+require 'yaml'
+
+Puppet::Functions.create_function(:yaml_data) do
+  dispatch :yaml_data do
+    param 'Struct[{path=>String[1]}]', :options
+    param 'Puppet::LookupContext', :context
+  end
+
+  def yaml_data(options, context)
+    begin
+      data = YAML.load_file(options['path'])
+      Puppet::Pops::Lookup::HieraConfig.symkeys_to_string(data.nil? ? {} : data)
+    rescue YAML::SyntaxError => ex
+      # Psych errors includes the absolute path to the file, so no need to add that
+      # to the message
+      raise Puppet::DataBinding::LookupError, "Unable to parse #{ex.message}"
+    end
+  end
+end

data/lib/puppet/generate/type.rb

@@ -222,7 +222,7 @@ module Puppet
             effective_output_path = input.effective_output_path(outputdir)
             Puppet.notice "Generating '#{effective_output_path}' using '#{input.format}' format."
             FileUtils.mkdir_p(File.dirname(effective_output_path))
-            File.open(effective_output_path, 'w') do |file|
+            Puppet::FileSystem.open(effective_output_path, nil, 'w:UTF-8') do |file|
               file.write(result)
             end
           rescue Exception => e

data/lib/puppet/graph/simple_graph.rb

@@ -258,7 +258,8 @@ class Puppet::Graph::SimpleGraph
     graph << '}'
 
     filename = File.join(Puppet[:graphdir], "cycles.dot")
-    File.open(filename, "w") { |f| f.puts graph }
+    # DOT files are assumed to be UTF-8 by default - http://www.graphviz.org/doc/info/lang.html
+    File.open(filename, "w:UTF-8") { |f| f.puts graph }
     return filename
   end
 
@@ -463,7 +464,8 @@ class Puppet::Graph::SimpleGraph
     return unless Puppet[:graph]
 
     file = File.join(Puppet[:graphdir], "#{name}.dot")
-    File.open(file, "w") { |f|
+    # DOT files are assumed to be UTF-8 by default - http://www.graphviz.org/doc/info/lang.html
+    File.open(file, "w:UTF-8") { |f|
       f.puts to_dot("name" => name.to_s.capitalize)
     }
   end

data/lib/puppet/indirector/file_bucket_file/file.rb

@@ -115,7 +115,11 @@ module Puppet::FileBucketFile
     # @param files_original_path [String]
     #
     def matches(paths_file, files_original_path)
-      Puppet::FileSystem.open(paths_file, 0640, 'a+') do |f|
+      # Puppet will have already written the paths_file in the systems encoding
+      # given its possible that request.options[:bucket_path] or Puppet[:bucketdir]
+      # contained characters in an encoding that are not represented the
+      # same way when the bytes are decoded as UTF-8, continue using system encoding
+      Puppet::FileSystem.open(paths_file, 0640, 'a+:external') do |f|
         path_match(f, files_original_path)
       end
     end
@@ -138,7 +142,11 @@ module Puppet::FileBucketFile
           Puppet::FileSystem.dir_mkpath(paths_file)
         end
 
-        Puppet::FileSystem.exclusive_open(paths_file, 0640, 'a+') do |f|
+        # Puppet will have already written the paths_file in the systems encoding
+        # given its possible that request.options[:bucket_path] or Puppet[:bucketdir]
+        # contained characters in an encoding that are not represented the
+        # same way when the bytes are decoded as UTF-8, continue using system encoding
+        Puppet::FileSystem.exclusive_open(paths_file, 0640, 'a+:external') do |f|
           if Puppet::FileSystem.exist?(contents_file)
             verify_identical_file!(contents_file, bucket_file)
             Puppet::FileSystem.touch(contents_file)

data/lib/puppet/indirector/request.rb

@@ -243,6 +243,8 @@ class Puppet::Indirector::Request
   def set_uri_key(key)
     @uri = key
     begin
+      # calling URI.escape for UTF-8 characters will % escape them
+      # and the resulting string components of the URI are now ASCII
       uri = URI.parse(URI.escape(key))
     rescue => detail
       raise ArgumentError, "Could not understand URL #{key}: #{detail}", detail.backtrace
@@ -272,6 +274,8 @@ class Puppet::Indirector::Request
       @protocol = uri.scheme
     end
 
-    @key = URI.unescape(uri.path.sub(/^\//, ''))
+    # The unescaped bytes are correct but in ASCII and must be treated
+    # as UTF-8 for the sake of performing string comparisons later
+    @key = URI.unescape(uri.path.sub(/^\//, '')).force_encoding(Encoding::UTF_8)
   end
 end

data/lib/puppet/interface.rb

@@ -149,12 +149,15 @@ class Puppet::Interface
 
   # @api private
   def initialize(name, version, &block)
-    unless SemVer.valid?(version)
+    unless SemanticPuppet::Version.valid?(version)
       raise ArgumentError, "Cannot create face #{name.inspect} with invalid version number '#{version}'!"
     end
 
     @name    = Puppet::Interface::FaceCollection.underscorize(name)
-    @version = SemVer.new(version)
+
+    # SemVer is deprecated but in 4.x we must use it here (the attr_reader is public api). The
+    # extra boolean argument suppresses the deprecation warning.
+    @version = SemVer.new(version, true)
 
     # The few bits of documentation we actually demand.  The default license
     # is a favour to our end users; if you happen to get that in a core face
@@ -180,6 +183,15 @@ class Puppet::Interface
     "Puppet::Face[#{name.inspect}, #{version.inspect}]"
   end
 
+  # @return [void]
+  def deprecate
+    @deprecated = true
+  end
+
+  # @return [Boolean]
+  def deprecated?
+    @deprecated
+  end
   ########################################################################
   # Action decoration, whee!  You are not expected to care about this code,
   # which exists to support face building and construction.  I marked these

data/lib/puppet/interface/face_collection.rb

@@ -27,7 +27,7 @@ module Puppet::Interface::FaceCollection
       # ...we need to search for it bound to an o{lder,ther} version.  Since
       # we load all actions when the face is first references, this will be in
       # memory in the known set of versions of the face.
-      (@faces[name].keys - [ :current ]).sort.reverse.each do |vers|
+      (@faces[name].keys - [ :current ]).sort.reverse_each do |vers|
         break if action = @faces[name][vers].get_action(action_name)
       end
     end

data/lib/puppet/module.rb

@@ -206,6 +206,17 @@ class Puppet::Module
     @metadata_file = File.join(path, "metadata.json")
   end
 
+  def hiera_conf_file
+    unless defined?(@hiera_conf_file)
+       @hiera_conf_file = path.nil? ? nil : File.join(path, Puppet::Pops::Lookup::HieraConfig::CONFIG_FILE_NAME)
+    end
+    @hiera_conf_file
+  end
+
+  def has_hiera_conf?
+    hiera_conf_file.nil? ? false : Puppet::FileSystem.exist?(hiera_conf_file)
+  end
+
   def modulepath
     File.dirname(path) if path
   end
@@ -309,8 +320,9 @@ class Puppet::Module
 
       if version_string
         begin
-          required_version_semver_range = SemVer[version_string]
-          actual_version_semver = SemVer.new(dep_mod.version)
+          # Suppress deprecation warnings from SemVer in 4.9. In 5.0, this will be SemanticPuppet instead
+          required_version_semver_range = SemVer[version_string, true]
+          actual_version_semver = SemVer.new(dep_mod.version, true)
         rescue ArgumentError
           error_details[:reason] = :non_semantic_version
           unmet_dependencies << error_details

data/lib/puppet/module_tool.rb

@@ -157,12 +157,12 @@ module Puppet
     end
 
     # Handles parsing of module dependency expressions into proper
-    # {Semantic::VersionRange}s, including reasonable error handling.
+    # {SemanticPuppet::VersionRange}s, including reasonable error handling.
     #
     # @param where [String] a description of the thing we're parsing the
     #        dependency expression for
     # @param dep [Hash] the dependency description to parse
-    # @return [Array(String, Semantic::VersionRange, String)] a tuple of the
+    # @return [Array(String, SemanticPuppet::VersionRange, String)] a tuple of the
     #         dependent module's name, the version range dependency, and the
     #         unparsed range expression.
     def self.parse_module_dependency(where, dep)
@@ -170,10 +170,10 @@ module Puppet
       range = dep['version_requirement'] || '>= 0.0.0'
 
       begin
-        parsed_range = Semantic::VersionRange.parse(range)
+        parsed_range = SemanticPuppet::VersionRange.parse(range)
       rescue ArgumentError => e
         Puppet.debug "Error in #{where} parsing dependency #{dep_name} (#{e.message}); using empty range."
-        parsed_range = Semantic::VersionRange::EMPTY_RANGE
+        parsed_range = SemanticPuppet::VersionRange::EMPTY_RANGE
       end
 
       [ dep_name, parsed_range, range ]