Class: Puppet::Application Abstract

Inherits:
Object show all
Extended by:
Util
Includes:
Util
Defined in:
lib/puppet/application.rb

Overview

This class is abstract.

Defines an abstract Puppet application.

# Usage

To create a new application extend `Puppet::Application`. Derived applications must implement the `main` method and should implement the `summary` and `help` methods in order to be included in `puppet help`, and should define application-specific options. For example:

“` class Puppet::Application::Example < Puppet::Application

def summary
  "My puppet example application"
end

def help
  <<~HELP
  puppet-example(8) -- #{summary}
  ...
  HELP
end

# define arg with a required option
option("--arg ARGUMENT") do |v|
  options[:arg] = v
end

# define arg with an optional option
option("--maybe [ARGUMENT]") do |v|
  options[:maybe] = v
end

# define long and short arg
option("--all", "-a")

def initialize(command_line = Puppet::Util::CommandLine.new)
  super
  @data = {}
end

def main
  # call action
  send(@command_line.args.shift)
end

def read
  # read action
end

def write
  # write action
end

end “`

Puppet defines the following application lifecycle methods that are called in the following order:

## Execution state The class attributes/methods of Puppet::Application serve as a global place to set and query the execution status of the application: stopping, restarting, etc. The setting of the application status does not directly affect its running status; it's assumed that the various components within the application will consult these settings appropriately and affect their own processing accordingly. Control operations (signal handlers and the like) should set the status appropriately to indicate to the overall system that it's the process of stopping or restarting (or just running as usual).

So, if something in your application needs to stop the process, for some reason, you might consider:

“`

def stop_me!
  # indicate that we're stopping
  Puppet::Application.stop!
  # ...do stuff...
end

“`

And, if you have some component that involves a long-running process, you might want to consider:

“`

def my_long_process(giant_list_to_munge)
  giant_list_to_munge.collect do |member|
    # bail if we're stopping
    return if Puppet::Application.stop_requested?
    process_member(member)
  end
end

“`

Defined Under Namespace

Classes: Agent, Apply, Catalog, CommandLineArgs, Config, Describe, Device, Doc, Epp, FaceBase, Facts, Filebucket, Generate, Help, IndirectionBase, Lookup, Module, Node, Parser, Plugin, Report, Resource, Script, Ssl

Constant Summary collapse

DOCPATTERN =
::File.expand_path(::File.dirname(__FILE__) + "/util/command_line/*" )

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::HttpProxy, Util::PUPPET_STACK_INSERTION_FRAME, Util::RFC_3986_URI_REGEX

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, format_backtrace_array, format_puppetstack_frame, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, resolve_stackframe, safe_posix_fork, set_env, skip_external_facts, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from Util::SymbolicFileMode

#normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::POSIX

#get_posix_field, #gid, groups_of, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Constructor Details

#initialize(command_line = Puppet::Util::CommandLine.new) ⇒ Application

Initialize the application receiving the Util::CommandLine object containing the application name and arguments.

Parameters:

  • command_line (Puppet::Util::CommandLine) (defaults to: Puppet::Util::CommandLine.new)

    An instance of the command line to create the application with


345
346
347
348
# File 'lib/puppet/application.rb', line 345

def initialize(command_line = Puppet::Util::CommandLine.new)
  @command_line = CommandLineArgs.new(command_line.subcommand_name, command_line.args.dup)
  @options = {}
end

Class Attribute Details

.run_statusObject


119
120
121
# File 'lib/puppet/application.rb', line 119

def run_status
  @run_status
end

Instance Attribute Details

#command_lineObject (readonly)


324
325
326
# File 'lib/puppet/application.rb', line 324

def command_line
  @command_line
end

#optionsObject (readonly)


324
325
326
# File 'lib/puppet/application.rb', line 324

def options
  @options
end

Class Method Details

.[](name) ⇒ Puppet::Application

Return an instance of the specified application.

Parameters:

  • name (Symbol)

    the lowercase name of the application

Returns:

Raises:

  • (Puppet::Error)

    if the application class was not found.

  • (LoadError)

    if there was a problem loading the application file.


273
274
275
# File 'lib/puppet/application.rb', line 273

def [](name)
  find(name).new
end

.available_application_namesArray<String>

Returns the names of available applications.

Returns:

  • (Array<String>)

    the names of available applications


204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/puppet/application.rb', line 204

def available_application_names
  # Use our configured environment to load the application, as it may
  # be in a module we installed locally, otherwise fallback to our
  # current environment (*root*). Once we load the application the
  # current environment will change from *root* to the application
  # specific environment.
  environment = Puppet.lookup(:environments).get(Puppet[:environment]) ||
                Puppet.lookup(:current_environment)
  @loader.files_to_load(environment).map do |fn|
    ::File.basename(fn, '.rb')
  end.uniq
end

191
192
193
# File 'lib/puppet/application.rb', line 191

def banner(banner = nil)
  @banner ||= banner
end

.clear!Object


121
122
123
# File 'lib/puppet/application.rb', line 121

def clear!
  self.run_status = nil
end

.clear?Boolean

Indicates that Puppet::Application believes that it's in usual running run_mode (no stop/restart request currently active).

Returns:

  • (Boolean)

161
162
163
# File 'lib/puppet/application.rb', line 161

def clear?
  run_status.nil?
end

.clear_everything_for_testsObject

This is for testing only


319
320
321
# File 'lib/puppet/application.rb', line 319

def clear_everything_for_tests
  @run_mode = @banner = @run_status = @option_parser_commands = nil
end

.controlled_run(&block) ⇒ Object

Only executes the given block if the run status of Puppet::Application is clear (no restarts, stops, etc. requested). Upon block execution, checks the run status again; if a restart has been requested during the block's execution, then controlled_run will send a new HUP signal to the current process. Thus, long-running background processes can potentially finish their work before a restart.


170
171
172
173
174
175
# File 'lib/puppet/application.rb', line 170

def controlled_run(&block)
  return unless clear?
  result = block.call
  Process.kill(:HUP, $PID) if restart_requested?
  result
end

.environment_mode(mode_name) ⇒ Object

Sets environment_mode name. When acting as a compiler, the environment mode should be `:local` since the directory must exist to compile the catalog. When acting as an agent, the environment mode should be `:remote` since the Puppet setting refers to an environment directoy on a remote system. The `:not_required` mode is for cases where the application does not need an environment to run.

Parameters:

  • mode_name (Symbol)

    The name of the environment mode to run in. May be one of `:local`, `:remote`, or `:not_required`. This impacts where the application looks for its specified environment. If `:not_required` or `:remote` are set, the application will not fail if the environment does not exist on the local filesystem.

Raises:


304
305
306
307
# File 'lib/puppet/application.rb', line 304

def environment_mode(mode_name)
  raise Puppet::Error, _("Invalid environment mode '%{mode_name}'") % { mode_name: mode_name } unless [:local, :remote, :not_required].include?(mode_name)
  @environment_mode = mode_name
end

.exit(code) ⇒ Object

this is used for testing


564
565
566
# File 'lib/puppet/application.rb', line 564

def self.exit(code)
  exit(code)
end

.find(application_name) ⇒ Class

Finds the class for a given application and loads the class. This does not create an instance of the application, it only gets a handle to the class. The code for the application is expected to live in a ruby file `puppet/application/##name.rb` that is available on the `$LOAD_PATH`.

Parameters:

  • application_name (String)

    the name of the application to find (eg. “apply”).

Returns:

  • (Class)

    the Class instance of the application that was found.

Raises:

  • (Puppet::Error)

    if the application class was not found.

  • (LoadError)

    if there was a problem loading the application file.


227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/puppet/application.rb', line 227

def find(application_name)
  begin
    require @loader.expand(application_name.to_s.downcase)
  rescue LoadError => e
    Puppet.log_and_raise(e, _("Unable to find application '%{application_name}'. %{error}") % { application_name: application_name, error: e })
  end

  class_name = Puppet::Util::ConstantInflector.file2constant(application_name.to_s)

  clazz = try_load_class(class_name)

  ################################################################
  #### Begin 2.7.x backward compatibility hack;
  ####  eventually we need to issue a deprecation warning here,
  ####  and then get rid of this stanza in a subsequent release.
  ################################################################
  if (clazz.nil?)
    class_name = application_name.capitalize
    clazz = try_load_class(class_name)
  end
  ################################################################
  #### End 2.7.x backward compatibility hack
  ################################################################

  if clazz.nil?
    raise Puppet::Error.new(_("Unable to load application class '%{class_name}' from file 'puppet/application/%{application_name}.rb'") % { class_name: class_name, application_name: application_name })
  end

  return clazz
end

.get_environment_modeSymbol

Gets environment_mode name. If none is set with `environment_mode=`, default to :local.

Returns:

  • (Symbol)

    The current environment mode


313
314
315
# File 'lib/puppet/application.rb', line 313

def get_environment_mode
  @environment_mode || :local
end

.interrupted?Boolean

Indicates that one of stop! or start! was invoked on Puppet::Application, and some kind of process shutdown/short-circuit may be necessary.

Returns:

  • (Boolean)

154
155
156
# File 'lib/puppet/application.rb', line 154

def interrupted?
  [:restart_requested, :stop_requested].include? run_status
end

.option(*options, &block) ⇒ Object

used to declare code that handle an option


178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/puppet/application.rb', line 178

def option(*options, &block)
  long = options.find { |opt| opt =~ /^--/ }.gsub(/^--(?:\[no-\])?([^ =]+).*$/, '\1' ).tr('-','_')
  fname = "handle_#{long}".intern
  if (block_given?)
    define_method(fname, &block)
  else
    define_method(fname) do |value|
      self.options["#{long}".to_sym] = value
    end
  end
  self.option_parser_commands << [options, fname]
end

.option_parser_commandsObject


195
196
197
198
199
200
# File 'lib/puppet/application.rb', line 195

def option_parser_commands
  @option_parser_commands ||= (
    superclass.respond_to?(:option_parser_commands) ? superclass.option_parser_commands.dup : []
  )
  @option_parser_commands
end

.restart!Object

Signal that the application should restart.


133
134
135
# File 'lib/puppet/application.rb', line 133

def restart!
  self.run_status = :restart_requested
end

.restart_requested?Boolean

Indicates that Puppet::Application.restart! has been invoked and components should do what is necessary to facilitate a restart.

Returns:

  • (Boolean)

140
141
142
# File 'lib/puppet/application.rb', line 140

def restart_requested?
  :restart_requested == run_status
end

.run_mode(mode_name = nil) ⇒ Object

Sets or gets the run_mode name. Sets the run_mode name if a mode_name is passed. Otherwise, gets the run_mode or a default run_mode


280
281
282
283
284
285
286
287
288
289
# File 'lib/puppet/application.rb', line 280

def run_mode(mode_name = nil)
  if mode_name
    Puppet.settings.preferred_run_mode = mode_name
  end

  return @run_mode if @run_mode and not mode_name

  require 'puppet/util/run_mode'
  @run_mode = Puppet::Util::RunMode[ mode_name || Puppet.settings.preferred_run_mode ]
end

.stop!Object

Signal that the application should stop.


127
128
129
# File 'lib/puppet/application.rb', line 127

def stop!
  self.run_status = :stop_requested
end

.stop_requested?Boolean

Indicates that Puppet::Application.stop! has been invoked and components should do what is necessary for a clean stop.

Returns:

  • (Boolean)

147
148
149
# File 'lib/puppet/application.rb', line 147

def stop_requested?
  :stop_requested == run_status
end

.try_load_class(class_name) ⇒ Class

Given the fully qualified name of a class, attempt to get the class instance.

Parameters:

  • class_name (String)

    the fully qualified name of the class to try to load

Returns:

  • (Class)

    the Class instance, or nil? if it could not be loaded.


261
262
263
# File 'lib/puppet/application.rb', line 261

def try_load_class(class_name)
    return self.const_defined?(class_name) ? const_get(class_name) : nil
end

Instance Method Details

#app_defaultsHash<String, String>

Now that the `run_mode` has been resolved, return default settings for the application. Note these values may be overridden when puppet's configuration is loaded later.

Examples:

To override the facts terminus:

def app_defaults
  super.merge({
    :facts_terminus => 'yaml'
  })
end

Returns:

  • (Hash<String, String>)

    default application settings


363
364
365
366
367
# File 'lib/puppet/application.rb', line 363

def app_defaults
  Puppet::Settings.app_defaults_for_run_mode(self.class.run_mode).merge(
      :name => name
  )
end

#configure_indirector_routesObject


487
488
489
# File 'lib/puppet/application.rb', line 487

def configure_indirector_routes
  Puppet::ApplicationSupport.configure_indirector_routes(name.to_s)
end

#deprecatevoid

This method returns an undefined value.

Call in setup of subclass to deprecate an application.


387
388
389
# File 'lib/puppet/application.rb', line 387

def deprecate
  @deprecated = true
end

#deprecated?Boolean

Return true if this application is deprecated.

Returns:

  • (Boolean)

393
394
395
# File 'lib/puppet/application.rb', line 393

def deprecated?
  @deprecated
end

#handle_logdest_arg(arg) ⇒ Object


475
476
477
478
479
480
481
482
483
484
485
# File 'lib/puppet/application.rb', line 475

def handle_logdest_arg(arg)
  return if arg.nil?

  begin
    Puppet[:logdest] = arg
    Puppet::Util::Log.newdestination(arg)
    options[:setdest] = true
  rescue => detail
    Puppet.log_and_raise(detail, _("Could not set logdest to %{dest}.") % { dest: arg })
  end
end

#handlearg(opt, val) ⇒ Object


558
559
560
561
# File 'lib/puppet/application.rb', line 558

def handlearg(opt, val)
  opt, val = Puppet::Settings.clean_opt(opt, val)
  send(:handle_unknown, opt, val) if respond_to?(:handle_unknown)
end

#helpString

Return the text to display when running `puppet help`.

Returns:

  • (String)

    The help to display


575
576
577
# File 'lib/puppet/application.rb', line 575

def help
  _("No help available for puppet %{app_name}") % { app_name: name }
end

#initialize_app_defaultsvoid

This method returns an undefined value.

Initialize application defaults. It's usually not necessary to override this method.


372
373
374
# File 'lib/puppet/application.rb', line 372

def initialize_app_defaults()
  Puppet.settings.initialize_app_defaults(app_defaults)
end

#log_runtime_environment(extra_info = nil) ⇒ void

This method returns an undefined value.

Output basic information about the runtime environment for debugging purposes.

Parameters:

  • extra_info (Hash{String => #to_s}) (defaults to: nil)

    a flat hash of extra information to log. Intended to be passed to super by subclasses.


498
499
500
501
502
503
504
505
506
507
508
# File 'lib/puppet/application.rb', line 498

def log_runtime_environment(extra_info=nil)
  runtime_info = {
    'puppet_version' => Puppet.version,
    'ruby_version'   => RUBY_VERSION,
    'run_mode'       => self.class.run_mode.name,
  }
  runtime_info['default_encoding'] = Encoding.default_external
  runtime_info.merge!(extra_info) unless extra_info.nil?

  Puppet.debug 'Runtime environment: ' + runtime_info.map{|k,v| k + '=' + v.to_s}.join(', ')
end

#mainvoid

This method returns an undefined value.

This method must be overridden and perform whatever action is required for the application. The `command_line` reader contains the actions and arguments.

Raises:

  • (NotImplementedError)

429
430
431
# File 'lib/puppet/application.rb', line 429

def main
  raise NotImplementedError, _("No valid command or main")
end

#nameObject


568
569
570
# File 'lib/puppet/application.rb', line 568

def name
  self.class.to_s.sub(/.*::/,"").downcase.to_sym
end

#parse_optionsvoid

This method returns an undefined value.

Options defined with the `option` method are parsed from settings and the command line. Refer to OptionParser documentation for the exact format. Options are parsed as follows:

  • If the option method is given a block, then it will be called whenever the option is encountered in the command-line argument.

  • If the option method has no block, then the default option handler will store the argument in the `options` instance variable.

  • If a given option was not defined by an `option` method, but it exists as a Puppet setting:

    • if `unknown` was used with a block, it will be called with the option name and argument.

    • if `unknown` wasn't used, then the option/argument is handed to Puppet.settings.handlearg for a default behavior.

  • The `-h` and `–help` options are automatically handled by the command line before creating the application.

Options specified on the command line override settings. It is usually not necessary to override this method.


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'lib/puppet/application.rb', line 525

def parse_options
  # Create an option parser
  option_parser = OptionParser.new(self.class.banner)

  # Here we're building up all of the options that the application may need to handle.  The main
  # puppet settings defined in "defaults.rb" have already been parsed once (in command_line.rb) by
  # the time we get here; however, our app may wish to handle some of them specially, so we need to
  # make the parser aware of them again.  We might be able to make this a bit more efficient by
  # re-using the parser object that gets built up in command_line.rb.  --cprice 2012-03-16

  # Add all global options to it.
  Puppet.settings.optparse_addargs([]).each do |option|
    option_parser.on(*option) do |arg|
      handlearg(option[0], arg)
    end
  end

  # Add options that are local to this application, which were
  # created using the "option()" metaprogramming method.  If there
  # are any conflicts, this application's options will be favored.
  self.class.option_parser_commands.each do |options, fname|
    option_parser.on(*options) do |value|
      # Call the method that "option()" created.
      self.send(fname, value)
    end
  end

  # Scan command line.  We just hand any exceptions to our upper levels,
  # rather than printing help and exiting, so that we can meaningfully
  # respond with context-sensitive help if we want to. --daniel 2011-04-12
  option_parser.parse!(self.command_line.args)
end

#preinitvoid

This method returns an undefined value.

The preinit block is the first code to be called in your application, after `initialize`, but before option parsing, setup or command execution. It is usually not necessary to override this method.


381
382
# File 'lib/puppet/application.rb', line 381

def preinit
end

#runvoid

This method returns an undefined value.

Execute the application. This method should not be overridden.


400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'lib/puppet/application.rb', line 400

def run

  # I don't really like the names of these lifecycle phases.  It would be nice to change them to some more meaningful
  # names, and make deprecated aliases.  --cprice 2012-03-16

  exit_on_fail(_("Could not get application-specific default settings")) do
    initialize_app_defaults
  end

  Puppet::ApplicationSupport.push_application_context(self.class.run_mode, self.class.get_environment_mode)

  exit_on_fail(_("Could not initialize"))                { preinit }
  exit_on_fail(_("Could not parse application options")) { parse_options }
  exit_on_fail(_("Could not prepare for execution"))     { setup }

  if deprecated?
    Puppet.deprecation_warning(_("`puppet %{name}` is deprecated and will be removed in a future release.") % { name: name })
  end

  exit_on_fail(_("Could not configure routes from %{route_file}") % { route_file: Puppet[:route_file] }) { configure_indirector_routes }
  exit_on_fail(_("Could not log runtime debug info"))                       { log_runtime_environment }
  exit_on_fail(_("Could not run"))                                          { run_command }
end

#run_commandvoid

This method returns an undefined value.

Run the application. By default, it calls #main.


436
437
438
# File 'lib/puppet/application.rb', line 436

def run_command
  main
end

#set_log_level(opts = nil) ⇒ Object


466
467
468
469
470
471
472
473
# File 'lib/puppet/application.rb', line 466

def set_log_level(opts = nil)
  opts ||= options
  if opts[:debug]
    Puppet::Util::Log.level = :debug
  elsif opts[:verbose] && !Puppet::Util::Log.sendlevel?(:info)
    Puppet::Util::Log.level = :info
  end
end

#setupvoid

This method returns an undefined value.

Setup the application. It is usually not necessary to override this method.


443
444
445
# File 'lib/puppet/application.rb', line 443

def setup
  setup_logs
end

#setup_logsvoid

This method returns an undefined value.

Setup logging. By default the `console` log destination will only be created if `debug` or `verbose` is specified on the command line. Override to customize the logging behavior.


452
453
454
455
456
457
458
459
460
461
462
463
464
# File 'lib/puppet/application.rb', line 452

def setup_logs
  handle_logdest_arg(Puppet[:logdest]) if !options[:setdest]

  unless options[:setdest]
    if options[:debug] || options[:verbose]
      Puppet::Util::Log.newdestination(:console)
    end
  end

  set_log_level

  Puppet::Util::Log.setup_default unless options[:setdest]
end

#summaryString

The description used in top level `puppet help` output If left empty in implementations, we will attempt to extract the summary from the help text itself.

Returns:

  • (String)

584
585
586
# File 'lib/puppet/application.rb', line 584

def summary
  ""
end