From dae63cd5bbdee81c33613b1fd972063a449c32bf Mon Sep 17 00:00:00 2001
From: Benjamin Dauvergne <bdauvergne@entrouvert.com>
Date: Wed, 22 Mar 2017 15:18:39 +0100
Subject: [PATCH] tests: make a fixture of EmailsMocking (fixes #15555)

---
 tests/conftest.py              |  8 +++++++-
 tests/test_backoffice_pages.py |  5 ++---
 tests/test_form_pages.py       |  7 +++----
 tests/test_register.py         |  8 ++++----
 tests/test_workflows.py        |  7 +++----
 tests/utilities.py             | 25 +++++++++++++++++--------
 6 files changed, 36 insertions(+), 24 deletions(-)

diff --git a/tests/conftest.py b/tests/conftest.py
index 15cd16d..1441562 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -3,7 +3,7 @@ import ConfigParser
 
 import pytest
 
-from utilities import SMSMocking
+from utilities import SMSMocking, EmailsMocking
 
 def pytest_addoption(parser):
     parser.addoption('--without-postgresql-tests', action='store_true',
@@ -56,3 +56,9 @@ def welco_url(request, pub):
 def sms_mocking():
     with SMSMocking() as sms:
         yield sms
+
+
+@pytest.fixture
+def emails():
+    with EmailsMocking() as mock:
+        yield mock
diff --git a/tests/test_backoffice_pages.py b/tests/test_backoffice_pages.py
index b96d95d..8896471 100644
--- a/tests/test_backoffice_pages.py
+++ b/tests/test_backoffice_pages.py
@@ -32,7 +32,7 @@ from wcs.formdef import FormDef
 from wcs import fields
 
 from utilities import (get_app, login, create_temporary_pub,
-        clean_temporary_pub, emails)
+        clean_temporary_pub)
 
 def pytest_generate_tests(metafunc):
     if 'pub' in metafunc.fixturenames:
@@ -2788,12 +2788,11 @@ def test_360_user_view(pub):
     assert resp.body.count('<li') == (count_li - 2)
 
 
-def test_360_user_view_tracking_code(pub, sms_mocking):
+def test_360_user_view_tracking_code(pub, sms_mocking, emails):
     if not pub.is_using_postgresql():
         pytest.skip('this requires SQL')
         return
 
-    emails.empty()
     user = create_user(pub)
     create_environment(pub)
     app = login(get_app(pub))
diff --git a/tests/test_form_pages.py b/tests/test_form_pages.py
index eb986a7..45ec250 100644
--- a/tests/test_form_pages.py
+++ b/tests/test_form_pages.py
@@ -32,7 +32,7 @@ from wcs.data_sources import NamedDataSource
 from wcs import fields
 from wcs.sessions import BasicSession
 
-from utilities import get_app, login, create_temporary_pub, clean_temporary_pub, emails
+from utilities import get_app, login, create_temporary_pub, clean_temporary_pub
 
 
 def assert_equal_zip(stream1, stream2):
@@ -809,7 +809,7 @@ def test_form_multi_page_post_conditions(pub):
     resp = resp.forms[0].submit('submit')
     assert 'Check values then click submit.' in resp.body
 
-def test_form_submit_with_user(pub):
+def test_form_submit_with_user(pub, emails):
     create_user(pub)
     formdef = create_formdef()
     page = login(get_app(pub), username='foo', password='foo').get('/test/')
@@ -1053,8 +1053,7 @@ def test_form_empty_tracking_code(pub):
     assert resp.location == 'http://example.net/code/%s/load' % tracking_code
     resp = resp.follow(status=404)
 
-def test_form_tracking_code_email(pub):
-    emails.empty()
+def test_form_tracking_code_email(pub, emails):
     formdef = create_formdef()
     formdef.data_class().wipe()
     formdef.fields = [fields.StringField(id='0', label='string')]
diff --git a/tests/test_register.py b/tests/test_register.py
index d7136b6..daaf147 100644
--- a/tests/test_register.py
+++ b/tests/test_register.py
@@ -7,7 +7,7 @@ from quixote import cleanup
 from wcs.qommon.http_request import HTTPRequest
 from wcs.qommon.ident.password_accounts import PasswordAccount
 
-from utilities import get_app, create_temporary_pub, clean_temporary_pub, emails
+from utilities import get_app, create_temporary_pub, clean_temporary_pub
 
 def pytest_generate_tests(metafunc):
     if 'pub' in metafunc.fixturenames:
@@ -117,7 +117,7 @@ def test_user_password_accents(pub):
     account = PasswordAccount.get('foo')
     assert account.password == password
 
-def test_admin_notification(pub):
+def test_admin_notification(pub, emails):
     pub.cfg['identities'] = {'creation': 'self', 'notify-on-register': True}
     pub.write_cfg()
     pub.user_class.wipe()
@@ -134,7 +134,7 @@ def test_admin_notification(pub):
     assert emails.get('New Registration')
     assert emails.get('New Registration').get('email_rcpt') == ['admin@localhost']
 
-def test_user_notification(pub):
+def test_user_notification(pub, emails):
     pub.cfg['identities'] = {'creation': 'self', 'notify-on-register': False,
             'email-as-username': True}
     pub.write_cfg()
@@ -179,7 +179,7 @@ def test_user_login(pub):
     resp = resp.forms[0].submit()
     assert resp.location == 'http://example.net/'
 
-def test_forgotten(pub):
+def test_forgotten(pub, emails):
     pub.cfg['identities'] = {'creation': 'self', 'notify-on-register': False}
     pub.user_class.wipe()
     PasswordAccount.wipe()
diff --git a/tests/test_workflows.py b/tests/test_workflows.py
index e4bb07a..443ed91 100644
--- a/tests/test_workflows.py
+++ b/tests/test_workflows.py
@@ -37,7 +37,7 @@ from wcs.wf.geolocate import GeolocateWorkflowStatusItem
 from wcs.wf.backoffice_fields import SetBackofficeFieldsWorkflowStatusItem
 from wcs.wf.redirect_to_url import RedirectToUrlWorkflowStatusItem
 
-from utilities import (create_temporary_pub, MockSubstitutionVariables, emails,
+from utilities import (create_temporary_pub, MockSubstitutionVariables,
         http_requests, clean_temporary_pub)
 
 def setup_module(module):
@@ -558,7 +558,7 @@ def test_register_comment_attachment(pub):
     assert len(os.listdir(os.path.join(get_publisher().app_dir, 'attachments'))) == 1
     assert url1 == url2
 
-def test_email(pub):
+def test_email(pub, emails):
     pub.substitutions.feed(MockSubstitutionVariables())
 
     formdef = FormDef()
@@ -583,7 +583,6 @@ def test_email(pub):
     role2.emails = ['bar@localhost', 'baz@localhost']
     role2.store()
 
-    emails.empty()
     # send using an uncompleted element
     item = SendmailWorkflowStatusItem()
     item.perform(formdata) # nothing
@@ -1494,7 +1493,7 @@ def test_workflow_display_message_to(pub):
     assert 'd1' in formdata.get_workflow_messages()
     assert 'd2' in formdata.get_workflow_messages()
 
-def test_workflow_roles(pub):
+def test_workflow_roles(pub, emails):
     pub.substitutions.feed(MockSubstitutionVariables())
 
     user = pub.user_class(name='foo')
diff --git a/tests/utilities.py b/tests/utilities.py
index 5b661dd..df04a77 100644
--- a/tests/utilities.py
+++ b/tests/utilities.py
@@ -175,14 +175,8 @@ def login(app, username='admin', password='admin'):
     assert resp.status_int == 302
     return app
 
-class EmailsMocking(object):
-    def __init__(self):
-        self.emails = {}
-        import wcs.qommon.emails
-        import qommon.emails
-        wcs.qommon.emails.create_smtp_server = self.create_smtp_server
-        qommon.emails.create_smtp_server = self.create_smtp_server
 
+class EmailsMocking(object):
     def create_smtp_server(self, *args, **kwargs):
         class MockSmtplibSMTP(object):
             def __init__(self, emails):
@@ -216,7 +210,22 @@ class EmailsMocking(object):
     def count(self):
         return len(self.emails)
 
-emails = EmailsMocking()
+    def __enter__(self):
+        import wcs.qommon.emails
+        import qommon.emails
+        self.wcs_create_smtp_server = wcs.qommon.emails.create_smtp_server
+        self.qommon_create_smtp_server = qommon.emails.create_smtp_server
+
+        wcs.qommon.emails.create_smtp_server = self.create_smtp_server
+        qommon.emails.create_smtp_server = self.create_smtp_server
+
+        self.emails = {}
+        return self
+
+    def __exit__(self, exc_type, exc_value, tb):
+        del self.emails
+        wcs.qommon.emails.create_smtp_server = self.wcs_create_smtp_server
+        qommon.emails.create_smtp_server = self.qommon_create_smtp_server
 
 
 class MockSubstitutionVariables(object):
-- 
2.1.4