Expose email send as an assistant and provide its fake in the test suite.

albu-diku · albu-diku · commit 7b0193b1364f · 2026-02-20T16:50:59.000+01:00
Use the runtime configuration concept to expose the sending of email to
logic codepaths. This avoids adding an argument at multiple levels of the
call stack of logic code purely to override email sending.

As a result, we are able to centrally intercept email sending. Do this,
and as a consequence sprinkle a bunch of additional assertions into calls
that happen to send email but this side-effect was completely uncovered.

Add a means for tests to check the the number of emails sent and whether
an email was sent to a particular recipient. For cases where the email
sent is not relevant to what is being tested, there is an escape hatch.
diff --git a/mig/server/grid_notify.py b/mig/server/grid_notify.py
@@ -130,12 +130,10 @@ def send_notifications(configuration):
         notify_message = "Found %s new events since: %s\n\n" \
             % (total_events, timestr) \
             + notify_message
-        status = send_email(
+        status = configuration.send_email(
             recipient,
             subject,
-            notify_message,
-            logger,
-            configuration)
+            notify_message)
         if status:
             logger.info("Send email with %s events to: %s"
                         % (total_events, recipient))
diff --git a/mig/shared/conf.py b/mig/shared/conf.py
@@ -37,6 +37,20 @@
 from mig.shared.fileio import unpickle
 
 
+_RUNTIME_ASSISTANTS = {
+    'send_email': None,
+}
+
+
+def default_runtime_assistants():
+    runtime_services = dict(_RUNTIME_ASSISTANTS)
+
+    from mig.shared.notification import send_email
+    runtime_services['send_email'] = send_email
+
+    return runtime_services
+
+
 class RuntimeConfiguration:
     """A proxy object to be passed in-place of a Configuration which can be
     extended with information relevant only at runtime.
@@ -52,8 +66,9 @@ class RuntimeConfiguration:
     to callers without being mixed in with the statuc data.
     """
 
-    def __init__(self, configuration):
+    def __init__(self, configuration, assistants):
         object.__setattr__(self, '_configuration', configuration)
+        object.__setattr__(self, '_assistants', assistants)
 
     def __delattr__(self, attr):
         return setattr(self._configuration, attr)
@@ -64,9 +79,32 @@ def __getattr__(self, attr):
     def __setattr__(self, attr, value):
         return setattr(self._configuration, attr, value)
 
+    def get_assistant(self, assistant_name):
+        return self._assistants[assistant_name]
+
+    def send_email(self, *args, **kwargs):
+        send_email = self._assistants['send_email']
+        return send_email(self, *args, **kwargs)
 
-def get_configuration_object(config_file=None, skip_log=False,
-                             disable_auth_log=False):
+    @classmethod
+    def create(cls, configuration, assistants):
+        supplied_assistants = set(assistants.keys())
+        expected_assistants = set(_RUNTIME_ASSISTANTS.keys())
+
+        missing_assistants = expected_assistants - supplied_assistants
+        if missing_assistants:
+            raise RuntimeError('missing runtime assistants: %s'
+                                    % (missing_assistants,))
+
+        return cls(configuration, assistants)
+
+    @staticmethod
+    def default_assistants():
+        return default_runtime_assistants()
+
+
+def get_configuration_object(config_file=None,
+                             skip_log=False, disable_auth_log=False, raw=False):
     """Simple helper to call the general configuration init. Optional skip_log
     and disable_auth_log arguments are passed on to allow skipping the default
     log initialization and disabling auth log for unit tests.
@@ -93,7 +131,12 @@ def get_configuration_object(config_file=None, skip_log=False,
 
     configuration = Configuration(_config_file, False, skip_log,
                                   disable_auth_log)
-    return RuntimeConfiguration(configuration)
+
+    if raw:
+        return configuration
+
+    assistants = RuntimeConfiguration.default_assistants()
+    return RuntimeConfiguration(configuration, assistants)
 
 
 def get_resource_configuration(resource_home, unique_resource_name,
diff --git a/mig/shared/configuration.py b/mig/shared/configuration.py
@@ -2921,6 +2921,10 @@ def parse_peers(self, peerfile):
                     peerfile)
         return peers_dict
 
+    @classmethod
+    def create(cls, *args, **kwargs):
+        return cls(*args, **kwargs)
+
     @staticmethod
     def is_configuration_like(obj):
         """Does the given object quack like a MiG Configuration."""
diff --git a/mig/shared/functionality/autocreate.py b/mig/shared/functionality/autocreate.py
@@ -740,8 +740,7 @@ def main(client_id, user_arguments_dict, environ=None):
         logger.info('Send email: to: %s, header: %s, smtp_server: %s'
                     % (email, email_header, smtp_server))
         logger.debug('email body:  %s' % email_msg)
-        if not send_email(email, email_header, email_msg, logger,
-                          configuration):
+        if not configuration.send_email(email, email_header, email_msg):
             output_objects.append({
                 'object_type': 'error_text', 'text': """An error occurred trying
 to send your account welcome email. Please contact support (%s) and include the
diff --git a/mig/shared/functionality/extcertaction.py b/mig/shared/functionality/extcertaction.py
@@ -316,8 +316,7 @@ def main(client_id, user_arguments_dict):
 
     logger.info('Sending email: to: %s, header: %s, msg: %s, smtp_server: %s'
                 % (admin_email, email_header, email_msg, smtp_server))
-    if not send_email(admin_email, email_header, email_msg, logger,
-                      configuration):
+    if not configuration.send_email(admin_email, email_header, email_msg):
         output_objects.append({'object_type': 'error_text', 'text':
                                """An error occurred trying to inform the site
 admins about your request for existing certificate sign up. Please contact %s site
diff --git a/mig/shared/functionality/extoidaction.py b/mig/shared/functionality/extoidaction.py
@@ -282,8 +282,7 @@ def main(client_id, user_arguments_dict):
 
     logger.info('Sending email: to: %s, header: %s, msg: %s, smtp_server: %s'
                 % (admin_email, email_header, email_msg, smtp_server))
-    if not send_email(admin_email, email_header, email_msg, logger,
-                      configuration):
+    if not configuration.send_email(admin_email, email_header, email_msg):
         output_objects.append({'object_type': 'error_text', 'text':
                                """An error occurred trying to inform the site
 admins about your request for OpenID account access. Please contact %s site
diff --git a/mig/shared/functionality/peersaction.py b/mig/shared/functionality/peersaction.py
@@ -309,8 +309,7 @@ def main(client_id, user_arguments_dict):
                     logger.info('Sending invitation: to: %s, header: %s, msg: %s, smtp_server: %s'
                                 % (peer_email, email_header, email_msg,
                                    smtp_server))
-                    if send_email(peer_email, email_header, email_msg, logger,
-                                  configuration):
+                    if configuration.send_email(peer_email, email_header, email_msg):
                         succeeded.append(peer_email)
                     else:
                         failed.append(peer_email)
@@ -369,8 +368,7 @@ def main(client_id, user_arguments_dict):
 
     logger.info('Sending email: to: %s, header: %s, msg: %s, smtp_server: %s'
                 % (admin_email, email_header, email_msg, smtp_server))
-    if not send_email(admin_email, email_header, email_msg, logger,
-                      configuration):
+    if not configuration.send_email(admin_email, email_header, email_msg):
         output_objects.append({'object_type': 'error_text', 'text': '''
 An error occurred trying to send the email about your %s peers to the site
 administrators. Please contact %s site support at %s or manually inform the
diff --git a/mig/shared/functionality/reqcertaction.py b/mig/shared/functionality/reqcertaction.py
@@ -346,8 +346,7 @@ def main(client_id, user_arguments_dict):
 
     logger.info('Sending email: to: %s, header: %s, msg: %s, smtp_server: %s'
                 % (admin_email, email_header, email_msg, smtp_server))
-    if not send_email(admin_email, email_header, email_msg, logger,
-                      configuration):
+    if not configuration.send_email(admin_email, email_header, email_msg):
         output_objects.append({'object_type': 'error_text', 'text':
                                """An error occurred trying to inform the site
 admins about your request for certificate sign up. Please contact %s site
diff --git a/mig/shared/functionality/reqoidaction.py b/mig/shared/functionality/reqoidaction.py
@@ -357,8 +357,7 @@ def main(client_id, user_arguments_dict):
 
     logger.info('Sending email: to: %s, header: %s, msg: %s, smtp_server: %s'
                 % (admin_email, email_header, email_msg, smtp_server))
-    if not send_email(admin_email, email_header, email_msg, logger,
-                      configuration):
+    if not configuration.send_email(admin_email, email_header, email_msg):
         output_objects.append({'object_type': 'error_text', 'text':
                                """An error occurred trying to inform the site
 admins about your request for OpenID account access. Please contact %s site
diff --git a/mig/shared/functionality/reqpwresetaction.py b/mig/shared/functionality/reqpwresetaction.py
@@ -271,8 +271,7 @@ def main(client_id, user_arguments_dict):
 
         logger.info('Sending email: to: %s, header: %s, msg: %s, smtp_server: %s'
                     % (email_to, email_header, email_msg, smtp_server))
-        if not send_email(email_to, email_header, email_msg, logger,
-                          configuration):
+        if not configuration.send_email(email_to, email_header, email_msg):
             output_objects.append({'object_type': 'error_text', 'text':
                                    """An error occurred trying to send the email
 for an account %s password reset request. Please contact %s site support at %s
diff --git a/mig/shared/gdp/base.py b/mig/shared/gdp/base.py
@@ -682,12 +682,10 @@ def __send_project_action_confirmation(configuration,
 
 Attached you'll find the details registered in relation to the operation.
         """ % mail_fill
-        status = send_email(
+        status = configuration.send_email(
             recipients,
             subject,
             message,
-            _logger,
-            configuration,
             files=[pdf_filepath],
         )
         if status:
diff --git a/mig/shared/notification.py b/mig/shared/notification.py
@@ -561,11 +561,10 @@ def send_instant_message(
 
 
 def send_email(
+    configuration,
     recipients,
     subject,
     message,
-    logger,
-    configuration,
     files=[],
     custom_sender=None
 ):
@@ -589,13 +588,14 @@ def send_email(
     """
 
     _logger = configuration.logger
+
     gpg_sign = False
     if configuration.site_gpg_passphrase is not None:
         if gnupg is None:
-            logger.warning("the gnupg module is required for gpg signing")
+            _logger.warning("the gnupg module is required for gpg signing")
         else:
             gpg_sign = True
-            logger.debug("enabling automatic gpg signing of email")
+            _logger.debug("enabling automatic gpg signing of email")
 
     if recipients.find(', ') > -1:
         recipients_list = recipients.split(', ')
@@ -631,7 +631,7 @@ def send_email(
         basemsg = MIMEText(force_utf8(message), "plain", "utf8")
         mime_msg.attach(basemsg)
         if gpg_sign:
-            logger.info("signing message with gpg")
+            _logger.info("signing message with gpg")
             gpg = gnupg.GPG()
             basetext = basemsg.as_string().replace('\n', '\r\n')
             signature = gpg.sign(basetext, detach=True,
@@ -643,7 +643,7 @@ def send_email(
                 msg_sig.set_payload("%s" % signature)
                 mime_msg.attach(msg_sig)
             else:
-                logger.warning("failed to create gnupg signature")
+                _logger.warning("failed to create gnupg signature")
 
         for name in files:
             part = MIMEBase('application', "octet-stream")
@@ -652,7 +652,7 @@ def send_email(
             part.add_header('Content-Disposition',
                             'attachment', filename=os.path.basename(name))
             mime_msg.attach(part)
-        logger.debug('sending email from %s to %s:\n%s' %
+        _logger.debug('sending email from %s to %s:\n%s' %
                      (from_email, recipients, mime_msg.as_string()))
         server = smtplib.SMTP(configuration.smtp_server)
         server.set_debuglevel(0)
@@ -664,10 +664,10 @@ def send_email(
                             % errors)
             return False
         else:
-            logger.debug('Email was sent to %s' % recipients)
+            _logger.debug('Email was sent to %s' % recipients)
             return True
     except Exception as err:
-        logger.error('Sending email to %s through %s failed!: %s'
+        _logger.error('Sending email to %s through %s failed!: %s'
                      % (recipients, configuration.smtp_server, err))
         return False
 
@@ -819,8 +819,8 @@ def notify_user(
 
                     continue
 
-                if send_email(single_dest, header, message, logger,
-                              configuration, custom_sender=email_sender):
+                if configuration.send_email(single_dest, header, message,
+                              custom_sender=email_sender):
                     logger.info('email sent to %s telling that %s %s'
                                 % (single_dest, jobid, status))
                 else:
@@ -906,7 +906,7 @@ def send_resource_create_request_mail(
         os.path.basename(pending_file),
     )
 
-    status = send_email(recipients, subject, txt, logger, configuration)
+    status = configuration.send_email(recipients, subject, txt)
     if status:
         msg += '\nEmail was sent to admins'
     else:
diff --git a/tests/support/__init__.py b/tests/support/__init__.py
@@ -45,6 +45,7 @@
 from tests.support.fixturesupp import _PreparedFixture
 from tests.support.suppconst import MIG_BASE, TEST_BASE, \
     TEST_DATA_DIR, TEST_OUTPUT_DIR, ENVHELP_OUTPUT_DIR
+from tests.support.fakes import make_fake_assistants
 
 from tests.support._env import MIG_ENV, PY2
 
@@ -223,8 +224,11 @@ def _make_configuration_instance(testcase, configuration_to_make):
         if configuration_to_make == 'fakeconfig':
             return FakeConfiguration(logger=testcase.logger)
         elif configuration_to_make == 'testconfig':
-            from mig.shared.conf import get_configuration_object
-            return get_configuration_object(skip_log=True, disable_auth_log=True)
+            from mig.shared.conf import get_configuration_object, RuntimeConfiguration
+            configuration = get_configuration_object(skip_log=True, disable_auth_log=True, raw=True)
+
+            assistants = make_fake_assistants()
+            return RuntimeConfiguration.create(configuration, assistants)
         else:
             raise AssertionError(
                 "MigTestCase: unknown configuration %r" % (configuration_to_make,))
diff --git a/tests/support/fakes.py b/tests/support/fakes.py
@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+#
+# --- BEGIN_HEADER ---
+#
+# __init__ - package marker and core package functions
+# Copyright (C) 2003-2026  The MiG Project by the Science HPC Center at UCPH
+#
+# This file is part of MiG.
+#
+# MiG is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# MiG is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# -- END_HEADER ---
+#
+
+"""Fake implementations of various assistant functionality used by MiG logic."""
+
+class FakeSendEmail:
+    def __init__(self):
+        self.calls = []
+        self._checked = False
+
+    def __call__(self, _, *args, **kwargs):
+        # Record any arguments upon a call to send email (discarding the
+        # leading configuration argument)
+        self.calls.append((args, kwargs))
+        return True
+
+    def _recipients(self):
+        recipients = set()
+        for args, kwargs in self.calls:
+            email_address = args[0]
+            recipients.add(email_address)
+        return recipients
+
+    def check_empty_and_reset(self):
+        if self._checked:
+            # nothing to do
+            return
+
+        has_calls = len(self.calls) > 0
+        if has_calls:
+            suprise_recipients = []
+            for args, kwargs in self.calls:
+                email_address = args[0]
+                suprise_recipients.append(email_address)
+            raise AssertionError('detected email sending without expectation: \n  %s'
+                                    % ('\n  '.join(suprise_recipients),))
+
+    def forgive_email(self):
+        self._checked = True
+
+    @property
+    def called_once(self):
+        self._checked = True
+        return len(self.calls) == 1
+
+    def email_was_sent_to(self, email_address):
+        recipients = self._recipients()
+        return email_address in recipients
+
+
+def make_fake_send_email(mig_test_case=None):
+    fake_send_email = FakeSendEmail()
+
+    if mig_test_case:
+        mig_test_case._register_check(fake_send_email.check_empty_and_reset)
+
+    return fake_send_email
+
+
+def make_fake_assistants(mig_test_case=None):
+    return {
+        'send_email': make_fake_send_email(mig_test_case=mig_test_case),
+    }
diff --git a/tests/test_mig_lib_janitor.py b/tests/test_mig_lib_janitor.py
diff --git a/tests/test_mig_shared_accountreq.py b/tests/test_mig_shared_accountreq.py
