openvox 8.19.0

data/lib/puppet/reports/store.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative '../../puppet'
+require 'fileutils'
+require_relative '../../puppet/util'
+
+SEPARATOR = [Regexp.escape(File::SEPARATOR.to_s), Regexp.escape(File::ALT_SEPARATOR.to_s)].join
+
+Puppet::Reports.register_report(:store) do
+  desc "Store the yaml report on disk.  Each host sends its report as a YAML dump
+    and this just stores the file on disk, in the `reportdir` directory.
+
+    These files collect quickly -- one every half hour -- so it is a good idea
+    to perform some maintenance on them if you use this report (it's the only
+    default report)."
+
+  def process
+    validate_host(host)
+
+    dir = File.join(Puppet[:reportdir], host)
+
+    unless Puppet::FileSystem.exist?(dir)
+      FileUtils.mkdir_p(dir)
+      FileUtils.chmod_R(0o750, dir)
+    end
+
+    # Now store the report.
+    now = Time.now.gmtime
+    name = %w[year month day hour min].collect do |method|
+      # Make sure we're at least two digits everywhere
+      "%02d" % now.send(method).to_s
+    end.join("") + ".yaml"
+
+    file = File.join(dir, name)
+
+    begin
+      Puppet::FileSystem.replace_file(file, 0o640) do |fh|
+        fh.print to_yaml
+      end
+    rescue => detail
+      Puppet.log_exception(detail, "Could not write report for #{host} at #{file}: #{detail}")
+    end
+
+    # Only testing cares about the return value
+    file
+  end
+
+  # removes all reports for a given host?
+  def self.destroy(host)
+    validate_host(host)
+
+    dir = File.join(Puppet[:reportdir], host)
+
+    if Puppet::FileSystem.exist?(dir)
+      Dir.entries(dir).each do |file|
+        next if ['.', '..'].include?(file)
+
+        file = File.join(dir, file)
+        Puppet::FileSystem.unlink(file) if File.file?(file)
+      end
+      Dir.rmdir(dir)
+    end
+  end
+
+  def validate_host(host)
+    if host =~ Regexp.union(/[#{SEPARATOR}]/, /\A\.\.?\Z/)
+      raise ArgumentError, _("Invalid node name %{host}") % { host: host.inspect }
+    end
+  end
+  module_function :validate_host
+end

data/lib/puppet/reports.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative '../puppet/util/instance_loader'
+
+# This class is an implementation of a simple mechanism for loading and returning reports.
+# The intent is that a user registers a report by calling {register_report} and providing a code
+# block that performs setup, and defines a method called `process`. The setup, and the `process` method
+# are called in the context where `self` is an instance of {Puppet::Transaction::Report} which provides the actual
+# data for the report via its methods.
+#
+# @example Minimal scaffolding for a report...
+#   Puppet::Reports::.register_report(:myreport) do
+#     # do setup here
+#     def process
+#       if self.status == 'failed'
+#         msg = "failed puppet run for #{self.host} #{self.status}"
+#         . . .
+#       else
+#         . . .
+#       end
+#     end
+#   end
+#
+# Required configuration:
+# --
+# * A .rb file that defines a new report should be placed in the master's directory `lib/puppet/reports`
+# * The `puppet.conf` file must have `report = true` in the `[agent]` section
+#
+# @see Puppet::Transaction::Report
+# @api public
+#
+class Puppet::Reports
+  extend Puppet::Util::ClassGen
+  extend Puppet::Util::InstanceLoader
+
+  # Set up autoloading and retrieving of reports.
+  instance_load :report, 'puppet/reports'
+
+  class << self
+    # @api private
+    attr_reader :hooks
+  end
+
+  # Adds a new report type.
+  # The block should contain setup, and define a method with the name `process`. The `process` method is
+  # called when the report is executed; the `process` method has access to report data via methods available
+  # in its context where `self` is an instance of {Puppet::Transaction::Report}.
+  #
+  # For an example, see the overview of this class.
+  #
+  # @param name [Symbol] the name of the report (do not use whitespace in the name).
+  # @param options [Hash] a hash of options
+  # @option options [Boolean] :useyaml whether yaml should be used or not
+  # @todo Uncertain what the options :useyaml really does; "whether yaml should be used or not", used where/how?
+  #
+  def self.register_report(name, options = {}, &block)
+    name = name.intern
+
+    mod = genmodule(name,
+                    :extend => Puppet::Util::Docs,
+                    :hash => instance_hash(:report),
+                    :overwrite => true,
+                    :block => block)
+
+    mod.useyaml = true if options[:useyaml]
+
+    mod.send(:define_method, :report_name) do
+      name
+    end
+  end
+
+  # Collects the docs for all reports.
+  # @api private
+  def self.reportdocs
+    docs = ''.dup
+
+    # Use this method so they all get loaded
+    instance_loader(:report).loadall(Puppet.lookup(:current_environment))
+    loaded_instances(:report).sort_by(&:to_s).each do |name|
+      mod = report(name)
+      docs << "#{name}\n#{'-' * name.to_s.length}\n"
+
+      docs << Puppet::Util::Docs.scrub(mod.doc) << "\n\n"
+    end
+
+    docs
+  end
+
+  # Lists each of the reports.
+  # @api private
+  def self.reports
+    instance_loader(:report).loadall(Puppet.lookup(:current_environment))
+    loaded_instances(:report)
+  end
+end