ionelmc / python-manhole / 352

pending completion

Build # 352

Build Type

push

travis-ci

Committed by

ionelmc

Commit Message

<a href="https://github.com/ionelmc/python-manhole/commit/<a class=hub.com/ionelmc/python-manhole/commit/a2aca14cce353421136c0f5d6e2c0c7e5560b7a3">a2aca14cc<a href="https://github.com/ionelmc/python-manhole/commit/a2aca14cce353421136c0f5d6e2c0c7e5560b7a3">&quot;&gt;Setup the hub or whatever. Use workaround from https://github.com/eventlet/eventlet/commit/</a><a class="double-link" href="https://github.com/ionelmc/python-manhole/commit/<a class="double-link" href="https://github.com/ionelmc/python-manhole/commit/b756447bab51046dfc6f1e0e299cc997ab343701">b756447ba</a>">b756447ba</a><a href="https://github.com/ionelmc/python-manhole/commit/a2aca14cce353421136c0f5d6e2c0c7e5560b7a3">.

Run Details

98 of 137 branches covered (71.53%)

426 of 512 relevant lines covered (83.2%)

31.58 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

37.82

/src/manhole/cli.py

#!/usr/bin/env python
from __future__ import print_function

import argparse
import errno
import os
import re
import readline
import select
import signal
import socket
import sys
import threading
import time

try:
    input = raw_input
except NameError:
    pass

SIG_NAMES = {}
SIG_NUMBERS = set()
for sig, num in vars(signal).items():
    if sig.startswith('SIG') and '_' not in sig:
        SIG_NAMES[sig] = num
        SIG_NAMES[sig[3:]] = num
        SIG_NUMBERS.add(num)


def parse_pid(value, regex=re.compile(r'^(/tmp/manhole-)?(?P<pid>\d+)$')):
    match = regex.match(value)
    if not match:
        raise argparse.ArgumentTypeError("PID must be in one of these forms: 1234 or /tmp/manhole-1234")

    return int(match.group('pid'))


def parse_signal(value):
    try:
        value = int(value)
    except ValueError:
        pass
    else:
        if value in SIG_NUMBERS:
            return value
        else:
            raise argparse.ArgumentTypeError("Invalid signal number %s. Expected one of: %s" % (
                value, ', '.join(str(i) for i in SIG_NUMBERS)
            ))
    value = value.upper()
    if value in SIG_NAMES:
        return SIG_NAMES[value]
    else:
        raise argparse.ArgumentTypeError("Invalid signal name %r." % value)


parser = argparse.ArgumentParser(description='Connect to a manhole.')
parser.add_argument('pid', metavar='PID', type=parse_pid,  # nargs='?',
                    help='A numerical process id, or a path in the form: /tmp/manhole-1234')
parser.add_argument('-t', '--timeout', dest='timeout', default=1, type=float,
                    help='Timeout to use. Default: %(default)s seconds.')
group = parser.add_mutually_exclusive_group()
group.add_argument('-1', '-USR1', dest='signal', action='store_const', const=int(signal.SIGUSR1),
                   help='Send USR1 (%(const)s) to the process before connecting.')
group.add_argument('-2', '-USR2', dest='signal', action='store_const', const=int(signal.SIGUSR2),
                   help='Send USR2 (%(const)s) to the process before connecting.')
group.add_argument('-s', '--signal', dest='signal', type=parse_signal, metavar="SIGNAL",
                   help='Send the given SIGNAL to the process before connecting.')


class ConnectionHandler(threading.Thread):
    def __init__(self, timeout, sock, read_fd=None, wait_the_end=True):
        super(ConnectionHandler, self).__init__()
        self.sock = sock
        self.read_fd = read_fd
        self.conn_fd = sock.fileno()
        self.timeout = timeout
        self.should_run = True
        self._poller = select.poll()
        self.wait_the_end = wait_the_end

    def run(self):
        if self.read_fd is not None:
            self._poller.register(self.read_fd, select.POLLIN)
        self._poller.register(self.conn_fd, select.POLLIN)

        while self.should_run:
            self.poll()
        if self.wait_the_end:
            t = time.time()
            while time.time() - t < self.timeout:
                self.poll()

    def poll(self):
        milliseconds = self.timeout * 1000
        for fd, _ in self._poller.poll(milliseconds):
            if fd == self.conn_fd:
                data = self.sock.recv(1024*1024)
                sys.stdout.write(data.decode('utf8'))
                sys.stdout.flush()
                readline.redisplay()
            elif fd == self.read_fd:
                data = os.read(self.read_fd, 1024)
                self.sock.sendall(data)
            else:
                raise RuntimeError("Unknown FD %s" % fd)


def main():
    args = parser.parse_args()

    histfile = os.path.join(os.path.expanduser("~"), ".manhole_history")
    try:
        readline.read_history_file(histfile)
    except IOError:
        pass
    import atexit

    atexit.register(readline.write_history_file, histfile)
    del histfile

    if args.signal:
        os.kill(args.pid, args.signal)

    start = time.time()
    uds_path = '/tmp/manhole-%s' % args.pid
    sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
    sock.settimeout(args.timeout)
    while time.time() - start < args.timeout:
        try:
            sock.connect(uds_path)
        except Exception as exc:
            if exc.errno not in (errno.ENOENT, errno.ECONNREFUSED):
                print("Failed to connect to %r: %r" % (uds_path, exc), file=sys.stderr)
        else:
            break
    else:
        print("Failed to connect to %r: Timeout" % uds_path, file=sys.stderr)
        sys.exit(5)

    read_fd, write_fd = os.pipe()

    thread = ConnectionHandler(args.timeout, sock, read_fd, not sys.stdin.isatty())
    thread.start()

    try:
        while thread.is_alive():
            try:
                data = input()
            except EOFError:
                break
            os.write(write_fd, data.encode('utf8'))
            os.write(write_fd, b'\n')
    except KeyboardInterrupt:
        pass
    finally:
        thread.should_run = False
        thread.join()

1	#!/usr/bin/env python
2	from __future__ import print_function	42✔
3
4	import argparse	42✔
5	import errno	42✔
6	import os	42✔
7	import re	42✔
8	import readline	42✔
9	import select	42✔
10	import signal	42✔
11	import socket	42✔
12	import sys	42✔
13	import threading	42✔
14	import time	42✔
15
16	try:	42✔
17	input = raw_input	42✔
18	except NameError:	30 all except TOXENV=2.7-signalfd-gevent-cover-patchthread,report,coveralls,codecov, TOXENV=2.7-eventlet-cover,report,coveralls,codecov, TOXENV=2.7-eventlet-cover-patchthread,report,coveralls,codecov, TOXENV=3.5-eventlet-nocov-patchthread, TOXENV=2.7-signalfd-eventlet-cover,report,coveralls,codecov, TOXENV=2.7-cover,report,coveralls,codecov, TOXENV=2.7-gevent-cover-patchthread,report,coveralls,codecov, TOXENV=2.7-signalfd-eventlet-cover-patchthread,report,coveralls,codecov, TOXENV=2.7-gevent-cover,report,coveralls,codecov, TOXENV=2.7-signalfd-cover,report,coveralls,codecov, TOXENV=2.7-signalfd-gevent-cover,report,coveralls,codecov, TOXENV=pypy-cover,report,coveralls,codecov, TOXENV=pypy-signalfd-cover,report,coveralls,codecov, and TOXENV=pypy-signalfd-nocov ✔
19	pass	30 all except TOXENV=2.7-signalfd-gevent-cover-patchthread,report,coveralls,codecov, TOXENV=2.7-eventlet-cover,report,coveralls,codecov, TOXENV=2.7-eventlet-cover-patchthread,report,coveralls,codecov, TOXENV=3.5-eventlet-nocov-patchthread, TOXENV=2.7-signalfd-eventlet-cover,report,coveralls,codecov, TOXENV=2.7-cover,report,coveralls,codecov, TOXENV=2.7-gevent-cover-patchthread,report,coveralls,codecov, TOXENV=2.7-signalfd-eventlet-cover-patchthread,report,coveralls,codecov, TOXENV=2.7-gevent-cover,report,coveralls,codecov, TOXENV=2.7-signalfd-cover,report,coveralls,codecov, TOXENV=2.7-signalfd-gevent-cover,report,coveralls,codecov, TOXENV=pypy-cover,report,coveralls,codecov, TOXENV=pypy-signalfd-cover,report,coveralls,codecov, and TOXENV=pypy-signalfd-nocov ✔
20
21	SIG_NAMES = {}	42✔
22	SIG_NUMBERS = set()	42✔
23	for sig, num in vars(signal).items():	42✔
24	if sig.startswith('SIG') and '_' not in sig:	42✔
25	SIG_NAMES[sig] = num	42✔
26	SIG_NAMES[sig[3:]] = num	42✔
27	SIG_NUMBERS.add(num)	42✔
28
29
30	def parse_pid(value, regex=re.compile(r'^(/tmp/manhole-)?(?P<pid>\d+)$')):	42✔
31	match = regex.match(value)	42✔
32	if not match:	42!
33	raise argparse.ArgumentTypeError("PID must be in one of these forms: 1234 or /tmp/manhole-1234")	42✔
34
35	return int(match.group('pid'))	×
36
37
38	def parse_signal(value):	42✔
39	try:	42✔
40	value = int(value)	42✔
41	except ValueError:	×
42	pass	×
43	else:
44	if value in SIG_NUMBERS:	42!
45	return value	×
46	else:
47	raise argparse.ArgumentTypeError("Invalid signal number %s. Expected one of: %s" % (	42✔
48	value, ', '.join(str(i) for i in SIG_NUMBERS)
49	))
50	value = value.upper()	×
51	if value in SIG_NAMES:	×
52	return SIG_NAMES[value]	×
53	else:
54	raise argparse.ArgumentTypeError("Invalid signal name %r." % value)	×
55
56
57	parser = argparse.ArgumentParser(description='Connect to a manhole.')	42✔
58	parser.add_argument('pid', metavar='PID', type=parse_pid, # nargs='?',	42✔
59	help='A numerical process id, or a path in the form: /tmp/manhole-1234')
60	parser.add_argument('-t', '--timeout', dest='timeout', default=1, type=float,	42✔
61	help='Timeout to use. Default: %(default)s seconds.')
62	group = parser.add_mutually_exclusive_group()	42✔
63	group.add_argument('-1', '-USR1', dest='signal', action='store_const', const=int(signal.SIGUSR1),	42✔
64	help='Send USR1 (%(const)s) to the process before connecting.')
65	group.add_argument('-2', '-USR2', dest='signal', action='store_const', const=int(signal.SIGUSR2),	42✔
66	help='Send USR2 (%(const)s) to the process before connecting.')
67	group.add_argument('-s', '--signal', dest='signal', type=parse_signal, metavar="SIGNAL",	42✔
68	help='Send the given SIGNAL to the process before connecting.')
69
70
71	class ConnectionHandler(threading.Thread):	42✔
72	def __init__(self, timeout, sock, read_fd=None, wait_the_end=True):	42✔
73	super(ConnectionHandler, self).__init__()	×
74	self.sock = sock	×
75	self.read_fd = read_fd	×
76	self.conn_fd = sock.fileno()	×
77	self.timeout = timeout	×
78	self.should_run = True	×
79	self._poller = select.poll()	×
80	self.wait_the_end = wait_the_end	×
81
82	def run(self):	42✔
83	if self.read_fd is not None:	×
84	self._poller.register(self.read_fd, select.POLLIN)	×
85	self._poller.register(self.conn_fd, select.POLLIN)	×
86
87	while self.should_run:	×
88	self.poll()	×
89	if self.wait_the_end:	×
90	t = time.time()	×
91	while time.time() - t < self.timeout:	×
92	self.poll()	×
93
94	def poll(self):	42✔
95	milliseconds = self.timeout * 1000	×
96	for fd, _ in self._poller.poll(milliseconds):	×
97	if fd == self.conn_fd:	×
98	data = self.sock.recv(1024*1024)	×
99	sys.stdout.write(data.decode('utf8'))	×
100	sys.stdout.flush()	×
101	readline.redisplay()	×
102	elif fd == self.read_fd:	×
103	data = os.read(self.read_fd, 1024)	×
104	self.sock.sendall(data)	×
105	else:
106	raise RuntimeError("Unknown FD %s" % fd)	×
107
108
109	def main():	42✔
110	args = parser.parse_args()	42✔
111
112	histfile = os.path.join(os.path.expanduser("~"), ".manhole_history")	×
113	try:	×
114	readline.read_history_file(histfile)	×
115	except IOError:	×
116	pass	×
117	import atexit	×
118
119	atexit.register(readline.write_history_file, histfile)	×
120	del histfile	×
121
122	if args.signal:	×
123	os.kill(args.pid, args.signal)	×
124
125	start = time.time()	×
126	uds_path = '/tmp/manhole-%s' % args.pid	×
127	sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)	×
128	sock.settimeout(args.timeout)	×
129	while time.time() - start < args.timeout:	×
130	try:	×
131	sock.connect(uds_path)	×
132	except Exception as exc:	×
133	if exc.errno not in (errno.ENOENT, errno.ECONNREFUSED):	×
134	print("Failed to connect to %r: %r" % (uds_path, exc), file=sys.stderr)	×
135	else:
136	break	×
137	else:
138	print("Failed to connect to %r: Timeout" % uds_path, file=sys.stderr)	×
139	sys.exit(5)	×
140
141	read_fd, write_fd = os.pipe()	×
142
143	thread = ConnectionHandler(args.timeout, sock, read_fd, not sys.stdin.isatty())	×
144	thread.start()	×
145
146	try:	×
147	while thread.is_alive():	×
148	try:	×
149	data = input()	×
150	except EOFError:	×
151	break	×
152	os.write(write_fd, data.encode('utf8'))	×
153	os.write(write_fd, b'\n')	×
154	except KeyboardInterrupt:	×
155	pass	×
156	finally:
157	thread.should_run = False	×
158	thread.join()	×

ionelmc / python-manhole / 352

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous