puppet 6.19.0 → 7.3.0

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/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/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

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

@@ -32,8 +32,14 @@ class Puppet::Node::Facts::Facter < Puppet::Indirector::Code
     # Initialize core Puppet facts, such as puppetversion
     Puppet.initialize_facts
 
-    result = Puppet::Node::Facts.new(request.key, Facter.to_hash)
-    result.add_local_facts
+    result = if request.options[:resolve_options]
+               raise(Puppet::Error, _("puppet facts show requires version 4.0.40 or greater of Facter.")) unless Facter.respond_to?(:resolve)
+               find_with_options(request)
+             else
+               Puppet::Node::Facts.new(request.key, Facter.to_hash)
+             end
+
+    result.add_local_facts unless request.options[:resolve_options]
     result.sanitize
     result
   end
@@ -61,7 +67,7 @@ class Puppet::Node::Facts::Facter < Puppet::Indirector::Code
 
       true
     end
-
+    dirs << request.options[:custom_dir] if request.options[:custom_dir]
     Facter.search(*dirs)
   end
 
@@ -83,6 +89,21 @@ class Puppet::Node::Facts::Facter < Puppet::Indirector::Code
       dirs << dir
     end
 
+    dirs << request.options[:external_dir] if request.options[:external_dir]
     Facter.search_external dirs
   end
+
+  private
+
+  def find_with_options(request)
+    options = request.options
+    options_for_facter = String.new
+    options_for_facter += options[:user_query].join(' ')
+    options_for_facter += " --config #{options[:config_file]}" if options[:config_file]
+    options_for_facter += " --show-legacy" if options[:show_legacy]
+    options_for_facter += " --no-block" if options[:no_block] == false
+    options_for_facter += " --no-cache" if options[:no_cache] == false
+
+    Puppet::Node::Facts.new(request.key, Facter.resolve(options_for_facter))
+  end
 end

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

@@ -0,0 +1,27 @@
+require 'puppet/node/facts'
+require 'puppet/indirector/json'
+require 'puppet/indirector/fact_search'
+
+class Puppet::Node::Facts::Json < Puppet::Indirector::JSON
+  desc "Store client facts as flat files, serialized using JSON, or
+    return deserialized facts from disk."
+
+  include Puppet::Indirector::FactSearch
+  
+  def search(request)
+    node_names = []
+    Dir.glob(json_dir_path).each do |file|
+      facts = load_json_from_file(file, '')
+      if facts && node_matches?(facts, request.options)
+        node_names << facts.name
+      end
+    end
+    node_names
+  end
+
+  private
+
+  def json_dir_path
+    self.path("*")
+  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/facts/yaml.rb

@@ -1,10 +1,13 @@
 require 'puppet/node/facts'
 require 'puppet/indirector/yaml'
+require 'puppet/indirector/fact_search'
 
 class Puppet::Node::Facts::Yaml < Puppet::Indirector::Yaml
   desc "Store client facts as flat files, serialized using YAML, or
     return deserialized facts from disk."
 
+  include Puppet::Indirector::FactSearch
+
   def search(request)
     node_names = []
     Dir.glob(yaml_dir_path).each do |file|
@@ -23,62 +26,4 @@ class Puppet::Node::Facts::Yaml < Puppet::Indirector::Yaml
     base = Puppet.run_mode.server? ? Puppet[:yamldir] : Puppet[:clientyamldir]
     File.join(base, 'facts', '*.yaml')
   end
-
-  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

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