com.github.sleroy.junit.mail.server.test.FakeSmtpRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fakesmtp-junit-runner Show documentation

JUnit Rule to create a FakeSmtp server to write mailing integration tests

There is a newer version: 0.1.1

Show newest version

/*
 *
 */
package com.github.sleroy.junit.mail.server.test;

import java.util.List;

import org.junit.rules.ExternalResource;

import com.github.sleroy.fakesmtp.core.ServerConfiguration;
import com.github.sleroy.fakesmtp.model.EmailModel;
import com.github.sleroy.junit.mail.server.MailServer;

/**
 * The Class FakeSmtpRule defines a JUnit Rule to start/stop a SMTP Server. It
 * can be useful to write integration tests with JavaMail libraries. The
 * configuration of the server has to provided in argument of the constructor.
 */
public class FakeSmtpRule extends ExternalResource {

    /** The server configuration. */
    private final ServerConfiguration serverConfiguration;

    /** The mail server. */
    private MailServer mailServer;

    /**
     * Instantiates a new fake smtp rule.
     *
     * @param serverConfiguration
     *            the server configuration
     */
    public FakeSmtpRule(final ServerConfiguration serverConfiguration) {
	super();
	this.serverConfiguration = serverConfiguration;
    }

    /*
     * (non-Javadoc)
     *
     * @see org.junit.rules.ExternalResource#after()
     */
    @Override
    protected void after() {
	super.after();
	try {
	    if (mailServer != null) {
		mailServer.close();
	    }
	    mailServer = null;
	} catch (final Exception e) {
	    throw new FakeSmtpRuleException(e);
	}
    }

    /*
     * (non-Javadoc)
     *
     * @see org.junit.rules.ExternalResource#before()
     */
    @Override
    protected void before() throws Throwable {
	mailServer = new MailServer(serverConfiguration);
	mailServer.start();
    }

    /**
     * Gets the server configuration.
     *
     * @return the server configuration
     */
    public ServerConfiguration getServerConfiguration() {
	return serverConfiguration;
    }

    /**
     * Checks if the server is running.
     *
     * @return true, if is running
     */
    public boolean isRunning() {

	return mailServer != null && mailServer.isRunning();
    }

    /**
     * Returns the list of mails from the server.
     *
     * @return the list of mails from the server
     */
    public List mailBox() {

	return mailServer.getMails();
    }

    /**
     * Returns the list of rejected mails.
     *
     * @return the list of rejected mails
     */
    public List rejectedMails() {
	return mailServer.getRejectedMails();
    }

    /**
     * Returns the list of domains to relay.
     *
     * @return the list of domains to relay.
     */
    public List relayDomains() {

	return mailServer.getRelayDomains();
    }

}