class Inspec::Resources::Cmd

Attributes

command[R]

Public Class Methods

new(cmd, options = {}) click to toggle source
# File lib/inspec/resources/command.rb, line 28
def initialize(cmd, options = {})
  if cmd.nil?
    raise "InSpec `command` was called with `nil` as the argument. This is not supported. Please provide a valid command instead."
  end

  @command = cmd
  cli_timeout = Inspec::Config.cached["command_timeout"]&.to_i
  # Can access this via Inspec::InspecCLI.commands["exec"].options[:command_timeout].default,
  # but that may not be loaded for kitchen-inspec and other pure gem consumers
  cli_timeout = nil if cli_timeout == 0 # Under test-kitchen we get a 0 timeout, which can't be a resonable value
  @timeout = cli_timeout || options[:timeout]&.to_i

  if options[:redact_regex]
    unless options[:redact_regex].is_a?(Regexp)
      # Make sure command is replaced so sensitive output isn't shown
      @command = "ERROR"
      raise Inspec::Exceptions::ResourceFailed,
            "The `redact_regex` option must be a regular expression"
    end
    @redact_regex = options[:redact_regex]
  end
end

Public Instance Methods

exist?() click to toggle source
# File lib/inspec/resources/command.rb, line 75
def exist? # rubocop:disable Metrics/AbcSize
  # silent for mock resources
  return false if inspec.os.name.nil? || inspec.os.name == "mock"

  if inspec.os.linux?
    res = if inspec.platform.name == "alpine"
            inspec.backend.run_command("which \"#{@command}\"")
          else
            inspec.backend.run_command("sh -c 'type \"#{@command}\"'")
          end
  elsif inspec.os.windows?
    res = inspec.backend.run_command("Get-Command \"#{@command}\"")
  elsif inspec.os.unix?
    res = inspec.backend.run_command("type \"#{@command}\"")
  else
    warn "`command(#{@command}).exist?` is not supported on your OS: #{inspec.os[:name]}"
    return false
  end
  res.exit_status.to_i == 0
end
exit_status() click to toggle source
# File lib/inspec/resources/command.rb, line 71
def exit_status
  result.exit_status.to_i
end
result() click to toggle source
# File lib/inspec/resources/command.rb, line 51
def result
  @result ||= begin
    inspec.backend.run_command(@command, timeout: @timeout)
              rescue Train::CommandTimeoutReached
                # Without a small sleep, the train connection gets broken
                # We've already timed out, so a small sleep is not likely to be painful here.
                sleep 0.1
                raise Inspec::Exceptions::ResourceFailed,
                      "Command `#{@command}` timed out after #{@timeout} seconds"
  end
end
stderr() click to toggle source
# File lib/inspec/resources/command.rb, line 67
def stderr
  result.stderr
end
stdout() click to toggle source
# File lib/inspec/resources/command.rb, line 63
def stdout
  result.stdout
end
to_s() click to toggle source
# File lib/inspec/resources/command.rb, line 96
def to_s
  output = "Command: `#{@command}`"
  # Redact output if the `redact_regex` option is passed
  # If no capture groups are passed then `\1` and `\2` are ignored
  output.gsub!(@redact_regex, '\1REDACTED\2') unless @redact_regex.nil?
  output
end