openvox 7.37.1 → 8.19.0

data/lib/puppet/application/lookup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application'
 require_relative '../../puppet/pops'
 require_relative '../../puppet/node'
@@ -5,10 +7,9 @@ require_relative '../../puppet/node/server_facts'
 require_relative '../../puppet/parser/compiler'
 
 class Puppet::Application::Lookup < Puppet::Application
-
   RUN_HELP = _("Run 'puppet lookup --help' for more details").freeze
-  DEEP_MERGE_OPTIONS = '--knock-out-prefix, --sort-merged-arrays, and --merge-hash-arrays'.freeze
-  TRUSTED_INFORMATION_FACTS = ["hostname", "domain", "fqdn", "clientcert"].freeze
+  DEEP_MERGE_OPTIONS = '--knock-out-prefix, --sort-merged-arrays, and --merge-hash-arrays'
+  TRUSTED_INFORMATION_FACTS = %w[hostname domain fqdn clientcert].freeze
 
   run_mode :server
 
@@ -61,8 +62,8 @@ class Puppet::Application::Lookup < Puppet::Application
 
   def app_defaults
     super.merge({
-      :facts_terminus => 'yaml'
-    })
+                  :facts_terminus => 'yaml'
+                })
   end
 
   def setup_logs
@@ -100,170 +101,172 @@ class Puppet::Application::Lookup < Puppet::Application
   end
 
   def summary
-    _("Interactive Hiera lookup")
+    _("Interactive Hiera lookup for OpenVox")
   end
 
   def help
-    <<-HELP
-
-puppet-lookup(8) -- #{summary}
-========
-
-SYNOPSIS
---------
-Does Hiera lookups from the command line.
-
-Since this command needs access to your Hiera data, make sure to run it on a
-node that has a copy of that data. This usually means logging into a Puppet
-Server node and running 'puppet lookup' with sudo.
-
-The most common version of this command is:
-
-'puppet lookup <KEY> --node <NAME> --environment <ENV> --explain'
-
-USAGE
------
-puppet lookup [--help] [--type <TYPESTRING>] [--merge first|unique|hash|deep]
-  [--knock-out-prefix <PREFIX-STRING>] [--sort-merged-arrays]
-  [--merge-hash-arrays] [--explain] [--environment <ENV>]
-  [--default <VALUE>] [--node <NODE-NAME>] [--facts <FILE>]
-  [--compile]
-  [--render-as s|json|yaml|binary|msgpack] <keys>
-
-DESCRIPTION
------------
-The lookup command is a CLI for Puppet's 'lookup()' function. It searches your
-Hiera data and returns a value for the requested lookup key, so you can test and
-explore your data. It is a modern replacement for the 'hiera' command.
-Lookup uses the setting for global hiera.yaml from puppet's config,
-and the environment to find the environment level hiera.yaml as well as the
-resulting modulepath for the environment (for hiera.yaml files in modules).
-Hiera usually relies on a node's facts to locate the relevant data sources. By
-default, 'puppet lookup' uses facts from the node you run the command on, but
-you can get data for any other node with the '--node <NAME>' option. If
-possible, the lookup command will use the requested node's real stored facts
-from PuppetDB; if PuppetDB isn't configured or you want to provide arbitrary
-fact values, you can pass alternate facts as a JSON or YAML file with '--facts
-<FILE>'.
-
-If you're debugging your Hiera data and want to see where values are coming
-from, use the '--explain' option.
-
-If '--explain' isn't specified, lookup exits with 0 if a value was found and 1
-otherwise. With '--explain', lookup always exits with 0 unless there is a major
-error.
-
-You can provide multiple lookup keys to this command, but it only returns a
-value for the first found key, omitting the rest.
-
-For more details about how Hiera works, see the Hiera documentation:
-https://puppet.com/docs/puppet/latest/hiera_intro.html
-
-OPTIONS
--------
-
-* --help:
-  Print this help message.
-
-* --explain
-  Explain the details of how the lookup was performed and where the final value
-  came from (or the reason no value was found).
-
-* --node <NODE-NAME>
-  Specify which node to look up data for; defaults to the node where the command
-  is run. Since Hiera's purpose is to provide different values for different
-  nodes (usually based on their facts), you'll usually want to use some specific
-  node's facts to explore your data. If the node where you're running this
-  command is configured to talk to PuppetDB, the command will use the requested
-  node's most recent facts. Otherwise, you can override facts with the '--facts'
-  option.
-
-* --facts <FILE>
-  Specify a .json or .yaml file of key => value mappings to override the facts
-  for this lookup. Any facts not specified in this file maintain their
-  original value.
-
-* --environment <ENV>
-  Like with most Puppet commands, you can specify an environment on the command
-  line. This is important for lookup because different environments can have
-  different Hiera data. This environment will be always be the one used regardless
-  of any other factors.
-
-* --merge first|unique|hash|deep:
-  Specify the merge behavior, overriding any merge behavior from the data's
-  lookup_options. 'first' returns the first value found. 'unique' appends
-  everything to a merged, deduplicated array. 'hash' performs a simple hash
-  merge by overwriting keys of lower lookup priority. 'deep' performs a deep
-  merge on values of Array and Hash type. There are additional options that can
-  be used with 'deep'.
-
-* --knock-out-prefix <PREFIX-STRING>
-  Can be used with the 'deep' merge strategy. Specifies a prefix to indicate a
-  value should be removed from the final result.
-
-* --sort-merged-arrays
-  Can be used with the 'deep' merge strategy. When this flag is used, all
-  merged arrays are sorted.
-
-* --merge-hash-arrays
-  Can be used with the 'deep' merge strategy. When this flag is used, hashes
-  WITHIN arrays are deep-merged with their counterparts by position.
-
-* --explain-options
-  Explain whether a lookup_options hash affects this lookup, and how that hash
-  was assembled. (lookup_options is how Hiera configures merge behavior in data.)
-
-* --default <VALUE>
-  A value to return if Hiera can't find a value in data. For emulating calls to
-  the 'lookup()' function that include a default.
-
-* --type <TYPESTRING>:
-  Assert that the value has the specified type. For emulating calls to the
-  'lookup()' function that include a data type.
-
-* --compile
-  Perform a full catalog compilation prior to the lookup. If your hierarchy and
-  data only use the $facts, $trusted, and $server_facts variables, you don't
-  need this option; however, if your Hiera configuration uses arbitrary
-  variables set by a Puppet manifest, you might need this option to get accurate
-  data. No catalog compilation takes place unless this flag is given.
-
-* --render-as s|json|yaml|binary|msgpack
-  Specify the output format of the results; "s" means plain text. The default
-  when producing a value is yaml and the default when producing an explanation
-  is s.
-
-EXAMPLE
--------
-  To look up 'key_name' using the Puppet Server node's facts:
-  $ puppet lookup key_name
-
-  To look up 'key_name' using the Puppet Server node's arbitrary variables from a manifest, and 
-  classify the node if applicable:
-  $ puppet lookup key_name --compile
-
-  To look up 'key_name' using the Puppet Server node's facts, overridden by facts given in a file:
-  $ puppet lookup key_name --facts fact_file.yaml
-
-  To look up 'key_name' with agent.local's facts:
-  $ puppet lookup --node agent.local key_name
-
-  To get the first value found for 'key_name_one' and 'key_name_two'
-  with agent.local's facts while merging values and knocking out
-  the prefix 'foo' while merging:
-  $ puppet lookup --node agent.local --merge deep --knock-out-prefix foo key_name_one key_name_two
-
-  To lookup 'key_name' with agent.local's facts, and return a default value of
-  'bar' if nothing was found:
-  $ puppet lookup --node agent.local --default bar key_name
-
-  To see an explanation of how the value for 'key_name' would be found, using
-  agent.local's facts:
-  $ puppet lookup --node agent.local --explain key_name
-
-COPYRIGHT
----------
-Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
+    <<~HELP
+
+      puppet-lookup(8) -- #{summary}
+      ========
+
+      SYNOPSIS
+      --------
+      Does Hiera lookups from the command line.
+
+      Since this command needs access to your Hiera data, make sure to run it on a
+      node that has a copy of that data. This usually means logging into an OpenVox
+      server node and running 'puppet lookup' with sudo.
+
+      The most common version of this command is:
+
+      'puppet lookup <KEY> --node <NAME> --environment <ENV> --explain'
+
+      USAGE
+      -----
+      puppet lookup [--help] [--type <TYPESTRING>] [--merge first|unique|hash|deep]
+        [--knock-out-prefix <PREFIX-STRING>] [--sort-merged-arrays]
+        [--merge-hash-arrays] [--explain] [--environment <ENV>]
+        [--default <VALUE>] [--node <NODE-NAME>] [--facts <FILE>]
+        [--compile]
+        [--render-as s|json|yaml|binary|msgpack] <keys>
+
+      DESCRIPTION
+      -----------
+      The lookup command is a CLI for Puppet's 'lookup()' function. It searches your
+      Hiera data and returns a value for the requested lookup key, so you can test and
+      explore your data. It is a modern replacement for the 'hiera' command.
+      Lookup uses the setting for global hiera.yaml from puppet's config,
+      and the environment to find the environment level hiera.yaml as well as the
+      resulting modulepath for the environment (for hiera.yaml files in modules).
+      Hiera usually relies on a node's facts to locate the relevant data sources. By
+      default, 'puppet lookup' uses facts from the node you run the command on, but
+      you can get data for any other node with the '--node <NAME>' option. If
+      possible, the lookup command will use the requested node's real stored facts
+      from PuppetDB; if PuppetDB isn't configured or you want to provide arbitrary
+      fact values, you can pass alternate facts as a JSON or YAML file with '--facts
+      <FILE>'.
+
+      If you're debugging your Hiera data and want to see where values are coming
+      from, use the '--explain' option.
+
+      If '--explain' isn't specified, lookup exits with 0 if a value was found and 1
+      otherwise. With '--explain', lookup always exits with 0 unless there is a major
+      error.
+
+      You can provide multiple lookup keys to this command, but it only returns a
+      value for the first found key, omitting the rest.
+
+      For more details about how Hiera works, see the Hiera documentation:
+      https://puppet.com/docs/puppet/latest/hiera_intro.html
+
+      OPTIONS
+      -------
+
+      * --help:
+        Print this help message.
+
+      * --explain
+        Explain the details of how the lookup was performed and where the final value
+        came from (or the reason no value was found).
+
+      * --node <NODE-NAME>
+        Specify which node to look up data for; defaults to the node where the command
+        is run. Since Hiera's purpose is to provide different values for different
+        nodes (usually based on their facts), you'll usually want to use some specific
+        node's facts to explore your data. If the node where you're running this
+        command is configured to talk to PuppetDB, the command will use the requested
+        node's most recent facts. Otherwise, you can override facts with the '--facts'
+        option.
+
+      * --facts <FILE>
+        Specify a .json or .yaml file of key => value mappings to override the facts
+        for this lookup. Any facts not specified in this file maintain their
+        original value.
+
+      * --environment <ENV>
+        Like with most Puppet commands, you can specify an environment on the command
+        line. This is important for lookup because different environments can have
+        different Hiera data. This environment will be always be the one used regardless
+        of any other factors.
+
+      * --merge first|unique|hash|deep:
+        Specify the merge behavior, overriding any merge behavior from the data's
+        lookup_options. 'first' returns the first value found. 'unique' appends
+        everything to a merged, deduplicated array. 'hash' performs a simple hash
+        merge by overwriting keys of lower lookup priority. 'deep' performs a deep
+        merge on values of Array and Hash type. There are additional options that can
+        be used with 'deep'.
+
+      * --knock-out-prefix <PREFIX-STRING>
+        Can be used with the 'deep' merge strategy. Specifies a prefix to indicate a
+        value should be removed from the final result.
+
+      * --sort-merged-arrays
+        Can be used with the 'deep' merge strategy. When this flag is used, all
+        merged arrays are sorted.
+
+      * --merge-hash-arrays
+        Can be used with the 'deep' merge strategy. When this flag is used, hashes
+        WITHIN arrays are deep-merged with their counterparts by position.
+
+      * --explain-options
+        Explain whether a lookup_options hash affects this lookup, and how that hash
+        was assembled. (lookup_options is how Hiera configures merge behavior in data.)
+
+      * --default <VALUE>
+        A value to return if Hiera can't find a value in data. For emulating calls to
+        the 'lookup()' function that include a default.
+
+      * --type <TYPESTRING>:
+        Assert that the value has the specified type. For emulating calls to the
+        'lookup()' function that include a data type.
+
+      * --compile
+        Perform a full catalog compilation prior to the lookup. If your hierarchy and
+        data only use the $facts, $trusted, and $server_facts variables, you don't
+        need this option; however, if your Hiera configuration uses arbitrary
+        variables set by a Puppet manifest, you might need this option to get accurate
+        data. No catalog compilation takes place unless this flag is given.
+
+      * --render-as s|json|yaml|binary|msgpack
+        Specify the output format of the results; "s" means plain text. The default
+        when producing a value is yaml and the default when producing an explanation
+        is s.
+
+      EXAMPLE
+      -------
+        To look up 'key_name' using the Puppet Server node's facts:
+        $ puppet lookup key_name
+
+        To look up 'key_name' using the Puppet Server node's arbitrary variables from a manifest, and
+        classify the node if applicable:
+        $ puppet lookup key_name --compile
+
+        To look up 'key_name' using the Puppet Server node's facts, overridden by facts given in a file:
+        $ puppet lookup key_name --facts fact_file.yaml
+
+        To look up 'key_name' with agent.local's facts:
+        $ puppet lookup --node agent.local key_name
+
+        To get the first value found for 'key_name_one' and 'key_name_two'
+        with agent.local's facts while merging values and knocking out
+        the prefix 'foo' while merging:
+        $ puppet lookup --node agent.local --merge deep --knock-out-prefix foo key_name_one key_name_two
+
+        To lookup 'key_name' with agent.local's facts, and return a default value of
+        'bar' if nothing was found:
+        $ puppet lookup --node agent.local --default bar key_name
+
+        To see an explanation of how the value for 'key_name' would be found, using
+        agent.local's facts:
+        $ puppet lookup --node agent.local --explain key_name
+
+      COPYRIGHT
+      ---------
+      Copyright (c) 2015 Puppet Inc.
+      Copyright (c) 2024 Vox Pupuli
+      Licensed under the Apache 2.0 License
 
 
     HELP
@@ -272,10 +275,6 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
   def main
     keys = command_line.args
 
-    #unless options[:node]
-    #  raise "No node was given via the '--node' flag for the scope of the lookup.\n#{RUN_HELP}"
-    #end
-
     if (options[:sort_merged_arrays] || options[:merge_hash_arrays] || options[:prefix]) && options[:merge] != 'deep'
       raise _("The options %{deep_merge_opts} are only available with '--merge deep'\n%{run_help}") % { deep_merge_opts: DEEP_MERGE_OPTIONS, run_help: RUN_HELP }
     end
@@ -287,21 +286,21 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
     unless merge.nil?
       strategies = Puppet::Pops::MergeStrategy.strategy_keys
       unless strategies.include?(merge.to_sym)
-        strategies = strategies.map {|k| "'#{k}'"}
+        strategies = strategies.map { |k| "'#{k}'" }
         raise _("The --merge option only accepts %{strategies}, or %{last_strategy}\n%{run_help}") % { strategies: strategies[0...-1].join(', '), last_strategy: strategies.last, run_help: RUN_HELP }
       end
 
       if merge == 'deep'
-        merge_options = {'strategy' => 'deep',
-          'sort_merged_arrays' => !options[:sort_merged_arrays].nil?,
-          'merge_hash_arrays' => !options[:merge_hash_arrays].nil?}
+        merge_options = { 'strategy' => 'deep',
+                          'sort_merged_arrays' => !options[:sort_merged_arrays].nil?,
+                          'merge_hash_arrays' => !options[:merge_hash_arrays].nil? }
 
         if options[:prefix]
           merge_options['knockout_prefix'] = options[:prefix]
         end
 
       else
-        merge_options = {'strategy' => merge}
+        merge_options = { 'strategy' => merge }
       end
     end
 
@@ -358,7 +357,7 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
         given_facts = Puppet::Util::Yaml.safe_load_file(fact_file)
       else
         given_facts = Puppet::Util::Json.load_file_if_valid(fact_file)
-        given_facts = Puppet::Util::Yaml.safe_load_file_if_valid(fact_file) unless given_facts
+        given_facts ||= Puppet::Util::Yaml.safe_load_file_if_valid(fact_file)
       end
 
       unless given_facts.instance_of?(Hash)
@@ -368,12 +367,14 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
       if TRUSTED_INFORMATION_FACTS.any? { |key| given_facts.key? key }
         unless TRUSTED_INFORMATION_FACTS.all? { |key| given_facts.key? key }
           raise _("When overriding any of the %{trusted_facts_list} facts with %{fact_file} "\
-            "given via the --facts flag, they must all be overridden.") % { fact_file: fact_file ,trusted_facts_list: TRUSTED_INFORMATION_FACTS.join(',')}
+                  "given via the --facts flag, they must all be overridden.") % { fact_file: fact_file, trusted_facts_list: TRUSTED_INFORMATION_FACTS.join(',') }
         end
       end
     end
 
-    unless node.is_a?(Puppet::Node) # to allow unit tests to pass a node instance
+    if node.is_a?(Puppet::Node)
+      node.add_extra_facts(given_facts) if given_facts
+    else # to allow unit tests to pass a node instance
       facts = retrieve_node_facts(node, given_facts)
       ni = Puppet::Node.indirection
       tc = ni.terminus_class
@@ -403,8 +404,6 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
         node = ni.find(node, facts: facts, environment: Puppet[:environment])
         ni.terminus_class = tc
       end
-    else
-      node.add_extra_facts(given_facts) if given_facts
     end
     node.environment = Puppet[:environment] if Puppet.settings.set_by_cli?(:environment)
     node.add_server_facts(Puppet::Node::ServerFacts.load)
@@ -426,8 +425,9 @@ Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
     facts.add_extra_values(given_facts) if given_facts
 
     if facts.values.empty?
-      raise _("No facts available for target node: %{node}") % { node: node}
+      raise _("No facts available for target node: %{node}") % { node: node }
     end
+
     facts
   end
 end

data/lib/puppet/application/module.rb

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

data/lib/puppet/application/node.rb

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

data/lib/puppet/application/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application/face_base'
 require_relative '../../puppet/face'
 

data/lib/puppet/application/plugin.rb

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

data/lib/puppet/application/report.rb

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