puppet 6.16.0-universal-darwin → 7.0.0-universal-darwin

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

@@ -1,49 +1,40 @@
 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.
   #
   def initialize(client, session, server, port)
-    url = build_url(API, server || Puppet[:server], port || Puppet[:masterport])
+    url = build_url(API, server || Puppet[:server], port || Puppet[:serverport])
     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,6 +96,8 @@ 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
   #
+  # @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)
 
@@ -130,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
@@ -142,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)
 
@@ -163,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
@@ -176,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

@@ -0,0 +1,53 @@
+# The puppetserver service.
+#
+# @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 (`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[: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.
+  #
+  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.
+  #
+  # @param [Puppet::SSL::SSLContext] ssl_context to use when establishing
+  # the connection.
+  # @return Puppet::HTTP::Response The HTTP response
+  #
+  # @api public
+  #
+  def get_simple_status(ssl_context: nil)
+    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)
+    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
+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)
 
@@ -64,42 +59,38 @@ class Puppet::HTTP::Session
     cached = @resolved_services[name]
     return cached if cached
 
-    resolution_exceptions = []
-    error_handler = proc { |e| resolution_exceptions << e }
+    canceled = false
+    canceled_handler  = lambda { |cancel| canceled = cancel }
 
     @resolvers.each do |resolver|
       Puppet.debug("Resolving service '#{name}' using #{resolver.class}")
-      service = resolver.resolve(self, name, ssl_context: ssl_context, error_handler: error_handler)
+      service = resolver.resolve(self, name, ssl_context: ssl_context, canceled_handler: canceled_handler)
       if service
         @resolved_services[name] = service
         Puppet.debug("Resolved service '#{name}' to #{service.url}")
         return service
+      elsif canceled
+        break
       end
     end
 
-    resolution_exceptions.each { |e| Puppet.log_exception(e) }
     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.
@@ -109,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.rb

@@ -46,7 +46,7 @@ module Puppet::Indirector
 
     # instantiate the actual Terminus for that type and this name (:ldap, w/ args :node)
     # & hook the instantiated Terminus into this class (Node: @indirection = terminus)
-    @indirection = Puppet::Indirector::Indirection.new(self, indirection, options)
+    @indirection = Puppet::Indirector::Indirection.new(self, indirection, **options)
   end
 
   module ClassMethods

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

@@ -75,7 +75,7 @@ class Puppet::Resource::Catalog::Compiler < Puppet::Indirector::Code
 
   # Is our compiler part of a network, or are we just local?
   def networked?
-    Puppet.run_mode.master?
+    Puppet.run_mode.server?
   end
 
   private

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/exec.rb

@@ -22,7 +22,7 @@ class Puppet::Indirector::Exec < Puppet::Indirector::Terminus
     end
 
     if output =~ /\A\s*\Z/ # all whitespace
-      Puppet.debug "Empty response for #{name} from #{self.name} terminus"
+      Puppet.debug { "Empty response for #{name} from #{self.name} terminus" }
       return nil
     else
       return output

data/lib/puppet/indirector/fact_search.rb

@@ -0,0 +1,60 @@
+# module containing common methods used by json and yaml facts indirection terminus
+module Puppet::Indirector::FactSearch
+  def node_matches?(facts, options)
+    options.each do |key, value|
+      type, name, operator = key.to_s.split(".")
+      operator ||= 'eq'
+
+      return false unless node_matches_option?(type, name, operator, value, facts)
+    end
+    return true
+  end
+
+  def node_matches_option?(type, name, operator, value, facts)
+    case type
+    when "meta"
+      case name
+      when "timestamp"
+        compare_timestamp(operator, facts.timestamp, Time.parse(value))
+      end
+    when "facts"
+      compare_facts(operator, facts.values[name], value)
+    end
+  end
+
+  def compare_facts(operator, value1, value2)
+    return false unless value1
+
+    case operator
+    when "eq"
+      value1.to_s == value2.to_s
+    when "le"
+      value1.to_f <= value2.to_f
+    when "ge"
+      value1.to_f >= value2.to_f
+    when "lt"
+      value1.to_f < value2.to_f
+    when "gt"
+      value1.to_f > value2.to_f
+    when "ne"
+      value1.to_s != value2.to_s
+    end
+  end
+
+  def compare_timestamp(operator, value1, value2)
+    case operator
+    when "eq"
+      value1 == value2
+    when "le"
+      value1 <= value2
+    when "ge"
+      value1 >= value2
+    when "lt"
+      value1 < value2
+    when "gt"
+      value1 > value2
+    when "ne"
+      value1 != value2
+    end
+  end
+end