hu.ibello.toolbox.email

Interface FakeEmailServer

public interface FakeEmailServer

This interface is designed for checking email communication during "ibello" tests. Some programs are sending emails to recipients, and in some cases we want to verify that an email with some attributes was sent. To use this tool you need to prepare your tests a little bit.

1. Firstly, you need to change you system under test and set the SMTP host and port for it. With this setting, all email communications originated by the system will go to the "fake" email server. (So the system will not send those emails to the real recipients, but you will be able to check them.)

   In many cases it is enough to set the mail.smtp.host system property to "localhost", and set the mail.smtp.port property to the port where we want to run our fake server. But the correct setup depends on the tested system - contact your developers if you are unsure about it.

2. Secondly, you need to add a FakeEmailServer instance to your step libraries, with the Inject annotation:

     @Inject
    private FakeEmailServer emailServer;
    

   The server is in session scope, but it controls a singleton SMTP server.

3. Before you want to use the email server, you need to start it. Call the start(int) method with your selected port number. Typically you can do this in a before-test block. It is not possible to start two servers on different ports in the same time.

4. At the end, you can stop the server with the stop() method. A good place for that is an after-test block. If you do not stop it, it will be automatically stopped after the test execution.

The expectations in this class are working similarly to other "ibello" expectations. They are also logged out and inserted into the result report. You can put them into complex expectations as well.

Author:

Kornél Simon

Method Summary

Modifier and Type	Method and Description
EmailExpectationBuilder	assumeLastEmail() Starts a soft expectation about the last email.
EmailExpectationBuilder	expectLastEmail() Starts a hard expectation about the last email.
FakeEmailServer	reset() Resets the email server and clears all emails from it.
FakeEmailServer	start(int port) Starts the email server on the given port.
FakeEmailServer	stop() Stops the email server.

Method Detail

start

FakeEmailServer start(int port)

Starts the email server on the given port. If the server was started on the given port, then this method does nothing. If the server was started on a different port, then the method will throw an exception.

Parameters:

port - the port where the server should be started

Returns:

the server instance

stop

FakeEmailServer stop()

Stops the email server. If it was not started, then does nothing.

Returns:

the server instance

reset

FakeEmailServer reset()

Resets the email server and clears all emails from it. Useful if we want to start with a clean state.

Returns:

the server instance

expectLastEmail

EmailExpectationBuilder expectLastEmail()

Starts a hard expectation about the last email.

Returns:

the builder object to build the expectation

assumeLastEmail

EmailExpectationBuilder assumeLastEmail()

Starts a soft expectation about the last email.

Returns:

the builder object to build the expectation