puppet 4.8.2 → 4.9.0

data/lib/puppet/module_tool/applications/builder.rb

@@ -131,11 +131,12 @@ module Puppet::ModuleTool
         # TODO: This may necessarily change the order in which the metadata.json
         # file is packaged from what was written by the user.  This is a
         # regretable, but required for now.
-        File.open(metadata_path, 'w') do |f|
+        Puppet::FileSystem.open(metadata_path, nil, 'w:UTF-8') do |f|
           f.write(metadata.to_json)
         end
 
-        File.open(File.join(build_path, 'checksums.json'), 'w') do |f|
+        # PSON.pretty_generate is a BINARY string
+        Puppet::FileSystem.open(File.join(build_path, 'checksums.json'), nil, 'wb') do |f|
           f.write(PSON.pretty_generate(Checksums.new(build_path)))
         end
       end

data/lib/puppet/module_tool/applications/installer.rb

@@ -34,19 +34,19 @@ module Puppet::ModuleTool
           release = local_tarball_source.release
           @name = release.name
           options[:version] = release.version.to_s
-          Semantic::Dependency.add_source(local_tarball_source)
+          SemanticPuppet::Dependency.add_source(local_tarball_source)
 
           # If we're operating on a local tarball and ignoring dependencies, we
           # don't need to search any additional sources.  This will cut down on
           # unnecessary network traffic.
           unless @ignore_dependencies
-            Semantic::Dependency.add_source(installed_modules_source)
-            Semantic::Dependency.add_source(module_repository)
+            SemanticPuppet::Dependency.add_source(installed_modules_source)
+            SemanticPuppet::Dependency.add_source(module_repository)
           end
 
         else
-          Semantic::Dependency.add_source(installed_modules_source) unless forced?
-          Semantic::Dependency.add_source(module_repository)
+          SemanticPuppet::Dependency.add_source(installed_modules_source) unless forced?
+          SemanticPuppet::Dependency.add_source(module_repository)
         end
       end
 
@@ -59,7 +59,7 @@ module Puppet::ModuleTool
         begin
           if installed_module = installed_modules[name]
             unless forced?
-              if Semantic::VersionRange.parse(version).include? installed_module.version
+              if SemanticPuppet::VersionRange.parse(version).include? installed_module.version
                 results[:result] = :noop
                 results[:version] = installed_module.version
                 return results
@@ -103,7 +103,7 @@ module Puppet::ModuleTool
               # locking it to upgrades within the same major version.
               installed_range = ">=#{version} #{version.major}.x"
               graph.add_constraint('installed', mod, installed_range) do |node|
-                Semantic::VersionRange.parse(installed_range).include? node.version
+                SemanticPuppet::VersionRange.parse(installed_range).include? node.version
               end
 
               release.mod.dependencies.each do |dep|
@@ -111,7 +111,7 @@ module Puppet::ModuleTool
 
                 range = dep['version_requirement']
                 graph.add_constraint("#{mod} constraint", dep_name, range) do |node|
-                  Semantic::VersionRange.parse(range).include? node.version
+                  SemanticPuppet::VersionRange.parse(range).include? node.version
                 end
               end
             end
@@ -125,8 +125,8 @@ module Puppet::ModuleTool
 
           begin
             Puppet.info "Resolving dependencies ..."
-            releases = Semantic::Dependency.resolve(graph)
-          rescue Semantic::Dependency::UnsatisfiableGraph
+            releases = SemanticPuppet::Dependency.resolve(graph)
+          rescue SemanticPuppet::Dependency::UnsatisfiableGraph
             raise NoVersionsSatisfyError, results.merge(:requested_name => name)
           end
 
@@ -205,15 +205,15 @@ module Puppet::ModuleTool
       end
 
       def build_single_module_graph(name, version)
-        range = Semantic::VersionRange.parse(version)
-        graph = Semantic::Dependency::Graph.new(name => range)
-        releases = Semantic::Dependency.fetch_releases(name)
+        range = SemanticPuppet::VersionRange.parse(version)
+        graph = SemanticPuppet::Dependency::Graph.new(name => range)
+        releases = SemanticPuppet::Dependency.fetch_releases(name)
         releases.each { |release| release.dependencies.clear }
         graph << releases
       end
 
       def build_dependency_graph(name, version)
-        Semantic::Dependency.query(name => version)
+        SemanticPuppet::Dependency.query(name => version)
       end
 
       def build_install_graph(release, installed, graphed = [])

data/lib/puppet/module_tool/applications/upgrader.rb

@@ -21,8 +21,8 @@ module Puppet::ModuleTool
         @ignore_changes      = forced? || options[:ignore_changes]
         @ignore_dependencies = forced? || options[:ignore_dependencies]
 
-        Semantic::Dependency.add_source(installed_modules_source)
-        Semantic::Dependency.add_source(module_repository)
+        SemanticPuppet::Dependency.add_source(installed_modules_source)
+        SemanticPuppet::Dependency.add_source(module_repository)
       end
 
       def run
@@ -48,7 +48,7 @@ module Puppet::ModuleTool
 
           installed_release = installed_modules[name]
 
-          # `priority` is an attribute of a `Semantic::Dependency::Source`,
+          # `priority` is an attribute of a `SemanticPuppet::Dependency::Source`,
           # which is delegated through `ModuleRelease` instances for the sake of
           # comparison (sorting). By default, the `InstalledModules` source has
           # a priority of 10 (making it the most preferable source, so that
@@ -66,7 +66,7 @@ module Puppet::ModuleTool
           end
 
           mod = installed_release.mod
-          results[:installed_version] = Semantic::Version.parse(mod.version)
+          results[:installed_version] = SemanticPuppet::Version.parse(mod.version)
           dir = Pathname.new(mod.modulepath)
 
           vstring = mod.version ? "v#{mod.version}" : '???'
@@ -90,7 +90,7 @@ module Puppet::ModuleTool
           if available_versions.empty?
             raise NoCandidateReleasesError, results.merge(:module_name => name, :source => module_repository.host)
           elsif results[:requested_version] != :latest
-            requested = Semantic::VersionRange.parse(results[:requested_version])
+            requested = SemanticPuppet::VersionRange.parse(results[:requested_version])
             unless available_versions.any? {|m| requested.include? m.version}
               raise NoCandidateReleasesError, results.merge(:module_name => name, :source => module_repository.host)
             end
@@ -119,7 +119,7 @@ module Puppet::ModuleTool
               # module, locking it to upgrades within the same major version.
               installed_range = ">=#{version} #{version.major}.x"
               graph.add_constraint('installed', installed_module, installed_range) do |node|
-                Semantic::VersionRange.parse(installed_range).include? node.version
+                SemanticPuppet::VersionRange.parse(installed_range).include? node.version
               end
 
               release.mod.dependencies.each do |dep|
@@ -127,7 +127,7 @@ module Puppet::ModuleTool
 
                 range = dep['version_requirement']
                 graph.add_constraint("#{installed_module} constraint", dep_name, range) do |node|
-                  Semantic::VersionRange.parse(range).include? node.version
+                  SemanticPuppet::VersionRange.parse(range).include? node.version
                 end
               end
             end
@@ -135,8 +135,8 @@ module Puppet::ModuleTool
 
           begin
             Puppet.info "Resolving dependencies ..."
-            releases = Semantic::Dependency.resolve(graph)
-          rescue Semantic::Dependency::UnsatisfiableGraph
+            releases = SemanticPuppet::Dependency.resolve(graph)
+          rescue SemanticPuppet::Dependency::UnsatisfiableGraph
             raise NoVersionsSatisfyError, results.merge(:requested_name => name)
           end
 
@@ -227,15 +227,15 @@ module Puppet::ModuleTool
       end
 
       def build_single_module_graph(name, version)
-        range = Semantic::VersionRange.parse(version)
-        graph = Semantic::Dependency::Graph.new(name => range)
-        releases = Semantic::Dependency.fetch_releases(name)
+        range = SemanticPuppet::VersionRange.parse(version)
+        graph = SemanticPuppet::Dependency::Graph.new(name => range)
+        releases = SemanticPuppet::Dependency.fetch_releases(name)
         releases.each { |release| release.dependencies.clear }
         graph << releases
       end
 
       def build_dependency_graph(name, version)
-        Semantic::Dependency.query(name => version)
+        SemanticPuppet::Dependency.query(name => version)
       end
 
       def build_install_graph(release, installed, graphed = [])

data/lib/puppet/module_tool/installed_modules.rb

@@ -4,7 +4,7 @@ require 'puppet/forge'
 require 'puppet/module_tool'
 
 module Puppet::ModuleTool
-  class InstalledModules < Semantic::Dependency::Source
+  class InstalledModules < SemanticPuppet::Dependency::Source
     attr_reader :modules, :by_name
 
     def priority
@@ -33,9 +33,9 @@ module Puppet::ModuleTool
     # Fetches {ModuleRelease} entries for each release of the named module.
     #
     # @param name [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(name)
       name = name.tr('/', '-')
 
@@ -51,7 +51,7 @@ module Puppet::ModuleTool
       @fetched
     end
 
-    class ModuleRelease < Semantic::Dependency::ModuleRelease
+    class ModuleRelease < SemanticPuppet::Dependency::ModuleRelease
       attr_reader :mod, :metadata
 
       def initialize(source, mod)
@@ -59,10 +59,10 @@ module Puppet::ModuleTool
         @metadata = mod.metadata
         name = mod.forge_name.tr('/', '-')
         begin
-          version = Semantic::Version.parse(mod.version)
-        rescue Semantic::Version::ValidationFailure => e
+          version = SemanticPuppet::Version.parse(mod.version)
+        rescue SemanticPuppet::Version::ValidationFailure => e
           Puppet.warning "#{mod.name} (#{mod.path}) has an invalid version number (#{mod.version}). The version has been set to 0.0.0. If you are the maintainer for this module, please update the metadata.json with a valid Semantic Version (http://semver.org)."
-          version = Semantic::Version.parse("0.0.0")
+          version = SemanticPuppet::Version.parse("0.0.0")
         end
         release = "#{name}@#{version}"
 

data/lib/puppet/module_tool/local_tarball.rb

@@ -5,7 +5,7 @@ require 'puppet/forge'
 require 'puppet/module_tool'
 
 module Puppet::ModuleTool
-  class LocalTarball < Semantic::Dependency::Source
+  class LocalTarball < SemanticPuppet::Dependency::Source
     attr_accessor :release
 
     def initialize(filename)
@@ -40,14 +40,14 @@ module Puppet::ModuleTool
       FileUtils.mv(staging_dir, module_dir)
     end
 
-    class ModuleRelease < Semantic::Dependency::ModuleRelease
+    class ModuleRelease < SemanticPuppet::Dependency::ModuleRelease
       attr_reader :mod, :install_dir, :metadata
 
       def initialize(source, mod)
         @mod = mod
         @metadata = mod.metadata
         name = mod.forge_name.tr('/', '-')
-        version = Semantic::Version.parse(mod.version)
+        version = SemanticPuppet::Version.parse(mod.version)
         release = "#{name}@#{version}"
 
         if mod.dependencies

data/lib/puppet/module_tool/metadata.rb

@@ -213,7 +213,7 @@ module Puppet::ModuleTool
 
     # Validates that the version range can be parsed by Semantic.
     def validate_version_range(version_range)
-      Semantic::VersionRange.parse(version_range)
+      SemanticPuppet::VersionRange.parse(version_range)
     rescue ArgumentError => e
       raise ArgumentError, "Invalid 'version_range' field in metadata.json: #{e}"
     end

data/lib/puppet/network/http/connection.rb

@@ -197,6 +197,8 @@ module Puppet::Network::HTTP
     end
 
     def apply_options_to(request, options)
+      request["User-Agent"] = Puppet[:http_user_agent]
+
       if options[:basic_auth]
         request.basic_auth(options[:basic_auth][:user], options[:basic_auth][:password])
       end

data/lib/puppet/network/http/webrick.rb

@@ -73,7 +73,8 @@ class Puppet::Network::HTTP::WEBrick
     file = Puppet[:masterhttplog]
 
     # open the log manually to prevent file descriptor leak
-    file_io = ::File.open(file, "a+")
+    # webrick logged strings may contain UTF-8
+    file_io = ::File.open(file, "a+:UTF-8")
     file_io.sync = true
     if defined?(Fcntl::FD_CLOEXEC)
       file_io.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)

data/lib/puppet/parser/functions/hiera.rb

@@ -77,6 +77,20 @@ $users = hiera('users') | $key | { "Key \'${key}\' not found" }
 The returned value's data type depends on the types of the results. In the example
 above, Hiera matches the 'users' key and returns it as a hash.
 
+The `hiera` function is deprecated in favor of using `lookup` and will be removed in 6.0.0.
+See  https://docs.puppet.com/puppet/#{Puppet.version}/reference/deprecated_language.html.
+Replace the calls as follows:
+
+| from  | to |
+| ----  | ---|
+| hiera($key) | lookup($key) |
+| hiera($key, $default) | lookup($key, { 'default_value' => $default }) |
+| hiera($key, $default, $level) | override level not supported |
+
+Note that calls using the 'override level' option are not directly supported by 'lookup' and the produced
+result must be post processed to get exactly the same result, for example using simple hash/array `+` or
+with calls to stdlib's `deep_merge` function depending on kind of hiera call and setting of merge in hiera.yaml.
+
 See
 [the documentation](https://docs.puppetlabs.com/hiera/latest/puppet.html#hiera-lookup-functions)
 for more information about Hiera lookup functions.

data/lib/puppet/parser/functions/hiera_array.rb

@@ -65,6 +65,20 @@ $allusers = hiera_array('users') | $key | { "Key \'${key}\' not found" }
 `hiera_array` expects that all values returned will be strings or arrays. If any matched
 value is a hash, Puppet raises a type mismatch error.
 
+`hiera_array` is deprecated in favor of using `lookup` and will be removed in 6.0.0.
+See  https://docs.puppet.com/puppet/#{Puppet.version}/reference/deprecated_language.html.
+Replace the calls as follows:
+
+| from  | to |
+| ----  | ---|
+| hiera_array($key) | lookup($key, { 'merge' => 'unique' }) |
+| hiera_array($key, $default) | lookup($key, { 'default_value' => $default, 'merge' => 'unique' }) |
+| hiera_array($key, $default, $level) | override level not supported |
+
+Note that calls using the 'override level' option are not directly supported by 'lookup' and the produced
+result must be post processed to get exactly the same result, for example using simple hash/array `+` or
+with calls to stdlib's `deep_merge` function depending on kind of hiera call and setting of merge in hiera.yaml.
+
 See
 [the documentation](https://docs.puppetlabs.com/hiera/latest/puppet.html#hiera-lookup-functions)
 for more information about Hiera lookup functions.

data/lib/puppet/parser/functions/hiera_hash.rb

@@ -75,6 +75,20 @@ $allusers = hiera_hash('users') | $key | { "Key \'${key}\' not found" }
 `hiera_hash` expects that all values returned will be hashes. If any of the values
 found in the data sources are strings or arrays, Puppet raises a type mismatch error.
 
+`hiera_hash` is deprecated in favor of using `lookup` and will be removed in 6.0.0.
+See  https://docs.puppet.com/puppet/#{Puppet.version}/reference/deprecated_language.html.
+Replace the calls as follows:
+
+| from  | to |
+| ----  | ---|
+| hiera_hash($key) | lookup($key, { 'merge' => 'hash' }) |
+| hiera_hash($key, $default) | lookup($key, { 'default_value' => $default, 'merge' => 'hash' }) |
+| hiera_hash($key, $default, $level) | override level not supported |
+
+Note that calls using the 'override level' option are not directly supported by 'lookup' and the produced
+result must be post processed to get exactly the same result, for example using simple hash/array `+` or
+with calls to stdlib's `deep_merge` function depending on kind of hiera call and setting of merge in hiera.yaml.
+
 See
 [the documentation](https://docs.puppetlabs.com/hiera/latest/puppet.html#hiera-lookup-functions)
 for more information about Hiera lookup functions.

data/lib/puppet/parser/functions/hiera_include.rb

@@ -75,6 +75,20 @@ hiera_include('classes') | $key | {"Key \'${key}\' not found" }
 # "Key 'classes' not found".
 ~~~
 
+`hiera_include` is deprecated in favor of using a combination of `include`and `lookup` and will be
+removed in 6.0.0. See  https://docs.puppet.com/puppet/#{Puppet.version}/reference/deprecated_language.html.
+Replace the calls as follows:
+
+| from  | to |
+| ----  | ---|
+| hiera_include($key) | include(lookup($key, { 'merge' => 'unique' })) |
+| hiera_include($key, $default) | include(lookup($key, { 'default_value' => $default, 'merge' => 'unique' })) |
+| hiera_include($key, $default, $level) | override level not supported |
+
+Note that calls using the 'override level' option are not directly supported by 'lookup' and the produced
+result must be post processed to get exactly the same result, for example using simple hash/array `+` or
+with calls to stdlib's `deep_merge` function depending on kind of hiera call and setting of merge in hiera.yaml.
+
 See [the documentation](http://links.puppetlabs.com/hierainclude) for more information
 and a more detailed example of how `hiera_include` uses array merge lookups to classify
 nodes.

data/lib/puppet/parser/scope.rb

@@ -23,6 +23,7 @@ class Puppet::Parser::Scope
 
   # Variables that always exist with nil value even if not set
   BUILT_IN_VARS = ['module_name'.freeze, 'caller_module_name'.freeze].freeze
+  EMPTY_HASH = {}.freeze
 
   Puppet::Util.logmethods(self)
 
@@ -83,11 +84,8 @@ class Puppet::Parser::Scope
     end
 
     def [](name)
-      if @symbols.include?(name)
-        @symbols[name]
-      else
-        super
-      end
+      val = @symbols[name]
+      val.nil? && !@symbols.include?(val) ? super : val
     end
 
     def is_local_scope?
@@ -486,28 +484,24 @@ class Puppet::Parser::Scope
   # @return Object the value of the variable, or nil if it's not found
   #
   # @api public
-  def lookupvar(name, options = {})
+  def lookupvar(name, options = EMPTY_HASH)
     unless name.is_a? String
       raise Puppet::ParseError, "Scope variable name #{name.inspect} is a #{name.class}, not a string"
     end
 
-    table = @ephemeral.last
-
     if name =~ /^(.*)::(.+)$/
-      class_name = $1
-      variable_name = $2
-      lookup_qualified_variable(class_name, variable_name, options)
+      return lookup_qualified_variable($1, $2, options)
+    end
+
+    table = @ephemeral.last
+    val = table[name]
+    return val unless val.nil? && !table.include?(name)
 
-    # TODO: optimize with an assoc instead, this searches through scopes twice for a hit
-    elsif table.include?(name)
-      table[name]
+    next_scope = inherited_scope || enclosing_scope
+    if next_scope
+      next_scope.lookupvar(name, options)
     else
-      next_scope = inherited_scope || enclosing_scope
-      if next_scope
-        next_scope.lookupvar(name, options)
-      else
-        variable_not_found(name)
-      end
+      variable_not_found(name)
     end
   end
 

data/lib/puppet/plugins/data_providers.rb

@@ -1,6 +1,8 @@
 module Puppet::Plugins; end
 
+# TODO: API 5.0, remove this module
 # @api private
+# @deprecated
 module Puppet::Plugins::DataProviders
 
   # The lookup **key** for the multibind containing data provider name per module

data/lib/puppet/plugins/data_providers/data_provider.rb

@@ -1,25 +1,37 @@
 require 'puppet/pops/lookup/interpolation'
 
+# TODO: API 5.0, remove this module
+# @api private
+# @deprecated
 module Puppet::Plugins::DataProviders
-  # @api private
+  # @deprecated
   module DataProvider
+    include Puppet::Pops::Lookup::DataProvider
     include Puppet::Pops::Lookup::Interpolation
 
-    # Performs a lookup with an endless recursion check.
-    #
-    # @param key [String] The key to lookup
-    # @param lookup_invocation [Puppet::Pops::Lookup::Invocation] The current lookup invocation
-    # @param merge [String|Hash<String,Object>|nil] Merge strategy or hash with strategy and options
-    def lookup(name, lookup_invocation, merge)
-      lookup_invocation.check(name) { unchecked_lookup(name, lookup_invocation, merge) }
+    def key_lookup(key, lookup_invocation, merge)
+      lookup(key.to_s, lookup_invocation, merge)
+    end
+
+    def unchecked_key_lookup(key, lookup_invocation, merge)
+      unchecked_lookup(key.to_s, lookup_invocation, merge)
+    end
+
+    # @deprecated
+    def lookup(key, lookup_invocation, merge)
+      lookup_invocation.check(key) { unchecked_lookup(key, lookup_invocation, merge) }
     end
 
     # Performs a lookup with the assumption that a recursive check has been made.
     #
     # @param key [String] The key to lookup
     # @param lookup_invocation [Puppet::Pops::Lookup::Invocation] The current lookup invocation
-    # @param merge [String|Hash<String,Object>|nil] Merge strategy or hash with strategy and options
+    # @param merge [String|Hash{String => Object}] Merge strategy or hash with strategy and options
     def unchecked_lookup(key, lookup_invocation, merge)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'DataProvider#unchecked_lookup',
+          'DataProvider#unchecked_lookup is deprecated and will be removed in the next major version of Puppet')
+      end
       segments = split_key(key)
       root_key = segments.shift
       lookup_invocation.with(:data_provider, self) do
@@ -41,6 +53,7 @@ module Puppet::Plugins::DataProviders
     # @param value [Object] The value to perform post processing on
     # @param lookup_invocation [Puppet::Pops::Lookup::Invocation] The current lookup invocation
     # @return [Object] The result of post processing the value.
+    # @deprecated
     def post_process(value, lookup_invocation)
       interpolate(value, lookup_invocation, true)
     end
@@ -56,10 +69,15 @@ module Puppet::Plugins::DataProviders
     # @param lookup_invocation [Puppet::Pops::Lookup::Invocation] The current lookup invocation
     # @param merge [String|Hash<String,Object>|nil] Merge strategy or hash with strategy and options
     # @return [Hash] The data hash for the given _key_
+    # @deprecated
     def data(data_key, lookup_invocation)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'DataProvider#data',
+          'DataProvider#data is deprecated and will be removed in the next major version of Puppet')
+      end
       compiler = lookup_invocation.scope.compiler
       adapter = Puppet::DataProviders::DataAdapter.get(compiler) || Puppet::DataProviders::DataAdapter.adapt(compiler)
-      adapter.data[data_key] ||= validate_data(initialize_data(data_key, lookup_invocation), data_key)
+      adapter.data[data_key] ||= validate_data(initialize_data(data_key, lookup_invocation))
     end
     protected :data
 
@@ -67,7 +85,12 @@ module Puppet::Plugins::DataProviders
     #
     # @param key [String] The key to lookup
     # @return [String,nil] The data key or nil if not applicable
+    # @deprecated
     def data_key(key, lookup_invocation)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'DataProvider#data_key',
+          'DataProvider#data_key is deprecated and will be removed in the next major version of Puppet')
+      end
       nil
     end
 
@@ -76,7 +99,12 @@ module Puppet::Plugins::DataProviders
     # @param data_key [String] The data key such as the name of a module or the constant 'environment'
     # @param lookup_invocation [Puppet::Pops::Lookup::Invocation] The current lookup invocation
     # @return [Hash] The hash of values
+    # @deprecated
     def initialize_data(data_key, lookup_invocation)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'DataProvider#initialize_data',
+          'DataProvider#initialize_data is deprecated and will be removed in the next major version of Puppet')
+      end
       {}
     end
     protected :initialize_data
@@ -86,23 +114,38 @@ module Puppet::Plugins::DataProviders
       cname[cname.rindex(':')+1..-1]
     end
 
+    # @deprecated
     def validate_data(data, data_key)
       data
     end
   end
 
+  # TODO: API 5.0 Remove this class
+  # @deprecated
   # @api private
   class ModuleDataProvider
-    LOOKUP_OPTIONS = Puppet::Pops::Lookup::LOOKUP_OPTIONS
+    LOOKUP_OPTIONS = 'lookup_options'.freeze
     include DataProvider
 
+    attr_reader :module_name
+
+    def initialize(module_name = nil)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'Plugins::DataProviders::ModuleDataProvider',
+          'Plugins::DataProviders::ModuleDataProvider is deprecated and will be removed in the next major version of Puppet')
+      end
+      @module_name = module_name || Puppet::Pops::Lookup::Invocation.current.module_name
+    end
+
     # Retrieve the first segment of the qualified name _key_. This method will throw
     # :no_such_key unless the segment can be extracted.
     #
     # @param key [String] The key
     # @return [String] The first segment of the given key
+    # @api private
+    # @deprecated
     def data_key(key, lookup_invocation)
-      return lookup_invocation.module_name if key == LOOKUP_OPTIONS
+      return module_name if key == LOOKUP_OPTIONS
       qual_index = key.index('::')
       throw :no_such_key if qual_index.nil?
       key[0..qual_index-1]
@@ -132,10 +175,21 @@ module Puppet::Plugins::DataProviders
     end
   end
 
+  # TODO: API 5.0 Remove this class
+  # @deprecated
   # @api private
   class EnvironmentDataProvider
     include DataProvider
 
+    def initialize
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'Plugins::DataProviders::EnvironmentDataProvider',
+          'Plugins::DataProviders::EnvironmentDataProvider is deprecated and will be removed in the next major version of Puppet')
+      end
+    end
+
+    # @api private
+    # @deprecated
     def data_key(key, lookup_invocation)
       'environment'
     end
@@ -145,11 +199,13 @@ module Puppet::Plugins::DataProviders
   # the fully resolved path, and whether or the resolved path exists.
   #
   # @api private
+  # @deprecated
   class ResolvedPath
     attr_reader :original_path, :path
 
     # @param original_path [String] path as found in declaration. May contain interpolation expressions
     # @param path [Pathname] the expanded absolute path
+    # @deprecated
     def initialize(original_path, path)
       @original_path = original_path
       @path = path
@@ -157,11 +213,12 @@ module Puppet::Plugins::DataProviders
     end
 
     # @return [Boolean] cached info if the path exists or not
-    # @api public
+    # @deprecated
     def exists?
       @exists = @path.exist? if @exists.nil?
       @exists
     end
+    alias exist? exists?
   end
 
   # A data provider that is initialized with a set of _paths_. When performing lookup, each
@@ -170,6 +227,7 @@ module Puppet::Plugins::DataProviders
   #
   # @abstract
   # @api private
+  # @deprecated
   class PathBasedDataProvider
     include DataProvider
 
@@ -178,7 +236,12 @@ module Puppet::Plugins::DataProviders
     # @param name [String] The name of the data provider
     # @param paths [Array<ResolvedPath>] Paths used by this provider
     # @param parent_data_provider [DataProvider] The data provider that is the container of this data provider
+    # @deprecated
     def initialize(name, paths, parent_data_provider = nil)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'PathBasedDataProvider',
+          'PathBasedDataProvider is deprecated and will be removed in the next major version of Puppet')
+      end
       @name = name
       @paths = paths
       @parent_data_provider = parent_data_provider
@@ -196,6 +259,7 @@ module Puppet::Plugins::DataProviders
     # @param lookup_invocation [Puppet::Pops::Lookup::Invocation] The current lookup invocation
     # @param merge [String|Hash<String,Object>|nil] Merge strategy or hash with strategy and options
     # @return [Hash] The data hash for the given _key_
+    # @deprecated
     def load_data(path, data_key, lookup_invocation)
       compiler = lookup_invocation.scope.compiler
       adapter = Puppet::DataProviders::DataAdapter.get(compiler) || Puppet::DataProviders::DataAdapter.adapt(compiler)
@@ -203,6 +267,7 @@ module Puppet::Plugins::DataProviders
     end
     protected :data
 
+    # @deprecated
     def validate_data(data, module_name)
       @parent_data_provider.nil? ? data : @parent_data_provider.validate_data(data, module_name)
     end
@@ -213,6 +278,7 @@ module Puppet::Plugins::DataProviders
     # @param key [String] The key to lookup
     # @param lookup_invocation [Puppet::Pops::Lookup::Invocation] The current lookup invocation
     # @param merge [Puppet::Pops::MergeStrategy,String,Hash<String,Object>,nil] Merge strategy or hash with strategy and options
+    # @deprecated
     def unchecked_lookup(key, lookup_invocation, merge)
       segments = split_key(key)
       root_key = segments.shift
@@ -222,7 +288,7 @@ module Puppet::Plugins::DataProviders
         merge_strategy = Puppet::Pops::MergeStrategy.strategy(merge)
         lookup_invocation.with(:merge, merge_strategy) do
           merged_result = merge_strategy.merge_lookup(@paths) do |path|
-            lookup_invocation.with(:path, path) do
+            lookup_invocation.with(:location, path) do
               if path.exists?
                 hash = load_data(path.path, module_name, lookup_invocation)
                 value = hash[root_key]
@@ -234,7 +300,7 @@ module Puppet::Plugins::DataProviders
                   throw :no_such_key
                 end
               else
-                lookup_invocation.report_path_not_found
+                lookup_invocation.report_location_not_found
                 throw :no_such_key
               end
             end
@@ -245,17 +311,28 @@ module Puppet::Plugins::DataProviders
     end
   end
 
+  # TODO: API 5.0 Remove this class
   # Factory for creating path based data providers
   #
   # @abstract
   # @api private
+  # @deprecated
   class PathBasedDataProviderFactory
+    # @deprecated
+    def initialize
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'PathBasedDataProviderFactory',
+        'PathBasedDataProviderFactory is deprecated and will be removed in the next major version of Puppet')
+      end
+    end
+
     # Create a path based data provider with the given _name_ and _paths_
     #
     # @param name [String] the name of the created provider (for logging and debugging)
     # @param paths [Array<String>] array of resolved paths
     # @param parent_data_provider [DataProvider] The data provider that is the container of this data provider
     # @return [DataProvider] The created data provider
+    # @deprecated
     def create(name, paths, parent_data_provider)
       raise NotImplementedError, "Subclass of PathBasedDataProviderFactory must implement 'create' method"
     end
@@ -271,6 +348,7 @@ module Puppet::Plugins::DataProviders
     # @param paths [Array<String>] paths that have been preprocessed (interpolations resolved)
     # @param lookup_invocation [Puppet::Pops::Lookup::Invocation] The current lookup invocation
     # @return [Array<ResolvedPath>] Array of resolved paths
+    # @deprecated
     def resolve_paths(datadir, declared_paths, paths, lookup_invocation)
       []
     end
@@ -283,30 +361,43 @@ module Puppet::Plugins::DataProviders
     end
   end
 
+  # TODO: API 5.0 Remove this class
   # Factory for creating file based data providers. This is an extension of the path based
   # factory where it is required that each resolved path appoints an existing file in the local
   # file system.
   #
   # @abstract
   # @api private
+  # @deprecated
   class FileBasedDataProviderFactory < PathBasedDataProviderFactory
+    # @deprecated
+    def initialize
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'FileBasedDataProviderFactory',
+          'FileBasedDataProviderFactory is deprecated and will be removed in the next major version of Puppet')
+      end
+    end
+
     # @param datadir [Pathname] The base when creating absolute paths
     # @param declared_paths [Array<String>] paths as found in declaration. May contain interpolation expressions
     # @param paths [Array<String>] paths that have been preprocessed (interpolations resolved)
     # @param lookup_invocation [Puppet::Pops::Lookup::Invocation] The current lookup invocation
-    # @return [Array<ResolvedPath>] Array of resolved paths
+    # @return [Array<Puppet::DataProviders::ResolvedLocation>] Array of resolved paths
+    # @deprecated
     def resolve_paths(datadir, declared_paths, paths, lookup_invocation)
       resolved_paths = []
       unless paths.nil? || datadir.nil?
         ext = path_extension
         paths.each_with_index do |path, idx|
           path = path + ext unless path.end_with?(ext)
-          resolved_paths << ResolvedPath.new(declared_paths[idx], datadir + path)
+          path = datadir + path
+          resolved_paths << Puppet::Pops::Lookup::ResolvedLocation.new(declared_paths[idx], path, path.exist?)
         end
       end
       resolved_paths
     end
 
+    # @deprecated
     def path_extension
       raise NotImplementedError, "Subclass of FileBasedProviderFactory must implement 'path_extension' method"
     end