Merge pull request #319 from itkovian/feat-vscmail-config

Add mail config file argument for VscMail

Author: stdweird

lib/vsc/utils/mail.py

@@ -35,6 +35,7 @@
 import re
 import smtplib
 import ssl
+from configparser import ConfigParser
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 from email.mime.image import MIMEImage
@@ -71,16 +72,35 @@ class VscMail(object):
     def __init__(
         self,
         mail_host='',
-        mail_port=0,
+        mail_port=587,
         smtp_auth_user=None,
         smtp_auth_password=None,
-        smtp_use_starttls=False):
+        smtp_use_starttls=False,
+        mail_config=None):
+        """
+        - If there is a config file provided, its values take precedence over the arguments passed to __init__
+        - If the mail_host is of the format host:port, that port takes precedence over mail_port
+        """
+
+        mail_options = ConfigParser()
+        if mail_config:
+            logging.info("Reading config file: %s", mail_config)
+            with open(mail_config, "r") as mc:
+                mail_options.read_file(mc)
+
+        # we can have cases where the host part is actually host:port
+        _mail_host = mail_options.get("main", "mail_host", fallback=mail_host)
+        try:
+            self.mail_host, _mail_port = _mail_host.split(":")
+        except ValueError:
+            self.mail_host = _mail_host
+            _mail_port = mail_options.get("main", "mail_port", fallback=mail_port)
+
+        self.mail_port = int(_mail_port)
+        self.smtp_auth_user = mail_options.get("main", "smtp_auth_user", fallback=smtp_auth_user)
+        self.smtp_auth_password = mail_options.get("main", "smtp_auth_password", fallback=smtp_auth_password)
+        self.smtp_use_starttls = mail_options.get("main", "smtp_use_starttls", fallback=smtp_use_starttls)
 
-        self.mail_host = mail_host
-        self.mail_port = mail_port
-        self.smtp_auth_user = smtp_auth_user
-        self.smtp_auth_password = smtp_auth_password
-        self.smtp_use_starttls = smtp_use_starttls
 
     def _connect(self):
         """

setup.py

@@ -36,15 +36,15 @@
 import vsc.install.shared_setup as shared_setup
 from vsc.install.shared_setup import ag, kh, jt, sdw
 
-VSC_INSTALL_REQ_VERSION = '0.15.2'
+VSC_INSTALL_REQ_VERSION = '0.17.19'
 
 _coloredlogs_pkgs = [
     'coloredlogs < 6.0',     # automatic log colorizer
     'humanfriendly',   # detect if terminal has colors
 ]
 
 PACKAGE = {
-    'version': '3.3.2',
+    'version': '3.4.0',
     'author': [sdw, jt, ag, kh],
     'maintainer': [sdw, jt, ag, kh],
     # as long as 1.0.0 is not out, vsc-base should still provide vsc.fancylogger

test/data/mailconfig.ini

@@ -0,0 +1,6 @@
+[main]
+mail_host = config_host
+mail_port = 789
+smtp_auth_user = config_user
+smtp_auth_password = config_passwd
+smtp_use_starttls = 1

test/mail.py

@@ -29,6 +29,7 @@
 @author: Andy Georges (Ghent University)
 """
 import mock
+import logging
 import os
 
 from vsc.install.testing import TestCase
@@ -38,6 +39,35 @@
 
 class TestVscMail(TestCase):
 
+
+    def test_config_file(self):
+
+        mail_host = "mailhost.domain"
+        mail_port = 123
+        mail_host_port = "mailhost.domain:567"
+        smtp_auth_user = "user"
+        smtp_auth_password = "passwd"
+        smtp_use_starttls = True
+
+        mail = VscMail(mail_host=mail_host)
+
+        self.assertEqual(mail.mail_host, mail_host)
+        self.assertEqual(mail.mail_port, 587)
+
+        mail = VscMail(mail_host=mail_host, mail_port=mail_port)
+        self.assertEqual(mail.mail_host, mail_host)
+        self.assertEqual(mail.mail_port, mail_port)
+
+        mail = VscMail(mail_config=os.path.dirname(__file__) + '/data/' + 'mailconfig.ini')
+
+        logging.warning("mail.mail_host: %s", mail.mail_host)
+
+        self.assertEqual(mail.mail_host, "config_host")
+        self.assertEqual(mail.mail_port, 789)
+        self.assertEqual(mail.smtp_auth_user, "config_user")
+        self.assertEqual(mail.smtp_auth_password, "config_passwd")
+        self.assertEqual(mail.smtp_use_starttls, '1')
+
     @mock.patch('vsc.utils.mail.smtplib')
     @mock.patch('vsc.utils.mail.ssl')
     def test_send(self, mock_ssl, mock_smtplib):
@@ -51,7 +81,7 @@ def test_send(self, mock_ssl, mock_smtplib):
         vm = VscMail()
 
         self.assertEqual(vm.mail_host, '')
-        self.assertEqual(vm.mail_port, 0)
+        self.assertEqual(vm.mail_port, 587)
         self.assertEqual(vm.smtp_auth_user, None)
         self.assertEqual(vm.smtp_auth_password, None)
         self.assertEqual(vm.smtp_use_starttls, False)