paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-24 00:23:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

test_runner: Fix accumulation of uniquely named test templates.

Browse Source 
N = self.parallel templates are created, and these templates were
previously named 'zulip_test_template_<1, N>'.  However, to support
running multiple instances of `test-backend`, a unique
`random_id_range_start` was created for each template database.

There was no problem prior because the templates would simply be
used again and thus did not require any clean up. Now that there are
unique database names being created, every time `test-backend` is run
these templates can accumulate on disk.  Instead, we clean up our
templates at the end of every complete run of the test suite, or upon a
SIGINT.

Fixes: #12426
This commit is contained in:
Wyatt Hoodes
2019-06-04 15:44:56 +01:00
committed by Tim Abbott
parent d3500867d9
commit ccfcd6b4d8
1 changed files with 23 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
zerver/lib/test_runner.py
View File

@@ -225,13 +225,20 @@ def _replacement_destroy_test_db(self: DatabaseCreation,
% (self.connection.ops.quote_name(test_database_name),))
DatabaseCreation._destroy_test_db = _replacement_destroy_test_db
def destroy_test_databases(worker_id: int) -> None:
"""Modified from the Django original to """
database_id = random_id_range_start + worker_id
def destroy_test_databases(worker_id: Optional[int]=None) -> None:
for alias in connections:
connection = connections[alias]
try:
connection.creation.destroy_test_db(number=database_id)
if worker_id is not None:
"""Modified from the Django original to """
database_id = random_id_range_start + worker_id
connection.creation.destroy_test_db(number=database_id)
else:
# In theory, this code path should be the same as the
# parallel one; but a bug results in that
# double-adding the database_id. So we save that
# double-add by just passing nothing here.
connection.creation.destroy_test_db()
except ProgrammingError:
# DB doesn't exist. No need to do anything.
pass
@@ -403,13 +410,18 @@ class Runner(DiscoverRunner):
return super().setup_test_environment(*args, **kwargs)
def teardown_test_environment(self, *args: Any, **kwargs: Any) -> Any:
# No need to pass the database id now. It will be picked up
# automatically through settings.
if self.parallel == 1:
# In parallel mode (parallel > 1), destroy_test_databases will
# destroy settings.BACKEND_DATABASE_TEMPLATE; we don't want that.
# So run this only in serial mode.
destroy_test_databases(_worker_id)
# The test environment setup clones the zulip_test_template
# database, creating databases with names:
# 'zulip_test_template_<N, N + self.parallel - 1>',
# where N is random_id_range_start.
#
# We need to delete those databases to avoid leaking disk
# (Django is smart and calls this on SIGINT too).
if self.parallel > 1:
for index in range(self.parallel):
destroy_test_databases(index + 1)
else:
destroy_test_databases()
return super().teardown_test_environment(*args, **kwargs)
def test_imports(self, test_labels: List[str], suite: unittest.TestSuite) -> None: