1 package org.cacert.gigi.testUtils;
3 import java.io.DataInputStream;
4 import java.io.DataOutputStream;
5 import java.io.IOException;
6 import java.net.Socket;
7 import java.net.SocketAddress;
9 import java.net.URLConnection;
10 import java.util.concurrent.LinkedBlockingQueue;
11 import java.util.concurrent.TimeUnit;
12 import java.util.regex.Matcher;
13 import java.util.regex.Pattern;
15 import org.cacert.gigi.email.EmailProvider;
16 import org.cacert.gigi.email.TestEmailProvider;
19 * This class reveives emails from the current system under test. It is the
20 * counterpart to the {@link TestEmailProvider} who is loaded into the system to
21 * intercept the emails. This class resides in the VM that executes the
22 * testcases and supplies the intercepted emails to the current test case.
24 public final class TestEmailReceiver extends EmailProvider implements Runnable {
27 * An email that has been intercepted.
29 public class TestMail {
41 public TestMail(String to, String subject, String message, String from, String replyto) {
43 this.subject = subject;
44 this.message = message;
46 this.replyto = replyto;
49 public String getTo() {
53 public String getSubject() {
57 public String getMessage() {
61 public String getFrom() {
65 public String getReplyto() {
69 public String extractLink() {
70 Pattern link = Pattern.compile("https?://[^\\s]+(?=\\s)");
71 Matcher m = link.matcher(getMessage());
76 public void verify() throws IOException {
77 String[] parts = extractLink().split("\\?");
78 URL u = new URL("https://" + ManagedTest.getServerName() + "/verify?" + parts[1]);
80 URLConnection csrfConn = u.openConnection();
81 String csrf = ManagedTest.getCSRF(csrfConn, 0);
83 u = new URL("https://" + ManagedTest.getServerName() + "/verify");
84 URLConnection uc = u.openConnection();
85 ManagedTest.cookie(uc, ManagedTest.stripCookie(csrfConn.getHeaderField("Set-Cookie")));
87 uc.getOutputStream().write((parts[1] + "&csrf=" + csrf).getBytes("UTF-8"));
89 uc.getInputStream().close();
96 private DataInputStream dis;
98 private DataOutputStream dos;
101 * Creates a new TestEmailReceiver based on the address where the
102 * {@link TestEmailProvider} is listening. This class is only ready after
103 * {@link #start()} has been called.
106 * the address where the {@link TestEmailProvider} is listening.
107 * @throws IOException
108 * if the connection cannot be opened
110 public TestEmailReceiver(SocketAddress target) throws IOException {
113 s.setKeepAlive(true);
114 s.setSoTimeout(1000 * 60 * 60);
115 dis = new DataInputStream(s.getInputStream());
116 dos = new DataOutputStream(s.getOutputStream());
121 * Spawns a new {@link Thread} that reads incoming {@link TestMail}s.
125 public void start() {
126 new Thread(this, "Mail reciever").start();
129 private LinkedBlockingQueue<TestMail> mails = new LinkedBlockingQueue<TestEmailReceiver.TestMail>();
132 * Retrieves an outgoing mail from the system. The method will return a
133 * {@link TestMail} or fail.
135 * @return The intercepted {@link TestMail}
138 public TestMail receive() {
142 poll = mails.poll(60, TimeUnit.SECONDS);
144 } catch (InterruptedException e) {
145 throw new AssertionError("Interrupted while recieving mails");
148 throw new AssertionError("Mail recieving timed out");
155 * Retrieves an outgoing mail from the system or returns <code>null</code>
156 * if there was no mail sent in 30 seconds.
158 * @return The intercepted {@link TestMail} or <code>null</code> if no mail
162 public TestMail poll() {
170 String type = dis.readUTF();
171 if (type.equals("mail")) {
172 String to = dis.readUTF();
173 String subject = dis.readUTF();
174 String message = dis.readUTF();
175 String from = dis.readUTF();
176 String replyto = dis.readUTF();
177 mails.add(new TestMail(to, subject, message, from, replyto));
178 } else if (type.equals("challengeAddrBox")) {
179 String email = dis.readUTF();
180 dos.writeUTF(quickEmailCheck(email));
182 } else if (type.equals("ping")) {
184 System.err.println("Unknown type: " + type);
187 } catch (IOException e) {
195 private String quickEmailCheck(String email) throws IOException {
196 if (approveRegex.matcher(email).matches()) {
203 String error = "FAIL";
206 * Sets the error that will be sent back to incoming "fast mail checks" that
207 * only check for the availability of a mailbox.
210 * the error Massage to return in
211 * {@link EmailProvider#checkEmailServer(int, String)}
213 public void setEmailCheckError(String error) {
217 private Pattern approveRegex = Pattern.compile(".*");
220 * Specifies a pattern that will be used for incoming
221 * {@link EmailProvider#checkEmailServer(int, String)} calls to determine
222 * whether the mailbox should exist.
224 * @param approveRegex
225 * the regex that will perform the check
227 public void setApproveRegex(Pattern approveRegex) {
228 this.approveRegex = approveRegex;
232 * Removes all queued mails.
234 public void clearMails() {
239 * Resets this class to its initial state
242 * @see #setApproveRegex(Pattern)
243 * @see #setEmailCheckError(String)
245 public void reset() {
248 approveRegex = Pattern.compile(".*");
251 private boolean closed = false;
254 * stops reading for incoming messages
258 public void destroy() {
262 } catch (IOException e) {
268 public String checkEmailServer(int forUid, String address) throws IOException {
269 return quickEmailCheck(address);
273 public void sendmail(String to, String subject, String message, String from, String replyto, String toname, String fromname, String errorsto, boolean extra) throws IOException {
274 mails.add(new TestMail(to, subject, message, from, replyto));