summaryrefslogtreecommitdiffstats
path: root/scripts/sendkeys.py
blob: a67903d0f892e76f2ac2597f31734d4fbf84d830 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
#!/usr/bin/env python3
"""Type lines into a QEMU guest via the monitor's `sendkey` command.

Each positional argument is one line: it is typed character by character
(US layout) followed by Enter.  Use it to drive the rs-dos shell from a
test script without a display.

Usage:
    sendkeys.py "ls /disk" "echo hi WRITING /disk/a.txt" "poweroff"
    sendkeys.py --sock /tmp/qmon.sock "date"

Environment: QMON_SOCK (default: /tmp/qmon.sock)
"""
import os
import socket
import sys
import time

SOCK = os.environ.get("QMON_SOCK", "/tmp/qmon.sock")

# Unshifted punctuation needs QEMU's *named* keys — bare '-'/'.'/'/' are
# not valid sendkey names (and '-' is the modifier separator).
BASE = {
    "-": "minus", "=": "equal", "[": "bracketleft", "]": "bracketright",
    "\\": "backslash", ";": "semicolon", "'": "apostrophe",
    ",": "comma", ".": "dot", "/": "slash", "`": "grave",
}

# Characters that need a shift key on US layout, and the key QEMU's
# `sendkey` understands for them.
SHIFT = {
    "~": "grave", "!": "1", "@": "2", "#": "3", "$": "4", "%": "5",
    "^": "6", "&": "7", "*": "8", "(": "9", ")": "0",
    "_": "minus", "+": "equal", "{": "bracketleft", "}": "bracketright",
    "|": "backslash", ":": "semicolon", '"': "apostrophe",
    "<": "comma", ">": "dot", "?": "slash",
}

ALNUM = set("abcdefghijklmnopqrstuvwxyz0123456789")


def connect(path, timeout=60):
    """Connect to the monitor socket, retrying until QEMU is up."""
    deadline = time.time() + timeout
    while True:
        try:
            s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
            s.connect(path)
            return s
        except OSError:
            if time.time() > deadline:
                raise
            time.sleep(0.2)


def sendkey(sock, keys):
    sock.sendall(("sendkey %s\n" % keys).encode())


def type_line(sock, line):
    for ch in line:
        if ch == " ":
            sendkey(sock, "spc")
        elif ch in BASE:
            sendkey(sock, BASE[ch])
        elif ch in SHIFT:
            sendkey(sock, "shift-" + SHIFT[ch])
        elif ch.isupper():
            sendkey(sock, "shift-" + ch.lower())
        elif ch in ALNUM:
            sendkey(sock, ch)
        else:
            sys.stderr.write("warning: no sendkey mapping for %r\n" % ch)
            continue
        time.sleep(0.25)
    sendkey(sock, "ret")
    time.sleep(1.5)


def main():
    args = [a for a in sys.argv[1:] if a != "--sock"]
    sock_path = SOCK
    if "--sock" in sys.argv:
        i = sys.argv.index("--sock")
        sock_path = sys.argv[i + 1]
        args = sys.argv[i + 2:]
    if not args:
        sys.stderr.write(__doc__ or "")
        return 1
    sock = connect(sock_path)
    # Let the monitor drain any startup banner before typing.
    time.sleep(0.5)
    for line in args:
        try:
            type_line(sock, line)
        except OSError:
            # Guest powered off (last line was usually "poweroff").
            break
    return 0


if __name__ == "__main__":
    sys.exit(main())