/* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You 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 * * http://www.apache.org/licenses/LICENSE-2.0 * * 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 org.apache.tools.mail; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import java.io.BufferedReader; import java.io.BufferedWriter; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.io.PrintStream; import java.net.InetAddress; import java.net.ServerSocket; import java.net.Socket; import java.util.Vector; import org.apache.tools.ant.BuildException; import org.junit.AssumptionViolatedException; import org.junit.Before; import org.junit.Test; /** * JUnit testcases for org.apache.tools.mail.MailMessage. * * @since Ant 1.6 */ public class MailMessageTest { // 27224 = magic (a random port which is unlikely to be in use) private static int TEST_PORT = 27224; private String local = null; @Before public void setUp() { try { local = InetAddress.getLocalHost().getHostName(); } catch (java.net.UnknownHostException uhe) { // ignore } } /** * Test an example that is similar to the one given in the API * If this testcase takes >90s to complete, it is very likely that * the two threads are blocked waiting for each other and Thread.join() * timed out. * @throws InterruptedException if something goes wrong */ @Test public void testAPIExample() throws InterruptedException { final int port = TEST_PORT + 1; ServerThread testMailServer = new ServerThread(port); Thread server = new Thread(testMailServer); server.start(); ClientThread testMailClient = new ClientThread(port); testMailClient.from("Mail Message "); testMailClient.to("to@you.com"); testMailClient.cc("cc1@you.com"); testMailClient.cc("cc2@you.com"); testMailClient.bcc("bcc@you.com"); testMailClient.setSubject("Test subject"); testMailClient.setMessage("test line 1\n" + "test line 2"); Thread client = new Thread(testMailClient); client.start(); server.join(60 * 1000); // 60s client.join(30 * 1000); // a further 30s String result = testMailServer.getResult(); String expectedResult = "220 test SMTP EmailTaskTest\r\n" + "HELO " + local + "\r\n" + "250 " + local + " Hello " + local + " [127.0.0.1], pleased to meet you\r\n" + "MAIL FROM: \r\n" + "250\r\n" + "RCPT TO: \r\n" + "250\r\n" + "RCPT TO: \r\n" + "250\r\n" + "RCPT TO: \r\n" + "250\r\n" + "RCPT TO: \r\n" + "250\r\n" + "DATA\r\n" + "354\r\n" + "Subject: Test subject\r\n" + "From: Mail Message \r\n" + "To: to@you.com\r\n" + "Cc: cc1@you.com, cc2@you.com\r\n" + "X-Mailer: org.apache.tools.mail.MailMessage (ant.apache.org)\r\n" + "\r\n" + "test line 1\r\n" + "test line 2\r\n" + "\r\n" + ".\r\n" + "250\r\n" + "QUIT\r\n" + "221\r\n"; assertEquals(expectedResult, result); // order of headers cannot be guaranteed assertFalse(testMailClient.getFailMessage(), testMailClient.isFailed()); } /** * Test a MailMessage with no cc or bcc lines * @throws InterruptedException if something goes wrong */ @Test public void testToOnly() throws InterruptedException { final int port = TEST_PORT + 2; ServerThread testMailServer = new ServerThread(port); Thread server = new Thread(testMailServer); server.start(); ClientThread testMailClient = new ClientThread(port); testMailClient.from("Mail Message "); testMailClient.to("to@you.com"); testMailClient.setSubject("Test subject"); testMailClient.setMessage("test line 1\n" + "test line 2"); Thread client = new Thread(testMailClient); client.start(); server.join(60 * 1000); // 60s client.join(30 * 1000); // a further 30s String result = testMailServer.getResult(); String expectedResult = "220 test SMTP EmailTaskTest\r\n" + "HELO " + local + "\r\n" + "250 " + local + " Hello " + local + " [127.0.0.1], pleased to meet you\r\n" + "MAIL FROM: \r\n" + "250\r\n" + "RCPT TO: \r\n" + "250\r\n" + "DATA\r\n" + "354\r\n" + "Subject: Test subject\r\n" + "From: Mail Message \r\n" + "To: to@you.com\r\n" + "X-Mailer: org.apache.tools.mail.MailMessage (ant.apache.org)\r\n" + "\r\n" + "test line 1\r\n" + "test line 2\r\n" + "\r\n" + ".\r\n" + "250\r\n" + "QUIT\r\n" + "221\r\n"; assertEquals(expectedResult, result); // order of headers cannot be guaranteed assertFalse(testMailClient.getFailMessage(), testMailClient.isFailed()); } /** * Test a MailMessage with no to or bcc lines * @throws InterruptedException if something goes wrong */ @Test public void testCcOnly() throws InterruptedException { final int port = TEST_PORT + 3; ServerThread testMailServer = new ServerThread(port); Thread server = new Thread(testMailServer); server.start(); ClientThread testMailClient = new ClientThread(port); testMailClient.from("Mail Message "); testMailClient.cc("cc@you.com"); testMailClient.setSubject("Test subject"); testMailClient.setMessage("test line 1\n" + "test line 2"); Thread client = new Thread(testMailClient); client.start(); server.join(60 * 1000); // 60s client.join(30 * 1000); // a further 30s String result = testMailServer.getResult(); String expectedResult = "220 test SMTP EmailTaskTest\r\n" + "HELO " + local + "\r\n" + "250 " + local + " Hello " + local + " [127.0.0.1], pleased to meet you\r\n" + "MAIL FROM: \r\n" + "250\r\n" + "RCPT TO: \r\n" + "250\r\n" + "DATA\r\n" + "354\r\n" + "Subject: Test subject\r\n" + "From: Mail Message \r\n" + "Cc: cc@you.com\r\n" + "X-Mailer: org.apache.tools.mail.MailMessage (ant.apache.org)\r\n" + "\r\n" + "test line 1\r\n" + "test line 2\r\n" + "\r\n" + ".\r\n" + "250\r\n" + "QUIT\r\n" + "221\r\n"; assertEquals(expectedResult, result); assertFalse(testMailClient.getFailMessage(), testMailClient.isFailed()); } /** * Test a MailMessage with no to or cc lines * @throws InterruptedException if something goes wrong */ @Test public void testBccOnly() throws InterruptedException { final int port = TEST_PORT + 4; ServerThread testMailServer = new ServerThread(port); Thread server = new Thread(testMailServer); server.start(); ClientThread testMailClient = new ClientThread(port); testMailClient.from("Mail Message "); testMailClient.bcc("bcc@you.com"); testMailClient.setSubject("Test subject"); testMailClient.setMessage("test line 1\n" + "test line 2"); Thread client = new Thread(testMailClient); client.start(); server.join(60 * 1000); // 60s client.join(30 * 1000); // a further 30s String result = testMailServer.getResult(); String expectedResult = "220 test SMTP EmailTaskTest\r\n" + "HELO " + local + "\r\n" + "250 " + local + " Hello " + local + " [127.0.0.1], pleased to meet you\r\n" + "MAIL FROM: \r\n" + "250\r\n" + "RCPT TO: \r\n" + "250\r\n" + "DATA\r\n" + "354\r\n" + "Subject: Test subject\r\n" + "From: Mail Message \r\n" + "X-Mailer: org.apache.tools.mail.MailMessage (ant.apache.org)\r\n" + "\r\n" + "test line 1\r\n" + "test line 2\r\n" + "\r\n" + ".\r\n" + "250\r\n" + "QUIT\r\n" + "221\r\n"; assertEquals(expectedResult, result); assertFalse(testMailClient.getFailMessage(), testMailClient.isFailed()); } /** * Test a MailMessage with no subject line * Subject is an optional field (RFC 822 s4.1) * @throws InterruptedException if something goes wrong */ @Test public void testNoSubject() throws InterruptedException { final int port = TEST_PORT + 5; ServerThread testMailServer = new ServerThread(port); Thread server = new Thread(testMailServer); server.start(); ClientThread testMailClient = new ClientThread(port); testMailClient.from("Mail Message "); testMailClient.to("to@you.com"); testMailClient.setMessage("test line 1\n" + "test line 2"); Thread client = new Thread(testMailClient); client.start(); server.join(60 * 1000); // 60s client.join(30 * 1000); // a further 30s String result = testMailServer.getResult(); String expectedResult = "220 test SMTP EmailTaskTest\r\n" + "HELO " + local + "\r\n" + "250 " + local + " Hello " + local + " [127.0.0.1], pleased to meet you\r\n" + "MAIL FROM: \r\n" + "250\r\n" + "RCPT TO: \r\n" + "250\r\n" + "DATA\r\n" + "354\r\n" + "From: Mail Message \r\n" + "To: to@you.com\r\n" + "X-Mailer: org.apache.tools.mail.MailMessage (ant.apache.org)\r\n" + "\r\n" + "test line 1\r\n" + "test line 2\r\n" + "\r\n" + ".\r\n" + "250\r\n" + "QUIT\r\n" + "221\r\n"; assertEquals(expectedResult, result); assertFalse(testMailClient.getFailMessage(), testMailClient.isFailed()); } /** * Test a MailMessage with empty body message * @throws InterruptedException if something goes wrong */ @Test public void testEmptyBody() throws InterruptedException { final int port = TEST_PORT + 6; ServerThread testMailServer = new ServerThread(port); Thread server = new Thread(testMailServer); server.start(); ClientThread testMailClient = new ClientThread(port); testMailClient.from("Mail Message "); testMailClient.to("to@you.com"); testMailClient.setSubject("Test subject"); testMailClient.setMessage(""); Thread client = new Thread(testMailClient); client.start(); server.join(60 * 1000); // 60s client.join(30 * 1000); // a further 30s String result = testMailServer.getResult(); String expectedResult = "220 test SMTP EmailTaskTest\r\n" + "HELO " + local + "\r\n" + "250 " + local + " Hello " + local + " [127.0.0.1], pleased to meet you\r\n" + "MAIL FROM: \r\n" + "250\r\n" + "RCPT TO: \r\n" + "250\r\n" + "DATA\r\n" + "354\r\n" + "Subject: Test subject\r\n" + "From: Mail Message \r\n" + "To: to@you.com\r\n" + "X-Mailer: org.apache.tools.mail.MailMessage (ant.apache.org)\r\n" + "\r\n" + "\r\n" + "\r\n" + ".\r\n" + "250\r\n" + "QUIT\r\n" + "221\r\n"; assertEquals(expectedResult, result); assertFalse(testMailClient.getFailMessage(), testMailClient.isFailed()); } /** * Test a MailMessage with US-ASCII character set * The next four testcase can be kinda hard to debug as Ant will often * print the junit failure in US-ASCII. * @throws InterruptedException if something goes wrong */ @Test public void testAsciiCharset() throws InterruptedException { final int port = TEST_PORT + 7; ServerThread testMailServer = new ServerThread(port); Thread server = new Thread(testMailServer); server.start(); ClientThread testMailClient = new ClientThread(port); testMailClient.from("Mail Message "); testMailClient.to("Ceki G\u00fclc\u00fc "); testMailClient.setSubject("Test subject"); testMailClient.setMessage(""); Thread client = new Thread(testMailClient); client.start(); server.join(60 * 1000); // 60s client.join(30 * 1000); // a further 30s String result = testMailServer.getResult(); String expectedResult = "220 test SMTP EmailTaskTest\r\n" + "HELO " + local + "\r\n" + "250 " + local + " Hello " + local + " [127.0.0.1], pleased to meet you\r\n" + "MAIL FROM: \r\n" + "250\r\n" + "RCPT TO: \r\n" + "250\r\n" + "DATA\r\n" + "354\r\n" + "Subject: Test subject\r\n" + "From: Mail Message \r\n" + "To: Ceki G\u00fclc\u00fc \r\n" + "X-Mailer: org.apache.tools.mail.MailMessage (ant.apache.org)\r\n" + "\r\n" + "\r\n" + "\r\n" + ".\r\n" + "250\r\n" + "QUIT\r\n" + "221\r\n"; ByteArrayOutputStream baos1 = new ByteArrayOutputStream(); ByteArrayOutputStream baos2 = new ByteArrayOutputStream(); PrintStream bos1 = new PrintStream(baos1, true); PrintStream bos2 = new PrintStream(baos2, true); bos1.print(expectedResult); bos2.print(result); assertEquals("baos1 and baos2 should be the same in testAsciiCharset()", baos1.toString(), baos2.toString()); // order of headers cannot be guaranteed assertFalse(testMailClient.getFailMessage(), testMailClient.isFailed()); } /** * A private test class that pretends to be a mail transfer agent */ private class ServerThread implements Runnable { private final int port; private StringBuilder sb = null; private boolean loop = false; ServerSocket ssock = null; Socket sock = null; BufferedWriter out = null; BufferedReader in = null; private boolean data = false; // state engine: false=envelope, true=message ServerThread(int port) { this.port = port; } public void run() { try { ssock = new ServerSocket(port); sock = ssock.accept(); // wait for connection in = new BufferedReader(new InputStreamReader( sock.getInputStream())); out = new BufferedWriter(new OutputStreamWriter( sock.getOutputStream())); sb = new StringBuilder(); send("220 test SMTP EmailTaskTest\r\n"); loop = true; while (loop) { String response = in.readLine(); if (response == null) { loop = false; break; } sb.append(response).append("\r\n"); if (!data && response.startsWith("HELO")) { send("250 " + local + " Hello " + local + " " + "[127.0.0.1], pleased to meet you\r\n"); } else if (!data && response.startsWith("MAIL")) { send("250\r\n"); } else if (!data && response.startsWith("RCPT")) { send("250\r\n"); } else if (!data && response.startsWith("DATA")) { send("354\r\n"); data = true; } else if (data && response.equals(".")) { send("250\r\n"); data = false; } else if (!data && response.startsWith("QUIT")) { send("221\r\n"); loop = false; } else if (!data) { //throw new IllegalStateException("Command unrecognized: " // + response); send("500 5.5.1 Command unrecognized: \"" + response + "\"\r\n"); loop = false; } else { // sb.append(response + "\r\n"); } } // while } catch (IOException ioe) { throw new BuildException(ioe); } finally { disconnect(); } } private void send(String retmsg) throws IOException { out.write(retmsg); out.flush(); sb.append(retmsg); } private void disconnect() { if (out != null) { try { out.flush(); out.close(); out = null; } catch (IOException e) { // ignore } } if (in != null) { try { in.close(); in = null; } catch (IOException e) { // ignore } } if (sock != null) { try { sock.close(); sock = null; } catch (IOException e) { // ignore } } if (ssock != null) { try { ssock.close(); ssock = null; } catch (IOException e) { // ignore } } } public synchronized String getResult() { loop = false; return sb.toString(); } } /** * A private test class that wraps MailMessage */ private class ClientThread implements Runnable { private final int port; private MailMessage msg; private boolean fail = false; private String failMessage = null; protected String from = null; protected String subject = null; protected String message = null; protected Vector replyToList = new Vector<>(); protected Vector toList = new Vector<>(); protected Vector ccList = new Vector<>(); protected Vector bccList = new Vector<>(); ClientThread(int port) { this.port = port; } public void run() { for (int i = 9; i > 0; i--) { try { msg = new MailMessage("localhost", port); } catch (java.net.ConnectException ce) { try { Thread.sleep(10 * 1000); } catch (InterruptedException ie) { throw new AssumptionViolatedException("Thread interrupted", ie); } } catch (IOException ioe) { fail = true; failMessage = "IOException: " + ioe; return; } if (msg != null) { break; } } if (msg == null) { fail = true; failMessage = "java.net.ConnectException: Connection refused"; return; } try { msg.from(from); replyToList.forEach(e -> msg.replyto(e)); for (String e : toList) { msg.to(e); } for (String e : ccList) { msg.cc(e); } for (String e : bccList) { msg.bcc(e); } if (subject != null) { msg.setSubject(subject); } if (message != null) { PrintStream out = msg.getPrintStream(); out.println(message); } msg.sendAndClose(); } catch (IOException ioe) { fail = true; failMessage = "IOException: " + ioe; } } public boolean isFailed() { return fail; } public String getFailMessage() { return failMessage; } @SuppressWarnings("unused") public void replyTo(String replyTo) { replyToList.add(replyTo); } public void to(String to) { toList.add(to); } public void cc(String cc) { ccList.add(cc); } public void bcc(String bcc) { bccList.add(bcc); } public void setSubject(String subject) { this.subject = subject; } public void from(String from) { this.from = from; } public void setMessage(String message) { this.message = message; } } }