module Facter::Core::Execution

Public Class Methods

impl() click to toggle source
# File lib/facter/custom_facts/core/execution.rb, line 12
def self.impl
  @@impl
end

Public Instance Methods

absolute_path?(path, platform = nil) click to toggle source

@param platform [:posix/:windows/nil] The platform logic to use

@api private

# File lib/facter/custom_facts/core/execution.rb, line 51
def absolute_path?(path, platform = nil)
  case platform
  when :posix
    Facter::Core::Execution::Posix.new.absolute_path?(path)
  when :windows
    Facter::Core::Execution::Windows.new.absolute_path?(path)
  else
    @@impl.absolute_path?(path)
  end
end
exec(command) click to toggle source

Try to execute a command and return the output.

@param command [String] Command to run

@return [String/nil] Output of the program, or nil if the command does

not exist or could not be executed.

@deprecated Use #{execute} instead @api public

# File lib/facter/custom_facts/core/execution.rb, line 99
def exec(command)
  @@impl.execute(command, on_fail: nil)
end
execute(command, options = {}) click to toggle source

Execute a command and return the output of that program.

@param command [String] Command to run

@param options [Hash] Hash with options for the command

@option options [Object] :on_fail How to behave when the command could

not be run. Specifying :raise will raise an error, anything else will
return that object on failure. Default is :raise.

@option options [Object] :logger Optional logger used to log the

command's stderr.

@option options :timeout Optional time out for the specified

command. If no timeout is passed, a default of 300 seconds is used.

@raise [Facter::Core::Execution::ExecutionFailure] If the command does

not exist or could not be executed and :on_fail is set to :raise

@return [String] the output of the program, or the value of :on_fail (if it’s different than :raise) if

command execution failed and :on_fail was specified.

@api public

# File lib/facter/custom_facts/core/execution.rb, line 124
def execute(command, options = {})
  @@impl.execute(command, options)
end
execute_command(command, on_fail = nil, logger = nil, timeout = nil) click to toggle source

Execute a command and return the stdout and stderr of that program.

@param command [String] Command to run

@param on_fail How to behave when the command could

not be run. Specifying :raise will raise an error, anything else will
return that object on failure. Default is to not raise.

@param logger Optional logger used to log the command’s stderr. @param timeout Optional time out for the specified command. If no timeout is passed,

a default of 300 seconds is used.

@raise [Facter::Core::Execution::ExecutionFailure] If the command does

not exist or could not be executed and :on_fail is set to :raise

@return [String, String] the stdout and stderr of the program, or the value of

:on_fail if command execution failed and :on_fail was specified.

@api private

# File lib/facter/custom_facts/core/execution.rb, line 146
def execute_command(command, on_fail = nil, logger = nil, timeout = nil)
  @@impl.execute_command(command, on_fail, logger, timeout)
end
expand_command(command) click to toggle source

Given a command line, this returns the command line with the executable written as an absolute path. If the executable contains spaces, it has to be put in double quotes to be properly recognized.

@param command [String] the command line

@return [String/nil] The command line with the executable’s path

expanded, or nil if the executable cannot be found.

@api private

# File lib/facter/custom_facts/core/execution.rb, line 72
def expand_command(command)
  @@impl.expand_command(command)
end
search_paths() click to toggle source

Returns the locations to be searched when looking for a binary. This is currently determined by the PATH environment variable plus ‘/sbin` and `/usr/sbin` when run on unix

@return [Array<String>] The paths to be searched for binaries

@api private

# File lib/facter/custom_facts/core/execution.rb, line 25
def search_paths
  @@impl.search_paths
end
which(bin) click to toggle source

Determines the full path to a binary. If the supplied filename does not already describe an absolute path then different locations (determined by {search_paths}) will be searched for a match.

@param bin [String] The executable to locate

@return [String/nil] The full path to the executable or nil if not

found

@api public

# File lib/facter/custom_facts/core/execution.rb, line 39
def which(bin)
  @@impl.which(bin)
end
with_env(values, &block) click to toggle source

Overrides environment variables within a block of code. The specified values will be set for the duration of the block, after which the original values (if any) will be restored.

@param values [Hash<String=>String>] A hash of the environment

variables to override

@return [String] The block’s return string

@api private

# File lib/facter/custom_facts/core/execution.rb, line 86
def with_env(values, &block)
  @@impl.with_env(values, &block)
end