Addition of --silent option and re-write of email notification module

Author: Nathan Lee

pyrunner/core/config.py

@@ -93,6 +93,7 @@ def __init__(self):
       'nozip'              : { 'type': bool, 'preserve': False, 'env': 'APP_NOZIP'             , 'value': None, 'default': False },
       'dump_logs'          : { 'type': bool, 'preserve': False, 'env': 'APP_DUMP_LOGS'         , 'value': None, 'default': False },
       'email'              : { 'type': str , 'preserve': False, 'env': 'APP_EMAIL'             , 'value': None, 'default': None },
+      'silent'             : { 'type': bool, 'preserve': False, 'env': 'APP_SILENT'            , 'value': None, 'default': False },
       'debug'              : { 'type': bool, 'preserve': False, 'env': 'APP_DEBUG'             , 'value': None, 'default': False },
       'tickrate'           : { 'type': int , 'preserve': False, 'env': 'APP_TICKRATE'          , 'value': None, 'default': 1 },
       'time_between_tasks' : { 'type': int , 'preserve': True,  'env': 'APP_TIME_BETWEEN_TASKS', 'value': None, 'default': 0 },

pyrunner/core/engine.py

@@ -130,7 +130,7 @@ def initiate(self, **kwargs):
             node.execute()
             self.register.running_nodes.add(node)
 
-        if not kwargs.get('silent'):
+        if not kwargs.get('silent') and not self.config['silent']:
           self._print_current_state()
 
         # Check for input requests from interactive mode
@@ -166,7 +166,7 @@ def initiate(self, **kwargs):
     if self._on_destroy_func:
       self._on_destroy_func()
 
-    if not kwargs.get('silent'):
+    if not kwargs.get('silent') and not self.config['silent']:
       self._print_final_state()
 
     if not self.config['test_mode'] and self.save_state_func:

pyrunner/core/pyrunner.py

@@ -32,6 +32,8 @@
 from pyrunner.core.signal import SignalHandler, SIG_ABORT, SIG_PAUSE, SIG_PULSE
 from pyrunner.version import __version__
 
+from pyrunner.notification import Notification
+
 from datetime import datetime as datetime
 import pickle
 import time
@@ -41,7 +43,7 @@ class PyRunner:
   def __init__(self, **kwargs):
     self._environ = os.environ.copy()
     self.config = Config()
-    self.notification = notification.EmailNotification()
+    self._notification = notification.EmailNotification()
     self.signal_handler = SignalHandler(self.config)
 
     self.serde_obj = serde.ListSerDe()
@@ -84,6 +86,16 @@ def load_proc_file(self, proc_file, restart=False):
 
     return True
 
+  @property
+  def notification(self):
+    return self._notification
+  @notification.setter
+  def notification(self, o):
+    if not issubclass(o, Notification):
+      raise TypeError('Not an extension of pyrunner.notification.Notification')
+    self._notification = o
+    return self
+  
   @property
   def version(self):
     return __version__
@@ -342,7 +354,7 @@ def parse_args(self, run_getopts=True):
     opt_list = 'c:l:n:e:x:N:D:A:t:drhiv'
     longopt_list = [
       'setup', 'help', 'nozip', 'interactive', 'abort',
-      'restart', 'version', 'dryrun', 'debug',
+      'restart', 'version', 'dryrun', 'debug', 'silent',
       'preserve-context', 'dump-logs', 'allow-duplicate-jobs',
       'email=', 'email-on-fail=', 'email-on-success=',
       'env=', 'cvar=', 'context=', 'time-between-tasks=',
@@ -410,6 +422,8 @@ def parse_args(self, run_getopts=True):
           self.config['exec_proc_name'] = arg
         elif opt == '--abort':
           abort = True
+        elif opt == '--silent':
+          self.config['silent'] = True
         elif opt in ['--serde']:
           if arg.lower() == 'json':
             self.plugin_serde(serde.JsonSerDe())

pyrunner/notification/email.py

@@ -14,19 +14,23 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-from subprocess import Popen, STDOUT, PIPE
+import time, smtplib, os
 from datetime import datetime as datetime
-import time
 from pyrunner.notification.abstract import Notification
+from email.message import EmailMessage
 
 class EmailNotification(Notification):
 
   def emit_notification(self, config, register):
+    if not config['email']:
+      print('Email address not provided - skipping notification email')
+      return 0
+    
     failed_objects = register.failed_nodes
-    subject = ''
-    message = ''
+    subject, message = '', ''
     attachments = [config.ctllog_file]
 
+    # Build message body
     message += "Dear User,\n\n"
 
     if failed_objects:
@@ -48,29 +52,19 @@ def emit_notification(self, config, register):
 
     message += "Log Directory: {}\n\n".format(config['log_dir'])
 
-    if not config['email']:
-      print('Email address not provided - skipping notification email')
-      return 0
-    
     print('Sending Email Notification to: {}'.format(config['email']))
-    command = ['mailx', '-s', subject]
-    
-    if attachments:
-      for a in attachments:
-        command.append('-a')
-        command.append(a)
-    
-    command.append(config['email'])
 
-    proc = Popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
-    out, err = proc.communicate(input = str.encode(message))
-    retcode = proc.returncode
+    msg = EmailMessage()
+    msg["From"] = os.environ['USER']
+    msg["Subject"] = subject
+    msg["To"] = config['email']
+    msg.set_content(message)
 
-    if retcode > 0:
-      if out:
-        print(out)
-      if err:
-        print(err)
-      raise RuntimeError('Error while sending notification email')
+    # Attach ctllog file and any failure logs, if any
+    for filepath in attachments:
+      with open(filepath, 'r') as f:
+        msg.add_attachment(f.read(), filename=os.path.basename(filepath))
 
-    return retcode
+    s = smtplib.SMTP('localhost')
+    s.send_message(msg)
+    s.quit()

pyrunner/version.py

@@ -1 +1 @@
-__version__ = '5.1.2'
+__version__ = '5.2.0'