Logs notification metadata

tracim/development.ini.base

@@ -184,6 +184,7 @@ website.base_url = http://127.0.0.1:8080
 website.server_name = 127.0.0.1
 
 email.notification.activated = False
+# email.notification.log_file_path = /tmp/mail-notifications.log
 # email notifications can be sent with the user_id added as an identifier
 # this way email clients like Thunderbird will be able to distinguish
 # notifications generated by a user or another one

tracim/test.ini

@@ -15,6 +15,7 @@ radicale.server.filesystem.folder = /tmp/tracim_tests_radicale_fs
 radicale.client.base_url.host = http://localhost:15232
 radicale.client.base_url.prefix = /
 email.notification.activated = false
+email.notification.log_file_path = /tmp/mail-notifications-test.log
 
 [server:main]
 use = egg:gearbox#wsgiref

tracim/tracim/config/app_cfg.py

@@ -339,6 +339,10 @@ class CFG(object):
         self.EMAIL_NOTIFICATION_SMTP_PASSWORD = tg.config.get(
             'email.notification.smtp.password',
         )
+        self.EMAIL_NOTIFICATION_LOG_FILE_PATH = tg.config.get(
+            'email.notification.log_file_path',
+            None,
+        )
 
         self.TRACKER_JS_PATH = tg.config.get(
             'js_tracker_path',

tracim/tracim/lib/notifications.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+import datetime
 
 from email.header import Header
 from email.mime.multipart import MIMEMultipart
@@ -210,6 +211,24 @@ class EmailNotifier(object):
             email_address = email_address
         )
 
+    @staticmethod
+    def _log_notification(
+            recipient: str,
+            subject: str
+    ) -> None:
+        """Log notification metadata."""
+        from tracim.config.app_cfg import CFG
+        log_path = CFG.get_instance().EMAIL_NOTIFICATION_LOG_FILE_PATH
+        if log_path:
+            with open(log_path, 'a') as log_file:
+                print(
+                    datetime.datetime.now(),
+                    recipient,
+                    subject,
+                    sep='|',
+                    file=log_file,
+                )
+
     def notify_content_update(self, event_actor_id: int, event_content_id: int):
         """
         Look for all users to be notified about the new content and send them an individual email
@@ -277,6 +296,10 @@ class EmailNotifier(object):
             message.attach(part1)
             message.attach(part2)
 
+            self._log_notification(
+                recipient=message['for'],
+                subject=message['Subject'],
+            )
             send_email_through(async_email_sender.send_mail, message)
 
     def _build_email_body(self, mako_template_filepath: str, role: UserRoleInWorkspace, content: Content, actor: User) -> str:

tracim/tracim/tests/library/test_notification.py

@@ -1,12 +1,9 @@
 # -*- coding: utf-8 -*-
+import os
+import re
 
 from nose.tools import eq_
 from nose.tools import ok_
-from nose.tools import raises
-
-from sqlalchemy.orm.exc import NoResultFound
-
-import transaction
 
 from tracim.config.app_cfg import CFG
 from tracim.lib.notifications import DummyNotifier
@@ -16,7 +13,6 @@ from tracim.lib.notifications import NotifierFactory
 from tracim.lib.notifications import RealNotifier
 from tracim.model.auth import User
 from tracim.model.data import Content
-
 from tracim.tests import TestStandard
 
 
@@ -43,7 +39,7 @@ class TestDummyNotifier(TestStandard):
     def test_email_subject_tag_list(self):
         tags = EST.all()
 
-        eq_(4,len(tags))
+        eq_(4, len(tags))
         ok_('{website_title}' in tags)
         ok_('{workspace_label}' in tags)
         ok_('{content_label}' in tags)
@@ -51,6 +47,31 @@ class TestDummyNotifier(TestStandard):
 
 
 class TestEmailNotifier(TestStandard):
+
+    def test_unit__log_notification(self):
+        log_path = CFG.get_instance().EMAIL_NOTIFICATION_LOG_FILE_PATH
+        pattern = '\|{rec}\|{subj}$\\n'
+        line_1_rec = 'user 1 <us.er@o.ne>'
+        line_1_subj = 'notification 1'
+        line_1_pattern = pattern.format(rec=line_1_rec, subj=line_1_subj)
+        line_2_rec = 'user 2 <us.er@t.wo>'
+        line_2_subj = 'notification 2'
+        line_2_pattern = pattern.format(rec=line_2_rec, subj=line_2_subj)
+        EmailNotifier._log_notification(
+            recipient=line_1_rec,
+            subject=line_1_subj,
+        )
+        EmailNotifier._log_notification(
+            recipient=line_2_rec,
+            subject=line_2_subj,
+        )
+        with open(log_path, 'rt') as log_file:
+            line_1 = log_file.readline()
+            line_2 = log_file.readline()
+        os.remove(path=log_path)
+        ok_(re.search(pattern=line_1_pattern, string=line_1))
+        ok_(re.search(pattern=line_2_pattern, string=line_2))
+
     def test_email_notifier__build_name_with_user_id(self):
         u = User()
         u.user_id = 3
@@ -95,4 +116,3 @@ class TestEmailNotifier(TestStandard):
         notifier = EmailNotifier(smtp_config=None, global_config=config)
         email = notifier._get_sender()
         eq_('Robot <noreply@tracim.io>', email)
-