puppet 4.8.2-x64-mingw32 → 4.9.0-x64-mingw32

data/lib/puppet/data_providers/data_adapter.rb

@@ -1,6 +1,8 @@
 # A DataAdapter adapts an object with a Hash of data
 #
+# TODO: API 5.0, remove this class
 # @api private
+# @deprecated
 class Puppet::DataProviders::DataAdapter < Puppet::Pops::Adaptable::Adapter
   include Puppet::Plugins::DataProviders
 
@@ -11,6 +13,10 @@ class Puppet::DataProviders::DataAdapter < Puppet::Pops::Adaptable::Adapter
   end
 
   def initialize
+    unless Puppet[:strict] == :off
+      Puppet.warn_once(:deprecation, 'Puppet::DataProviders::DataAdapter',
+        'Puppet::DataProviders::DataAdapter is deprecated and will be removed in the next major version of Puppet')
+    end
     @data = {}
   end
 

data/lib/puppet/data_providers/data_function_support.rb

@@ -1,9 +1,16 @@
+# TODO: API 5.0, remove this module
 # @api private
+# @deprecated
 module Puppet::DataProviders::DataFunctionSupport
   def initialize_data(data_key, lookup_invocation)
     name = "#{data_key}::data"
     scope = lookup_invocation.scope
     Puppet::Util::Profiler.profile("Called #{name}", [ :functions, name ]) do
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'Puppet::DataProviders::DataFunctionSupport',
+        'Puppet::DataProviders::DataFunctionSupport is deprecated and will be removed in the next major version of Puppet')
+      end
+
       loader = loader(data_key, scope)
       if loader && func = loader.load(:function, name)
         # function found, call without arguments, must return a Hash

data/lib/puppet/data_providers/function_env_data_provider.rb

@@ -8,11 +8,18 @@ module Puppet::DataProviders; end
 # The function is called on demand, and is associated with the compiler via an Adapter. This ensures that the data
 # is only produced once per compilation.
 #
+# TODO: API 5.0, remove this class
 # @api private
+# @deprecated
 class Puppet::DataProviders::FunctionEnvDataProvider < Puppet::Plugins::DataProviders::EnvironmentDataProvider
   include Puppet::DataProviders::DataFunctionSupport
 
   def loader(key, scope)
+    unless Puppet[:strict] == :off
+      Puppet.warn_once(:deprecation, 'Puppet::DataProviders::FunctionEnvDataProvider',
+        'Puppet::DataProviders::FunctionEnvDataProvider is deprecated and will be removed in the next major version of Puppet')
+    end
+
     # This loader allows the data function to be private or public in the environment
     scope.compiler.loaders.private_environment_loader
   end

data/lib/puppet/data_providers/function_module_data_provider.rb

@@ -8,11 +8,17 @@ module Puppet::DataProviders; end
 # The function is called on demand, and is associated with the compiler via an Adapter. This ensures that the data
 # is only produced once per compilation.
 #
+# TODO: API 5.0, remove this class
 # @api private
+# @deprecated
 class Puppet::DataProviders::FunctionModuleDataProvider < Puppet::Plugins::DataProviders::ModuleDataProvider
   include Puppet::DataProviders::DataFunctionSupport
 
   def loader(key, scope)
+    unless Puppet[:strict] == :off
+      Puppet.warn_once(:deprecation, 'Puppet::DataProviders::FunctionModuleDataProvider',
+      'Puppet::DataProviders::FunctionModuleDataProvider is deprecated and will be removed in the next major version of Puppet')
+    end
     scope.compiler.loaders.private_loader_for_module(key)
   end
 end

data/lib/puppet/data_providers/hiera_config.rb

@@ -1,11 +1,13 @@
-require 'pathname'
-require 'puppet/pops/lookup/interpolation'
+require 'puppet/plugins/data_providers'
 
+# @api private
 module Puppet::DataProviders
+  # TODO: API 5.0, remove this class
   # @api private
+  # @deprecated
   class HieraConfig
     include Puppet::Plugins::DataProviders
-    include Puppet::Pops::Lookup::Interpolation
+    include Puppet::Pops::Lookup::LocationResolver
 
     DEFAULT_CONFIG = {
       'version' => 4,
@@ -33,6 +35,11 @@ module Puppet::DataProviders
       end
     end
 
+    def self.config_exist?(config_root)
+      config_path = config_root + 'hiera.yaml'
+      config_path.exist?
+    end
+
     def self.create_config_type
       hierarchy_elem_type_base = 'Struct[{'\
         'backend=>String[1],'\
@@ -58,6 +65,10 @@ module Puppet::DataProviders
     # @param config_root [Pathname] Absolute path to the configuration root
     # @api public
     def initialize(config_root)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'Puppet::DataProviders::HieraConfig',
+          "Use of class Puppet::DataProviders::HieraConfig' is deprecated. Puppet::Pops::Lookup::HieraConfig should be used instead", config_path.to_s)
+      end
       @config_root = config_root
       @config_path = config_root + 'hiera.yaml'
       if @config_path.exist?
@@ -92,7 +103,7 @@ module Puppet::DataProviders
       data_providers = {}
       @config['hierarchy'].each do |he|
         name = he['name']
-        raise Puppet::DataBinding::LookupError, "#{path}: Name '#{name}' defined more than once" if data_providers.include?(name)
+        raise Puppet::DataBinding::LookupError, "#{@config_path}: Name '#{name}' defined more than once" if data_providers.include?(name)
         original_paths = he['paths']
         if original_paths.nil?
           single_path = he['path']
@@ -100,17 +111,27 @@ module Puppet::DataProviders
           original_paths = [single_path]
         end
         paths = original_paths.map { |path| interpolate(path, lookup_invocation, false)}
-        provider_name = he['backend']
-        provider_factory = injector.lookup(nil, service_type, PATH_BASED_DATA_PROVIDER_FACTORIES_KEY)[provider_name]
-        raise Puppet::DataBinding::LookupError, "#{@config_path}: No data provider is registered for backend '#{provider_name}' " unless provider_factory
-
         datadir = @config_root + (he['datadir'] || default_datadir)
-        data_providers[name] = create_data_provider(parent_data_provider, provider_factory, name,
-          provider_factory.resolve_paths(datadir, original_paths, paths, lookup_invocation))
+        provider_name = he['backend']
+        data_providers[name] = case provider_name
+        when 'json', 'yaml'
+          Puppet::Pops::Lookup::DataHashFunctionProvider.new(name, parent_data_provider, "#{provider_name}_data", {},
+            resolve_paths(datadir, original_paths, lookup_invocation, ".#{provider_name}"))
+        else
+          # TODO: Remove support for injected provider factories
+          paths = original_paths.map { |path| interpolate(path, lookup_invocation, false)}
+          provider_factory = injector.lookup(nil, service_type, PATH_BASED_DATA_PROVIDER_FACTORIES_KEY)[provider_name]
+          raise Puppet::DataBinding::LookupError, "#{@config_path}: No data provider is registered for backend '#{provider_name}' " unless provider_factory
+          create_data_provider(parent_data_provider, provider_factory, name, provider_factory.resolve_paths(datadir, original_paths, paths, lookup_invocation))
+        end
       end
       data_providers.values
     end
 
+    def name
+      "hiera version #{version}"
+    end
+
     def create_data_provider(parent_data_provider, provider_factory, name, resolved_paths)
       provider_factory_version = provider_factory.respond_to?(:version) ? provider_factory.version : 1
       if provider_factory_version == 1

data/lib/puppet/data_providers/hiera_env_data_provider.rb

@@ -2,7 +2,9 @@
 require_relative 'hiera_support'
 
 module Puppet::DataProviders
+  # TODO: API 5.0, remove this class
   # @api private
+  # @deprecated
   class HieraEnvDataProvider < Puppet::Plugins::DataProviders::EnvironmentDataProvider
     include HieraSupport
 
@@ -12,6 +14,10 @@ module Puppet::DataProviders
     # @param scope [Puppet::Parser::Scope] the parser scope where the environment is found
     # @return [Pathname] Path to root of the environment
     def provider_root(_, scope)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'Puppet::DataProviders::HieraEnvDataProvider',
+        'Puppet::DataProviders::HieraEnvDataProvider is deprecated and will be removed in the next major version of Puppet')
+      end
       Pathname.new(scope.environment.configuration.path_to_env)
     end
     protected :provider_root

data/lib/puppet/data_providers/hiera_interpolate.rb

@@ -1,3 +1,4 @@
+# TODO: API 5.0, remove this module
 # @deprecated Moved to Puppet::Pops::Lookup::Interpolation
 module Puppet::DataProviders::HieraInterpolate
   include Puppet::Pops::Lookup::Interpolation
@@ -15,6 +16,6 @@ module Puppet::DataProviders::HieraInterpolate
         Puppet.warn_once(:deprecation, 'HieraInterpolate#qualified_lookup', msg)
       end
     end
-    sub_lookup('<unknown key>', Puppet::Pops::Lookup::Invocation.new(nil), segments, value)
+    sub_lookup('<unknown key>', Puppet::Pops::Lookup::Invocation.current, segments, value)
   end
 end

data/lib/puppet/data_providers/hiera_module_data_provider.rb

@@ -2,7 +2,9 @@
 require_relative 'hiera_support'
 
 module Puppet::DataProviders
+  # TODO: API 5.0, remove this class
   # @api private
+  # @deprecated
   class HieraModuleDataProvider < Puppet::Plugins::DataProviders::ModuleDataProvider
     include HieraSupport
 
@@ -14,6 +16,10 @@ module Puppet::DataProviders
     # @raise [Puppet::DataBinder::LookupError] if the given module is can not be found
     #
     def provider_root(module_name, scope)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'Puppet::DataProviders::HieraModuleDataProvider',
+        'Puppet::DataProviders::HieraModuleDataProvider is deprecated and will be removed in the next major version of Puppet')
+      end
       env = scope.environment
       mod = env.modules.find { |m| m.name == module_name }
       raise Puppet::DataBinder::LookupError, "Environment '#{env.name}', cannot find module '#{module_name}'" unless mod

data/lib/puppet/data_providers/hiera_support.rb

@@ -1,6 +1,8 @@
 require_relative 'hiera_config'
 
+# TODO: API 5.0, remove this module
 # @api private
+# @deprecated
 module Puppet::DataProviders::HieraSupport
   def config_path
     @hiera_config.nil? ? 'not yet configured' : @hiera_config.config_path
@@ -17,6 +19,10 @@ module Puppet::DataProviders::HieraSupport
   # @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
   def unchecked_lookup(key, lookup_invocation, merge)
+    unless Puppet[:strict] == :off
+      Puppet.warn_once(:deprecation, 'Puppet::DataProviders::HieraSupport',
+      'Puppet::DataProviders::HieraSupport is deprecated and will be removed in the next major version of Puppet')
+    end
     lookup_invocation.with(:data_provider, self) do
       merge_strategy = Puppet::Pops::MergeStrategy.strategy(merge)
       lookup_invocation.with(:merge, merge_strategy) do

data/lib/puppet/data_providers/json_data_provider_factory.rb

@@ -3,9 +3,15 @@
 require 'json'
 
 module Puppet::DataProviders
+  # TODO: API 5.0, remove this class
   # @api private
+  # @deprecated
   class JsonDataProviderFactory < Puppet::Plugins::DataProviders::FileBasedDataProviderFactory
     def create(name, paths, parent_data_provider)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'Puppet::DataProviders::JsonDataProviderFactory',
+          'Puppet::DataProviders::JsonDataProviderFactory is deprecated and will be removed in the next major version of Puppet')
+      end
       JsonDataProvider.new(name, paths, parent_data_provider)
     end
 
@@ -14,9 +20,15 @@ module Puppet::DataProviders
     end
   end
 
+  # TODO: API 5.0, remove this class
   # @api private
+  # @deprecated
   class JsonDataProvider < Puppet::Plugins::DataProviders::PathBasedDataProvider
     def initialize_data(path, lookup_invocation)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'Puppet::DataProviders::JsonDataProvider',
+          'Puppet::DataProviders::JsonDataProvider is deprecated and will be removed in the next major version of Puppet')
+      end
       JSON.parse(Puppet::FileSystem.read(path, :encoding => 'utf-8'))
     rescue JSON::ParserError => ex
       # Filename not included in message, so we add it here.

data/lib/puppet/data_providers/yaml_data_provider_factory.rb

@@ -3,9 +3,15 @@
 require 'yaml'
 
 module Puppet::DataProviders
+  # TODO: API 5.0, remove this class
   # @api private
+  # @deprecated
   class YamlDataProviderFactory < Puppet::Plugins::DataProviders::FileBasedDataProviderFactory
     def create(name, paths, parent_data_provider)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'Puppet::DataProviders::YamlDataProviderFactory',
+        'Puppet::DataProviders::YamlDataProviderFactory is deprecated and will be removed in the next major version of Puppet')
+      end
       YamlDataProvider.new(name, paths, parent_data_provider)
     end
 
@@ -14,9 +20,15 @@ module Puppet::DataProviders
     end
   end
 
+  # TODO: API 5.0, remove this class
   # @api private
+  # @deprecated
   class YamlDataProvider < Puppet::Plugins::DataProviders::PathBasedDataProvider
     def initialize_data(path, lookup_invocation)
+      unless Puppet[:strict] == :off
+        Puppet.warn_once(:deprecation, 'Puppet::DataProviders::YamlDataProvider',
+        'Puppet::DataProviders::YamlDataProvider is deprecated and will be removed in the next major version of Puppet')
+      end
       data = YAML.load_file(path)
       HieraConfig.symkeys_to_string(data.nil? ? {} : data)
     rescue YAML::SyntaxError => ex

data/lib/puppet/defaults.rb

@@ -419,7 +419,20 @@ deprecated and has been replaced by 'always_retry_plugins'."
     :data_binding_terminus => {
       :type    => :terminus,
       :default => "hiera",
-      :desc    => "Where to retrieve information about data.",
+      :desc    =>
+        "This setting has been deprecated. Use of any value other than 'hiera' should instead be configured
+         in a version 5 hiera.yaml. Until this setting is removed, it controls which data binding terminus
+         to use for global automatic data binding (across all environments). By default this value is 'hiera'.
+         A value of 'none' turns off the global binding.",
+      :call_hook => :on_initialize_and_write,
+      :hook => proc do |value|
+        if Puppet[:strict] != :off
+          s_val = value.to_s # because sometimes the value is a symbol
+          unless s_val == 'hiera' || s_val == 'none' || value == '' || value.nil?
+            Puppet.deprecation_warning "Setting 'data_binding_terminus' is deprecated. Convert custom terminus to hiera 5 API."
+          end
+        end
+      end
     },
     :hiera_config => {
       :default => lambda do
@@ -517,6 +530,10 @@ deprecated and has been replaced by 'always_retry_plugins'."
       read after the elapsed interval then the connection will be closed. The default value is unlimited.
       #{AS_DURATION}",
     },
+    :http_user_agent => {
+      :default => "Puppet/#{Puppet.version} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} (#{RUBY_PLATFORM})",
+      :desc    => "The HTTP User-Agent string to send when making network requests."
+    },
     :filetimeout => {
       :default    => "15s",
       :type       => :duration,
@@ -556,13 +573,17 @@ deprecated and has been replaced by 'always_retry_plugins'."
       inconsistent catalogs."
     },
     :environment_data_provider => {
-      :default    => "none",
       :desc       => "The name of a registered environment data provider used when obtaining environment
       specific data. The three built in and registered providers are 'none' (no data), 'function' (data
       obtained by calling the function 'environment::data()') and 'hiera' (data obtained using a data
       provider configured using a hiera.yaml file in root of the environment).
       Other environment data providers may be registered in modules on the module path. For such
-      custom data providers see the respective module documentation."
+      custom data providers see the respective module documentation. This setting is deprecated.",
+      :hook => proc { |value|
+        unless value.nil? || Puppet[:strict] == :off
+          Puppet.deprecation_warning "Setting 'environment_data_provider' is deprecated."
+        end
+      }
     },
     :prerun_command => {
       :default    => "",
@@ -1715,7 +1736,7 @@ EOT
     },
 
     :pluginsignore => {
-        :default  => ".svn CVS .git",
+        :default  => ".svn CVS .git .hg",
         :desc     => "What files to ignore when pulling down plugins.",
     }
   )

data/lib/puppet/face/ca.rb

@@ -254,4 +254,6 @@ Puppet::Face.define(:ca, '0.1.0') do
       end
     end
   end
+
+  deprecate
 end

data/lib/puppet/face/certificate_request.rb

@@ -51,4 +51,6 @@ Puppet::Indirector::Face.define(:certificate_request, '0.0.1') do
 
   get_action(:save).summary "API only: submit a certificate signing request."
   get_action(:save).arguments "<x509_CSR>"
+
+  deprecate
 end

data/lib/puppet/face/certificate_revocation_list.rb

@@ -51,4 +51,6 @@ Puppet::Indirector::Face.define(:certificate_revocation_list, '0.0.1') do
 
   deactivate_action(:search)
   deactivate_action(:save)
+
+  deprecate
 end

data/lib/puppet/face/file.rb

@@ -44,4 +44,7 @@ Puppet::Indirector::Face.define(:file, '0.0.1') do
   deactivate_action(:destroy)
 
   set_indirection_name :file_bucket_file
+
+  # The file face is deprecated
+  deprecate
 end

data/lib/puppet/face/help.rb

@@ -6,22 +6,22 @@ require 'erb'
 
 Puppet::Face.define(:help, '0.0.1') do
   copyright "Puppet Labs", 2011
-  license   "Apache 2 license; see COPYING"
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Display Puppet help."
+  summary _("Display Puppet help.")
 
   action(:help) do
-    summary "Display help about Puppet subcommands and their actions."
-    arguments "[<subcommand>] [<action>]"
-    returns "Short help text for the specified subcommand or action."
-    examples <<-'EOT'
+    summary _("Display help about Puppet subcommands and their actions.")
+    arguments _("[<subcommand>] [<action>]")
+    returns _("Short help text for the specified subcommand or action.")
+    examples _(<<-'EOT')
       Get help for an action:
 
       $ puppet help
     EOT
 
-    option "--version VERSION" do
-      summary "The version of the subcommand for which to show help."
+    option _("--version VERSION") do
+      summary _("The version of the subcommand for which to show help.")
     end
 
     default
@@ -47,7 +47,7 @@ Puppet::Face.define(:help, '0.0.1') do
           EOT
           353.times{i,x=i.divmod(1184);a,b=x.divmod(37);print(c[a]*b)}
         end
-        raise ArgumentError, "Puppet help only takes two (optional) arguments: a subcommand and an action"
+        raise ArgumentError, _("Puppet help only takes two (optional) arguments: a subcommand and an action")
       end
 
       version = :current
@@ -56,7 +56,7 @@ Puppet::Face.define(:help, '0.0.1') do
           version = options[:version]
         else
           if args.length == 0 then
-            raise ArgumentError, "Version only makes sense when a Faces subcommand is given"
+            raise ArgumentError, _("Version only makes sense when a Faces subcommand is given")
           end
         end
       end
@@ -66,7 +66,7 @@ Puppet::Face.define(:help, '0.0.1') do
       facename, actionname = args
       if legacy_applications.include? facename then
         if actionname then
-          raise ArgumentError, "Legacy subcommands don't take actions"
+          raise ArgumentError, _("Legacy subcommands don't take actions")
         end
         return render_application_help(facename)
       else
@@ -78,7 +78,7 @@ Puppet::Face.define(:help, '0.0.1') do
   def render_application_help(applicationname)
     return Puppet::Application[applicationname].help
   rescue StandardError, LoadError => detail
-    msg = <<-MSG
+    msg = _(<<-MSG)
 Could not load help for the application #{applicationname}.
 Please check the error logs for more information.
 
@@ -91,7 +91,7 @@ MSG
     face, action = load_face_help(facename, actionname, version)
     return template_for(face, action).result(binding)
   rescue StandardError, LoadError => detail
-    msg = <<-MSG
+    msg = _(<<-MSG)
 Could not load help for the face #{facename}.
 Please check the error logs for more information.
 
@@ -105,7 +105,7 @@ MSG
     if actionname
       action = face.get_action(actionname.to_sym)
       if not action
-        fail ArgumentError, "Unable to load action #{actionname} from #{face}"
+        fail ArgumentError, _("Unable to load action #{actionname} from #{face}")
       end
     end
 
@@ -146,9 +146,11 @@ MSG
       if (is_face_app?(appname))
         begin
           face = Puppet::Face[appname, :current]
-          result << [appname, face.summary]
+          # Add deprecation message to summary if the face is deprecated
+          summary = face.deprecated? ? face.summary + _(" (Deprecated)") : face.summary
+          result << [appname, summary]
         rescue StandardError, LoadError
-          result << [ "! #{appname}", "! Subcommand unavailable due to error. Check error logs." ]
+          result << [ "! #{appname}", _("! Subcommand unavailable due to error. Check error logs.") ]
         end
       else
         result << [appname, horribly_extract_summary_from(appname)]
@@ -169,7 +171,7 @@ MSG
         end
       end
     rescue StandardError, LoadError
-      return "! Subcommand unavailable due to error. Check error logs."
+      return _("! Subcommand unavailable due to error. Check error logs.")
     end
     return ''
   end