Mercurial > hg
annotate tests/dummysmtpd.py @ 29859:a1092e2d70a3
help: internals topic for wire protocol
The Mercurial wire protocol is under-documented. This includes a lack
of source docstrings and comments as well as pages on the official
wiki.
This patch adds the beginnings of "internals" documentation on the
wire protocol.
The documentation should have nearly complete coverage on the
lower-level parts of the protocol, such as the different transport
mechanims, how commands and arguments are sent, capabilities, and,
of course, the commands themselves.
As part of writing this documentation, I discovered a number of
deficiencies in the protocol and bugs in the implementation. I've
started sending patches for some of the issues. I hope to send a lot
more.
This patch starts with the scaffolding for a new internals page.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Mon, 22 Aug 2016 19:46:39 -0700 |
parents | 1b8b6adb2365 |
children | d9d8d78e6bc9 |
rev | line source |
---|---|
29332
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
1 #!/usr/bin/env python |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
2 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
3 """dummy SMTP server for use in tests""" |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
4 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
5 from __future__ import absolute_import |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
6 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
7 import asyncore |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
8 import optparse |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
9 import smtpd |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
10 import ssl |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
11 import sys |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
12 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
13 from mercurial import ( |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
14 cmdutil, |
29556
1b8b6adb2365
tests: use sslutil.wrapserversocket()
Gregory Szorc <gregory.szorc@gmail.com>
parents:
29332
diff
changeset
|
15 sslutil, |
1b8b6adb2365
tests: use sslutil.wrapserversocket()
Gregory Szorc <gregory.szorc@gmail.com>
parents:
29332
diff
changeset
|
16 ui as uimod, |
29332
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
17 ) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
18 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
19 def log(msg): |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
20 sys.stdout.write(msg) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
21 sys.stdout.flush() |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
22 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
23 class dummysmtpserver(smtpd.SMTPServer): |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
24 def __init__(self, localaddr): |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
25 smtpd.SMTPServer.__init__(self, localaddr, remoteaddr=None) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
26 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
27 def process_message(self, peer, mailfrom, rcpttos, data): |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
28 log('%s from=%s to=%s\n' % (peer[0], mailfrom, ', '.join(rcpttos))) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
29 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
30 class dummysmtpsecureserver(dummysmtpserver): |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
31 def __init__(self, localaddr, certfile): |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
32 dummysmtpserver.__init__(self, localaddr) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
33 self._certfile = certfile |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
34 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
35 def handle_accept(self): |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
36 pair = self.accept() |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
37 if not pair: |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
38 return |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
39 conn, addr = pair |
29556
1b8b6adb2365
tests: use sslutil.wrapserversocket()
Gregory Szorc <gregory.szorc@gmail.com>
parents:
29332
diff
changeset
|
40 ui = uimod.ui() |
29332
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
41 try: |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
42 # wrap_socket() would block, but we don't care |
29556
1b8b6adb2365
tests: use sslutil.wrapserversocket()
Gregory Szorc <gregory.szorc@gmail.com>
parents:
29332
diff
changeset
|
43 conn = sslutil.wrapserversocket(conn, ui, certfile=self._certfile) |
29332
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
44 except ssl.SSLError: |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
45 log('%s ssl error\n' % addr[0]) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
46 conn.close() |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
47 return |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
48 smtpd.SMTPChannel(self, conn, addr) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
49 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
50 def run(): |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
51 try: |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
52 asyncore.loop() |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
53 except KeyboardInterrupt: |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
54 pass |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
55 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
56 def main(): |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
57 op = optparse.OptionParser() |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
58 op.add_option('-d', '--daemon', action='store_true') |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
59 op.add_option('--daemon-postexec', action='append') |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
60 op.add_option('-p', '--port', type=int, default=8025) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
61 op.add_option('-a', '--address', default='localhost') |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
62 op.add_option('--pid-file', metavar='FILE') |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
63 op.add_option('--tls', choices=['none', 'smtps'], default='none') |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
64 op.add_option('--certificate', metavar='FILE') |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
65 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
66 opts, args = op.parse_args() |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
67 if opts.tls == 'smtps' and not opts.certificate: |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
68 op.error('--certificate must be specified') |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
69 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
70 addr = (opts.address, opts.port) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
71 def init(): |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
72 if opts.tls == 'none': |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
73 dummysmtpserver(addr) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
74 else: |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
75 dummysmtpsecureserver(addr, opts.certificate) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
76 log('listening at %s:%d\n' % addr) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
77 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
78 cmdutil.service(vars(opts), initfn=init, runfn=run, |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
79 runargs=[sys.executable, __file__] + sys.argv[1:]) |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
80 |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
81 if __name__ == '__main__': |
2bb0ddd8267b
tests: add dummy SMTP daemon for SSL tests
Yuya Nishihara <yuya@tcha.org>
parents:
diff
changeset
|
82 main() |