Verified Commit e00cf5f1 authored by Kevin Morris's avatar Kevin Morris
Browse files

test: use smtplib.SMTP[_SSL] timeout = notifications.smtp-timeout



A new option has been added for configuration of SMTP timeout:
- notifications.smtp-timeout

During tests, we can change this timeout to be small, so we aren't
depending on hardware-based RNG to pass the timeout.

Without a timeout, users can run into a long-running test for no
particular reason.
Signed-off-by: Kevin Morris's avatarKevin Morris <kevr@0cost.org>
parent 13217be9
...@@ -104,7 +104,10 @@ class Notification: ...@@ -104,7 +104,10 @@ class Notification:
False: smtplib.SMTP, False: smtplib.SMTP,
True: smtplib.SMTP_SSL, True: smtplib.SMTP_SSL,
} }
server = classes[use_ssl](server_addr, server_port) smtp_timeout = aurweb.config.getint("notifications",
"smtp-timeout")
server = classes[use_ssl](server_addr, server_port,
timeout=smtp_timeout)
if use_starttls: if use_starttls:
server.ehlo() server.ehlo()
......
...@@ -36,6 +36,9 @@ class FakeSMTP: ...@@ -36,6 +36,9 @@ class FakeSMTP:
def quit(self) -> None: def quit(self) -> None:
self.quit_count += 1 self.quit_count += 1
def __call__(self, *args, **kwargs) -> "FakeSMTP":
return self
class FakeSMTP_SSL(FakeSMTP): class FakeSMTP_SSL(FakeSMTP):
""" A fake version of smtplib.SMTP_SSL used for testing. """ """ A fake version of smtplib.SMTP_SSL used for testing. """
......
...@@ -65,6 +65,7 @@ smtp-use-ssl = 0 ...@@ -65,6 +65,7 @@ smtp-use-ssl = 0
smtp-use-starttls = 0 smtp-use-starttls = 0
smtp-user = smtp-user =
smtp-password = smtp-password =
smtp-timeout = 60
sender = notify@aur.archlinux.org sender = notify@aur.archlinux.org
reply-to = noreply@aur.archlinux.org reply-to = noreply@aur.archlinux.org
......
...@@ -547,18 +547,18 @@ def test_smtp(user: User): ...@@ -547,18 +547,18 @@ def test_smtp(user: User):
with db.begin(): with db.begin():
user.ResetKey = "12345678901234567890123456789012" user.ResetKey = "12345678901234567890123456789012"
SMTP = FakeSMTP() smtp = FakeSMTP()
get = "aurweb.config.get" get = "aurweb.config.get"
getboolean = "aurweb.config.getboolean" getboolean = "aurweb.config.getboolean"
with mock.patch(get, side_effect=mock_smtp_config(str)): with mock.patch(get, side_effect=mock_smtp_config(str)):
with mock.patch(getboolean, side_effect=mock_smtp_config(bool)): with mock.patch(getboolean, side_effect=mock_smtp_config(bool)):
with mock.patch("smtplib.SMTP", side_effect=lambda a, b: SMTP): with mock.patch("smtplib.SMTP", side_effect=smtp):
config.rehash() config.rehash()
notif = notify.WelcomeNotification(user.ID) notif = notify.WelcomeNotification(user.ID)
notif.send() notif.send()
config.rehash() config.rehash()
assert len(SMTP.emails) == 1 assert len(smtp.emails) == 1
def mock_smtp_starttls_config(cls): def mock_smtp_starttls_config(cls):
...@@ -586,25 +586,25 @@ def test_smtp_starttls(user: User): ...@@ -586,25 +586,25 @@ def test_smtp_starttls(user: User):
user.ResetKey = "12345678901234567890123456789012" user.ResetKey = "12345678901234567890123456789012"
user.BackupEmail = "backup@example.org" user.BackupEmail = "backup@example.org"
SMTP = FakeSMTP() smtp = FakeSMTP()
get = "aurweb.config.get" get = "aurweb.config.get"
getboolean = "aurweb.config.getboolean" getboolean = "aurweb.config.getboolean"
with mock.patch(get, side_effect=mock_smtp_starttls_config(str)): with mock.patch(get, side_effect=mock_smtp_starttls_config(str)):
with mock.patch( with mock.patch(
getboolean, side_effect=mock_smtp_starttls_config(bool)): getboolean, side_effect=mock_smtp_starttls_config(bool)):
with mock.patch("smtplib.SMTP", side_effect=lambda a, b: SMTP): with mock.patch("smtplib.SMTP", side_effect=smtp):
notif = notify.WelcomeNotification(user.ID) notif = notify.WelcomeNotification(user.ID)
notif.send() notif.send()
assert SMTP.starttls_enabled assert smtp.starttls_enabled
assert SMTP.user assert smtp.user
assert SMTP.passwd assert smtp.passwd
assert len(SMTP.emails) == 2 assert len(smtp.emails) == 2
to = SMTP.emails[0][1] to = smtp.emails[0][1]
assert to == [user.Email] assert to == [user.Email]
to = SMTP.emails[1][1] to = smtp.emails[1][1]
assert to == [user.BackupEmail] assert to == [user.BackupEmail]
...@@ -629,19 +629,19 @@ def test_smtp_ssl(user: User): ...@@ -629,19 +629,19 @@ def test_smtp_ssl(user: User):
with db.begin(): with db.begin():
user.ResetKey = "12345678901234567890123456789012" user.ResetKey = "12345678901234567890123456789012"
SMTP = FakeSMTP_SSL() smtp = FakeSMTP_SSL()
get = "aurweb.config.get" get = "aurweb.config.get"
getboolean = "aurweb.config.getboolean" getboolean = "aurweb.config.getboolean"
with mock.patch(get, side_effect=mock_smtp_ssl_config(str)): with mock.patch(get, side_effect=mock_smtp_ssl_config(str)):
with mock.patch(getboolean, side_effect=mock_smtp_ssl_config(bool)): with mock.patch(getboolean, side_effect=mock_smtp_ssl_config(bool)):
with mock.patch("smtplib.SMTP_SSL", side_effect=lambda a, b: SMTP): with mock.patch("smtplib.SMTP_SSL", side_effect=smtp):
notif = notify.WelcomeNotification(user.ID) notif = notify.WelcomeNotification(user.ID)
notif.send() notif.send()
assert len(SMTP.emails) == 1 assert len(smtp.emails) == 1
assert SMTP.use_ssl assert smtp.use_ssl
assert SMTP.user assert smtp.user
assert SMTP.passwd assert smtp.passwd
def test_notification_defaults(): def test_notification_defaults():
...@@ -655,6 +655,7 @@ def test_notification_oserror(user: User, caplog: pytest.LogCaptureFixture): ...@@ -655,6 +655,7 @@ def test_notification_oserror(user: User, caplog: pytest.LogCaptureFixture):
""" Try sending a notification with a bad SMTP configuration. """ """ Try sending a notification with a bad SMTP configuration. """
caplog.set_level(ERROR) caplog.set_level(ERROR)
config_get = config.get config_get = config.get
config_getint = config.getint
mocked_options = { mocked_options = {
"sendmail": str(), "sendmail": str(),
...@@ -662,8 +663,9 @@ def test_notification_oserror(user: User, caplog: pytest.LogCaptureFixture): ...@@ -662,8 +663,9 @@ def test_notification_oserror(user: User, caplog: pytest.LogCaptureFixture):
"smtp-port": "587", "smtp-port": "587",
"smtp-user": "notify@server.xyz", "smtp-user": "notify@server.xyz",
"smtp-password": "notify_server_xyz", "smtp-password": "notify_server_xyz",
"smtp-timeout": 1,
"sender": "notify@server.xyz", "sender": "notify@server.xyz",
"reply-to": "no-reply@server.xyz" "reply-to": "no-reply@server.xyz",
} }
def mock_config_get(section: str, key: str) -> str: def mock_config_get(section: str, key: str) -> str:
...@@ -672,7 +674,14 @@ def test_notification_oserror(user: User, caplog: pytest.LogCaptureFixture): ...@@ -672,7 +674,14 @@ def test_notification_oserror(user: User, caplog: pytest.LogCaptureFixture):
return mocked_options.get(key) return mocked_options.get(key)
return config_get(section, key) return config_get(section, key)
def mock_config_getint(section: str, key: str) -> str:
if section == "notifications":
if key in mocked_options:
return mocked_options.get(key)
return config_getint(section, key)
notif = notify.WelcomeNotification(user.ID) notif = notify.WelcomeNotification(user.ID)
with mock.patch("aurweb.config.getint", side_effect=mock_config_getint):
with mock.patch("aurweb.config.get", side_effect=mock_config_get): with mock.patch("aurweb.config.get", side_effect=mock_config_get):
notif.send() notif.send()
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment