openvox 8.19.0

data/lib/puppet/application/resource.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+require_relative '../../puppet/application'
+
+class Puppet::Application::Resource < Puppet::Application
+  environment_mode :not_required
+
+  attr_accessor :host, :extra_params
+
+  def preinit
+    @extra_params = [:provider]
+  end
+
+  option("--debug", "-d")
+  option("--verbose", "-v")
+  option("--edit", "-e")
+  option("--to_yaml", "-y")
+  option('--fail', '-f')
+
+  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
+    exit(0)
+  end
+
+  option("--param PARAM", "-p") do |arg|
+    @extra_params << arg.to_sym
+  end
+
+  def summary
+    _("The OpenVox resource abstraction layer shell")
+  end
+
+  def help
+    <<~HELP
+
+      puppet-resource(8) -- #{summary}
+      ========
+
+      SYNOPSIS
+      --------
+      Uses the OpenVox 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.
+
+      * --fail:
+        Fails and returns an exit code of 1 if the resource could not be modified.
+
+      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.
+      Copyright (c) 2024 Vox Pupuli
+      Licensed under the Apache 2.0 License
+
+    HELP
+  end
+
+  def main
+    # If the specified environment does not exist locally, fall back to the default (production) environment
+    env = Puppet.lookup(:environments).get(Puppet[:environment]) || create_default_environment
+
+    Puppet.override(
+      current_environment: env,
+      loaders: Puppet::Pops::Loaders.new(env),
+      stringify_rich: true
+    ) do
+      type, name, params = parse_args(command_line.args)
+
+      raise _("Editing with Yaml output is not supported") if options[:edit] and options[:to_yaml]
+
+      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
+
+      options[:edit] ?
+        handle_editing(text) :
+        (puts text)
+    end
+  end
+
+  def setup
+    Puppet::Util::Log.newdestination(:console)
+    set_log_level
+  end
+
+  private
+
+  def local_key(type, name)
+    [type, name].join('/')
+  end
+
+  def handle_editing(text)
+    require 'tempfile'
+    # Prefer the current directory, which is more likely to be secure
+    # and, in the case of interactive use, accessible to the user.
+    tmpfile = Tempfile.new('x2puppet', Dir.pwd, :encoding => Encoding::UTF_8)
+    begin
+      # sync write, so nothing buffers before we invoke the editor.
+      tmpfile.sync = true
+      tmpfile.puts text
+
+      # edit the content
+      system(ENV.fetch("EDITOR", nil) || 'vi', tmpfile.path)
+
+      # ...and, now, pass that file to puppet to apply.  Because
+      # many editors rename or replace the original file we need to
+      # feed the pathname, not the file content itself, to puppet.
+      system('puppet apply -v ' + tmpfile.path)
+    ensure
+      # The temporary file will be safely removed.
+      tmpfile.close(true)
+    end
+  end
+
+  def parse_args(args)
+    type = args.shift or raise _("You must specify the type to display")
+    Puppet::Type.type(type) or raise _("Could not find type %{type}") % { type: type }
+    name = args.shift
+    params = {}
+    args.each do |setting|
+      if setting =~ /^(\w+)=(.+)$/
+        params[::Regexp.last_match(1)] = ::Regexp.last_match(2)
+      else
+        raise _("Invalid parameter setting %{setting}") % { setting: setting }
+      end
+    end
+
+    [type, name, params]
+  end
+
+  def create_default_environment
+    Puppet.debug("Specified environment '#{Puppet[:environment]}' does not exist on the filesystem, defaulting to 'production'")
+    Puppet[:environment] = :production
+    basemodulepath = Puppet::Node::Environment.split_path(Puppet[:basemodulepath])
+    modulepath = Puppet[:modulepath]
+    modulepath = (modulepath.nil? || modulepath.empty?) ? basemodulepath : Puppet::Node::Environment.split_path(modulepath)
+    Puppet::Node::Environment.create(Puppet[:environment], modulepath, Puppet::Node::Environment::NO_MANIFEST)
+  end
+
+  def find_or_save_resources(type, name, params)
+    key = local_key(type, name)
+
+    Puppet.override(stringify_rich: true) do
+      if name
+        if params.empty?
+          [Puppet::Resource.indirection.find(key)]
+        else
+          resource = Puppet::Resource.new(type, name, :parameters => params)
+
+          # save returns [resource that was saved, transaction log from applying the resource]
+          save_result, report = Puppet::Resource.indirection.save(resource, key)
+          status = report.resource_statuses[resource.ref]
+          raise "Failed to manage resource #{resource.ref}" if status&.failed? && options[:fail]
+
+          [save_result]
+        end
+      else
+        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
+  end
+end

data/lib/puppet/application/script.rb

@@ -0,0 +1,266 @@
+# 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
+  end
+  option("--test", "-t")
+  option("--verbose", "-v")
+
+  option("--logdest LOGDEST", "-l") do |arg|
+    handle_logdest_arg(arg)
+  end
+
+  def summary
+    _("Run a puppet manifests as a script without compiling a catalog")
+  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.
+      Copyright (c) 2024 Vox Pupuli
+      Licensed under the Apache 2.0 License
+
+    HELP
+  end
+
+  def app_defaults
+    super.merge({
+                  :default_file_terminus => :file_server,
+                })
+  end
+
+  def run_command
+    if Puppet.features.bolt?
+      Puppet.override(:bolt_executor => Bolt::Executor.new) do
+        main
+      end
+    else
+      raise _("Bolt must be installed to use the script application")
+    end
+  end
+
+  def main
+    # The tasks feature is always on
+    Puppet[:tasks] = true
+
+    # Set the puppet code or file to use.
+    if options[:code] || command_line.args.length == 0
+      Puppet[:code] = options[:code] || STDIN.read
+    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
+
+    unless Puppet[:node_name_fact].empty?
+      # Collect the facts specified for that node
+      facts = Puppet::Node::Facts.indirection.find(Puppet[:node_name_value])
+      raise _("Could not find facts for %{node}") % { node: Puppet[:node_name_value] } unless facts
+
+      Puppet[:node_name_value] = facts.values[Puppet[:node_name_fact]]
+      facts.name = Puppet[:node_name_value]
+    end
+
+    # Find the Node
+    node = Puppet::Node.indirection.find(Puppet[:node_name_value])
+    raise _("Could not find node %{node}") % { node: Puppet[:node_name_value] } unless node
+
+    configured_environment = node.environment || Puppet.lookup(:current_environment)
+
+    apply_environment = manifest ?
+      configured_environment.override_with(:manifest => manifest) :
+      configured_environment
+
+    # Modify the node descriptor to use the special apply_environment.
+    # It is based on the actual environment from the node, or the locally
+    # configured environment if the node does not specify one.
+    # If a manifest file is passed on the command line, it overrides
+    # the :manifest setting of the apply_environment.
+    node.environment = apply_environment
+
+    # TRANSLATION, the string "For puppet script" is not user facing
+    Puppet.override({ :current_environment => apply_environment }, "For puppet script") do
+      # Merge in the facts.
+      node.merge(facts.values) if facts
+
+      # Add server facts so $server_facts[environment] exists when doing a puppet script
+      # SCRIPT TODO: May be needed when running scripts under orchestrator. Leave it for now.
+      #
+      node.add_server_facts({})
+
+      begin
+        # Compile the catalog
+
+        # When compiling, the compiler traps and logs certain errors
+        # Those that do not lead to an immediate exit are caught by the general
+        # rule and gets logged.
+        #
+        begin
+          # support the following features when evaluating puppet code
+          # * $facts with facts from host running the script
+          # * $settings with 'settings::*' namespace populated, and '$settings::all_local' hash
+          # * $trusted as setup when using puppet apply
+          # * an environment
+          #
+
+          # fixup trusted information
+          node.sanitize()
+
+          compiler = Puppet::Parser::ScriptCompiler.new(node.environment, node.name)
+          topscope = compiler.topscope
+
+          # When scripting the trusted data are always local, but set them anyway
+          topscope.set_trusted(node.trusted_data)
+
+          # Server facts are always about the local node's version etc.
+          topscope.set_server_facts(node.server_facts)
+
+          # Set $facts for the node running the script
+          facts_hash = node.facts.nil? ? {} : node.facts.values
+          topscope.set_facts(facts_hash)
+
+          # create the $settings:: variables
+          topscope.merge_settings(node.environment.name, false)
+
+          compiler.compile()
+        rescue Puppet::Error
+          # already logged and handled by the compiler, including Puppet::ParseErrorWithIssue
+          exit(1)
+        end
+
+        exit(0)
+      rescue => detail
+        Puppet.log_exception(detail)
+        exit(1)
+      end
+    end
+  ensure
+    if @profiler
+      Puppet::Util::Profiler.remove_profiler(@profiler)
+      @profiler.shutdown
+    end
+  end
+
+  def setup
+    exit(Puppet.settings.print_configs ? 0 : 1) if Puppet.settings.print_configs?
+
+    handle_logdest_arg(Puppet[:logdest])
+    Puppet::Util::Log.newdestination(:console) unless options[:setdest]
+
+    Signal.trap(:INT) do
+      $stderr.puts _("Exiting")
+      exit(1)
+    end
+
+    # TODO: This skips applying the settings catalog for these settings, but
+    # the effect of doing this is unknown. It may be that it only works if there is a puppet
+    # installed where a settings catalog have already been applied...
+    # This saves 1/5th of the startup time
+
+    #    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
+
+    # we do not want the last report to be persisted
+    Puppet::Transaction::Report.indirection.cache_class = nil
+
+    set_log_level
+
+    if Puppet[:profile]
+      @profiler = Puppet::Util::Profiler.add_profiler(Puppet::Util::Profiler::Aggregate.new(Puppet.method(:info), "script"))
+    end
+  end
+end