puppet 8.3.1 → 8.4.0

data/lib/puppet/application/resource.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/application'
 
 class Puppet::Application::Resource < Puppet::Application
@@ -15,12 +16,13 @@ class Puppet::Application::Resource < Puppet::Application
   option("--edit","-e")
   option("--to_yaml","-y")
 
-  option("--types", "-t") do |arg|
+  option("--types", "-t") do |_arg|
     env = Puppet.lookup(:environments).get(Puppet[:environment]) || create_default_environment
     types = []
     Puppet::Type.typeloader.loadall(env)
     Puppet::Type.eachtype do |t|
       next if t.name == :component
+
       types << t.name.to_s
     end
     puts types.sort
@@ -36,103 +38,103 @@ class Puppet::Application::Resource < Puppet::Application
   end
 
   def help
-    <<-HELP
-
-puppet-resource(8) -- #{summary}
-========
-
-SYNOPSIS
---------
-Uses the Puppet RAL to directly interact with the system.
-
-
-USAGE
------
-puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit]
-  [-p|--param <parameter>] [-t|--types] [-y|--to_yaml] <type>
-  [<name>] [<attribute>=<value> ...]
-
-
-DESCRIPTION
------------
-This command provides simple facilities for converting current system
-state into Puppet code, along with some ability to modify the current
-state using Puppet's RAL.
-
-By default, you must at least provide a type to list, in which case
-puppet resource will tell you everything it knows about all resources of
-that type. You can optionally specify an instance name, and puppet
-resource will only describe that single instance.
-
-If given a type, a name, and a series of <attribute>=<value> pairs,
-puppet resource will modify the state of the specified resource.
-Alternately, if given a type, a name, and the '--edit' flag, puppet
-resource will write its output to a file, open that file in an editor,
-and then apply the saved file as a Puppet transaction.
-
-
-OPTIONS
--------
-Note that any setting that's valid in the configuration
-file is also a valid long argument. For example, 'ssldir' is a valid
-setting, so you can specify '--ssldir <directory>' as an
-argument.
-
-See the configuration file documentation at
-https://puppet.com/docs/puppet/latest/configuration.html for the
-full list of acceptable parameters. A commented list of all
-configuration options can also be generated by running puppet with
-'--genconfig'.
-
-* --debug:
-  Enable full debugging.
-
-* --edit:
-  Write the results of the query to a file, open the file in an editor,
-  and read the file back in as an executable Puppet manifest.
-
-* --help:
-  Print this help message.
-
-* --param:
-  Add more parameters to be outputted from queries.
-
-* --types:
-  List all available types.
-
-* --verbose:
-  Print extra information.
-
-* --to_yaml:
-  Output found resources in yaml format, suitable to use with Hiera and
-  create_resources.
-
-EXAMPLE
--------
-This example uses `puppet resource` to return a Puppet configuration for
-the user `luke`:
-
-    $ puppet resource user luke
-    user { 'luke':
-     home => '/home/luke',
-     uid => '100',
-     ensure => 'present',
-     comment => 'Luke Kanies,,,',
-     gid => '1000',
-     shell => '/bin/bash',
-     groups => ['sysadmin','audio','video','puppet']
-    }
-
-
-AUTHOR
-------
-Luke Kanies
-
-
-COPYRIGHT
----------
-Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
-
+    <<~HELP
+      
+      puppet-resource(8) -- #{summary}
+      ========
+      
+      SYNOPSIS
+      --------
+      Uses the Puppet RAL to directly interact with the system.
+      
+      
+      USAGE
+      -----
+      puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit]
+        [-p|--param <parameter>] [-t|--types] [-y|--to_yaml] <type>
+        [<name>] [<attribute>=<value> ...]
+      
+      
+      DESCRIPTION
+      -----------
+      This command provides simple facilities for converting current system
+      state into Puppet code, along with some ability to modify the current
+      state using Puppet's RAL.
+      
+      By default, you must at least provide a type to list, in which case
+      puppet resource will tell you everything it knows about all resources of
+      that type. You can optionally specify an instance name, and puppet
+      resource will only describe that single instance.
+      
+      If given a type, a name, and a series of <attribute>=<value> pairs,
+      puppet resource will modify the state of the specified resource.
+      Alternately, if given a type, a name, and the '--edit' flag, puppet
+      resource will write its output to a file, open that file in an editor,
+      and then apply the saved file as a Puppet transaction.
+      
+      
+      OPTIONS
+      -------
+      Note that any setting that's valid in the configuration
+      file is also a valid long argument. For example, 'ssldir' is a valid
+      setting, so you can specify '--ssldir <directory>' as an
+      argument.
+      
+      See the configuration file documentation at
+      https://puppet.com/docs/puppet/latest/configuration.html for the
+      full list of acceptable parameters. A commented list of all
+      configuration options can also be generated by running puppet with
+      '--genconfig'.
+      
+      * --debug:
+        Enable full debugging.
+      
+      * --edit:
+        Write the results of the query to a file, open the file in an editor,
+        and read the file back in as an executable Puppet manifest.
+      
+      * --help:
+        Print this help message.
+      
+      * --param:
+        Add more parameters to be outputted from queries.
+      
+      * --types:
+        List all available types.
+      
+      * --verbose:
+        Print extra information.
+      
+      * --to_yaml:
+        Output found resources in yaml format, suitable to use with Hiera and
+        create_resources.
+      
+      EXAMPLE
+      -------
+      This example uses `puppet resource` to return a Puppet configuration for
+      the user `luke`:
+      
+          $ puppet resource user luke
+          user { 'luke':
+           home => '/home/luke',
+           uid => '100',
+           ensure => 'present',
+           comment => 'Luke Kanies,,,',
+           gid => '1000',
+           shell => '/bin/bash',
+           groups => ['sysadmin','audio','video','puppet']
+          }
+      
+      
+      AUTHOR
+      ------
+      Luke Kanies
+      
+      
+      COPYRIGHT
+      ---------
+      Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
+      
     HELP
   end
 
@@ -147,16 +149,16 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
       resources = find_or_save_resources(type, name, params)
 
-    if options[:to_yaml]
-      data = resources.map do |resource|
-        resource.prune_parameters(:parameters_to_include => @extra_params).to_hiera_hash
-      end.inject(:merge!)
-      text = YAML.dump(type.downcase => data)
-    else
-      text = resources.map do |resource|
-        resource.prune_parameters(:parameters_to_include => @extra_params).to_manifest.force_encoding(Encoding.default_external)
-      end.join("\n")
-    end
+      if options[:to_yaml]
+        data = resources.map do |resource|
+          resource.prune_parameters(:parameters_to_include => @extra_params).to_hiera_hash
+        end.inject(:merge!)
+        text = YAML.dump(type.downcase => data)
+      else
+        text = resources.map do |resource|
+          resource.prune_parameters(:parameters_to_include => @extra_params).to_manifest.force_encoding(Encoding.default_external)
+        end.join("\n")
+      end
 
       options[:edit] ?
         handle_editing(text) :
@@ -241,6 +243,7 @@ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
         if type == "file"
           raise _("Listing all file instances is not supported.  Please specify a file or directory, e.g. puppet resource file /etc")
         end
+
         Puppet::Resource.indirection.search( key, {} )
       end
     end

data/lib/puppet/application/script.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/application'
 require_relative '../../puppet/configurer'
 require_relative '../../puppet/util/profiler/aggregate'
 require_relative '../../puppet/parser/script_compiler'
 
 class Puppet::Application::Script < Puppet::Application
-
   option("--debug","-d")
   option("--execute EXECUTE","-e") do |arg|
     options[:code] = arg
@@ -22,100 +22,100 @@ class Puppet::Application::Script < Puppet::Application
   end
 
   def help
-    <<-HELP
-
-puppet-script(8) -- #{summary}
-========
-
-SYNOPSIS
---------
-Runs a puppet language script without compiling a catalog.
-
-
-USAGE
------
-puppet script [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
-  [-e|--execute]
-  [-l|--logdest syslog|eventlog|<FILE>|console] [--noop]
-  <file>
-
-
-DESCRIPTION
------------
-This is a standalone puppet script runner tool; use it to run puppet code
-without compiling a catalog.
-
-When provided with a modulepath, via command line or config file, puppet
-script can load functions, types, tasks and plans from modules.
-
-OPTIONS
--------
-Note that any setting that's valid in the configuration
-file is also a valid long argument. For example, 'environment' is a
-valid setting, so you can specify '--environment mytest'
-as an argument.
-
-See the configuration file documentation at
-https://puppet.com/docs/puppet/latest/configuration.html for the
-full list of acceptable parameters. A commented list of all
-configuration options can also be generated by running puppet with
-'--genconfig'.
-
-* --debug:
-  Enable full debugging.
-
-* --help:
-  Print this help message
-
-
-* --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 '.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. Applies to tasks only.
-
-* --execute:
-  Execute a specific piece of Puppet code
-
-* --verbose:
-  Print extra information.
-
-EXAMPLE
--------
-    $ puppet script -l /tmp/manifest.log manifest.pp
-    $ puppet script --modulepath=/root/dev/modules -e 'notice("hello world")'
-
-
-AUTHOR
-------
-Henrik Lindberg
-
-
-COPYRIGHT
----------
-Copyright (c) 2017 Puppet Inc., LLC Licensed under the Apache 2.0 License
-
+    <<~HELP
+      
+      puppet-script(8) -- #{summary}
+      ========
+      
+      SYNOPSIS
+      --------
+      Runs a puppet language script without compiling a catalog.
+      
+      
+      USAGE
+      -----
+      puppet script [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
+        [-e|--execute]
+        [-l|--logdest syslog|eventlog|<FILE>|console] [--noop]
+        <file>
+      
+      
+      DESCRIPTION
+      -----------
+      This is a standalone puppet script runner tool; use it to run puppet code
+      without compiling a catalog.
+      
+      When provided with a modulepath, via command line or config file, puppet
+      script can load functions, types, tasks and plans from modules.
+      
+      OPTIONS
+      -------
+      Note that any setting that's valid in the configuration
+      file is also a valid long argument. For example, 'environment' is a
+      valid setting, so you can specify '--environment mytest'
+      as an argument.
+      
+      See the configuration file documentation at
+      https://puppet.com/docs/puppet/latest/configuration.html for the
+      full list of acceptable parameters. A commented list of all
+      configuration options can also be generated by running puppet with
+      '--genconfig'.
+      
+      * --debug:
+        Enable full debugging.
+      
+      * --help:
+        Print this help message
+      
+      
+      * --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 '.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. Applies to tasks only.
+      
+      * --execute:
+        Execute a specific piece of Puppet code
+      
+      * --verbose:
+        Print extra information.
+      
+      EXAMPLE
+      -------
+          $ puppet script -l /tmp/manifest.log manifest.pp
+          $ puppet script --modulepath=/root/dev/modules -e 'notice("hello world")'
+      
+      
+      AUTHOR
+      ------
+      Henrik Lindberg
+      
+      
+      COPYRIGHT
+      ---------
+      Copyright (c) 2017 Puppet Inc., LLC Licensed under the Apache 2.0 License
+      
     HELP
   end
 
   def app_defaults
     super.merge({
-      :default_file_terminus => :file_server,
-    })
+                  :default_file_terminus => :file_server,
+                })
   end
 
   def run_command
@@ -138,6 +138,7 @@ Copyright (c) 2017 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 used per run. Skipping %{files}") % { files: command_line.args.join(', ') }) if command_line.args.size > 0
     end
 
@@ -212,7 +213,6 @@ Copyright (c) 2017 Puppet Inc., LLC Licensed under the Apache 2.0 License
           topscope.merge_settings(node.environment.name, false)
 
           compiler.compile()
-
         rescue Puppet::Error
           # already logged and handled by the compiler, including Puppet::ParseErrorWithIssue
           exit(1)
@@ -224,7 +224,6 @@ Copyright (c) 2017 Puppet Inc., LLC Licensed under the Apache 2.0 License
         exit(1)
       end
     end
-
   ensure
     if @profiler
       Puppet::Util::Profiler.remove_profiler(@profiler)
@@ -248,7 +247,7 @@ Copyright (c) 2017 Puppet Inc., LLC Licensed under the Apache 2.0 License
     # installed where a settings catalog have already been applied...
     # This saves 1/5th of the startup time
 
-#    Puppet.settings.use :main, :agent, :ssl
+    #    Puppet.settings.use :main, :agent, :ssl
 
     # When running a script, the catalog is not relevant, and neither is caching of it
     Puppet::Resource::Catalog.indirection.cache_class = nil