/*
    * MailWorkerImpl tests
    *
    * TODO:
    * -- Replace string literals in tests with resources
    * -- Inject currently hard-coded dumbster port
    */
   
   package org.sourceforge.vlibrary.user.workers;
  
  import java.util.Iterator;
  import java.util.Properties;
  
  import javax.mail.Session;
  
  import junit.framework.TestCase;
  
  import org.apache.log4j.Logger;
  import org.sourceforge.vlibrary.TestUtils;
  
  import org.springframework.mail.MailSendException;
  import org.springframework.mail.SimpleMailMessage;
  
  import com.dumbster.smtp.SmtpMessage;
  
  public class MailSenderTest extends TestCase {
      
      
      private static Logger logger =
          Logger.getLogger(MailSenderTest.class.getName());
      protected DelegatingSimpleSmtpServer server = null;
      
      /** 
       * <p>Generate and return a new Dumbster mock SMPT server
       * (http://quintanasoft.com/dumbster/) listening on the designated
       * port. DelegatingSimpleSmtpServer exposes the port. </p>
       * 
       * <p>This method is a hacked version of the static start method in
       * Dumbster's SimpleSmtpServer.  The hack is to implement the fix in the
       * first patch against deadlock bug <> </p>
       */
      public static DelegatingSimpleSmtpServer newMockSmtpServer(int port) {
          
          logger.info("creating DelegatingSimpleSmtpServer listening on port "
                  + port);
          DelegatingSimpleSmtpServer ret = null;
          ret =  new DelegatingSimpleSmtpServer(port);
          logger.info("Starting DelegatingSimpleSmtpServer... ");
          ret.start();
          logger.info("returning DelegatingSimpleSmtpServer listening on port "
                  + port);
          return ret;
      }
      
      /** Test message */
      protected SimpleMailMessage message;
      protected String messageText = "Deep and thoughtful text";
      protected String subject = "Subject";
      protected String toAddress = "joe@schmoe.com";
      protected String fromAddress = "moe@schmoe.com";
      
      /** MailSender */
      protected MailSender mailSender=null; 
          
      public MailSenderTest(String testName) {
          super(testName);
      }
      
      protected void setUp() throws Exception {
          message = new SimpleMailMessage();
          message.setText(messageText);
          message.setTo(toAddress);
          message.setSubject(subject);
          message.setFrom(fromAddress); 
          
          // FIXME - spring up the port number
          server = newMockSmtpServer(2500);
          mailSender = newMailSender(server.getPort());
          logger.info("dumbster contents before test");
          TestUtils.logMessages(server.getDelegate(), logger);   
      }
      
      protected void tearDown() throws Exception {
          logger.info("dumbster contents after test");
          TestUtils.logMessages(server.getDelegate(), logger);   
          server.stop();
      }
      
      public static MailSender newMailSender(int port) {
          MailSender mailSender = new MailSenderImpl();
          mailSender.setPort(port);
          return mailSender;
      }
      
      public void testSendNoAuthNoTLS() throws Exception {
          logger.info("Entering");
          assertEquals("localhost", mailSender.getHost());
          assertFalse(mailSender.isAuthenticated());
          assertFalse(mailSender.isTls());
         mailSender.send(message);
         TestUtils.checkMessage(server, toAddress, subject, messageText);
         Session session = mailSender.getSession();
         Properties sessionProperties = session.getProperties();
         assertEquals("localhost", 
                 sessionProperties.getProperty("mail.smtp.host"));
         assertEquals("smtp",
                 sessionProperties.getProperty("mail.transport.protocol"));
         assertEquals("2500",
                 sessionProperties.getProperty("mail.smtp.port"));  
     }
     
     public void testSendAuthNoTLS() throws Exception {
         logger.info("Entering");
         mailSender.setAuthenticated(true);
         mailSender.setUser("joe");
         mailSender.setPassword("password");
         assertEquals("localhost", mailSender.getHost());
         assertTrue(mailSender.isAuthenticated());
         assertFalse(mailSender.isTls());
         mailSender.send(message);
         TestUtils.checkMessage(server, toAddress, subject, messageText);
         Session session = mailSender.getSession();
         Properties sessionProperties = session.getProperties();
         assertEquals("localhost", 
                 sessionProperties.getProperty("mail.smtp.host"));
         assertEquals("smtp",
                 sessionProperties.getProperty("mail.transport.protocol"));
         assertEquals("2500",
                 sessionProperties.getProperty("mail.smtp.port"));
         assertEquals("true",
                 sessionProperties.getProperty("mail.smtp.auth")); 
     }
     
     public void testSendAuthTLS() throws Exception {
         logger.info("Entering");
         mailSender.setAuthenticated(true);
         mailSender.setUser("joe");
         mailSender.setPassword("password");
         mailSender.setTls(true);
         assertEquals("localhost", mailSender.getHost());
         assertTrue(mailSender.isAuthenticated());
         assertTrue(mailSender.isTls());
         // Can't actually make tls connection, so just check session
         Session session = mailSender.getSession();
         Properties sessionProperties = session.getProperties();
         assertEquals("localhost", 
                 sessionProperties.getProperty("mail.smtps.host"));
         assertEquals("smtps",
                 sessionProperties.getProperty("mail.transport.protocol"));
         assertEquals("2500",
                 sessionProperties.getProperty("mail.smtp.socketFactory.port")); 
         assertEquals("true",
                 sessionProperties.getProperty("mail.smtps.auth"));  
     }
     
     public void testFailedSendBadPort() throws Exception {
         logger.info("Entering");
         try {
             mailSender.setPort(200);
             mailSender.send(message);
             fail("Expecting MailSendException");
         } catch (MailSendException ex) {
            // expected
         } 
     }
     
     public void testFailedSendBadHost() throws Exception {
         logger.info("Entering");
         try {
             mailSender.setHost("xxIDW%%^^*"); //no way this is the local host
             mailSender.send(message);
             fail("Expecting MailSendException");
         } catch (MailSendException ex) {
           // expected
         }  
     }
     
     public void testBatchSend() {
         logger.info("Entering");
         SimpleMailMessage[] messages = {message, message, message};
         mailSender.send(messages);
         assertEquals(3, server.getReceivedEmailSize());
         Iterator<SmtpMessage> emailIter = server.getReceivedEmail();
         while (emailIter.hasNext()) {
             SmtpMessage email = emailIter.next();
             assertEquals(toAddress,email.getHeaderValue("To"));
             assertEquals(subject, email.getHeaderValue("Subject"));
             assertEquals(messageText,email.getBody());
         }   
     }
     
     public void testSetSession() {
         logger.info("Entering");
         Properties props = new Properties();
         props.put("mail.smtp.host", "localhst");
         props.put("mail.smtp.port", "2400");
         props.put("mail.smtp.auth", "true");
         props.put("mail.transport.protocol", "smtps");
         Session session = Session.getInstance(props);
         mailSender.setSession(session);
         assertEquals("localhst", mailSender.getHost());
         assertEquals(2400, mailSender.getPort());
         assertTrue(mailSender.isAuthenticated());
         assertTrue(mailSender.isTls());   
     }
     
 }