Merge lp:~free.ekanayaka/txlongpoll/fast-rabbit-reset into lp:txlongpoll

[Free Ekanayaka]

This branch adds a few improvements to the test suite:

- Take advantage of testresources.OptimisingTestSuite in order to avoid a wholesale shutdown/restart of the rabbit process at each test and just delete the queues created by the test instead.

- Silence the Twisted logger in FrontEndAjaxTest.test_render_error.

- Remove the workaround of aborting tearDown early without running any asynchronous logic (see the comment in the code).

- Point buildout to bson 0.4.3 since the default (1.1.1) is not compatible
with Python 2.

[lp:~free.ekanayaka/txlongpoll/fast-rabbit-reset]

90. By Free Ekanayaka on 2016-05-24

Add custom test program

91. By Free Ekanayaka on 2016-05-24

Revert spurious changes

[Robert Collins (lifeless)]

The whole custom runner is not needed, is it? Why is it there. Surely a load_tests hook is much cleaner.

review: Needs Fixing

[lp:~free.ekanayaka/txlongpoll/fast-rabbit-reset]

92. By Free Ekanayaka on 2016-05-24

Use load_tests protocol

93. By Free Ekanayaka on 2016-05-24

Fix buildout versions

[Free Ekanayaka (free.ekanayaka)]

> The whole custom runner is not needed, is it? Why is it there. Surely a
> load_tests hook is much cleaner.

Nice, didn't know about it. Fixed as suggested.

[William Grant (wgrant)]

review: Approve (code)

[William Grant (wgrant)]

The new load_tests doesn't seem to work as intended (on at least precise and xenial). If I break at the end and inspect result:

(Pdb) p result
<testresources.OptimisingTestSuite tests=[<unittest2.suite.TestSuite tests=[<unittest2.suite.TestSuite tests=[<txlongpoll.tests.test_client.AMQClosingTest.test_catch_closed [...]

It's an OptimisingTestSuite wrapping a whole lot of normal TestSuites, so the fixture is restarted for each test, and the newly un-neutered tearDown fails.

Overriding loader.suiteClass works, but I wonder if there is a better way.

review: Needs Fixing (code)

[lp:~free.ekanayaka/txlongpoll/fast-rabbit-reset]

94. By Free Ekanayaka on 2016-05-25

Fix testr configuration

[William Grant (wgrant)]

As discussed on IRC, the problem was my old version of testresources. Newer versions of OptimisingTestSuite flatten nested test suites, fixing the problem.

=== modified file '.testr.conf'
--- .testr.conf	2011-11-08 11:30:22 +0000
+++ .testr.conf	2016-05-25 08:37:19 +0000
@@ -1,5 +1,4 @@
 [DEFAULT]
 test_command = bin/testpy -m subunit/run -- discover $LISTOPT $IDOPTION
 test_id_option = --load-list $IDFILE
-# The "ignore" value below works around a bug in subunit.
-test_list_option = --list=ignore
+test_list_option = --list

=== modified file 'README'
--- README	2011-11-08 11:30:22 +0000
+++ README	2016-05-25 08:37:19 +0000
@@ -42,7 +42,7 @@
 will build all the test-related parts of txlongpoll and then do a full
 test run, but
 
- $ make bin/test
+ $ make bin/testpy
 
 will just do the first part.
 

=== modified file 'buildout.cfg'
--- buildout.cfg	2012-03-12 17:07:58 +0000
+++ buildout.cfg	2016-05-25 08:37:19 +0000
@@ -18,6 +18,12 @@
 # Once you have the desired software, reenable this option.
 install-from-cache = true
 
+[versions]
+# Set the version explicitely for bson, since the default would be
+# version 1.1.1 which is not compatible with Python 2.
+# See https://pypi.python.org/pypi/bson/1.1.0
+bson = 0.4.3
+
 [runtime]
 recipe = zc.recipe.egg:scripts
 eggs = txlongpoll

=== modified file 'txlongpoll/testing/client.py'
--- txlongpoll/testing/client.py	2011-09-30 09:56:12 +0000
+++ txlongpoll/testing/client.py	2016-05-25 08:37:19 +0000
@@ -36,12 +36,22 @@
         return self._real_queue_get(timeout)
 
 
+class RabbitServerWithoutReset(RabbitServer):
+
+    def reset(self):
+        """No-op reset.
+
+        Logic to cleanup relevant state is delegated to the test case, which is
+        in charge to delete the queues it created (see AMQTest.tearDown).
+        """
+
+
 class AMQTest(ResourcedTestCase, TestCase):
 
     run_tests_with = AsynchronousDeferredRunTestForBrokenTwisted.make_factory(
         timeout=5)
 
-    resources = [('rabbit', FixtureResource(RabbitServer()))]
+    resources = [('rabbit', FixtureResource(RabbitServerWithoutReset()))]
 
     VHOST = "/"
     USER = "guest"
@@ -65,18 +75,23 @@
             self.factory)
         return self.connected_deferred
 
+    def tearDown(self):
+        # The AsynchronousDeferredRunTest machinery from testools doesn't play
+        # well with an asynchronous tearDown decorated with inlineCallbacks,
+        # because testtools.TestCase._run_teardown attempts to ensure that the
+        # test class upcalls testtools.TestCase.tearDown and raises an error if
+        # it doesn't find it. To workaround that, we move the inlineCallbacks
+        # logic in a separate method, so we can run the superclass tearDown()
+        # before returning.
+        deferred = self._deleteQueuesAndExchanges()
+        super(AMQTest, self).tearDown()
+        return deferred
+
     @inlineCallbacks
-    def tearDown(self):
-        # XXX: Moving this up here to silence a nigh-on inexplicable error
-        # that occurs when it's at the bottom of the function.
+    def _deleteQueuesAndExchanges(self):
+        """Delete any queue or exchange that the test might have created."""
         self.factory.stopTrying()
         self.connector.disconnect()
-        super(AMQTest, self).tearDown()
-
-        # XXX: This is only safe because we tear down the whole server.
-        #      We can't run this after the tearDown above, because the
-        #      fixture is gone.
-        return
 
         self.connected_deferred = Deferred()
         factory = AMQFactory(self.USER, self.PASSWORD, self.VHOST,

=== modified file 'txlongpoll/tests/__init__.py'
--- txlongpoll/tests/__init__.py	2011-06-28 16:21:03 +0000
+++ txlongpoll/tests/__init__.py	2016-05-25 08:37:19 +0000
@@ -1,2 +1,15 @@
 # Copyright 2005-2011 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
+import os
+
+from testresources import OptimisingTestSuite
+
+
+def load_tests(loader, standard_tests, pattern):
+    # top level directory cached on loader instance
+    this_dir = os.path.dirname(__file__)
+    package_tests = loader.discover(start_dir=this_dir, pattern=pattern)
+    result = OptimisingTestSuite()
+    result.addTests(standard_tests)
+    result.addTests(package_tests)
+    return result

=== modified file 'txlongpoll/tests/test_frontend.py'
--- txlongpoll/tests/test_frontend.py	2011-09-30 09:56:12 +0000
+++ txlongpoll/tests/test_frontend.py	2016-05-25 08:37:19 +0000
@@ -6,7 +6,10 @@
 from unittest import defaultTestLoader
 
 from testtools import TestCase
-from testtools.deferredruntest import assert_fails_with
+from testtools.deferredruntest import (
+    assert_fails_with,
+    run_with_log_observers,
+    )
 from twisted.internet import reactor
 from twisted.internet.defer import (
     Deferred,
@@ -374,7 +377,7 @@
         """
         self.message_queue.messages["uuid1"] = ValueError("Not there")
         request = FakeRequest({"uuid": ["uuid1"], "sequence": ["0"]})
-        self.ajax.render(request)
+        run_with_log_observers([], self.ajax.render, request)
         self.assertEquals(request.written.getvalue(), "Not there")
         self.assertEquals(request.code, 500)