June 2014 - tor-commits - lists.torproject.org

[bridgedb/develop] Create TravisCI build matrix for testing dependency versions.
by isis＠torproject.org 06 Jun '14

06 Jun '14

commit 86b02570461415236e7a8dc86335ec0e82ecdb6d Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed May 21 01:54:54 2014 +0000 Create TravisCI build matrix for testing dependency versions. --- .travis.requirements.txt | 9 +++++++++ .travis.yml | 36 ++++++++++++++++++++++++++++-------- 2 files changed, 37 insertions(+), 8 deletions(-) diff --git a/.travis.requirements.txt b/.travis.requirements.txt new file mode 100644 index 0000000..e018631 --- /dev/null +++ b/.travis.requirements.txt @@ -0,0 +1,9 @@ +Babel==0.9.6 +BeautifulSoup==3.2.1 +Mako==0.8.1 +https://ipaddr-py.googlecode.com/files/ipaddr-2.1.10.tar.gz#sha1=c608450b077b19773d4f1b5f1ef88b26f6650ce0#egg=ipaddr-2.1.10-py2.7 +pycrypto==2.6.1 +pygeoip==0.2.7 +pygpgme==0.3 +recaptcha-client==1.0.6 +zope.interface==3.6.1 diff --git a/.travis.yml b/.travis.yml index 7c0429e..1338608 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,11 +4,11 @@ notifications: irc: channels: - "irc.oftc.net#tor-bots" + template: + - "%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}" + - "Build details : %{build_url}" on_success: always on_failure: always - template: - - "%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}" - - "Build details : %{build_url}" email: recipients: - isis(a)torproject.org @@ -16,20 +16,40 @@ notifications: on_success: never on_failure: change +python: + - "2.7" + - "pypy" + addons: hosts: - bridges.torproject.org +env: + global: + - LEEKSPIN_VERSION=0.1.3 + - COVERAGE_VERSION=3.7.1 + - COVERALLS_VERSION=0.4.2 + - SURE_VERSION=1.2.2 + matrix: + - TWISTED_VERSION=13.2.0 PYOPENSSL_VERSION=0.13.1 + +matrix: + include: + - python: "2.7" + env: TWISTED_VERSION=14.0.0 PYOPENSSL_VERSION=0.14 + allow_failures: + - python: "pypy" + fast_finish: true + before_install: - sudo apt-get update -python: - - "2.7" - install: - sudo apt-get install -qq --no-install-suggests --no-install-recommends build-essential openssl sqlite3 libgpgme11 libgpgme11-dev python-dev python-setuptools - - pip install -q -r requirements.txt - - pip install --no-use-wheel leekspin==0.1.3 coverage==3.7.1 coveralls==0.4.2 sure==1.2.2 + - pip install -q -r .travis.requirements.txt + - pip install -q --no-use-wheel leekspin==$LEEKSPIN_VERSION sure==$SURE_VERSION + - pip install -q --no-use-wheel coverage==$COVERAGE_VERSION coveralls==$COVERALLS_VERSION + - pip install -q --no-use-wheel Twisted==$TWISTED_VERSION pyOpenSSL==$PYOPENSSL_VERSION - make install script:

1 0

[bridgedb/develop] Add --quiet options to apt-get and pip during TravisCI builds.
by isis＠torproject.org 06 Jun '14

06 Jun '14

commit 3044c3f266f28ff6f04ab4590ee9d5520040ec17 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed May 21 01:31:19 2014 +0000 Add --quiet options to apt-get and pip during TravisCI builds. --- .travis.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 4e3db1e..7c0429e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -27,8 +27,8 @@ python: - "2.7" install: - - sudo apt-get install --no-install-suggests --no-install-recommends build-essential openssl sqlite3 libgpgme11 libgpgme11-dev python-dev python-setuptools - - pip install -r requirements.txt + - sudo apt-get install -qq --no-install-suggests --no-install-recommends build-essential openssl sqlite3 libgpgme11 libgpgme11-dev python-dev python-setuptools + - pip install -q -r requirements.txt - pip install --no-use-wheel leekspin==0.1.3 coverage==3.7.1 coveralls==0.4.2 sure==1.2.2 - make install

1 0

[bridgedb/develop] Add unittests for MailResponse close(), write(), and writelines() methods.
by isis＠torproject.org 06 Jun '14

06 Jun '14

commit 7e6a652878ba3e7c29751540579ca12f01424a3a Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed May 21 04:12:10 2014 +0000 Add unittests for MailResponse close(), write(), and writelines() methods. --- lib/bridgedb/test/test_email_server.py | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/lib/bridgedb/test/test_email_server.py b/lib/bridgedb/test/test_email_server.py index 01be6a7..7805458 100644 --- a/lib/bridgedb/test/test_email_server.py +++ b/lib/bridgedb/test/test_email_server.py @@ -266,6 +266,32 @@ a ball of timey-wimey, wibbly-warbly... stuff.""" self.assertSubstring("In-Reply-To: NSA", contents) self.assertSubstring("X-been-there: They were so 2004", contents) + def test_MailResponse_close(self): + """Calling MailResponse.close() should close the ``mailfile`` and set + ``closed=True``. + """ + response = server.MailResponse() + self.assertEqual(response.closed, False) + response.close() + self.assertEqual(response.closed, True) + self.assertRaises(ValueError, response.write, self.body) + + def test_MailResponse_write(self): + """Calling MailResponse.write() should write to the mailfile.""" + response = server.MailResponse() + response.write(self.body) + contents = str(response.readContents()).replace('\x00', '') + self.assertEqual(self.body.replace('\n', '\r\n') + '\r\n', contents) + + def test_MailResponse_writelines(self): + """Calling MailResponse.writelines() with a list should write the + concatenated contents of the list into the mailfile. + """ + response = server.MailResponse() + response.writelines(self.body.split('\n')) + contents = str(response.readContents()).replace('\x00', '') + self.assertEqual(self.body.replace('\n', '\r\n') + '\r\n', contents) + class MailMessageTests(unittest.TestCase): """Unittests for :class:`bridgedb.email.server.MailMessage`."""

1 0

[bridgedb/develop] Simplify MailResponse class by not implementing smtp.IMessage.
by isis＠torproject.org 06 Jun '14

06 Jun '14

commit cbbbbf8aefc5061be6f28c4c09104ebc9d18d6a9 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed May 21 04:14:22 2014 +0000 Simplify MailResponse class by not implementing smtp.IMessage. We aren't using it as an SMTP message delivery class anywhere, so there's no need to have the extra methods. * REMOVE bridgedb.email.server.MailResponse.lineReceived() * REMOVE bridgedb.email.server.MailResponse.eomReceived() * REMOVE bridgedb.email.server.MailResponse.connectionLost() * REMOVE zope.interface implementation declaration of twisted.mail.smtp.IMessage by b.e.s.MailResponse. --- lib/bridgedb/email/server.py | 30 ------------------------------ 1 file changed, 30 deletions(-) diff --git a/lib/bridgedb/email/server.py b/lib/bridgedb/email/server.py index 09df526..077bc17 100644 --- a/lib/bridgedb/email/server.py +++ b/lib/bridgedb/email/server.py @@ -286,9 +286,6 @@ class MailResponse(object): :cvar mailfile: An in-memory file for storing the formatted headers and body of the response email. """ - - implements(smtp.IMessage) - _buff = buffer if NEW_BUFFER_INTERFACE else unicode mailfile = io.BytesIO if NEW_BUFFER_INTERFACE else io.StringIO @@ -437,33 +434,6 @@ class MailResponse(object): body, _ = gpgSignMessage(self.gpgContext, body) self.writelines(body) - # The following methods implement the IMessage interface. - - def lineReceived(self, line): - """Called when we receive a line from an underlying transport.""" - self.write(line) - - def eomRecieved(self): - """Called when we receive an EOM. - - :rtype: :api:`twisted.internet.defer.Deferred` - :returns: A ``Deferred`` which has already been callbacked with the - entire response email contents retrieved from - :meth:`readContents`. - """ - contents = self.readContents() - if not self.closed: - self.connectionLost() - return defer.succeed(contents) - - def connectionLost(self): - """Called if we die partway through reading a message. - - Truncate the :cvar:`mailfile` to null length, then close it. - """ - self.mailfile.truncate(0) - self.mailfile.close() - class MailMessage(object): """Plugs into the Twisted Mail and receives an incoming message.

1 0

[bridgedb/develop] Simplify MailResponse by removing extra file I/O methods.
by isis＠torproject.org 06 Jun '14

06 Jun '14

commit cc3b60859dd85083053c989ebd3b1704fe867a75 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed May 21 04:18:02 2014 +0000 Simplify MailResponse by removing extra file I/O methods. The only one we really need is MailResponse.close(), the utility methods (i.e. MailResponse.rewind()) handle other important functionality for us. * REMOVE bridgedb.email.server.MailResponse.flush() * REMOVE bridgedb.email.server.MailResponse.read() * REMOVE bridgedb.email.server.MailResponse.readline() * REMOVE bridgedb.email.server.MailResponse.readlines() * REMOVE bridgedb.email.server.MailResponse.seek() * REMOVE bridgedb.email.server.MailResponse.tell() * REMOVE bridgedb.email.server.MailResponse.truncate() --- lib/bridgedb/email/server.py | 29 +---------------------------- 1 file changed, 1 insertion(+), 28 deletions(-) diff --git a/lib/bridgedb/email/server.py b/lib/bridgedb/email/server.py index 077bc17..079960a 100644 --- a/lib/bridgedb/email/server.py +++ b/lib/bridgedb/email/server.py @@ -315,33 +315,6 @@ class MailResponse(object): self.closed = True close.__doc__ = mailfile.close.__doc__ - def flush(self, *args, **kwargs): self.mailfile.flush(*args, **kwargs) - flush.__doc__ = mailfile.flush.__doc__ - - def read(self, *args, **kwargs): - self.mailfile.read(*args, **kwargs) - read.__doc__ = mailfile.read.__doc__ - - def readline(self, *args, **kwargs): - self.mailfile.readline(*args, **kwargs) - readline.__doc__ = mailfile.readline.__doc__ - - def readlines(self, *args, **kwargs): - self.mailfile.readlines(*args, **kwargs) - readlines.__doc__ = mailfile.readlines.__doc__ - - def seek(self, *args, **kwargs): - self.mailfile.seek(*args, **kwargs) - seek.__doc__ = mailfile.seek.__doc__ - - def tell(self, *args, **kwargs): - self.mailfile.tell(*args, **kwargs) - tell.__doc__ = mailfile.tell.__doc__ - - def truncate(self, *args, **kwargs): - self.mailfile.truncate(*args, **kwargs) - truncate.__doc__ = mailfile.truncate.__doc__ - # The following are custom methods to control reading and writing to the # underlying ``mailfile``. @@ -361,7 +334,7 @@ class MailResponse(object): def rewind(self): """Rewind to the very beginning of the :cvar:`mailfile`.""" - self.seek(0) + self.mailfile.seek(0) def write(self, line): """Any **line** written to me will have ``'\r\n'`` appended to it."""

1 0

[bridgedb/develop] Fix misnamed methods in MailMessage.reply() docstring.
by isis＠torproject.org 06 Jun '14

06 Jun '14

commit 3e34dfdc2c841da487d50ffcb9dd17f546c3f8a3 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed May 21 04:23:42 2014 +0000 Fix misnamed methods in MailMessage.reply() docstring. --- lib/bridgedb/email/server.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/bridgedb/email/server.py b/lib/bridgedb/email/server.py index 43acd99..2684d00 100644 --- a/lib/bridgedb/email/server.py +++ b/lib/bridgedb/email/server.py @@ -545,12 +545,12 @@ class MailMessage(object): def reply(self): """Reply to an incoming email. Maybe. - If no `response` is returned from :func:`createMailResponse`, then the - incoming email will not be responded to at all. This can happen for - several reasons, for example: if the DKIM signature was invalid or - missing, or if the incoming email came from an unacceptable domain, or - if there have been too many emails from this client in the allotted - time period. + If nothing is returned from either :func:`createResponseBody` or + :func:`generateResponse`, then the incoming email will not be + responded to at all. This can happen for several reasons, for example: + if the DKIM signature was invalid or missing, or if the incoming email + came from an unacceptable domain, or if there have been too many + emails from this client in the allotted time period. :rtype: :api:`twisted.internet.defer.Deferred` :returns: A ``Deferred`` which will callback when the response has

1 0

[bridgedb/develop] Fix bug in MailResponse.write() multiline string handling.
by isis＠torproject.org 06 Jun '14

06 Jun '14

commit 212d6dfe9866a9a2d6c60dd6e43e93e6f14908ac Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed May 21 04:20:56 2014 +0000 Fix bug in MailResponse.write() multiline string handling. The bridgedb.email.server.MailResponse.write() method wasn't properly converting '\n' newlines in multiline strings to SMTP-formatted '\r\n' newlines. * FIXES multiline string newline replacement bug in bridgedb.email.server.MailResponse.write() method. --- lib/bridgedb/email/server.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/email/server.py b/lib/bridgedb/email/server.py index 079960a..43acd99 100644 --- a/lib/bridgedb/email/server.py +++ b/lib/bridgedb/email/server.py @@ -338,8 +338,13 @@ class MailResponse(object): def write(self, line): """Any **line** written to me will have ``'\r\n'`` appended to it.""" - self.mailfile.write(self._buff(line + '\r\n')) - self.mailfile.flush() + if line.find('\n') != -1: + # If **line** contains newlines, send it to :meth:`writelines` to + # break it up so that we can replace them with '\r\n': + self.writelines(line) + else: + self.mailfile.write(self._buff(line + '\r\n')) + self.mailfile.flush() def writelines(self, lines): """Calls :meth:`write` for each line in **lines**."""

1 0

[bridgedb/develop] Add 'pragma:' directive to MailMessage.reply() errback function.
by isis＠torproject.org 06 Jun '14

06 Jun '14

commit 8a71b50e9d7e81de011cb5c92d578e6b69e9fa0f Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed May 21 04:25:29 2014 +0000 Add 'pragma:' directive to MailMessage.reply() errback function. We can't really test it, since it's a nested function. However, we shouldn't need to, all it does is log the twisted.python.failure.Failure. --- lib/bridgedb/email/server.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/bridgedb/email/server.py b/lib/bridgedb/email/server.py index 2684d00..dd5b4fb 100644 --- a/lib/bridgedb/email/server.py +++ b/lib/bridgedb/email/server.py @@ -559,7 +559,7 @@ class MailMessage(object): """ logging.info("Got an email; deciding whether to reply.") - def _replyEB(fail): + def _replyEB(fail): # pragma: no cover """Errback for a :api:`twisted.mail.smtp.SMTPSenderFactory`. :param fail: A :api:`twisted.python.failure.Failure` which occurred during

1 0

[bridgedb/develop] Add unittest for MailMessage.getRecipient() which exposes 2.5 bugs.
by isis＠torproject.org 06 Jun '14

06 Jun '14

commit f1b7d03cf1e2dfbb9e11897d0bb07b43f5ad33e5 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed May 21 15:02:17 2014 +0000 Add unittest for MailMessage.getRecipient() which exposes 2.5 bugs. Bug #1: ------- BridgeDB's current code will accept an incoming email with a 'To: givemebridges(a)serious.ly' header. However, BridgeDB's reply will still contain: 'From: bridges(a)torproject.org' Obviously, it *shouldn't* be possible for any email whose SMTP RCPT TO domain is 'serious.ly' to actually end up in BridgeDB's mail queue. Though, if the outside SMTP layer is sent to '[bridges|ponticum].torproject.org' (with MAIL FROM a gmail/yahoo address), these messages still end up in BridgeDB's mail queue. The following netcat session demonstrates that this is possible: ∃!isisⒶwintermute:(master *$=)~ ∴ torsocks nc bridges.torproject.org 25 220 ponticum.torproject.org ESMTP Postfix (Debian/GNU) HELO ponticum.torproject.org 250 ponticum.torproject.org MAIL FROM: isisgrimalkin(a)gmail.com 250 2.1.0 Ok RCPT TO: bridges(a)bridges.torproject.org 250 2.1.5 Ok DATA 354 End data with <CR><LF>.<CR><LF> From: isislovecruft(a)gmail.com To: givemebridgesrightnow(a)serious.ly Subject: mwhahaha get transport obfs3 . 250 2.0.0 Ok: queued as F03972834F QUIT 221 2.0.0 Bye This request resulted in the following debug logs: _______________________________________________________________________________ 15:30:31 DEBUG L690:server.validateFrom() ORIGIN: "'<bridgedb@ponticum>'" 15:30:31 DEBUG L699:server.validateFrom() Got canonical domain: 'ponticum' 15:30:31 DEBUG L495:server.lineReceived() > Received: from ponticum (ponticum [127.0.0.1]) for <bridges@bridgedb>; Wed, 21 May 2014 15:30:31 +0000 15:30:31 DEBUG L495:server.lineReceived() > From isisgrimalkin(a)gmail.com Wed May 21 15:30:31 2014 15:30:31 DEBUG L495:server.lineReceived() > X-Original-To: bridges(a)bridges.torproject.org 15:30:31 DEBUG L495:server.lineReceived() > Delivered-To: bridgedb(a)ponticum.torproject.org 15:30:31 DEBUG L495:server.lineReceived() > Received: from ponticum.torproject.org (kpebetka.net [95.79.25.182]) 15:30:31 DEBUG L495:server.lineReceived() > by ponticum.torproject.org (Postfix) with SMTP id F03972834F 15:30:31 DEBUG L495:server.lineReceived() > for <bridges(a)bridges.torproject.org>; Wed, 21 May 2014 15:29:18 +0000 (UTC) 15:30:31 DEBUG L495:server.lineReceived() > From: isislovecruft(a)gmail.com 15:30:31 DEBUG L495:server.lineReceived() > To: givemebridgesrightnow(a)serious.ly 15:30:31 DEBUG L495:server.lineReceived() > Subject: mwhahaha 15:30:31 DEBUG L495:server.lineReceived() > X-DKIM-Authentication-Results: dunno 15:30:31 DEBUG L495:server.lineReceived() > Date: Wed, 21 May 2014 15:30:31 -0000 15:30:31 DEBUG L495:server.lineReceived() > Message-Id: <1400686231.135135.6548@ponticum> 15:30:31 DEBUG L495:server.lineReceived() > 15:30:31 DEBUG L495:server.lineReceived() > get transport obfs3 15:30:31 DEBUG L495:server.lineReceived() > 15:30:31 INFO L611:server.reply() Got an email; deciding whether to reply. 15:30:31 INFO L646:server.reply() Client requested email translation: en 15:30:31 DEBUG L70:request.determineBridg() Email request was valid. 15:30:31 DEBUG L160:request.withPluggableT() Parsing 'transport' line: 'get transport obfs3' 15:30:31 INFO L169:request.withPluggableT() Email requested transport type: 'obfs3' 15:30:31 DEBUG L81:request.determineBridg() Generating hashring filters for request. 15:30:31 INFO L420:Dist.getBridgesForEmai() Attempting to return for 3 bridges for isislovecruft(a)gmail.com... 15:30:31 DEBUG L445:Dist.getBridgesForEmai() Cache hit frozenset([<function filterBridgesByTransport(obfs3,<class 'ipaddr.IPv4Address'>)>]) 15:30:31 DEBUG L75:Dist.getNumBridgesPerA() Returning 3 bridges from ring of len: 492 15:30:31 DEBUG L1034:Bridges.getBridges() Got duplicate bridge 'edfa2fd66533da52f40424bbe917bd03c8378c2d' in main hashring for position 'eda7f69f7c08bd80861c3afa2921168a007d9ae5'. 15:30:31 DEBUG L1034:Bridges.getBridges() Got duplicate bridge 'ed0b2fd66f398afbf10424bb911790faca9ddb8e' in main hashring for position 'eda7f69f7c08bd80861c3afa2921168a007d9ae5'. 15:30:31 DEBUG L183:server.generateRespons() Email contents: From: bridges(a)torproject.org To: isislovecruft(a)gmail.com Message-ID: <20140521153031.21456.73227139.10726(a)ponticum.torproject.org> In-Reply-To: <1400686231.135135.6548@ponticum> Content-Type: text/plain; charset="utf-8" Date: Wed, 21 May 2014 15:30:31 +0000 Subject: Re: mwhahaha Hey, isislovecruft! [This is an automated message; please do not reply.] Here are your bridges: obfs3 10.1.1.1:1111 d14133856abbba8a65607baebf692162c567bf41 obfs3 10.2.2.2:2222 86f45ab5dcef80a4b1abfcc43579e76f1d0b25a4 obfs3 10.3.3.3:3333 5d55daabd91e041e74f62dcfab1a29c8bb32f0b2 To enter bridges into Tor Browser, follow the instructions on the Tor Browser download page [0] to start Tor Browser. When the 'Tor Network Settings' dialogue pops up, click 'Configure' and follow the wizard until it asks: > Does your Internet Service Provider (ISP) block or otherwise censor connections > to the Tor network? Select 'Yes' and then click 'Next'. To configure your new bridges, copy and paste the bridge lines into the text input box. Finally, click 'Connect', and you should be good to go! If you experience trouble, try clicking the 'Help' button in the 'Tor Network Settings' wizard for further assistance. [0]: https://www.torproject.org/projects/torbrowser.html.en#downloads-beta COMMANDs: (combine COMMANDs to specify multiple options simultaneously) get bridges Request vanilla bridges. get transport [TYPE] Request a Pluggable Transport by TYPE. get help Displays this message. get key Get a copy of BridgeDB's public GnuPG key. get ipv6 Request IPv6 bridges. Currently supported transport TYPEs: obfs2 obfs3 scramblesuit -- <3 BridgeDB ---------------------------------------------------------------------- Public Keys: https://bridges.torproject.org/keys This email was generated with rainbows, unicorns, and sparkles for isislovecruft(a)gmail.com on Wednesday, 21 May, 2014 at 15:30:31. 15:30:31 INFO L655:server.reply() Sending reply to isislovecruft(a)gmail.com _______________________________________________________________________________ Which obviously brings us to the other bug. Bug #2: ------- BridgeDB will accept an email from an arbitrary gmail/yahoo email address at the SMTP layer, and then send the reply to a *different* arbitrary gmail/yahoo email address taken from the contents of the email headers. As you can see in the example above, the SMTP command 'MAIL FROM: isisgrimalkin(a)gmail.com' combined with a 'From: isislovecruft(a)gmail.com' in the email headers within the SMTP DATA segment caused the reply to be sent the reply to the later, when it came from the former. The person reading the response from BridgeDB also has no way to know who originally emailed BridgeDB to cause this email to end up in her inbox. I'm not exactly certain if this is a bug or a feature. While it could be used for sending some junk to an arbitrary gmail/yahoo address, it could also be used as a sort of "Dear BridgeDB, can I have some bridges? Asking for a friend." mechanism. Bug #2.5: --------- Also, "dunno" certainly isn't a valid DKIM signature. --- lib/bridgedb/test/test_email_server.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lib/bridgedb/test/test_email_server.py b/lib/bridgedb/test/test_email_server.py index d7f2922..32c40ac 100644 --- a/lib/bridgedb/test/test_email_server.py +++ b/lib/bridgedb/test/test_email_server.py @@ -323,6 +323,17 @@ class MailMessageTests(unittest.TestCase): recipient = self.message.getRecipient(incoming) self.assertEqual(recipient, self.context.fromAddr) + def test_MailMessage_getRecipient_givemebridges_at_seriously(self): + """MailMessage.getRecipient() for an incoming email sent to any email + address other than the one we're listening for should return our + configured address, not the one in the incoming email. + """ + self._getIncomingLines() + self.message.lines[1] = 'To: givemebridges(a)serious.ly' + incoming = self.message.getIncomingMessage() + recipient = self.message.getRecipient(incoming) + self.assertEqual(recipient, self.context.fromAddr) + def test_MailMessage_getRecipient_bad_address(self): """MailMessage.getRecipient() for an incoming email sent to a malformed email address should log an smtp.AddressError and then return our

1 0

[bridgedb/develop] Cleanup b.e.server.MailDelivery unittests.
by isis＠torproject.org 06 Jun '14

06 Jun '14

commit ec15fd9506548c06869c4d65f22ba0550545da6b Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu May 29 18:17:24 2014 +0000 Cleanup b.e.server.MailDelivery unittests. --- lib/bridgedb/test/test_email_server.py | 148 +++++++++++++++++++++++++------- 1 file changed, 118 insertions(+), 30 deletions(-) diff --git a/lib/bridgedb/test/test_email_server.py b/lib/bridgedb/test/test_email_server.py index 32c40ac..7015339 100644 --- a/lib/bridgedb/test/test_email_server.py +++ b/lib/bridgedb/test/test_email_server.py @@ -32,6 +32,10 @@ from bridgedb.test.util import TestCaseMixin from twisted.python import log from twisted.internet import defer from twisted.internet import reactor +from twisted.mail.smtp import SMTPBadRcpt +from twisted.mail.smtp import SMTPBadSender +from twisted.mail.smtp import User +from twisted.mail.smtp import Address from twisted.test import proto_helpers from twisted.trial import unittest @@ -417,68 +421,152 @@ class MailMessageTests(unittest.TestCase): return ret -class MailDeliveryTest(unittest.TestCase): +class MailDeliveryTests(unittest.TestCase): """Unittests for :class:`email.server.MailDelivery`.""" def setUp(self): + """Set up our :class:`server.MailDelivery` instance, and reset the + following ``TestCase`` attributes to ``None``: + - ``helo`` + - ``proto`` + - ``origin`` + - ``user`` + """ self.config = _createConfig() self.context = _createMailContext(self.config) self.delivery = server.MailDelivery() - self.helo = ('fubar.example.com', '127.0.0.1') - self.origin = server.smtp.Address('user(a)example.com') - self.users = [server.smtp.User('bridges', self.helo, None, self.origin),] - def tets_MailDelivery(self): + self.helo = None + self.proto = None + self.origin = None + self.user = None + + def tearDown(self): + """Reset all TestCase instance attributes between each test run.""" + self.helo = None + self.proto = None + self.origin = None + self.user = None + + def _createProtocolWithHost(self, host): + """Mock a Protocol which has a ``host`` attribute. + + We don't currently use any of the ``IProtocol`` methods of the + returned ``twisted.test.proto_helpers.AccumulatingProtocol``, and so + this could be any class, although a mocked ``IProtocol`` implementer + was chosen for completeness and realism's sakes. + + :param str host: A domain name or IP address. + :rtype: :api:`twisted.test.proto_helpers.AccumulatingProtocol` + :returns: A Protocol instance which has its ``host`` attribute set to + the given **host**, so that an :api:`twisted.mail.smtp.User` can + be constructed with it. + """ + self.proto = proto_helpers.AccumulatingProtocol() + self.proto.host = host + + def _createUser(self, username, domain, ipaddress): + """Create a ``twisted.mail.smtp.User`` for testing. + + :param str username: The local part of the client's email address. + :param str domain: The host part of the client's email address. + :param str ipaddress: The IP address of the client's mail server. + """ + self.helo = (domain, ipaddress) + self._createProtocolWithHost(domain) + self.origin = Address('@'.join((username, domain,))) + self.user = User(username, self.helo, self.proto, self.origin) + + def _setUpMAILFROM(self): + """Set up the parameters for emulating a connected client sending a + SMTP 'MAIL FROM:' command to us. + + The default is to emulate sending: ``MAIL FROM: client(a)example.com``. + """ + self.helo = ('localhost', '127.0.0.1') + self.origin = server.smtp.Address('client(a)example.com') + self.delivery.setBridgeDBContext(self.context) + + def _setUpRCPTTO(self, username=None): + """Set up the parameters for emulating a connected client sending a + SMTP 'RCPT TO:' command to us. + + The default is to emulate sending: ``RCPT TO: bridges@localhost``. + """ + name = username if username is not None else self.config.EMAIL_USERNAME + self._createUser(name, 'localhost', '127.0.0.1') + self.delivery.setBridgeDBContext(self.context) + + def test_MailDelivery_init(self): + """After calling :meth:`server.MailDelivery.__init__`, we should have a + :class:`server.MailDelivery` object instance. + """ self.assertIsInstance(self.delivery, server.MailDelivery) def test_MailDelivery_setBridgeDBContext(self): + """Calling :meth:`server.MailDelivery.setBridgeDBContext` should set + the :ivar:`MailDelivery.context` attribute. + + The ``MailDelivery.context`` should be a :class:`server.MailContext`, + and it should have relevant settings from the config file stored + within it. + """ self.delivery.setBridgeDBContext(self.context) + self.assertIsInstance(self.delivery.context, server.MailContext) + self.assertEqual(self.delivery.context.smtpFromAddr, + self.config.EMAIL_SMTP_FROM_ADDR) def test_MailDelivery_receivedHeader(self): - self.delivery.setBridgeDBContext(self.context) - hdr = self.delivery.receivedHeader(self.helo, self.origin, self.users) - self.assertTrue(hdr) - self.assertSubstring("Received: from fubar.example.com", hdr) + """The email resulting from a MailDelivery, the latter received from + ``'client(a)example.com'`` should contain a header stating: + ``'Received: from example.com'``. + """ + self._createUser('client', 'example.com', '127.0.0.1') + hdr = self.delivery.receivedHeader(self.helo, self.origin, [self.user,]) + self.assertSubstring("Received: from example.com", hdr) def test_MailDelivery_validateFrom(self): """A valid origin should be stored as ``MailDelivery.fromCanonical``.""" - self.delivery.setBridgeDBContext(self.context) + self._setUpMAILFROM() self.delivery.validateFrom(self.helo, self.origin) self.assertEqual(self.delivery.fromCanonical, 'example.com') def test_MailDelivery_validateFrom_unsupportedDomain(self): """A domain not in our canon should raise a SMTPBadSender.""" - self.delivery.setBridgeDBContext(self.context) - helo = ('yo.mama', '0.0.0.0') + self._setUpMAILFROM() origin = server.smtp.Address('throwing.pickles(a)yo.mama') - self.assertRaises(server.smtp.SMTPBadSender, - self.delivery.validateFrom, helo, origin) + self.assertRaises(SMTPBadSender, + self.delivery.validateFrom, self.helo, origin) - def test_MailDelivery_validateFrom_badOriginType(self): - """A non t.m.smtp.Address origin should raise cause an Exception.""" - self.delivery.setBridgeDBContext(self.context) - helo = ('yo.mama', '0.0.0.0') + def test_MailDelivery_validateFrom_origin_notAdressType(self): + """A non ``twisted.mail.smtp.Address`` origin should raise an + AttributeError exception. + """ + self._setUpMAILFROM() origin = 'throwing.pickles(a)yo.mama' - self.delivery.validateFrom(helo, origin) + self.delivery.validateFrom(self.helo, origin) def test_MailDelivery_validateTo(self): """Should return a callable that results in a MailMessage.""" - self.delivery.setBridgeDBContext(self.context) - ret = self.delivery.validateTo(self.users[0]) - self.assertIsInstance(ret, types.FunctionType) + self._setUpRCPTTO() + validated = self.delivery.validateTo(self.user) + self.assertIsInstance(validated, types.FunctionType) + self.assertIsInstance(validated(), server.MailMessage) def test_MailDelivery_validateTo_plusAddress(self): """Should return a callable that results in a MailMessage.""" - self.delivery.setBridgeDBContext(self.context) - user = server.smtp.User('bridges+ar', self.helo, None, self.origin) - ret = self.delivery.validateTo(user) - self.assertIsInstance(ret, types.FunctionType) + self._setUpRCPTTO('bridges+ar') + validated = self.delivery.validateTo(self.user) + self.assertIsInstance(validated, types.FunctionType) + self.assertIsInstance(validated(), server.MailMessage) def test_MailDelivery_validateTo_badUsername(self): - self.delivery.setBridgeDBContext(self.context) - user = server.smtp.User('yo.mama', self.helo, None, self.origin) - self.assertRaises(server.smtp.SMTPBadRcpt, - self.delivery.validateTo, user) + """A :class:`server.MailDelivery` which sends a SMTP + ``RCPT TO: yo.mama@localhost`` should raise a + ``twisted.mail.smtp.SMTPBadRcpt`` exception. + """ + self._setUpRCPTTO('yo.mama') + self.assertRaises(SMTPBadRcpt, self.delivery.validateTo, self.user) class SMTPTestCaseMixin(TestCaseMixin):

1 0