openvox 7.37.1 → 8.19.0

data/lib/puppet/application/apply.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application'
 require_relative '../../puppet/configurer'
 require_relative '../../puppet/util/profiler/aggregate'
@@ -6,13 +8,13 @@ class Puppet::Application::Apply < Puppet::Application
   require_relative '../../puppet/util/splayer'
   include Puppet::Util::Splayer
 
-  option("--debug","-d")
-  option("--execute EXECUTE","-e") do |arg|
+  option("--debug", "-d")
+  option("--execute EXECUTE", "-e") do |arg|
     options[:code] = arg
   end
-  option("--loadclasses","-L")
-  option("--test","-t")
-  option("--verbose","-v")
+  option("--loadclasses", "-L")
+  option("--test", "-t")
+  option("--verbose", "-v")
   option("--use-nodes")
   option("--detailed-exitcodes")
 
@@ -20,7 +22,7 @@ class Puppet::Application::Apply < Puppet::Application
     Puppet[:write_catalog_summary] = arg
   end
 
-  option("--catalog catalog",  "-c catalog") do |arg|
+  option("--catalog catalog", "-c catalog") do |arg|
     options[:catalog] = arg
   end
 
@@ -28,151 +30,153 @@ class Puppet::Application::Apply < Puppet::Application
     handle_logdest_arg(arg)
   end
 
-  option("--parseonly") do |args|
+  option("--parseonly") do |_args|
     puts "--parseonly has been removed. Please use 'puppet parser validate <manifest>'"
     exit 1
   end
 
   def summary
-    _("Apply Puppet manifests locally")
+    _("Apply Puppet manifests locally via OpenVox")
   end
 
   def help
-    <<-HELP
+    <<~HELP
 
-puppet-apply(8) -- #{summary}
-========
+      puppet-apply(8) -- #{summary}
+      ========
 
-SYNOPSIS
---------
-Applies a standalone Puppet manifest to the local system.
+      SYNOPSIS
+      --------
+      Applies a standalone Puppet manifest to the local system.
 
 
-USAGE
------
-puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
-  [-e|--execute] [--detailed-exitcodes] [-L|--loadclasses]
-  [-l|--logdest syslog|eventlog|<ABS FILEPATH>|console] [--noop]
-  [--catalog <catalog>] [--write-catalog-summary] <file>
+      USAGE
+      -----
+      puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
+        [-e|--execute] [--detailed-exitcodes] [-L|--loadclasses]
+        [-l|--logdest syslog|eventlog|<ABS FILEPATH>|console] [--noop]
+        [--catalog <catalog>] [--write-catalog-summary] <file>
 
 
-DESCRIPTION
------------
-This is the standalone puppet execution tool; use it to apply
-individual manifests.
+      DESCRIPTION
+      -----------
+      This is the standalone puppet execution tool; use it to apply
+      individual manifests.
 
-When provided with a modulepath, via command line or config file, puppet
-apply can effectively mimic the catalog that would be served by puppet
-master with access to the same modules, although there are some subtle
-differences. When combined with scheduling and an automated system for
-pushing manifests, this can be used to implement a serverless Puppet
-site.
+      When provided with a modulepath, via command line or config file, puppet
+      apply can effectively mimic the catalog that would be served by OpenVox
+      server with access to the same modules, although there are some subtle
+      differences. When combined with scheduling and an automated system for
+      pushing manifests, this can be used to implement a serverless site.
 
-Most users should use 'puppet agent' and 'puppet master' for site-wide
-manifests.
+      Most users should use 'puppet agent' and 'puppet master' for site-wide
+      manifests.
 
 
-OPTIONS
--------
-Any setting that's valid in the configuration
-file is a valid long argument for puppet apply. For example, 'tags' is a
-valid setting, so you can specify '--tags <class>,<tag>'
-as an argument.
+      OPTIONS
+      -------
+      Any setting that's valid in the configuration
+      file is a valid long argument for puppet apply. For example, 'tags' is a
+      valid setting, so you can specify '--tags <class>,<tag>'
+      as an argument.
 
-See the configuration file documentation at
-https://puppet.com/docs/puppet/latest/configuration.html for the
-full list of acceptable parameters. You can generate a commented list of all
-configuration options by running puppet with
-'--genconfig'.
+      See the configuration file documentation at
+      https://puppet.com/docs/puppet/latest/configuration.html for the
+      full list of acceptable parameters. You can generate a commented list of all
+      configuration options by running puppet with
+      '--genconfig'.
 
-* --debug:
-  Enable full debugging.
+      * --debug:
+        Enable full debugging.
 
-* --detailed-exitcodes:
-  Provide extra information about the run via exit codes. If enabled, 'puppet
-  apply' will use the following exit codes:
+      * --detailed-exitcodes:
+        Provide extra information about the run via exit codes. If enabled, 'puppet
+        apply' will use the following exit codes:
 
-  0: The run succeeded with no changes or failures; the system was already in
-  the desired state.
+        0: The run succeeded with no changes or failures; the system was already in
+        the desired state.
 
-  1: The run failed.
+        1: The run failed.
 
-  2: The run succeeded, and some resources were changed.
+        2: The run succeeded, and some resources were changed.
 
-  4: The run succeeded, and some resources failed.
+        4: The run succeeded, and some resources failed.
 
-  6: The run succeeded, and included both changes and failures.
+        6: The run succeeded, and included both changes and failures.
 
-* --help:
-  Print this help message
+      * --help:
+        Print this help message
 
-* --loadclasses:
-  Load any stored classes. 'puppet agent' caches configured classes
-  (usually at /etc/puppetlabs/puppet/classes.txt), and setting this option causes
-  all of those classes to be set in your puppet manifest.
+      * --loadclasses:
+        Load any stored classes. 'puppet agent' caches configured classes
+        (usually at /etc/puppetlabs/puppet/classes.txt), and setting this option causes
+        all of those classes to be set in your puppet manifest.
 
-* --logdest:
-  Where to send log messages. Choose between 'syslog' (the POSIX syslog
-  service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
-  file. Defaults to 'console'.
-  Multiple destinations can be set using a comma separated list
-  (eg: `/path/file1,console,/path/file2`)"
+      * --logdest:
+        Where to send log messages. Choose between 'syslog' (the POSIX syslog
+        service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
+        file. Defaults to 'console'.
+        Multiple destinations can be set using a comma separated list
+        (eg: `/path/file1,console,/path/file2`)"
 
-  A path ending with '.json' will receive structured output in JSON format. The
-  log file will not have an ending ']' automatically written to it due to the
-  appending nature of logging. It must be appended manually to make the content
-  valid JSON.
+        A path ending with '.json' will receive structured output in JSON format. The
+        log file will not have an ending ']' automatically written to it due to the
+        appending nature of logging. It must be appended manually to make the content
+        valid JSON.
 
-  A path ending with '.jsonl' will receive structured output in JSON Lines
-  format.
+        A path ending with '.jsonl' will receive structured output in JSON Lines
+        format.
 
-* --noop:
-  Use 'noop' mode where Puppet runs in a no-op or dry-run mode. This
-  is useful for seeing what changes Puppet will make without actually
-  executing the changes.
+      * --noop:
+        Use 'noop' mode where Puppet runs in a no-op or dry-run mode. This
+        is useful for seeing what changes Puppet will make without actually
+        executing the changes.
 
-* --execute:
-  Execute a specific piece of Puppet code
+      * --execute:
+        Execute a specific piece of Puppet code
 
-* --test:
-  Enable the most common options used for testing. These are 'verbose',
-  'detailed-exitcodes' and 'show_diff'.
+      * --test:
+        Enable the most common options used for testing. These are 'verbose',
+        'detailed-exitcodes' and 'show_diff'.
 
-* --verbose:
-  Print extra information.
+      * --verbose:
+        Print extra information.
 
-* --catalog:
-  Apply a JSON catalog (such as one generated with 'puppet master --compile'). You can
-  either specify a JSON file or pipe in JSON from standard input.
+      * --catalog:
+        Apply a JSON catalog (such as one generated with 'puppet master --compile'). You can
+        either specify a JSON file or pipe in JSON from standard input.
 
-* --write-catalog-summary
-  After compiling the catalog saves the resource list and classes list to the node
-  in the state directory named classes.txt and resources.txt
+      * --write-catalog-summary
+        After compiling the catalog saves the resource list and classes list to the node
+        in the state directory named classes.txt and resources.txt
 
-EXAMPLE
--------
-    $ puppet apply -l /tmp/manifest.log manifest.pp
-    $ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server"
-    $ puppet apply --catalog catalog.json
+      EXAMPLE
+      -------
+          $ puppet apply -e 'notify { "hello world": }'
+          $ puppet apply -l /tmp/manifest.log manifest.pp
+          $ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server"
+          $ puppet apply --catalog catalog.json
 
 
-AUTHOR
-------
-Luke Kanies
+      AUTHOR
+      ------
+      Luke Kanies
 
 
-COPYRIGHT
----------
-Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
+      COPYRIGHT
+      ---------
+      Copyright (c) 2011 Puppet Inc.
+      Copyright (c) 2024 Vox Pupuli
+      Licensed under the Apache 2.0 License
 
     HELP
   end
 
   def app_defaults
     super.merge({
-      :default_file_terminus => :file_server,
-      :write_catalog_summary => false
-    })
+                  :default_file_terminus => :file_server,
+                  :write_catalog_summary => false
+                })
   end
 
   def run_command
@@ -202,14 +206,16 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
   end
 
   def main
+    # rubocop:disable Layout/ExtraSpacing
     manifest          = get_manifest() # Get either a manifest or nil if apply should use content of Puppet[:code]
     splay                              # splay if needed
     facts             = get_facts()    # facts or nil
     node              = get_node()     # node or error
     apply_environment = get_configured_environment(node, manifest)
+    # rubocop:enable Layout/ExtraSpacing
 
     # TRANSLATORS "puppet apply" is a program command and should not be translated
-    Puppet.override({:current_environment => apply_environment, :loaders => create_loaders(apply_environment)}, _("For puppet apply")) do
+    Puppet.override({ :current_environment => apply_environment, :loaders => create_loaders(apply_environment) }, _("For puppet apply")) do
       configure_node_facts(node, facts)
 
       # Allow users to load the classes that puppet agent creates.
@@ -220,7 +226,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
             $stderr.puts _("%{file} is not readable") % { file: file }
             exit(63)
           end
-          node.classes = Puppet::FileSystem.read(file, :encoding => 'utf-8').split(/[\s]+/)
+          node.classes = Puppet::FileSystem.read(file, :encoding => 'utf-8').split(/\s+/)
         end
       end
 
@@ -233,12 +239,12 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
         # rule and gets logged.
         #
         catalog =
-        begin
-          Puppet::Resource::Catalog.indirection.find(node.name, :use_node => node)
-        rescue Puppet::Error
-          # already logged and handled by the compiler, including Puppet::ParseErrorWithIssue
-          exit(1)
-        end
+          begin
+            Puppet::Resource::Catalog.indirection.find(node.name, :use_node => node)
+          rescue Puppet::Error
+            # already logged and handled by the compiler, including Puppet::ParseErrorWithIssue
+            exit(1)
+          end
 
         # Resolve all deferred values and replace them / mutate the catalog
         Puppet::Pops::Evaluator::DeferredResolver.resolve_and_replace(node.facts, catalog, apply_environment, Puppet[:preprocess_deferred])
@@ -272,7 +278,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
         exit_status = apply_catalog(catalog)
 
-        if not exit_status
+        if !exit_status
           exit(1)
         elsif options[:detailed_exitcodes] then
           exit(exit_status)
@@ -309,7 +315,6 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     Puppet.settings.use :main, :agent, :ssl
 
-
     if Puppet[:catalog_cache_terminus]
       Puppet::Resource::Catalog.indirection.cache_class = Puppet[:catalog_cache_terminus]
     end
@@ -337,7 +342,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
     configured_environment = get_configured_environment(node)
 
     # TRANSLATORS "puppet apply" is a program command and should not be translated
-    Puppet.override({:current_environment => configured_environment}, _("For puppet apply")) do
+    Puppet.override({ :current_environment => configured_environment }, _("For puppet apply")) do
       configure_node_facts(node, facts)
 
       # NOTE: Does not set rich_data = true automatically (which would ensure always reading catalog with rich data
@@ -363,7 +368,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
   # Returns facts or nil
   #
-  def get_facts()
+  def get_facts
     facts = nil
     unless Puppet[:node_name_fact].empty?
       # Collect our facts.
@@ -378,15 +383,16 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
   # Returns the node or raises and error if node not found.
   #
-  def get_node()
+  def get_node
     node = Puppet::Node.indirection.find(Puppet[:node_name_value])
     raise _("Could not find node %{node}") % { node: Puppet[:node_name_value] } unless node
+
     node
   end
 
   # Returns either a manifest (filename) or nil if apply should use content of Puppet[:code]
   #
-  def get_manifest()
+  def get_manifest
     manifest = nil
     # Set our code or file to use.
     if options[:code] or command_line.args.length == 0
@@ -394,6 +400,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
     else
       manifest = command_line.args.shift
       raise _("Could not find file %{manifest}") % { manifest: manifest } unless Puppet::FileSystem.exist?(manifest)
+
       Puppet.warning(_("Only one file can be applied per run.  Skipping %{files}") % { files: command_line.args.join(', ') }) if command_line.args.size > 0
     end
     manifest

data/lib/puppet/application/catalog.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application/indirection_base'
 
 class Puppet::Application::Catalog < Puppet::Application::IndirectionBase

data/lib/puppet/application/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application/face_base'
 
 class Puppet::Application::Config < Puppet::Application::FaceBase

data/lib/puppet/application/describe.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application'
 
 class Formatter
-
   def initialize(width)
     @width = width
   end
 
   def wrap(txt, opts)
     return "" unless txt && !txt.empty?
+
     work = (opts[:scrub] ? scrub(txt) : txt)
-    indent = (opts[:indent] ? opts[:indent] : 0)
+    indent = opts[:indent] || 0
     textLen = @width - indent
     patt = Regexp.new("\\A(.{0,#{textLen}})[ \n]")
     prefix = " " * indent
@@ -18,8 +20,8 @@ class Formatter
 
     while work.length > textLen
       if work =~ patt
-        res << $1
-        work.slice!(0, $MATCH.length)
+        res << ::Regexp.last_match(1)
+        work.slice!(0, ::Regexp.last_match(0).length)
       else
         res << work.slice!(0, textLen)
       end
@@ -41,23 +43,22 @@ class Formatter
     # If we can match an indentation, then just remove that same level of
     # indent from every line.
     if text =~ /^(\s+)/
-      indent = $1
-      return text.gsub(/^#{indent}/,'')
+      indent = ::Regexp.last_match(1)
+      text.gsub(/^#{indent}/, '')
     else
-      return text
+      text
     end
   end
-
 end
 
 class TypeDoc
-
   def initialize
     @format = Formatter.new(76)
     @types = {}
     Puppet::Type.loadall
     Puppet::Type.eachtype { |type|
       next if type.name == :component
+
       @types[type.name] = type
     }
   end
@@ -125,7 +126,7 @@ class TypeDoc
       docs[name] = type.attrclass(name).doc if attrs.include?(kind) && name != :provider
     end
 
-    docs.sort { |a,b|
+    docs.sort { |a, b|
       a[0].to_s <=> b[0].to_s
     }.each { |name, doc|
       print "\n- **#{name}**"
@@ -159,73 +160,75 @@ class TypeDoc
     list = type.providers.sort_by(&:to_s).join(", ")
     puts @format.wrap(list, :indent => 4)
   end
-
 end
 
 class Puppet::Application::Describe < Puppet::Application
   banner "puppet describe [options] [type]"
 
-  option("--short", "-s", "Only list parameters without detail") do |arg|
+  option("--short", "-s", "Only list parameters without detail") do |_arg|
     options[:parameters] = false
   end
 
-  option("--providers","-p")
+  option("--providers", "-p")
   option("--list", "-l")
-  option("--meta","-m")
+  option("--meta", "-m")
 
   def summary
-    _("Display help about resource types")
+    _("Display help about resource types available to OpenVox")
   end
 
   def help
-    <<-HELP
+    <<~HELP
 
-puppet-describe(8) -- #{summary}
-========
+      puppet-describe(8) -- #{summary}
+      ========
 
-SYNOPSIS
---------
-Prints help about Puppet resource types, providers, and metaparameters.
+      SYNOPSIS
+      --------
+      Prints help about Puppet resource types, providers, and metaparameters
+      installed on an OpenVox node.
 
 
-USAGE
------
-puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta]
+      USAGE
+      -----
+      puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta]
 
 
-OPTIONS
--------
-* --help:
-  Print this help text
+      OPTIONS
+      -------
+      * --help:
+        Print this help text
 
-* --providers:
-  Describe providers in detail for each type
+      * --providers:
+        Describe providers in detail for each type
 
-* --list:
-  List all types
+      * --list:
+        List all types
 
-* --meta:
-  List all metaparameters
+      * --meta:
+        List all metaparameters
 
-* --short:
-  List only parameters without detail
+      * --short:
+        List only parameters without detail
 
 
-EXAMPLE
--------
-    $ puppet describe --list
-    $ puppet describe file --providers
-    $ puppet describe user -s -m
+      EXAMPLE
+      -------
+          $ puppet describe --list
+          $ puppet describe file --providers
+          $ puppet describe user -s -m
 
 
-AUTHOR
-------
-David Lutterkort
+      AUTHOR
+      ------
+      David Lutterkort
 
 
-COPYRIGHT
----------
-Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
+      COPYRIGHT
+      ---------
+      Copyright (c) 2011 Puppet Inc.
+      Copyright (c) 2024 Vox Pupuli
+      Licensed under the Apache 2.0 License
 
     HELP
   end
@@ -249,5 +252,4 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
     handle_help(nil) unless options[:list] || options[:types].size > 0
     $stderr.puts "Warning: ignoring types when listing all types" if options[:list] && options[:types].size > 0
   end
-
 end