def test_regular_protocol_commands(self, docker_env):
self.assert_env(docker_env)
with docker_env.devconnect.get_websocket() as ws:
# Start shell.
shell = proto_shell.ProtoShell(ws)
body = shell.startShell()
assert shell.protomsg.props[
"status"] == protomsg.PROP_STATUS_NORMAL
assert body == proto_shell.MSG_BODY_SHELL_STARTED
# Drain any initial output from the prompt. It should end in either "# "
# (root) or "$ " (user).
output = shell.recvOutput()
assert shell.protomsg.props[
"status"] == protomsg.PROP_STATUS_NORMAL
assert output[-2:].decode() in [
"# ",
"$ ",
], "Could not detect shell prompt."
# Starting the shell again should be a no-op. It should return that
# it is already started, as long as the shell limit is 1. MEN-4240.
body = shell.startShell()
assert shell.protomsg.props["status"] == protomsg.PROP_STATUS_ERROR
assert body == b"failed to start shell: shell is already running"
# Make sure we do not get any new output, it should be the same shell as before.
output = shell.recvOutput()
assert (
output == b""
), "Unexpected output received when relauncing already launched shell."
# Test if a simple command works.
shell.sendInput("ls /\n".encode())
output = shell.recvOutput()
assert shell.protomsg.props[
"status"] == protomsg.PROP_STATUS_NORMAL
output = output.decode()
assert "usr" in output
assert "etc" in output
# Try to stop shell.
body = shell.stopShell()
assert shell.protomsg.props[
"status"] == protomsg.PROP_STATUS_NORMAL
assert body is None
# Repeat stopping and verify the error
body = shell.stopShell()
assert shell.protomsg.props["status"] == protomsg.PROP_STATUS_ERROR
assert b"session not found" in body, body
# Make sure we can not send anything to the shell.
shell.sendInput("ls /\n".encode())
output = shell.recvOutput()
assert shell.protomsg.props["status"] == protomsg.PROP_STATUS_ERROR
output = output.decode()
assert "usr" not in output
assert "etc" not in output
assert "session not found" in output, output
# Start it again.
shell.startShell()
assert shell.protomsg.props[
"status"] == protomsg.PROP_STATUS_NORMAL
# Drain any initial output from the prompt. It should end in either "# "
# (root) or "$ " (user).
output = shell.recvOutput()
assert shell.protomsg.props[
"status"] == protomsg.PROP_STATUS_NORMAL
assert output[-2:].decode() in [
"# ",
"$ ",
], "Could not detect shell prompt."
def test_session_recording(self, docker_env):
self.assert_env(docker_env)
def get_cmd(ws, timeout=1):
pmsg = protomsg.ProtoMsg(proto_shell.PROTO_TYPE_SHELL)
body = b""
try:
while True:
msg = ws.recv(timeout)
b = pmsg.decode(msg)
if pmsg.typ == proto_shell.MSG_TYPE_SHELL_COMMAND:
body += b
except TimeoutError:
return body
session_id = ""
session_bytes = b""
with docker_env.devconnect.get_websocket() as ws:
# Start shell.
shell = proto_shell.ProtoShell(ws)
body = shell.startShell()
assert shell.protomsg.props[
"status"] == protomsg.PROP_STATUS_NORMAL
assert body == proto_shell.MSG_BODY_SHELL_STARTED
assert shell.sid is not None
session_id = shell.sid
""" Record a series of commands """
shell.sendInput("echo 'now you see me'\n".encode())
session_bytes += get_cmd(ws)
# Disable echo
time.sleep(1)
shell.sendInput("stty -echo\n".encode())
time.sleep(1)
session_bytes += get_cmd(ws)
shell.sendInput('echo "now you don\'t" > /dev/null\n'.encode())
session_bytes += get_cmd(ws)
shell.sendInput("# Invisible comment\n".encode())
session_bytes += get_cmd(ws)
# Turn echo back on
time.sleep(1)
shell.sendInput("stty echo\n".encode())
time.sleep(1)
session_bytes += get_cmd(ws)
shell.sendInput("echo 'and now echo is back on'\n".encode())
session_bytes += get_cmd(ws)
body = shell.stopShell()
assert shell.protomsg.props[
"status"] == protomsg.PROP_STATUS_NORMAL
assert body is None
# Sleep for a second to make sure the session log propagate to the DB.
time.sleep(1)
playback_bytes = b""
with docker_env.devconnect.get_playback_websocket(session_id,
sleep_ms=0) as ws:
playback_bytes = get_cmd(ws)
assert playback_bytes == session_bytes
assert b"now you see me" in playback_bytes
assert b"echo 'now you see me'" in playback_bytes
# Check that the commands after echo was disabled is not present in the log
assert b"# Invisible comment" not in playback_bytes
assert b'echo "now you don\'t" > /dev/null' not in playback_bytes
# ... and after echo is enabled
assert b"echo 'and now echo is back on'" in playback_bytes