Added optional argument for email subject-line prefix (TriBITSPub#600)

Added argument to specify a prefix string for the built html
page title and the email subject. This can help with the
tool's email searchability.

test/ci_support/cdash_analyze_and_report_random_failures_UnitTests.py

@@ -229,7 +229,9 @@ def test_random_failure(self):
 
     # Test to no random failure case starting from two initial failing tests (ift).
     # Each ift has a test history containing multiple tests with passing and nonpassing results,
-    # but non share the same sha1 pair.
+    # but non share the same sha1 pair. This also tests the --email-subject-prefix argument
+    # and checks if it's present in the html page title, which is also used in the email subject
+    # line.
     #
     def test_no_random_failure(self):
 
@@ -247,7 +249,7 @@ def test_no_random_failure(self):
                 "PASSED \(rft=0, ift=2\): Project Name Group Name on 2018-10-26 to 2018-10-28"
             ],
             htmlFileRegexList=[
-                "<h2>PASSED \(rft=0, ift=2\): Project Name Group Name on 2018-10-26 to 2018-10-28</h2>",
+                "<h2>Subject Prefix PASSED \(rft=0, ift=2\): Project Name Group Name on 2018-10-26 to 2018-10-28</h2>",
 
                 "<h2>Random test failure scan results for Project Name from 2018-10-26 to 2018-10-28</h2>",
 
@@ -260,7 +262,8 @@ def test_no_random_failure(self):
                 "</p>"
             ],
             extraCmndLineOptionsList=[
-                "--days-of-history=3"
+                "--days-of-history=3",
+                "--email-subject-prefix='Subject Prefix '"
             ]
         )
 

tribits/ci_support/CDashAnalyzeReportRandomFailures.py

@@ -32,6 +32,7 @@ def runDriver(self):
     writeEmailToFile = self.args.write_email_to_file
     sendEmailFrom = self.args.send_email_from
     sendEmailTo = self.args.send_email_to
+    emailSubjectPrefix = self.args.email_subject_prefix
 
     randomFailureSummaries = []
 
@@ -231,11 +232,12 @@ def runDriver(self):
     cdashReportData.htmlEmailBodyTop += "\n</p>"
 
     defaultPageStyle = CDQAR.getDefaultHtmlPageStyleStr()
+    subjectLine = emailSubjectPrefix+summaryLine
 
     if writeEmailToFile:
       print("\nWriting HTML to file: "+writeEmailToFile+" ...")
       htmlStr = CDQAR.getFullCDashHtmlReportPageStr(cdashReportData,
-        pageTitle=summaryLine, pageStyle=defaultPageStyle)
+        pageTitle=subjectLine, pageStyle=defaultPageStyle)
       # print(htmlStr)
       with open(writeEmailToFile, 'w') as outFile:
         outFile.write(htmlStr)
@@ -247,7 +249,7 @@ def runDriver(self):
         emailAddress = emailAddress.strip()
         print("\nSending email to '"+emailAddress+"' ...")
         msg=CDQAR.createHtmlMimeEmail(
-          sendEmailFrom, emailAddress, summaryLine, "", htmlStr)
+          sendEmailFrom, emailAddress, subjectLine, "", htmlStr)
         CDQAR.sendMineEmail(msg)
 
   def getCmndLineArgs(self):
@@ -290,6 +292,9 @@ def getCmndLineArgs(self):
     parser.add_argument("--send-email-from", default="[email protected]",
       help="Addressed sender of the script summary results email."+\
         " [default='[email protected]']")
+    parser.add_argument("--email-subject-prefix", default="",
+      help="Prefix string added to the email subject line."+\
+        " [default='']")
 
     self.args = parser.parse_args()