Rework email sending as a reference placed in a context.

albu-diku · albu-diku · commit 497886e927bb · 2026-03-04T16:06:19.000+01:00
diff --git a/mig/server/grid_notify.py b/mig/server/grid_notify.py
@@ -130,7 +130,7 @@ def send_notifications(configuration):
         notify_message = "Found %s new events since: %s\n\n" \
             % (total_events, timestr) \
             + notify_message
-        status = configuration.send_email(
+        status = send_email(configuration,
             recipient,
             subject,
             notify_message)
diff --git a/mig/shared/conf.py b/mig/shared/conf.py
@@ -37,20 +37,6 @@
 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.
@@ -66,9 +52,9 @@ class RuntimeConfiguration:
     to callers without being mixed in with the statuc data.
     """
 
-    def __init__(self, configuration, assistants):
+    def __init__(self, configuration):
         object.__setattr__(self, '_configuration', configuration)
-        object.__setattr__(self, '_assistants', assistants)
+        object.__setattr__(self, '_context', {})
 
     def __delattr__(self, attr):
         return setattr(self._configuration, attr)
@@ -79,28 +65,11 @@ 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)
-
-    @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)
+    def context_get(self, context_key):
+        return self._context.get(context_key, None)
 
-    @staticmethod
-    def default_assistants():
-        return default_runtime_assistants()
+    def context_set(self, context_key, context_value):
+        self._context[context_key] = context_value
 
 
 def get_configuration_object(config_file=None,
@@ -135,8 +104,7 @@ def get_configuration_object(config_file=None,
     if raw:
         return configuration
 
-    assistants = RuntimeConfiguration.default_assistants()
-    return RuntimeConfiguration(configuration, assistants)
+    return RuntimeConfiguration(configuration)
 
 
 def get_resource_configuration(resource_home, unique_resource_name,
diff --git a/mig/shared/configuration.py b/mig/shared/configuration.py
@@ -83,6 +83,7 @@
     'skip_log',
     'verbose',
     'logger',
+    '_context',
 ])
 
 
diff --git a/mig/shared/functionality/autocreate.py b/mig/shared/functionality/autocreate.py
@@ -740,7 +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 configuration.send_email(email, email_header, email_msg):
+        if not send_email(configuration, 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,7 +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 configuration.send_email(admin_email, email_header, email_msg):
+    if not send_email(configuration, 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,7 +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 configuration.send_email(admin_email, email_header, email_msg):
+    if not send_email(configuration, 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,7 +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 configuration.send_email(peer_email, email_header, email_msg):
+                    if send_email(configuration, peer_email, email_header, email_msg):
                         succeeded.append(peer_email)
                     else:
                         failed.append(peer_email)
@@ -368,7 +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 configuration.send_email(admin_email, email_header, email_msg):
+    if not send_email(configuration, 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,7 +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 configuration.send_email(admin_email, email_header, email_msg):
+    if not send_email(configuration, 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,7 +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 configuration.send_email(admin_email, email_header, email_msg):
+    if not send_email(configuration, 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,7 +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 configuration.send_email(email_to, email_header, email_msg):
+        if not send_email(configuration, 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,7 +682,7 @@ def __send_project_action_confirmation(configuration,
 
 Attached you'll find the details registered in relation to the operation.
         """ % mail_fill
-        status = configuration.send_email(
+        status = send_email(configuration,
             recipients,
             subject,
             message,
diff --git a/mig/shared/notification.py b/mig/shared/notification.py
@@ -561,6 +561,26 @@ def send_instant_message(
 
 
 def send_email(
+        configuration,
+        recipients,
+        subject,
+        message,
+        files=[],
+        custom_sender=None):
+    notifier = configuration.context_get('notifier')
+    if not notifier:
+        notifier = Notifier(configuration)
+        configuration.context_set('notifier', notifier)
+    return notifier.send_email(
+        recipients,
+        subject,
+        message,
+        files=files,
+        custom_sender=custom_sender,
+    )
+
+
+def direct_send_email(
     configuration,
     recipients,
     subject,
@@ -819,7 +839,7 @@ def notify_user(
 
                     continue
 
-                if configuration.send_email(single_dest, header, message,
+                if send_email(configuration, single_dest, header, message,
                               custom_sender=email_sender):
                     logger.info('email sent to %s telling that %s %s'
                                 % (single_dest, jobid, status))
@@ -906,7 +926,7 @@ def send_resource_create_request_mail(
         os.path.basename(pending_file),
     )
 
-    status = configuration.send_email(recipients, subject, txt)
+    status = send_email(configuration, recipients, subject, txt)
     if status:
         msg += '\nEmail was sent to admins'
     else:
@@ -961,3 +981,13 @@ def send_system_notification(user_id, category, message, configuration):
     return send_message_to_grid_notify(pickled_notification,
                                        configuration.logger,
                                        configuration)
+
+
+class Notifier:
+    def __init__(self, configuration):
+        self.configuration = configuration
+
+    def send_email(self, recipients, subject, message, files=[], custom_sender=None):
+        return direct_send_email(self.configuration, recipients, subject, message,
+                                                        files=[],
+                                                        custom_sender=None)
diff --git a/tests/fixture/mig_shared_configuration--new.json b/tests/fixture/mig_shared_configuration--new.json
@@ -29,7 +29,6 @@
   "ca_user": "mig-ca",
   "certs_path": "/some/place/certs",
   "cloud_services": [],
-  "config_file": null,
   "cputime_for_empty_jobs": 0,
   "default_page": [
     ""
@@ -104,14 +103,12 @@
   ],
   "log_dir": "",
   "logfile": "",
-  "logger": null,
   "logger_obj": null,
   "loglevel": "",
   "lrmstypes": [],
   "mig_code_base": "",
   "mig_path": "/some/place/mig",
   "mig_server_home": "",
-  "mig_server_id": null,
   "mig_system_files": "",
   "mig_system_run": "",
   "mig_system_storage": "",
diff --git a/tests/support/__init__.py b/tests/support/__init__.py
@@ -45,7 +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
+import tests.support.fakes as fakes
 
 from tests.support._env import MIG_ENV, PY2
 
@@ -226,9 +226,7 @@ def _make_configuration_instance(testcase, configuration_to_make):
         elif configuration_to_make == 'testconfig':
             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)
+            return RuntimeConfiguration(configuration)
         else:
             raise AssertionError(
                 "MigTestCase: unknown configuration %r" % (configuration_to_make,))
@@ -262,6 +260,8 @@ def configuration(self):
 
         self._configuration = configuration_instance
 
+        fakes.instrument_test_case(self, self._configuration)
+
         return configuration_instance
 
 
diff --git a/tests/support/configsupp.py b/tests/support/configsupp.py
@@ -50,6 +50,7 @@ def _generate_namespace_kwargs():
 
     properties_and_defaults = dict(_CONFIGURATION_PROPERTIES)
     properties_and_defaults['logger'] = None
+    properties_and_defaults['_context'] = {}
     return properties_and_defaults
 
 
@@ -83,6 +84,12 @@ def __init__(self, logger=None, **kwargs):
             for k, v in kwargs.items():
                 setattr(self, k, v)
 
+    def context_get(self, context_key):
+        return self._context.get(context_key, None)
+
+    def context_set(self, context_key, context_value):
+        self._context[context_key] = context_value
+
     def reload_config(self, *args, **kwargs):
         """Stub defined to quack like Configuration."""
 
diff --git a/tests/support/fakes.py b/tests/support/fakes.py
@@ -24,14 +24,18 @@
 # -- END_HEADER ---
 #
 
+import inspect
+from types import SimpleNamespace
+
+
 """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):
+    def __call__(self, *args, **kwargs):
         # Record any arguments upon a call to send email (discarding the
         # leading configuration argument)
         self.calls.append((args, kwargs))
@@ -71,16 +75,21 @@ def email_was_sent_to(self, email_address):
         return email_address in recipients
 
 
-def make_fake_send_email(mig_test_case=None):
+def make_fake_notifier(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
+    return SimpleNamespace(send_email=fake_send_email)
+
 
+def instrument_test_case(mig_test_case=None, mig_configuration=None):
+    assert inspect.ismethod(getattr(mig_configuration, 'context_set', None)), \
+            "supplied configuration must be usable at runtime"
 
-def make_fake_assistants(mig_test_case=None):
-    return {
-        'send_email': make_fake_send_email(mig_test_case=mig_test_case),
+    fakes_by_context_key = {
+        'notifier': make_fake_notifier(mig_test_case=mig_test_case),
     }
+    for content_key, context_value in fakes_by_context_key.items():
+        mig_configuration.context_set(content_key, context_value)
diff --git a/tests/test_mig_lib_janitor.py b/tests/test_mig_lib_janitor.py
@@ -332,7 +332,8 @@ def test_expire_user_pending(self):
         handled = remind_and_expire_user_pending(self.configuration)
         # self.assertEqual(handled, 1)
         self.assertEqual(handled, 2)  # counted stale and expired (see above)
-        fake_send_email = self.configuration.get_assistant('send_email')
+
+        fake_send_email = self.configuration.context_get('notifier').send_email
         self.assertTrue(fake_send_email.called_once)
         self.assertTrue(fake_send_email.email_was_sent_to('test@example.com'))
 
@@ -381,13 +382,14 @@ def test_handle_pending_requests(self):
         handled = handle_pending_requests(self.configuration)
         # self.assertEqual(handled, 2)  # 1 manage + 1 expire
         self.assertEqual(handled, 3)  # 1 manage + 1 expire + 1 stale
-        fake_send_email = self.configuration.get_assistant('send_email')
+
+        fake_send_email = self.configuration.context_get('notifier').send_email
         self.assertTrue(fake_send_email.called_once)
         self.assertTrue(fake_send_email.email_was_sent_to('test@example.com'))
 
     def test_handle_janitor_tasks_full(self):
         """Test full janitor task scheduler"""
-        self.configuration.get_assistant('send_email').forgive_email()
+        self.configuration.context_get('notifier').send_email.forgive_email()
         # Prepare environment with pending tasks of each kind
         mig_stamp = time.time() - EXPIRE_STATE_DAYS * SECS_PER_DAY - 1
         mig_path = os.path.join(self.configuration.mig_system_files,
@@ -849,7 +851,7 @@ def test_verify_reset_token_success(self):
 
     def test_remind_and_expire_edge_cases(self):
         """Test request expiration with exact boundary timestamps"""
-        self.configuration.get_assistant('send_email').forgive_email()
+        self.configuration.context_get('notifier').send_email.forgive_email()
         now = time.time()
         test_cases = [
             ('exact_remind', now - REMIND_REQ_DAYS * SECS_PER_DAY),
diff --git a/tests/test_mig_shared_accountreq.py b/tests/test_mig_shared_accountreq.py
diff --git a/tests/test_mig_shared_configuration.py b/tests/test_mig_shared_configuration.py
