[1.6.x] Final attempt to solve sporadic test failures.

tearDownClass is not called if setUpClass throws an exception, in our case
this means that LiveServerTestCase leaks LiveServerThread sockets if the
test happens to be skipped later on, and AdminSeleniumWebDriverTestCase
doesn't close it's already open browser window. To prevent this leakage
we catch errors where needed and manually call _tearDownClassInternal.
_tearDownClassInternal should be written as defensively as possible since
it is not allowed to make any assumptions on how far setUpClass got.

This patch should fix the sporadic "Address already in use"-errors on jenkins
and also the "This code isn't under transaction management"-error for sqlite
(also just on jenkins).

After discussion with koniiiik, jezdez, kmtracey, tos9, lifeless, nedbat and
voidspace it was decided that this is the safest approach (thanks to everyone
for their comments and help). Manually calling tearDownClass was shut down
cause we don't know how our users override our classes.

This is a private and very specialized API on purpose and should not be used
without a strong reason!

This patch partially reverts the earlier attempts to fix those issues,
namely:
	2fa0dd73b1 and
	3c5775d36f

Final note: If this patch breaks in a later version of Django, please be
very careful on how you fix it, you might not see test failures locally.
That said, this patch hopefully doesn't produce even more failures.

Backport of 73a610d2a8 from master.
This commit is contained in:
Florian Apolloner 2013-09-17 16:28:20 +02:00
parent 5937f291c1
commit 325b03ea84
2 changed files with 10 additions and 3 deletions

View File

@ -26,13 +26,14 @@ class AdminSeleniumWebDriverTestCase(LiveServerTestCase):
except Exception as e: except Exception as e:
raise SkipTest('Selenium webdriver "%s" not installed or not ' raise SkipTest('Selenium webdriver "%s" not installed or not '
'operational: %s' % (cls.webdriver_class, str(e))) 'operational: %s' % (cls.webdriver_class, str(e)))
# This has to be last to ensure that resources are cleaned up properly!
super(AdminSeleniumWebDriverTestCase, cls).setUpClass() super(AdminSeleniumWebDriverTestCase, cls).setUpClass()
@classmethod @classmethod
def tearDownClass(cls): def _tearDownClassInternal(cls):
if hasattr(cls, 'selenium'): if hasattr(cls, 'selenium'):
cls.selenium.quit() cls.selenium.quit()
super(AdminSeleniumWebDriverTestCase, cls).tearDownClass() super(AdminSeleniumWebDriverTestCase, cls)._tearDownClassInternal()
def wait_until(self, callback, timeout=10): def wait_until(self, callback, timeout=10):
""" """

View File

@ -1182,12 +1182,15 @@ class LiveServerTestCase(TransactionTestCase):
# Wait for the live server to be ready # Wait for the live server to be ready
cls.server_thread.is_ready.wait() cls.server_thread.is_ready.wait()
if cls.server_thread.error: if cls.server_thread.error:
# Clean up behind ourselves, since tearDownClass won't get called in
# case of errors.
cls._tearDownClassInternal()
raise cls.server_thread.error raise cls.server_thread.error
super(LiveServerTestCase, cls).setUpClass() super(LiveServerTestCase, cls).setUpClass()
@classmethod @classmethod
def tearDownClass(cls): def _tearDownClassInternal(cls):
# There may not be a 'server_thread' attribute if setUpClass() for some # There may not be a 'server_thread' attribute if setUpClass() for some
# reasons has raised an exception. # reasons has raised an exception.
if hasattr(cls, 'server_thread'): if hasattr(cls, 'server_thread'):
@ -1200,4 +1203,7 @@ class LiveServerTestCase(TransactionTestCase):
and conn.settings_dict['NAME'] == ':memory:'): and conn.settings_dict['NAME'] == ':memory:'):
conn.allow_thread_sharing = False conn.allow_thread_sharing = False
@classmethod
def tearDownClass(cls):
cls._tearDownClassInternal()
super(LiveServerTestCase, cls).tearDownClass() super(LiveServerTestCase, cls).tearDownClass()