Thursday, April 26, 2012

Тестирование Java Mail API

В данной статье я хочу рассказать об одном очень простом способе тестировать код, который использует Java Mail API.

Трудности в тестировании такого кода следующие:

  1. отправка сообщения осуществляется при помощи статического метода javax.mail.Transport.send, и его сложно "замочить"
  2. для тестирование необходим почтовый сервер, через который будут отправляться сообщения
  3. нужно писать клиента, чтобы сравить то, чтобы было отправлено, с тем, что было получено
  4. если несколько разработчиков одновременно запустят тесты, то на сервер придут дубликаты, чтобы избежать конфликтов, надо усложнять тесты и генерировался какой-нибудь иникальный идентификатор и по нему уже искать сообщения


Можно, конечно, "замочить" javax.mail.Transport.send. Существует много мок-фреймворков, которые позволяют это сделать, но есть способ лучше и проще!

Дело в том, что разработчики Java Mail API предусмотрели возможность расширения путем регистрации своих провайдеров в файле META-INF/javamail.providers. Не буду вдаваться в технические подробности, так как я из не знаю :)

Благо есть на свете люди, которые уже подумали об этом и написали такой мок-провайдер: http://java.net/projects/mock-javamail. Чтобы его спользовать достаточно в classpath добавить mock-javamail.jar и все.

Данный провайдер работает как in-memory почтовый сервер. Это означает, что все отправленные сообщения сохраняются в почтовых ящиках, из которых их можно извлечь. С каждым уникальным почтовым адресом связан один почтовый ящик, который создается автоматически, при отправке сообщения.

Доступ к ящику осуществляется через класс Mailbox. Данный класс отвечает за хранение пришедших сообщений в обычной коллекции и позволяет добавлять/удалять сообщения, получать количество новых сообщений. Кроме того, данный класс имеет два статических фабричных метода, которые возвращают объект почтового ящика по переданному почтовому адресу (если ящика нет, он будет создан). Ниже показан пример вызова:
Mailbox mailbox = Mailbox.get("some@email.com");
Еще один статический метод, который, на мой взгляд, заслуживает внимания: Mailbox.clearAll(). Этот метод удаляет все почтовые ящики. Полезно вызывать перед началом теста, чтобы не мешались данные от предыдущих. Пример использования:
Mailbox.clearAll();
Ниже я приведу пример использования данного провайдера:
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemalocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>ru.nikisoft.article</groupId>
  <artifactId>mock-javamail</artifactId>
  <version>1.0.0</version>
  <packaging>jar</packaging>
  <dependencies>
    <dependency>
      <groupId>org.jvnet.mock-javamail</groupId>
      <artifactId>mock-javamail</artifactId>
      <version>1.11</version>
    </dependency>
  </dependencies>
</project>
package ru.nikisoft.article.mockjavamail;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;

import java.io.IOException;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;

import javax.mail.Address;
import javax.mail.Message;
import javax.mail.Message.RecipientType;
import javax.mail.MessagingException;

import org.junit.Test;
import org.jvnet.mock_javamail.Mailbox;

public class MailSenderTest
{
  @Test
  public void testSend() throws MessagingException, IOException
  {
    Mailbox.clearAll();
    Mailbox mailbox = Mailbox.get("to@email.com");

    MailSender mailSender = new MailSender("smtp.host", "from@email.com");
    mailSender.send("to@email.com", "Subject: testSend", "Body: testSend");

    assertEquals(1, mailbox.getNewMessageCount());
    assertFromEquals(mailbox.get(0), "from@email.com");
    assertToEquals(mailbox.get(0), "to@email.com");
    assertSubjectEquals(mailbox.get(0), "Subject: testSend");
    assertBodyEquals(mailbox.get(0), "Body: testSend");
  }

  private void assertFromEquals(Message message, String... expectedFrom) throws MessagingException
  {
    Set<String> expectedFromSet = new HashSet<String>(Arrays.asList(expectedFrom));

    for (Address actualFrom: message.getFrom())
    {
      expectedFromSet.remove(actualFrom.toString());
    }

    if (expectedFromSet.size() > 0)
      fail("From should contain these addresses: " + expectedFromSet);
  }

  private void assertToEquals(Message message, String... expectedTo) throws MessagingException
  {
    Set<String> expectedToSet = new HashSet<String>(Arrays.asList(expectedTo));

    for (Address actualFrom: message.getRecipients(RecipientType.TO))
    {
      expectedToSet.remove(actualFrom.toString());
    }

    if (expectedToSet.size() > 0)
      fail("From should contain these addresses: " + expectedToSet);
  }

  private void assertSubjectEquals(Message message, String expectedSubject) throws MessagingException
  {
    String actualSubject = message.getSubject();
    assertEquals(expectedSubject, actualSubject);
  }

  private void assertBodyEquals(Message message, String expectedBody) throws IOException, MessagingException
  {
    String contentType = message.getContentType();

    if (contentType.contains("text/plain"))
    {
      String actualBody = (String) message.getContent();
      assertEquals(expectedBody, actualBody);
      return;
    }

    fail("Unsupported content-type: " + contentType);
  }
}
package ru.nikisoft.article.mockjavamail;

import java.util.Properties;

import javax.mail.Message.RecipientType;
import javax.mail.MessagingException;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;

public class MailSender
{
  private Properties properties;

  public MailSender(String host, String from)
  {
    properties = new Properties();
    properties.put("mail.transport.protocol", "smtp");
    properties.put("mail.smtp.host", host);
    properties.put("mail.from", from);
  }

  public void send(String to, String subject, String body) throws MessagingException
  {
    Session session = Session.getDefaultInstance(properties);
    MimeMessage message = new MimeMessage(session);
    message.setFrom(InternetAddress.getLocalAddress(session));
    message.setRecipients(RecipientType.TO, to);
    message.setSubject(subject);
    message.setText(body);

    Transport.send(message);
  }
}

Monday, April 23, 2012

Сбор статистики использования классов при помощи Cobertura

На текущем проекте появилась необходимость получить список неиспользуемых классов с целью избавиться от них :)

Так как классов много и связи между ними не всегда можно отследить в IDE - сейчас редкий проект обходится без использования Spring, но мне, в очередной раз, повезло. У нас испольуется самописаное решение, которое пришлось немного доработать и научить делать dependency-injection, чтобы развязать классы между собой и начать по-тихоньку избавляться от синглтонов, которые только портят жизнь.

Для оценки покрытия кода тестами у нас используется Cobertura. Именно по этому я решил использовать именно ее для сбора статистики использования классов - мне для этого пришлось просто добавить сборку инструментированного jar-файла, который так же должен попадать в итоговую сборку.

Собственно сам сбор статистики заключается в том, чтобы инструментированные классы использовались приложением во время работы. Все в точности как и при оценке покрытия за тем лишь исключением, что мы гоняем не тесты, а реально работающее приложение на одном из тестовых стендов.

Ниже представлен пример Ant-скрипта, который инструментирует классы:
<?xml version="1.0" encoding="UTF-8"?>
<project name="UsageStatistics" basedir=".">
  <property name="src.main.java" location="${basedir}/src/main/java" />
  <property name="src.test.java" location="${basedir}/src/test/java" />
  <property name="lib" location="${basedir}/lib" />
  <property name="target" location="${basedir}/target" />
  <property name="target.compile" location="${target}/compile" />
  <property name="target.compile.classes" location="${target.compile}/classes" />
  <property name="target.instrument" location="${target}/instrument" />
  <property name="target.instrument.classes" location="${target.instrument}/classes" />
  <property name="target.instrument.report" location="${target.instrument}/report" />
  <property name="target.test" location="${target}/test" />
  <property name="target.test.classes" location="${target.test}/classes" />
  <property name="target.test.report" location="${target.test}/report" />
  <property name="target.package" location="${target}/package" />

  <target name="compile">
    <mkdir dir="${target.compile.classes}" />
    <javac srcdir="${src.main.java}" destdir="${target.compile.classes}" source="1.5" debug="on" debuglevel="lines,source">
      <classpath>
        <fileset dir="${lib}" includes="**/*.jar" />
      </classpath>
    </javac>
  </target>

  <target name="instrument" depends="compile">
    <mkdir dir="${target.instrument.classes}" />
    <copy todir="${target.instrument.classes}">
      <fileset dir="${target.compile.classes}" includes="**/*"/>
    </copy>

    <cobertura-instrument todir="${target.instrument.classes}" datafile="${target.instrument}/cobertura.ser">
      <fileset dir="${target.instrument.classes}" includes="**/*.class"/>
    </cobertura-instrument>

    <copy file="${target.cobertura}/cobertura.ser" tofile="${target.cobertura}/cobertura-clean.ser"/>
  </target>

  <target name="test-compile" depends="instrument">
    <mkdir dir="${target.test.classes}" />
    <javac srcdir="${src.test.java}" destdir="${target.test.classes}" source="1.5" debug="on" debuglevel="lines,source">
      <classpath>
        <fileset dir="${target.instrument.classes}" includes="**/*" />
        <fileset dir="${lib}" includes="**/*.jar" />
      </classpath>
    </javac>
  </target>

  <target name="test" description="Run tests" depends="compile-test" unless="test.skip">
    <mkdir dir="${target.test}" />
    <mkdir dir="${target.test.report}" />
    <junit printsummary="true" fork="yes" forkmode="once">
      <classpath>
        <pathelement location="${target.instrument.classes}"/>
        <pathelement location="${target.test.classes}"/>
        <fileset dir="${lib}" includes="**/*.jar" />
      </classpath>
      <sysproperty key="net.sourceforge.cobertura.datafile" file="${target.instrument}/cobertura.ser" />
      <batchtest todir="${target.test.report}">
        <fileset dir="${target.compile.test}">
          <include name="**/*Test.class"/>
        </fileset>
        <formatter type="xml"/>
      </batchtest>
    </junit>

    <cobertura-report datafile="${target.instrument}/cobertura.ser" format="html" destdir="${target.instrument.report}" srcdir="${src.main.java}" />
  </target>

  <target name="package" depends="test">
    <mkdir dir="${target.package}" />
    <jar jarfile="${target.package}/package.jar" basedir="${target.compile.classes}"/>
    <jar jarfile="${target.package}/package-instrumented.jar" basedir="${target.instrument.classes}"/>
  </target> 
</project>
Очень важное замечание: во время инструментации Cobertura генерирует файл, в который записывается информация о обо всех существеющих классах , его же и нужно использовать во время сбора статистики. В противном случае Cobertura создаст новый файл, в которои будет информация только о тех классах, которые использовались приложением и пользы от него будет 0. Поэтому не забывайте копировать этот файл на сервер, где будет работать ваше приложение.

Для того, чтобы Cobertura на сервере нашла этот файл приложению нужно каким-то образом передать путь к файлу. Есть несколько способов это сделать:
  • положить файл cobertura.properties в classpath приложения и в нем прописать net.sourceforge.cobertura.datafile=/путь/к/файлу
  • педедать параметр JVM -Dnet.sourceforge.cobertura.datafile=/путь/к/файлу

Если ваше приложение состоит из нескольких Java-процессов, они могут безопасно использовать один и тот же файл для сбора статистики.

Ниже приведены скриншоты отчетов статистики и покрытия для сравнения. Сейчас уже разница не такая большая, так как часть пакетов я уже удалил :)

Отчет статистики использования классов
Usage Statistics

Покрытие кода тестами Coverage Report

Сравнивая отчеты можно заметить, что package23 используется, хотя тестами не покрыт, package22 не используется, но при этом покрыт тестами, пакеты package16, package24, package25 - не используются.