puppet 8.3.1 → 8.4.0

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

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
-Puppet::Network::HTTP::Request = Struct.new(:headers, :params, :method, :path, :routing_path, :client_cert, :body) do
+
+# This class is effectively public API, because a Request object is passed as a
+# parameter to the current Handler subclass. Puppetserver implements its own
+# Handler
+# https://github.com/puppetlabs/puppetserver/blob/8.3.0/src/ruby/puppetserver-lib/puppet/server/network/http/handler.rb#L9
+# and the Request object is passed to its Handler#body method
+# https://github.com/puppetlabs/puppetserver/blob/8.3.0/src/ruby/puppetserver-lib/puppet/server/network/http/handler.rb#L36
+Puppet::Network::HTTP::Request = Struct.new(:headers, :params, :method, :path, :routing_path, :client_cert, :body) do # rubocop:disable Lint/StructNewOverride
   def self.from_hash(hash)
     symbol_members = members.collect(&:intern)
     unknown = hash.keys - symbol_members
@@ -28,15 +35,15 @@ Puppet::Network::HTTP::Request = Struct.new(:headers, :params, :method, :path, :
 
       return format if valid_network_format?(format)
 
-      #TRANSLATORS "mime-type" is a keyword and should not be translated
+      # TRANSLATORS "mime-type" is a keyword and should not be translated
       raise Puppet::Network::HTTP::Error::HTTPUnsupportedMediaTypeError.new(
-              _("Client sent a mime-type (%{header}) that doesn't correspond to a format we support") % { header: headers['content-type'] },
-              Puppet::Network::HTTP::Issues::UNSUPPORTED_MEDIA_TYPE)
+        _("Client sent a mime-type (%{header}) that doesn't correspond to a format we support") % { header: headers['content-type'] },
+        Puppet::Network::HTTP::Issues::UNSUPPORTED_MEDIA_TYPE)
     end
 
     raise Puppet::Network::HTTP::Error::HTTPBadRequestError.new(
-            _("No Content-Type header was received, it isn't possible to unserialize the request"),
-            Puppet::Network::HTTP::Issues::MISSING_HEADER_FIELD)
+      _("No Content-Type header was received, it isn't possible to unserialize the request"),
+      Puppet::Network::HTTP::Issues::MISSING_HEADER_FIELD)
   end
 
   def response_formatters_for(supported_formats, default_accepted_formats = nil)

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Puppet::Network::HTTP::Response
   def initialize(handler, response)
     @handler = handler

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 class Puppet::Network::HTTP::Route
-  MethodNotAllowedHandler = lambda do |req, res|
+  MethodNotAllowedHandler = lambda do |req, _res|
     raise Puppet::Network::HTTP::Error::HTTPMethodNotAllowedError.new("method #{req.method} not allowed for route #{req.path}", Puppet::Network::HTTP::Issues::UNSUPPORTED_METHOD)
   end
 
@@ -56,7 +57,7 @@ class Puppet::Network::HTTP::Route
   end
 
   def any(*handlers)
-    @method_handlers.each do |method, registered_handlers|
+    @method_handlers.each do |method, _registered_handlers|
       @method_handlers[method] = handlers
     end
     return self
@@ -74,6 +75,7 @@ class Puppet::Network::HTTP::Route
     else
       Puppet.debug { "Did not match path (#{request.routing_path.inspect})" }
     end
+
     return false
   end
 

data/lib/puppet/network/http.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # This module is used to handle puppet REST requests in puppetserver.
 module Puppet::Network::HTTP
   HEADER_ENABLE_PROFILING = "X-Puppet-Profiling"

data/lib/puppet/network/http_pool.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/network/http/connection'
 
 module Puppet::Network; end
@@ -9,12 +10,12 @@ module Puppet::Network; end
 # @deprecated Use {Puppet::HTTP::Client} instead.
 #
 module Puppet::Network::HttpPool
-
   @http_client_class = Puppet::Network::HTTP::Connection
 
   def self.http_client_class
     @http_client_class
   end
+
   def self.http_client_class=(klass)
     @http_client_class = klass
   end

data/lib/puppet/network/uri.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # This module holds funtions for network URI's
 module Puppet::Network::Uri
   # Mask credentials in given URI or address as string. Resulting string will

data/lib/puppet/network.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Just a stub, so we can correctly scope other classes.
 module Puppet::Network # :nodoc:
 end

data/lib/puppet/node/environment.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/util'
 require 'monitor'
 require_relative '../../puppet/parser/parser_factory'
@@ -23,7 +24,6 @@ end
 # logging functions. Logging functions are attached to the 'root' environment
 # when {Puppet::Parser::Functions.reset} is called.
 class Puppet::Node::Environment
-
   NO_MANIFEST = :no_manifest
 
   # The create() factory method should be used instead.
@@ -88,9 +88,9 @@ class Puppet::Node::Environment
   # @return [Puppet::Node::Environment]
   def override_with(env_params)
     return self.class.create(name,
-                      env_params[:modulepath] || modulepath,
-                      env_params[:manifest] || manifest,
-                      env_params[:config_version] || config_version)
+                             env_params[:modulepath] || modulepath,
+                             env_params[:manifest] || manifest,
+                             env_params[:config_version] || config_version)
   end
 
   # Creates a new Puppet::Node::Environment instance, overriding :manifest,
@@ -221,6 +221,7 @@ class Puppet::Node::Environment
   # @api private
   def conflicting_manifest_settings?
     return false if !Puppet[:disable_per_environment_manifest]
+
     original_manifest = configuration.raw_setting(:manifest)
     !original_manifest.nil? && !original_manifest.empty? && original_manifest != Puppet[:default_manifest]
   end
@@ -355,6 +356,7 @@ class Puppet::Node::Environment
           Puppet::FileSystem.basename_string(p)
         end.each do |name|
           next unless Puppet::Module.is_module_directory?(name, path)
+
           warn_about_mistaken_path(path, name)
           if not seen_modules[name]
             module_references << {:name => name, :path => File.join(path, name)}
@@ -453,13 +455,14 @@ class Puppet::Node::Environment
 
     modules.each do |mod|
       next unless mod.forge_name
+
       deps[mod.forge_name] ||= []
 
       mod.dependencies and mod.dependencies.each do |mod_dep|
         dep_name = mod_dep['name'].tr('-', '/')
         (deps[dep_name] ||= []) << {
-          'name'                => mod.forge_name,
-          'version'             => mod.version,
+          'name' => mod.forge_name,
+          'version' => mod.version,
           'version_requirement' => mod_dep['version_requirement']
         }
       end
@@ -595,9 +598,9 @@ class Puppet::Node::Environment
         # JRuby does not properly perform Dir.glob operations with wildcards, (see PUP-11788 and https://github.com/jruby/jruby/issues/7836).
         # We sort the results because Dir.glob order is inconsistent in Ruby < 3 (see PUP-10115).
         parse_results = Puppet::FileSystem::PathPattern.absolute(File.join(file, '**/*')).glob.select {|globbed_file| globbed_file.end_with?('.pp')}.sort.map do | file_to_parse |
-                          parser.file = file_to_parse
-                          parser.parse
-                        end
+          parser.file = file_to_parse
+          parser.parse
+        end
         # Use a parser type specific merger to concatenate the results
         Puppet::Parser::AST::Hostclass.new('', :code => Puppet::Parser::ParserFactory.code_merger.concatenate(parse_results))
       else

data/lib/puppet/node/facts.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 require 'time'
 
 require_relative '../../puppet/node'
 require_relative '../../puppet/indirector'
 require_relative '../../puppet/util/psych_support'
 
-
 # Manage a given node's facts.  This either accepts facts and stores them, or
 # returns facts for a given node.
 class Puppet::Node::Facts
@@ -79,6 +79,7 @@ class Puppet::Node::Facts
 
   def ==(other)
     return false unless self.name == other.name
+
     values == other.values
   end
 

data/lib/puppet/node.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../puppet/indirector'
 
 # A class for managing nodes, including their facts and environment.
@@ -92,7 +93,6 @@ class Puppet::Node
       @parameters[ENVIRONMENT] = @environment.name.to_s
       self.environment_name = @environment.name
     end
-    @environment
   end
 
   def has_environment_instance?
@@ -101,6 +101,7 @@ class Puppet::Node
 
   def initialize(name, options = {})
     raise ArgumentError, _("Node names cannot be nil") unless name
+
     @name = name
 
     classes = options[:classes]
@@ -190,7 +191,7 @@ class Puppet::Node
   def split_name(name)
     list = name.split(".")
     tmp = []
-    list.each_with_index do |short, i|
+    list.each_with_index do |_short, i|
       tmp << list[0..i].join(".")
     end
     tmp.reverse

data/lib/puppet/pal/catalog_compiler.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
 module Pal
   # A CatalogCompiler is a compiler that builds a catalog of resources and dependencies as a side effect of
@@ -9,7 +10,6 @@ module Pal
   #
   # @api public
   class CatalogCompiler < Compiler
-
     # @api private
     def catalog
       internal_compiler.catalog
@@ -63,7 +63,6 @@ module Pal
       end
     end
 
-
     # Compiles the result of additional evaluation taking place in a PAL catalog compilation.
     # This will evaluate all lazy constructs until all have been evaluated, and will the validate
     # the result.
@@ -104,6 +103,5 @@ module Pal
       internal_compiler.evaluate_ast_node
     end
   end
-
 end
 end

data/lib/puppet/pal/compiler.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 module Puppet
 module Pal
-
   # A configured compiler as obtained in the callback from `Puppet::Pal.with_script_compiler`.
   # (Later, there may also be a catalog compiler available.)
   #
@@ -46,6 +46,7 @@ module Pal
       if func
         return FunctionSignature.new(func.class)
       end
+
       # Could not find function
       nil
     end
@@ -87,6 +88,7 @@ module Pal
       unless puppet_code.is_a?(String)
         raise ArgumentError, _("The argument 'puppet_code' must be a String, got %{type}") % { type: puppet_code.class }
       end
+
       evaluate(parse_string(puppet_code, source_file))
     end
 
@@ -141,6 +143,7 @@ module Pal
       unless code_string.is_a?(String)
         raise ArgumentError, _("The argument 'code_string' must be a String, got %{type}") % { type: code_string.class }
       end
+
       internal_evaluator.parse_string(code_string, source_file)
     end
 
@@ -154,6 +157,7 @@ module Pal
       unless file.is_a?(String)
         raise ArgumentError, _("The argument 'file' must be a String, got %{type}") % { type: file.class }
       end
+
       internal_evaluator.parse_file(file)
     end
 
@@ -191,6 +195,7 @@ module Pal
       unless t.is_a?(Puppet::Pops::Types::PAnyType)
         raise ArgumentError, _("Given data_type value is not a data type, got '%{type}'") % {type: t.class}
       end
+
       call_function('new', t, *arguments)
     end
 
@@ -218,6 +223,5 @@ module Pal
       internal_compiler.topscope
     end
   end
-
 end
 end

data/lib/puppet/pal/function_signature.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
 module Pal
   # A FunctionSignature is returned from `function_signature`. Its purpose is to answer questions about the function's parameters
@@ -32,6 +33,7 @@ module Pal
 
       return true if callables.any? {|t| t.callable_with?(args) }
       return false unless block_given?
+
       args_type = Puppet::Pops::Types::TypeCalculator.singleton.infer_set(callable.nil? ? args : args + [callable])
       error_message = Puppet::Pops::Types::TypeMismatchDescriber.describe_signatures(@func.name, @func.signatures, args_type)
       yield error_message
@@ -48,6 +50,5 @@ module Pal
       signatures.is_a?(Puppet::Pops::Types::PVariantType) ? signatures.types : [signatures]
     end
   end
-
 end
 end

data/lib/puppet/pal/json_catalog_encoder.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # The JsonCatalogEncoder is a wrapper around a catalog produced by the Pal::CatalogCompiler.with_json_encoding
 # method.
 # It allows encoding the entire catalog or an individual resource as Rich Data Json.
@@ -53,8 +54,10 @@ class JsonCatalogEncoder
     #
     # TRANSLATORS 'type' and 'title' are internal parameter names - do not translate
     raise ArgumentError, _("Both type and title must be given") if type.nil? or title.nil?
+
     r = possibly_filtered_catalog.resource(type, title)
     return nil if r.nil?
+
     r.to_data_hash.to_json(:pretty => pretty)
   end
 
@@ -62,11 +65,12 @@ class JsonCatalogEncoder
   # or the catalog itself if filtering was not needed.
   # The result is cached.
   # @api private
-  #
+  # rubocop:disable Naming/MemoizedInstanceVariableName
   def possibly_filtered_catalog
     @filtered ||= (exclude_virtual ? catalog.filter { |r| r.virtual? } : catalog)
   end
   private :possibly_filtered_catalog
+  # rubocop:enable Naming/MemoizedInstanceVariableName
 end
 end
 end

data/lib/puppet/pal/pal_api.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
   require_relative '../../puppet/parser/script_compiler'
   require_relative '../../puppet/parser/catalog_compiler'

data/lib/puppet/pal/pal_impl.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Puppet as a Library "PAL"
 
 # Yes, this requires all of puppet for now because 'settings' and many other things...
@@ -28,7 +29,6 @@ module Puppet
 #
 # @api public
 module Pal
-
   # Defines a context in which multiple operations in an env with a script compiler can be performed in a given block.
   # The calls that takes place to PAL inside of the given block are all with the same instance of the compiler.
   # The parameter `configured_by_env` makes it possible to either use the configuration in the environment, or specify
@@ -57,14 +57,14 @@ module Pal
   # @yieldparam [Puppet::Pal::ScriptCompiler] compiler, a ScriptCompiler to perform operations on.
   #
   def self.with_script_compiler(
-      configured_by_env: false,
+    configured_by_env: false,
       manifest_file:     nil,
       code_string:       nil,
       facts:             {},
       variables:         {},
       set_local_facts:   true,
       &block
-    )
+  )
     # TRANSLATORS: do not translate variable name strings in these assertions
     assert_mutually_exclusive(manifest_file, code_string, 'manifest_file', 'code_string')
     assert_non_empty_string(manifest_file, 'manifest_file', true)
@@ -76,6 +76,7 @@ module Pal
         # TRANSLATORS: do not translate the variable names in this error message
         raise ArgumentError, _("manifest_file or code_string cannot be given when configured_by_env is true")
       end
+
       # Use the manifest setting
       manifest_file = Puppet[:manifest]
     else
@@ -96,11 +97,11 @@ module Pal
     # If manifest_file is nil, the #main method will use the env configured manifest
     # to do things in the block while a Script Compiler is in effect
     main(
-      manifest:                manifest_file,
-      facts:                   facts,
-      variables:               variables,
+      manifest: manifest_file,
+      facts: facts,
+      variables: variables,
       internal_compiler_class: :script,
-      set_local_facts:         set_local_facts,
+      set_local_facts: set_local_facts,
       &block
     )
   ensure
@@ -182,6 +183,7 @@ module Pal
         # TRANSLATORS: do not translate the variable names in this error message
         raise ArgumentError, _("manifest_file or code_string cannot be given when configured_by_env is true")
       end
+
       # Use the manifest setting
       manifest_file = Puppet[:manifest]
     else
@@ -204,12 +206,12 @@ module Pal
     # If manifest_file is nil, the #main method will use the env configured manifest
     # to do things in the block while a Script Compiler is in effect
     main(
-      manifest:                manifest_file,
-      facts:                   facts,
-      variables:               variables,
-      target_variables:        target_variables,
+      manifest: manifest_file,
+      facts: facts,
+      variables: variables,
+      target_variables: target_variables,
       internal_compiler_class: :catalog,
-      set_local_facts:         false,
+      set_local_facts: false,
       &block
     )
   ensure
@@ -235,7 +237,7 @@ module Pal
       facts:         nil,
       variables:     {},
       &block
-    )
+  )
     assert_non_empty_string(env_name, _("temporary environment name"))
     # TRANSLATORS: do not translate variable name string in these assertions
     assert_optionally_empty_array(modulepath, 'modulepath')
@@ -249,7 +251,7 @@ module Pal
     in_environment_context(
       Puppet::Environments::Static.new(env), # The tmp env is the only known env
       env, facts, variables, &block
-      )
+    )
   end
 
   # Defines the context in which to perform puppet operations (evaluation, etc)
@@ -278,7 +280,7 @@ module Pal
   #
   # @api public
   def self.in_environment(env_name,
-      modulepath:    nil,
+      modulepath: nil,
       pre_modulepath: [],
       post_modulepath: [],
       settings_hash: {},
@@ -287,7 +289,7 @@ module Pal
       facts:         nil,
       variables:     {},
       &block
-    )
+  )
     # TRANSLATORS terms in the assertions below are names of terms in code
     assert_non_empty_string(env_name, 'env_name')
     assert_optionally_empty_array(modulepath, 'modulepath', true)
@@ -326,6 +328,7 @@ module Pal
       if env.nil?
         raise ArgumentError, _("No directory found for the environment '%{env_name}' on the path '%{envpath}'") % { env_name: env_name, envpath: envpath }
       end
+
       # A given modulepath should override the default
       mid_modulepath = modulepath.nil? ? env.modulepath : modulepath
       env_path = env.configuration.path_to_env
@@ -479,7 +482,7 @@ module Pal
         # TODO: The compiler instances should be available under non PAL use as well!
         # TRANSLATORS: Do not translate, symbolic name
         Puppet.override(overrides, "PAL::with_#{internal_compiler_class}_compiler") do
-          compiler.compile do | compiler_yield |
+          compiler.compile do | _compiler_yield |
             # In case the variables passed to the compiler are PCore types defined in modules, they
             # need to be deserialized and added from within the this scope, so that loaders are
             # available during deserizlization.
@@ -497,11 +500,9 @@ module Pal
             end
           end
         end
-
       rescue Puppet::Error
         # already logged and handled by the compiler, including Puppet::ParseErrorWithIssue
         raise
-
       rescue => detail
         Puppet.log_exception(detail)
         raise

data/lib/puppet/pal/plan_signature.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
 module Pal
   # A PlanSignature is returned from `plan_signature`. Its purpose is to answer questions about the plans's parameters
@@ -48,6 +49,7 @@ module Pal
 
       errors = Puppet::Pops::Types::TypeMismatchDescriber.singleton.describe_struct_signature(dispatcher.params_struct, param_scope).flatten
       return true if errors.empty?
+
       if block_given?
         yield errors.map {|e| e.format }.join("\n")
       end
@@ -67,6 +69,5 @@ module Pal
       dispatcher.params_struct
     end
   end
-
 end
 end

data/lib/puppet/pal/script_compiler.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 module Puppet
 module Pal
-
   class ScriptCompiler < Compiler
     # Returns the signature of the given plan name
     # @param plan_name [String] the name of the plan to get the signature of
@@ -13,6 +13,7 @@ module Pal
       if func
         return PlanSignature.new(func)
       end
+
       # Could not find plan
       nil
     end
@@ -46,6 +47,7 @@ module Pal
       if task
         return TaskSignature.new(task)
       end
+
       # Could not find task
       nil
     end
@@ -69,6 +71,5 @@ module Pal
       list_loadable_kind(:task, filter_regex, error_collector)
     end
   end
-
 end
 end

data/lib/puppet/pal/task_signature.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet
 module Pal
   # A TaskSignature is returned from `task_signature`. Its purpose is to answer questions about the task's parameters
@@ -21,19 +22,24 @@ module Pal
     def runnable_with?(args_hash)
       params = @task.parameters
       params_type = if params.nil?
-        T_GENERIC_TASK_HASH
-      else
-        Puppet::Pops::Types::TypeFactory.struct(params)
-      end
+                      T_GENERIC_TASK_HASH
+                    else
+                      Puppet::Pops::Types::TypeFactory.struct(params)
+                    end
       return true if params_type.instance?(args_hash)
 
       if block_given?
         tm = Puppet::Pops::Types::TypeMismatchDescriber.singleton
         error = if params.nil?
-          tm.describe_mismatch('', params_type, Puppet::Pops::Types::TypeCalculator.infer_set(args_hash))
-        else
-          tm.describe_struct_signature(params_type, args_hash).flatten.map {|e| e.format }.join("\n")
-        end
+                  tm.describe_mismatch('', params_type, 
+                                       Puppet::Pops::Types::TypeCalculator
+                                         .infer_set(args_hash))
+                else
+                  tm.describe_struct_signature(params_type, args_hash)
+                    .flatten
+                    .map {|e| e.format }
+                    .join("\n")
+                end
         yield "Task #{@task.name}:\n#{error}"
       end
       false
@@ -54,6 +60,5 @@ module Pal
       @task
     end
   end
-
 end
 end

data/lib/puppet/parameter/boolean.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/coercion'
 
 # This specialized {Puppet::Parameter} handles Boolean options, accepting lots

data/lib/puppet/parameter/package_options.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/parameter'
 
 # This specialized {Puppet::Parameter} handles munging of package options.

data/lib/puppet/parameter/path.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/parameter'
 
 # This specialized {Puppet::Parameter} handles validation and munging of paths.
@@ -12,6 +13,7 @@ class Puppet::Parameter::Path < Puppet::Parameter
   def self.accept_arrays(bool = true)
     @accept_arrays = !!bool
   end
+
   def self.arrays?
     @accept_arrays
   end
@@ -53,6 +55,7 @@ class Puppet::Parameter::Path < Puppet::Parameter
     if paths.is_a?(Array) and ! self.class.arrays? then
       fail _("%{name} only accepts a single path, not an array of paths") % { name: name }
     end
+
     paths
   end
 end

data/lib/puppet/parameter/value.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/parameter/value_collection'
 
 # Describes an acceptable value for a parameter or property.