<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[265817] trunk/Tools</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/265817">265817</a></dd>
<dt>Author</dt> <dd>aakash_jain@apple.com</dd>
<dt>Date</dt> <dd>2020-08-18 09:04:03 -0700 (Tue, 18 Aug 2020)</dd>
</dl>

<h3>Log Message</h3>
<pre>Develop a mechanism to unsubscribe from ews emails
https://bugs.webkit.org/show_bug.cgi?id=215585

Reviewed by Jonathan Bedard.

* BuildSlaveSupport/ews-build/emails.json: Added.
* BuildSlaveSupport/ews-build/send_email.py:
(get_email_ids):
(send_email_to_patch_author): Do not email patch authors whose email is in unsubscribe list.
(send_email_to_bot_watchers):
* BuildSlaveSupport/ews-build/steps.py:
(AnalyzeCompileWebKitResults.send_email_for_new_build_failure):
(AnalyzeLayoutTestsResults.send_email_for_new_test_failures):
* BuildSlaveSupport/ews-build/email_unittest.py: Added unit-tests.
(EmailsDotJSONTest.test_valid_emails_json):
(EmailsDotJSONTest.test_emails_json_required_categories_present):</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkToolsBuildSlaveSupportewsbuildsend_emailpy">trunk/Tools/BuildSlaveSupport/ews-build/send_email.py</a></li>
<li><a href="#trunkToolsBuildSlaveSupportewsbuildstepspy">trunk/Tools/BuildSlaveSupport/ews-build/steps.py</a></li>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#trunkToolsBuildSlaveSupportewsbuildemail_unittestpy">trunk/Tools/BuildSlaveSupport/ews-build/email_unittest.py</a></li>
<li><a href="#trunkToolsBuildSlaveSupportewsbuildemailsjson">trunk/Tools/BuildSlaveSupport/ews-build/emails.json</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsBuildSlaveSupportewsbuildemail_unittestpy"></a>
<div class="addfile"><h4>Added: trunk/Tools/BuildSlaveSupport/ews-build/email_unittest.py (0 => 265817)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/BuildSlaveSupport/ews-build/email_unittest.py                                (rev 0)
+++ trunk/Tools/BuildSlaveSupport/ews-build/email_unittest.py   2020-08-18 16:04:03 UTC (rev 265817)
</span><span class="lines">@@ -0,0 +1,45 @@
</span><ins>+#!/usr/bin/env python
+#
+# Copyright (C) 2020 Apple Inc. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1.  Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+# 2.  Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+import json
+import os
+import unittest
+
+
+class EmailsDotJSONTest(unittest.TestCase):
+    def test_valid_emails_json(self):
+        cwd = os.path.dirname(os.path.abspath(__file__))
+        json.load(open(os.path.join(cwd, 'emails.json')))
+
+    def test_emails_json_required_categories_present(self):
+        cwd = os.path.dirname(os.path.abspath(__file__))
+        emails = json.load(open(os.path.join(cwd, 'emails.json')))
+        valid_email_categories = ['ADMIN_EMAILS', 'BOT_WATCHERS_EMAILS', 'EMAIL_IDS_TO_UNSUBSCRIBE']
+        for category in valid_email_categories:
+            self.assertTrue(category in emails.keys())
+
+
+if __name__ == '__main__':
+    unittest.main()
</ins></span></pre></div>
<a id="trunkToolsBuildSlaveSupportewsbuildemailsjson"></a>
<div class="addfile"><h4>Added: trunk/Tools/BuildSlaveSupport/ews-build/emails.json (0 => 265817)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/BuildSlaveSupport/ews-build/emails.json                              (rev 0)
+++ trunk/Tools/BuildSlaveSupport/ews-build/emails.json 2020-08-18 16:04:03 UTC (rev 265817)
</span><span class="lines">@@ -0,0 +1,10 @@
</span><ins>+{
+  "ADMIN_EMAILS": [
+      "aakash_jain@apple.com", 
+      "webkit-ews-bot-watchers@group.apple.com"
+  ],
+  "BOT_WATCHERS_EMAILS": [
+      "webkit-ews-bot-watchers@group.apple.com"
+  ],
+  "EMAIL_IDS_TO_UNSUBSCRIBE": []
+}
</ins></span></pre></div>
<a id="trunkToolsBuildSlaveSupportewsbuildsend_emailpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/BuildSlaveSupport/ews-build/send_email.py (265816 => 265817)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/BuildSlaveSupport/ews-build/send_email.py    2020-08-18 16:01:40 UTC (rev 265816)
+++ trunk/Tools/BuildSlaveSupport/ews-build/send_email.py       2020-08-18 16:04:03 UTC (rev 265817)
</span><span class="lines">@@ -20,6 +20,7 @@
</span><span class="cx"> # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
</span><span class="cx"> # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</span><span class="cx"> 
</span><ins>+import json
</ins><span class="cx"> import os
</span><span class="cx"> import smtplib
</span><span class="cx"> 
</span><span class="lines">@@ -27,11 +28,20 @@
</span><span class="cx"> 
</span><span class="cx"> is_test_mode_enabled = os.getenv('BUILDBOT_PRODUCTION') is None
</span><span class="cx"> 
</span><del>-BOT_WATCHERS_EMAILS = ['webkit-ews-bot-watchers@group.apple.com']
</del><span class="cx"> FROM_EMAIL = 'ews@webkit.org'
</span><span class="cx"> SERVER = 'localhost'
</span><span class="cx"> 
</span><span class="cx"> 
</span><ins>+def get_email_ids(category):
+    # Valid categories: 'ADMIN_EMAILS', 'BOT_WATCHERS_EMAILS', 'EMAIL_IDS_TO_UNSUBSCRIBE'
+    try:
+        emails = json.load(open('emails.json'))
+        return emails.get(category, [])
+    except Exception as e:
+        print('Error in reading emails.json: {}'.format(e))
+        return []
+
+
</ins><span class="cx"> def send_email(to_emails, subject, text):
</span><span class="cx">     if is_test_mode_enabled:
</span><span class="cx">         return
</span><span class="lines">@@ -55,5 +65,14 @@
</span><span class="cx">     server.quit()
</span><span class="cx"> 
</span><span class="cx"> 
</span><ins>+def send_email_to_patch_author(author_email, subject, text):
+    if not author_email:
+        return
+    if author_email in get_email_ids('EMAIL_IDS_TO_UNSUBSCRIBE'):
+        print('email {} is in unsubscribe list, skipping email'.format(author_email))
+        return
+    send_email([author_email], subject, text)
+
+
</ins><span class="cx"> def send_email_to_bot_watchers(subject, text):
</span><del>-    send_email(BOT_WATCHERS_EMAILS, subject, text)
</del><ins>+    send_email(get_email_ids('BOT_WATCHERS_EMAILS'), subject, text)
</ins></span></pre></div>
<a id="trunkToolsBuildSlaveSupportewsbuildstepspy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/BuildSlaveSupport/ews-build/steps.py (265816 => 265817)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/BuildSlaveSupport/ews-build/steps.py 2020-08-18 16:01:40 UTC (rev 265816)
+++ trunk/Tools/BuildSlaveSupport/ews-build/steps.py    2020-08-18 16:04:03 UTC (rev 265817)
</span><span class="lines">@@ -29,7 +29,7 @@
</span><span class="cx"> from twisted.internet import defer
</span><span class="cx"> 
</span><span class="cx"> from layout_test_failures import LayoutTestFailures
</span><del>-from send_email import send_email, send_email_to_bot_watchers
</del><ins>+from send_email import send_email_to_patch_author, send_email_to_bot_watchers
</ins><span class="cx"> 
</span><span class="cx"> import json
</span><span class="cx"> import re
</span><span class="lines">@@ -1490,7 +1490,7 @@
</span><span class="cx">                 logs = logs.replace('&', '&amp;').replace('<', '&lt;').replace('>', '&gt;')
</span><span class="cx">                 email_text += u'\n\nError lines:\n\n<code>{}</code>'.format(logs)
</span><span class="cx">             email_text += '\n\nTo unsubscrible from these notifications or to provide any feedback please email aakash_jain@apple.com'
</span><del>-            send_email([patch_author], email_subject, email_text)
</del><ins>+            send_email_to_patch_author(patch_author, email_subject, email_text)
</ins><span class="cx">         except Exception as e:
</span><span class="cx">             print('Error in sending email for new build failure: {}'.format(e))
</span><span class="cx"> 
</span><span class="lines">@@ -2164,7 +2164,7 @@
</span><span class="cx">             email_text += '\n\nFull details are available at: {}\n\nPatch author: {}'.format(build_url, patch_author)
</span><span class="cx">             email_text += '\n\nLayout test failure{}:\n{}'.format(pluralSuffix, test_names_string)
</span><span class="cx">             email_text += '\n\nTo unsubscrible from these notifications or to provide any feedback please email aakash_jain@apple.com'
</span><del>-            send_email([patch_author], email_subject, email_text)
</del><ins>+            send_email_to_patch_author(patch_author, email_subject, email_text)
</ins><span class="cx">         except Exception as e:
</span><span class="cx">             print('Error in sending email for new layout test failures: {}'.format(e))
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (265816 => 265817)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog    2020-08-18 16:01:40 UTC (rev 265816)
+++ trunk/Tools/ChangeLog       2020-08-18 16:04:03 UTC (rev 265817)
</span><span class="lines">@@ -1,3 +1,22 @@
</span><ins>+2020-08-17  Aakash Jain  <aakash_jain@apple.com>
+
+        Develop a mechanism to unsubscribe from ews emails
+        https://bugs.webkit.org/show_bug.cgi?id=215585
+
+        Reviewed by Jonathan Bedard.
+
+        * BuildSlaveSupport/ews-build/emails.json: Added.
+        * BuildSlaveSupport/ews-build/send_email.py:
+        (get_email_ids):
+        (send_email_to_patch_author): Do not email patch authors whose email is in unsubscribe list.
+        (send_email_to_bot_watchers):
+        * BuildSlaveSupport/ews-build/steps.py:
+        (AnalyzeCompileWebKitResults.send_email_for_new_build_failure):
+        (AnalyzeLayoutTestsResults.send_email_for_new_test_failures):
+        * BuildSlaveSupport/ews-build/email_unittest.py: Added unit-tests.
+        (EmailsDotJSONTest.test_valid_emails_json):
+        (EmailsDotJSONTest.test_emails_json_required_categories_present):
+
</ins><span class="cx"> 2020-08-17  Saagar Jha  <saagar@saagarjha.com>
</span><span class="cx"> 
</span><span class="cx">         Stop webkitpy from warning about not having a 64-bit git on Apple silicon
</span></span></pre>
</div>
</div>

</body>
</html>