Class: Shells::SshSession

Inherits:

ShellBase

Object
ShellBase
Shells::SshSession

show all

Includes:: BashCommon

Defined in:: lib/shells/ssh_session.rb

Overview

Executes an SSH session with a host.

The default setup of this class should work well with any bash-like shell. In particular, the exec_prompt method sets the “PS1” environment variable, which should set the prompt the shell uses, and the get_exit_code methods retrieves the value of the “$?” variable which should contain the exit code from the last action. Because there is a possibility that your shell does not utilize those methods, the override_set_prompt and override_get_exit_code options are available to change the behavior.

Valid options:

host: The name or IP address of the host to connect to. Defaults to ‘localhost’.
port: The port on the host to connect to. Defaults to 22.
user: The user to login with. This option is required.
password: The password to login with. If our public key is an authorized key on the host, the password is ignored for connection. The #sudo_exec method for bash-like shells will also use this password for elevation.
prompt: The prompt used to determine when processes finish execution. Defaults to ‘~~#’, but if that doesn’t work for some reason because it is valid output from one or more commands, you can change it to something else. It must be unique and cannot contain certain characters. The characters you should avoid are !, $, , /, “, and ‘ because no attempt is made to escape them and the resulting prompt can very easily become something else entirely. If they are provided, they will be replaced to protect the shell from getting stuck.
shell: If set to :shell, then the default shell is executed. If set to anything else, it is assumed to be the executable path to the shell you want to run.
quit: If set, this defines the command to execute when quitting the session. The default is “exit” which will probably work most of the time.
retrieve_exit_code: If set to a non-false value, then the default behavior will be to retrieve the exit code from the shell after executing a command. If set to a false or nil value, the default behavior will be to ignore the exit code from the shell. When retrieved, the exit code is stored in the last_exit_code property. This option can be overridden by providing an alternate value to the exec method on a case-by-case basis.
on_non_zero_exit_code: If set to :ignore (the default) then non-zero exit codes will not cause errors. You will still be able to check the last_exit_code property to determine if the command was successful. If set to :raise then non-zero exit codes will cause a Shells::NonZeroExitCode to be raised when a command exits with a non-zero return value. This option only comes into play when retrieve_exit_code is set to a non-false value. This option can be overridden by providing an alternate value to the exec method on a case-by-case basis.
silence_timeout: When a command is executing, this is the maximum amount of time to wait for any feedback from the shell. If set to 0 (or less) there is no timeout. Unlike command_timeout this value resets every time we receive feedback. This option can be overridden by providing an alternate value to the exec method on a case-by-case basis.
command_timeout: When a command is executing, this is the maximum amount of time to wait for the command to finish. If set to 0 (or less) there is no timeout. Unlike silence_timeout this value does not reset when we receive feedback. This option can be overridden by providing an alternate value to the exec method on a case-by-case basis.
connect_timeout: This is the maximum amount of time to wait for the initial connection to the SSH shell.
override_set_prompt: If provided, this must be set to either a command string that will set the prompt, or a Proc that accepts the shell as an argument. If set to a string, the string is sent to the shell and we wait up to two seconds for the prompt to appear. If that fails, we resend the string and wait one more time before failing. If set to a Proc, the Proc is called. If the Proc returns a false value, we fail. If the Proc returns a non-false value, we consider it successful.
override_get_exit_code: If provided, this must be set to either a command string that will retrieve the exit code, or a Proc that accepts the shell as an argument. If set to a string, the string is sent to the shell and the output is parsed as an integer and used as the exit code. If set to a Proc, the Proc is called and the return value of the proc is used as the exit code.

Shells::SshSession.new(
    host: '10.10.10.10',
    user: 'somebody',
    password: 'super-secret'
) do |shell|
  shell.exec('cd /usr/local/bin')
  user_bin_files = shell.exec('ls -A1').split("\n")
  @app_is_installed = user_bin_files.include?('my_app')
end

Direct Known Subclasses

PfSenseSshSession

Defined Under Namespace

Classes: FailedToRequestPty, FailedToStartShell

Instance Attribute Summary

Attributes inherited from ShellBase

#last_exit_code, #options

Method Summary

Methods included from BashCommon

#read_file, #sudo_exec, #write_file

Methods inherited from ShellBase

after_init, after_term, before_init, before_term, #combined_output, #exec, #exec_for_code, #initialize, #line_ending, on_debug, on_exception, #read_file, #session_complete?, #stderr, #stdout, #write_file

Constructor Details

This class inherits a constructor from Shells::ShellBase