1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/**
* Copyright 2016 Google Inc. All Rights Reserved.
*
* <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of the License at
*
* <p>http://www.apache.org/licenses/LICENSE-2.0
*
* <p>Unless required by applicable law or agreed to in writing, software distributed under the
* License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.vts.util;
import com.android.vts.entity.DeviceInfoEntity;
import com.android.vts.entity.TestRunEntity;
import com.android.vts.entity.UserFavoriteEntity;
import com.google.appengine.api.datastore.DatastoreService;
import com.google.appengine.api.datastore.DatastoreServiceFactory;
import com.google.appengine.api.datastore.Entity;
import com.google.appengine.api.datastore.Key;
import com.google.appengine.api.datastore.Query;
import com.google.appengine.api.datastore.Query.Filter;
import com.google.appengine.api.datastore.Query.FilterOperator;
import com.google.appengine.api.datastore.Query.FilterPredicate;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Optional;
import java.util.Properties;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.mail.Message;
import javax.mail.MessagingException;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import org.apache.commons.lang.StringUtils;
/** EmailHelper, a helper class for building and sending emails. */
public class EmailHelper {
protected static final Logger logger = Logger.getLogger(EmailHelper.class.getName());
protected static String DEFAULT_EMAIL;
protected static String EMAIL_DOMAIN;
protected static String SENDER_EMAIL;
private static final String VTS_EMAIL_NAME = "VTS Alert Bot";
public static void setPropertyValues(Properties systemConfigProp) {
DEFAULT_EMAIL = systemConfigProp.getProperty("appengine.defaultEmail");
EMAIL_DOMAIN = systemConfigProp.getProperty("appengine.emailDomain");
SENDER_EMAIL = systemConfigProp.getProperty("appengine.senderEmail");
}
/**
* Create an email footer with the information from the test run.
*
* @param testRun The TestRunEntity containing test run metadata, or null.
* @param devices The list of devices whose fingerprints to include in the email, or null.
* @param link A link to the Dashboard page containing more information.
* @return The String email footer.
*/
public static String getEmailFooter(
TestRunEntity testRun, List<DeviceInfoEntity> devices, String link) {
StringBuilder sb = new StringBuilder();
sb.append("<br><br>");
if (devices != null) {
for (DeviceInfoEntity device : devices) {
sb.append("Device: " + device.getFingerprint() + "<br>");
}
}
if (testRun != null) {
sb.append("VTS Build ID: " + testRun.getTestBuildId() + "<br>");
sb.append("Start Time: " + TimeUtil.getDateTimeZoneString(testRun.getStartTimestamp()));
sb.append("<br>End Time: " + TimeUtil.getDateTimeZoneString(testRun.getEndTimestamp()));
}
sb.append(
"<br><br>For details, visit the"
+ " <a href='"
+ link
+ "'>"
+ "VTS dashboard.</a>");
return sb.toString();
}
/**
* Fetches the list of subscriber email addresses for a test.
*
* @param testKey The key for the test for which to fetch the email addresses.
* @returns List of email addresses (String).
* @throws IOException
*/
public static List<String> getSubscriberEmails(Key testKey) throws IOException {
DatastoreService datastore = DatastoreServiceFactory.getDatastoreService();
Filter testFilter =
new FilterPredicate(UserFavoriteEntity.TEST_KEY, FilterOperator.EQUAL, testKey);
Query favoritesQuery = new Query(UserFavoriteEntity.KIND).setFilter(testFilter);
Set<String> emailSet = new HashSet<>();
if (!StringUtils.isBlank(DEFAULT_EMAIL)) {
emailSet.add(DEFAULT_EMAIL);
}
for (Entity favorite : datastore.prepare(favoritesQuery).asIterable()) {
UserFavoriteEntity favoriteEntity = UserFavoriteEntity.fromEntity(favorite);
// TODO this logic need to be reexamined thoroughly and improved
if (favoriteEntity != null
&& favoriteEntity.user != null
&& !favoriteEntity.muteNotifications) {
Optional<String> userEmail = Optional.of(favoriteEntity.user.getEmail());
if (userEmail.isPresent() &&
userEmail.orElse("").endsWith(EMAIL_DOMAIN)) {
emailSet.add(favoriteEntity.user.getEmail());
}
}
}
return new ArrayList<>(emailSet);
}
/**
* Sends an email to the specified email address to notify of a test status change.
*
* @param emails List of subscriber email addresses (byte[]) to which the email should be sent.
* @param subject The email subject field, string.
* @param body The html (string) body to send in the email.
* @returns The Message object to be sent.
* @throws MessagingException, UnsupportedEncodingException
*/
public static Message composeEmail(List<String> emails, String subject, String body)
throws MessagingException, UnsupportedEncodingException {
if (emails.size() == 0) {
throw new MessagingException("No subscriber email addresses provided");
}
Properties props = new Properties();
Session session = Session.getDefaultInstance(props, null);
Message msg = new MimeMessage(session);
for (String email : emails) {
try {
msg.addRecipient(Message.RecipientType.TO, new InternetAddress(email, email));
} catch (MessagingException | UnsupportedEncodingException e) {
// Gracefully continue when a subscriber email is invalid.
logger.log(Level.WARNING, "Error sending email to recipient " + email + " : ", e);
}
}
msg.setFrom(new InternetAddress(SENDER_EMAIL, VTS_EMAIL_NAME));
msg.setSubject(subject);
msg.setContent(body, "text/html; charset=utf-8");
return msg;
}
/**
* Sends an email.
*
* @param msg Message object to send.
* @returns true if the message sends successfully, false otherwise
*/
public static boolean send(Message msg) {
try {
Transport.send(msg);
} catch (MessagingException e) {
logger.log(Level.WARNING, "Error sending email : ", e);
return false;
}
return true;
}
/**
* Sends a list of emails and logs any failures.
*
* @param messages List of Message objects to be sent.
*/
public static void sendAll(List<Message> messages) {
for (Message msg : messages) {
send(msg);
}
}
/**
* Sends an email.
*
* @param recipients List of email address strings to which an email will be sent.
* @param subject The subject of the email.
* @param body The body of the email.
* @returns true if the message sends successfully, false otherwise
*/
public static boolean send(List<String> recipients, String subject, String body) {
try {
Message msg = composeEmail(recipients, subject, body);
return send(msg);
} catch (MessagingException | UnsupportedEncodingException e) {
logger.log(Level.WARNING, "Error composing email : ", e);
return false;
}
}
}
|
