tobiko.shell.sh

exception tobiko.shell.sh.CommandNotFound(message=None, **properties)

Bases: ObjectNotFound

tobiko.shell.sh.HostNameError

alias of HostnameError

class tobiko.shell.sh.ListNameserversFixture(ssh_client: Optional[SSHClientFixture] = None, filenames: Optional[Iterable[str]] = None, **execute_params)

Bases: SharedFixture

classmethod get(manager=None, fixture_id=None)

classmethod get_fixture_manager() → FixtureManager

class tobiko.shell.sh.LocalExecutePathFixture(executable_dirs=None, environ=None)

Bases: ExecutePathFixture

environ: Dict[str, str] = {'DEBIAN_FRONTEND': 'noninteractive', 'DOCUTILSCONFIG': '/home/docs/checkouts/readthedocs.org/user_builds/tobiko/checkouts/master/doc/source/docutils.conf', 'HOME': '/home/docs', 'HOSTNAME': 'build-24155497-project-432992-tobiko', 'LANG': 'C.UTF-8', 'NO_COLOR': '1', 'PATH': '/home/docs/checkouts/readthedocs.org/user_builds/tobiko/envs/master/bin:/home/docs/.asdf/shims:/home/docs/.asdf/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', 'PWD': '/home/docs/checkouts/readthedocs.org/user_builds/tobiko/checkouts/master/doc/source', 'PYTHON': '/home/docs/checkouts/readthedocs.org/user_builds/tobiko/envs/master/bin/python', 'READTHEDOCS': 'True', 'READTHEDOCS_CANONICAL_URL': 'https://tobiko.readthedocs.io/en/master/', 'READTHEDOCS_GIT_CLONE_URL': 'https://opendev.org/x/tobiko', 'READTHEDOCS_GIT_COMMIT_HASH': '2945010168e9277baf52ab1db44d49b8157253ee', 'READTHEDOCS_GIT_IDENTIFIER': 'master', 'READTHEDOCS_LANGUAGE': 'en', 'READTHEDOCS_OUTPUT': '/home/docs/checkouts/readthedocs.org/user_builds/tobiko/checkouts/master/_readthedocs/', 'READTHEDOCS_PROJECT': 'tobiko', 'READTHEDOCS_VERSION': 'master', 'READTHEDOCS_VERSION_NAME': 'master', 'READTHEDOCS_VERSION_TYPE': 'branch', 'READTHEDOCS_VIRTUALENV_PATH': '/home/docs/checkouts/readthedocs.org/user_builds/tobiko/envs/master'}

executable_dirs: List[str] = ['/home/docs/checkouts/readthedocs.org/user_builds/tobiko/envs/master/bin', '/home/docs/checkouts/readthedocs.org/user_builds/tobiko/envs/master/bin']

classmethod get(manager=None, fixture_id=None)

classmethod get_fixture_manager() → FixtureManager

class tobiko.shell.sh.LocalShellConnection

Bases: ShellConnection

classmethod get(manager=None, fixture_id=None)

classmethod get_fixture_manager() → FixtureManager

class tobiko.shell.sh.LocalShellProcessFixture(**kwargs)

Bases: ShellProcessFixture

classmethod get(manager=None, fixture_id=None)

classmethod get_fixture_manager() → FixtureManager

property path_execute: G

exception tobiko.shell.sh.PsError(message=None, **properties)

Bases: TobikoException

class tobiko.shell.sh.PsProcess(command: str, pid: int, ssh_client: Union[None, bool, SSHClientFixture], is_cirros: Optional[bool] = None)

Bases: PsProcessTuple, PsProcessBase

exception tobiko.shell.sh.PsWaitTimeout(message=None, **properties)

Bases: PsError

exception tobiko.shell.sh.RebootHostError(message=None, **properties)

Bases: TobikoException

class tobiko.shell.sh.RebootHostOperation(ssh_client: SSHClientFixture, timeout: Optional[float] = None, method: RebootHostMethod = RebootHostMethod.SOFT)

Bases: Operation

classmethod get(manager=None, fixture_id=None)

classmethod get_fixture_manager() → FixtureManager

exception tobiko.shell.sh.RebootHostTimeoutError(message=None, **properties)

Bases: RebootHostError

class tobiko.shell.sh.SSHShellConnection(ssh_client: Optional[SSHClientFixture] = None)

Bases: ShellConnection

classmethod get(manager=None, fixture_id=None)

classmethod get_fixture_manager() → FixtureManager

class tobiko.shell.sh.SSHShellProcessFixture(**kwargs)

Bases: ShellProcessFixture

classmethod get(manager=None, fixture_id=None)

classmethod get_fixture_manager() → FixtureManager

class tobiko.shell.sh.ShellCommand(iterable=(), /)

Bases: tuple

exception tobiko.shell.sh.ShellCommandFailed(message=None, **properties)

Bases: ShellError

Raised when shell command exited with non-zero status

class tobiko.shell.sh.ShellConnection

Bases: SharedFixture

classmethod get(manager=None, fixture_id=None)

classmethod get_fixture_manager() → FixtureManager

exception tobiko.shell.sh.ShellError(message=None, **properties)

Bases: TobikoException

class tobiko.shell.sh.ShellExecuteResult(command, exit_status, timeout, status, login, stdin, stdout, stderr)

Bases: ShellExecuteResult

class tobiko.shell.sh.ShellProcessFixture(**kwargs)

Bases: SharedFixture

classmethod get(manager=None, fixture_id=None)

classmethod get_fixture_manager() → FixtureManager

exception tobiko.shell.sh.ShellProcessNotTerminated(message=None, **properties)

Bases: ShellError

exception tobiko.shell.sh.ShellProcessTerminated(message=None, **properties)

Bases: ShellError

exception tobiko.shell.sh.ShellStdinClosed(message=None, **properties)

Bases: ShellError

class tobiko.shell.sh.ShellStdout(delegate, fd=None, buffer_size=None)

Bases: ShellReadable

exception tobiko.shell.sh.ShellTimeoutExpired(message=None, **properties)

Bases: ShellError

Raised when shell command timeouts and has been killed before exiting

exception tobiko.shell.sh.SkipOnCommandNotFound(message=None, **properties)

Bases: CommandNotFound, SkipTest

class tobiko.shell.sh.SystemdUnit(unit, load, active, sub, description, data)

Bases: NamedTuple

exception tobiko.shell.sh.UptimeError(message=None, **properties)

Bases: TobikoException