puppet 6.23.0 → 7.0.0

data/lib/puppet/http/service/file_server.rb

@@ -1,28 +1,24 @@
 require 'puppet/file_serving/metadata'
 
+# The FileServer service is used to retrieve file metadata and content.
 #
-# @api private
-#
-# The FileServer service is used to retrieve file metadata and content
+# @api public
 #
 class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
-  # @api private
   # @return [String] Default API for the FileServer service
   API = '/puppet/v3'.freeze
 
-  # @api private
   # @return [RegEx] RegEx used to determine if a path contains a leading slash
   PATH_REGEX = /^\//
 
-  #
-  # @api private
+  # Use `Puppet::HTTP::Session.route_to(:fileserver)` to create or get an instance of this class.
   #
   # @param [Puppet::HTTP::Client] client
   # @param [Puppet::HTTP::Session] session
-  # @param [String] server (Puppet[:ca_server]) If an explicit server is given,
+  # @param [String] server (`Puppet[:server]`) If an explicit server is given,
   #   create a service using that server. If server is nil, the default value
   #   is used to create the service.
-  # @param [Integer] port (Puppet[:ca_port]) If an explicit port is given, create
+  # @param [Integer] port (`Puppet[:masterport]`) If an explicit port is given, create
   #   a service using that port. If port is nil, the default value is used to
   #   create the service.
   #
@@ -31,19 +27,14 @@ class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
     super(client, session, url)
   end
 
-  #
-  # @api private
-  #
-  # Submit a GET request to the server to retrieve the metadata for a specified
-  # file
+  # Submit a GET request to the server to retrieve the metadata for a specified file.
   #
   # @param [String] path path to the file to retrieve data from
   # @param [String] environment the name of the environment we are operating in
   # @param [Symbol] links Can be one of either `:follow` or `:manage`, defines
   #   how links are handled.
   # @param [String] checksum_type The digest algorithm used to verify the file.
-  #   Currently if fips is enabled, this defaults to `sha256`. Otherwise, it
-  #   defaults to `md5`.
+  #   Defaults to `sha256`.
   # @param [Symbol] source_permissions Can be one of `:use`, `:use_when_creating`,
   #   or `:ignore`. This parameter tells the server if it should include the
   #   file permissions in the response. If set to `:ignore`, the server will
@@ -53,6 +44,8 @@ class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
   #   array with the request response and the deserialized metadata for the
   #   file returned from the server
   #
+  # @api public
+  #
   def get_file_metadata(path:, environment:, links: :manage, checksum_type: Puppet[:digest_algorithm], source_permissions: :ignore)
     validate_path(path)
 
@@ -74,9 +67,6 @@ class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
     [response, deserialize(response, Puppet::FileServing::Metadata)]
   end
 
-  #
-  # @api private
-  #
   # Submit a GET request to the server to retrieve the metadata for multiple files
   #
   # @param [String] path path to the file(s) to retrieve data from
@@ -106,7 +96,9 @@ class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
   #   An array with the request response and an array of the deserialized
   #   metadata for each file returned from the server
   #
-  def get_file_metadatas(path: nil, environment:, recurse: :false, recurselimit: nil, max_files: nil, ignore: nil, links: :manage, checksum_type: Puppet[:digest_algorithm], source_permissions: :ignore)
+  # @api public
+  #
+  def get_file_metadatas(path: nil, environment:, recurse: :false, recurselimit: nil, ignore: nil, links: :manage, checksum_type: Puppet[:digest_algorithm], source_permissions: :ignore)
     validate_path(path)
 
     headers = add_puppet_headers('Accept' => get_mime_types(Puppet::FileServing::Metadata).join(', '))
@@ -117,7 +109,6 @@ class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
       params: {
         recurse: recurse,
         recurselimit: recurselimit,
-        max_files: max_files,
         ignore: ignore,
         links: links,
         checksum_type: checksum_type,
@@ -131,10 +122,7 @@ class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
     [response, deserialize_multiple(response, Puppet::FileServing::Metadata)]
   end
 
-  #
-  # @api private
-  #
-  # Submit a GET request to the server to retrieve content of a file
+  # Submit a GET request to the server to retrieve content of a file.
   #
   # @param [String] path path to the file to retrieve data from
   # @param [String] environment the name of the environment we are operating in
@@ -143,6 +131,8 @@ class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
   #
   # @return [Puppet::HTTP::Response] The request response
   #
+  # @api public
+  #
   def get_file_content(path:, environment:, &block)
     validate_path(path)
 
@@ -164,10 +154,8 @@ class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
     response
   end
 
-  #
-  # @api private
-  #
-  # Submit a GET request to
+  # Submit a GET request to retrieve file content using the `static_file_content` API
+  # uniquely identified by (`code_id`, `environment`, `path`).
   #
   # @param [String] path path to the file to retrieve data from
   # @param [String] environment the name of the environment we are operating in
@@ -177,6 +165,8 @@ class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
   #
   # @return [Puppet::HTTP::Response] The request response
   #
+  # @api public
+  #
   def get_static_file_content(path:, environment:, code_id:, &block)
     validate_path(path)
 

data/lib/puppet/http/service/puppetserver.rb

@@ -1,38 +1,52 @@
 # The puppetserver service.
 #
-# @api private
+# @api public
 #
 class Puppet::HTTP::Service::Puppetserver < Puppet::HTTP::Service
+
+  # Use `Puppet::HTTP::Session.route_to(:puppetserver)` to create or get an instance of this class.
+  #
   # @param [Puppet::HTTP::Client] client
   # @param [Puppet::HTTP::Session] session
-  # @param [String] server If an explicit server is given,
+  # @param [String] server (`Puppet[:server]`) If an explicit server is given,
   #   create a service using that server. If server is nil, the default value
   #   is used to create the service.
-  # @param [Integer] port If an explicit port is given, create
+  # @param [Integer] port (`Puppet[:masterport]`) If an explicit port is given, create
   #   a service using that port. If port is nil, the default value is used to
   #   create the service.
-  # @api private
   #
   def initialize(client, session, server, port)
     url = build_url('', server || Puppet[:server], port || Puppet[:serverport])
     super(client, session, url)
   end
 
-  # Request the puppetserver's simple status
+  # Request the puppetserver's simple status.
   #
   # @param [Puppet::SSL::SSLContext] ssl_context to use when establishing
   # the connection.
   # @return Puppet::HTTP::Response The HTTP response
-  # @api private
+  #
+  # @api public
   #
   def get_simple_status(ssl_context: nil)
-    response = @client.get(
-      with_base_url("/status/v1/simple/master"),
-      headers: add_puppet_headers({}),
-      options: {ssl_context: ssl_context}
-    )
+    request_path = "/status/v1/simple/server"
+
+    begin
+      response = @client.get(
+        with_base_url(request_path),
+        headers: add_puppet_headers({}),
+        options: {ssl_context: ssl_context}
+      )
 
-    process_response(response)
+      process_response(response)
+    rescue Puppet::HTTP::ResponseError => e
+      if e.response.code == 404 && e.response.url.path == "/status/v1/simple/server"
+        request_path = "/status/v1/simple/master"
+        retry
+      else
+        raise e
+      end
+    end
 
     [response, response.body.to_s]
   end

data/lib/puppet/http/service/report.rb

@@ -1,16 +1,13 @@
+# The Report service is used to submit run reports to the report server.
 #
-# @api private
-#
-# The Report service is used to submit run reports to the report server
+# @api public
 #
 class Puppet::HTTP::Service::Report < Puppet::HTTP::Service
 
-  # @api private
   # @return [String] Default API for the report service
   API = '/puppet/v3'.freeze
 
-  #
-  # @api private
+  # Use `Puppet::HTTP::Session.route_to(:report)` to create or get an instance of this class.
   #
   # @param [Puppet::HTTP::Client] client
   # @param [Puppet::HTTP::Session] session
@@ -21,15 +18,14 @@ class Puppet::HTTP::Service::Report < Puppet::HTTP::Service
   #   a service using that port. If port is nil, the default value is used to
   #   create the service.
   #
+  # @api private
+  #
   def initialize(client, session, server, port)
     url = build_url(API, server || Puppet[:report_server], port || Puppet[:report_port])
     super(client, session, url)
   end
 
-  #
-  # @api private
-  #
-  # Submit a report to the report server
+  # Submit a report to the report server.
   #
   # @param [String] name the name of the report being submitted
   # @param [Puppet::Transaction::Report] report run report to be submitted
@@ -37,6 +33,8 @@ class Puppet::HTTP::Service::Report < Puppet::HTTP::Service
   #
   # @return [Puppet::HTTP::Response] response returned by the server
   #
+  # @api public
+  #
   def put_report(name, report, environment:)
     formatter = Puppet::Network::FormatHandler.format_for(Puppet[:preferred_serialization_format])
     headers = add_puppet_headers(

data/lib/puppet/http/session.rb

@@ -1,8 +1,6 @@
-#
-# @api private
-#
 # The session is the mechanism by which services may be connected to and accessed.
 #
+# @api public
 class Puppet::HTTP::Session
   # capabilities for a site
   CAP_LOCALES = 'locales'.freeze
@@ -14,16 +12,15 @@ class Puppet::HTTP::Session
   # puppet version where JSON was enabled by default
   SUPPORTED_JSON_DEFAULT = Gem::Version.new("5.0.0")
 
-  #
-  # @api private
-  #
   # Create a new HTTP session. The session is the mechanism by which services
-  # may be connected to and accessed.
+  # may be connected to and accessed. Sessions should be created using
+  # `Puppet::HTTP::Client#create_session`.
   #
   # @param [Puppet::HTTP::Client] client the container for this session
   # @param [Array<Puppet::HTTP::Resolver>] resolvers array of resolver strategies
   #   to implement.
   #
+  # @api private
   def initialize(client, resolvers)
     @client = client
     @resolvers = resolvers
@@ -31,9 +28,6 @@ class Puppet::HTTP::Session
     @server_versions = {}
   end
 
-  #
-  # @api private
-  #
   # If an explicit server and port are specified on the command line or
   # configuration file, this method always returns a Service with that host and
   # port. Otherwise, we walk the list of resolvers in priority order:
@@ -45,12 +39,13 @@ class Puppet::HTTP::Session
   # is cached and returned if `route_to` is called again.
   #
   # @param [Symbol] name the service to resolve
-  # @param [URI] url (nil) optional explicit url to use, if it is already known
-  # @param [Puppet::SSL::SSLContext] ssl_context ssl_context ssl context to be
+  # @param [URI] url optional explicit url to use, if it is already known
+  # @param [Puppet::SSL::SSLContext] ssl_context ssl context to be
   #   used for connections
   #
   # @return [Puppet::HTTP::Service] the resolved service
   #
+  # @api public
   def route_to(name, url: nil, ssl_context: nil)
     raise ArgumentError, "Unknown service #{name}" unless Puppet::HTTP::Service.valid_name?(name)
 
@@ -82,25 +77,20 @@ class Puppet::HTTP::Session
     raise Puppet::HTTP::RouteError, "No more routes to #{name}"
   end
 
-  #
-  # @api private
-  #
   # Collect per-site server versions. This will allow us to modify future
   # requests based on the version of puppetserver we are talking to.
   #
   # @param [Puppet::HTTP::Response] response the request response containing headers
   #
+  # @api private
   def process_response(response)
     version = response[Puppet::HTTP::HEADER_PUPPET_VERSION]
     if version
-      site = Puppet::Network::HTTP::Site.from_uri(response.url)
+      site = Puppet::HTTP::Site.from_uri(response.url)
       @server_versions[site] = version
     end
   end
 
-  #
-  # @api private
-  #
   # Determine if a session supports a capability. Depending on the server version
   # we are talking to, we know certain features are available or not. These
   # specifications are defined here so we can modify our requests appropriately.
@@ -110,13 +100,14 @@ class Puppet::HTTP::Session
   #
   # @return [Boolean]
   #
+  # @api public
   def supports?(name, capability)
     raise ArgumentError, "Unknown service #{name}" unless Puppet::HTTP::Service.valid_name?(name)
 
     service = @resolved_services[name]
     return false unless service
 
-    site = Puppet::Network::HTTP::Site.from_uri(service.url)
+    site = Puppet::HTTP::Site.from_uri(service.url)
     server_version = @server_versions[site]
 
     case capability

data/lib/puppet/{network/http → http}/site.rb

@@ -4,8 +4,7 @@
 # for the second.
 #
 # @api private
-#
-class Puppet::Network::HTTP::Site
+class Puppet::HTTP::Site
   attr_reader :scheme, :host, :port
 
   def self.from_uri(uri)

data/lib/puppet/indirector/catalog/compiler.rb

@@ -194,7 +194,6 @@ class Puppet::Resource::Catalog::Compiler < Puppet::Indirector::Code
           :source_permissions => resource[:source_permissions] ? resource[:source_permissions].to_sym : :ignore,
           :recurse            => true,
           :recurselimit       => resource[:recurselimit],
-          :max_files          => resource[:max_files],
           :ignore             => resource[:ignore],
         }
 

data/lib/puppet/indirector/catalog/rest.rb

@@ -5,8 +5,6 @@ class Puppet::Resource::Catalog::Rest < Puppet::Indirector::REST
   desc "Find resource catalogs over HTTP via REST."
 
   def find(request)
-    return super unless use_http_client?
-
     checksum_type = if request.options[:checksum_type]
                       request.options[:checksum_type].split('.')
                     else
@@ -30,11 +28,11 @@ class Puppet::Resource::Catalog::Rest < Puppet::Indirector::REST
     if e.response.code == 404
       return nil unless request.options[:fail_on_404]
 
-      _, body = parse_response(e.response.nethttp)
+      _, body = parse_response(e.response)
       msg = _("Find %{uri} resulted in 404 with the message: %{body}") % { uri: elide(e.response.url.path, 100), body: body }
       raise Puppet::Error, msg
     else
-      raise convert_to_http_error(e.response.nethttp)
+      raise convert_to_http_error(e.response)
     end
   end
 end

data/lib/puppet/indirector/facts/rest.rb

@@ -5,8 +5,6 @@ class Puppet::Node::Facts::Rest < Puppet::Indirector::REST
   desc "Find and save facts about nodes over HTTP via REST."
 
   def find(request)
-    return super unless use_http_client?
-
     session = Puppet.lookup(:http_session)
     api = session.route_to(:puppet)
     _, facts = api.get_facts(
@@ -18,19 +16,17 @@ class Puppet::Node::Facts::Rest < Puppet::Indirector::REST
     if e.response.code == 404
       return nil unless request.options[:fail_on_404]
 
-      _, body = parse_response(e.response.nethttp)
+      _, body = parse_response(e.response)
       msg = _("Find %{uri} resulted in 404 with the message: %{body}") % { uri: elide(e.response.url.path, 100), body: body }
       raise Puppet::Error, msg
     else
-      raise convert_to_http_error(e.response.nethttp)
+      raise convert_to_http_error(e.response)
     end
   end
 
   def save(request)
     raise ArgumentError, _("PUT does not accept options") unless request.options.empty?
 
-    return legacy_save(request) unless use_http_client?
-
     session = Puppet.lookup(:http_session)
     api = session.route_to(:puppet)
     api.put_facts(
@@ -43,21 +39,6 @@ class Puppet::Node::Facts::Rest < Puppet::Indirector::REST
     nil
   rescue Puppet::HTTP::ResponseError => e
     # always raise even if fail_on_404 is false
-    raise convert_to_http_error(e.response.nethttp)
-  end
-
-  private
-
-  def legacy_save(request)
-    response = do_request(request) do |req|
-      http_put(req, IndirectedRoutes.request_to_uri(req), req.instance.render, headers.merge({ "Content-Type" => req.instance.mime }))
-    end
-
-    if is_http_200?(response)
-      content_type, body = parse_response(response)
-      deserialize_save(content_type, body)
-    else
-      raise convert_to_http_error(response)
-    end
+    raise convert_to_http_error(e.response)
   end
 end

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

@@ -6,8 +6,6 @@ module Puppet::FileBucketFile
     desc "This is a REST based mechanism to send/retrieve file to/from the filebucket"
 
     def head(request)
-      return super unless use_http_client?
-
       session = Puppet.lookup(:http_session)
       api = session.route_to(:puppet)
       api.head_filebucket_file(
@@ -17,12 +15,10 @@ module Puppet::FileBucketFile
       )
     rescue Puppet::HTTP::ResponseError => e
       return nil if e.response.code == 404
-      raise convert_to_http_error(e.response.nethttp)
+      raise convert_to_http_error(e.response)
     end
 
     def find(request)
-      return super unless use_http_client?
-
       session = Puppet.lookup(:http_session)
       api = session.route_to(:puppet)
       _, filebucket_file = api.get_filebucket_file(
@@ -36,12 +32,10 @@ module Puppet::FileBucketFile
       )
       filebucket_file
     rescue Puppet::HTTP::ResponseError => e
-      raise convert_to_http_error(e.response.nethttp)
+      raise convert_to_http_error(e.response)
     end
 
     def save(request)
-      return super unless use_http_client?
-
       session = Puppet.lookup(:http_session)
       api = session.route_to(:puppet)
       api.put_filebucket_file(
@@ -50,7 +44,7 @@ module Puppet::FileBucketFile
         environment: request.environment.to_s,
       )
     rescue Puppet::HTTP::ResponseError => e
-      raise convert_to_http_error(e.response.nethttp)
+      raise convert_to_http_error(e.response)
     end
   end
 end