Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Release of FakeSmtp-Junit-Runner

DZone's Guide to

Release of FakeSmtp-Junit-Runner

The fakesmtp-junit-runner library is a JUnit extension which allows you to write integration tests where an SMTP server is required. Learn how to implement it here.

· DevOps Zone
Free Resource

Learn more about how CareerBuilder was able to resolve customer issues 5x faster by using Scalyr, the fastest log management tool on the market. 

Today, I released a new library to help developers to write integration tests with mail servers.

The library has been released on GitHub and Maven Central.

fakesmtp-junit-runner

fakesmtp-junit-runner can be found on GitHub.

Part of the source code of this library has been modified and adapted from the project of FakeSmtp. I want to thank him since his project inspired me the creation of that library.

This library is an extension to JUnit to allow developers to write integration tests where an SMTP server is required.

The how-to is quite simple:

  • Insert the @Rule in your integration tests.
  • a Fake SMTP Server will start.
  • You can send mail on it.
  • You can control the mailbox.
  • Write your own assertions to check mail.

Installation

The project requires JUnit 4.11 or higher. It also requires SLF4J API presents in the classpath. I did not bundle them in the library to avoid conflicts.

To use it, adds the library to your Maven or Gradle config script:

For Maven:

          < dependency > < groupId > com.github.sleroy < /groupId>          <artifactId>fakesmtp-junit-runner</artifactId > < version > 0.1 .1 < /version>          <scope>test</scope > < /dependency>

For Gradle:

          testCompile "com.github.sleroy:fakesmtp-junit-runner:0.1.1"        

Usage

Step 1:

Create a JUnit test:

          public class SmtpSendingClassTest & #123;                              @Test          public void testCase1() &# 123; & #125;                    &# 125;

Step 2:

Add the new JUnit rule with its configuration:

          public class SmtpSendingClassTest &#123;                    @Rule          public FakeSmtpRule smtpServer = new FakeSmtpRule(ServerConfiguration.create().port(2525).charset("UTF-8"));                    @Test          public void testCase1() &#123;                    &#125;                    &#125;        

Step 3:

You are ready to use it to control the mailbox or the server state:

          Assert.assertTrue(smtpServer.isRunning());        


          public class SmtpSendingClassTest &#123;                    @Rule          public FakeSmtpRule smtpServer = new FakeSmtpRule(ServerConfiguration.create().port(2525).charset("UTF-8"));                    @Test          public void testCase1() &#123;          Assert.assertTrue(smtpServer.isRunning());          Assert.assertTrue(smtpServer.mailbox().isEmpty());          &#125;                    &#125;        


Find out more about how Scalyr built a proprietary database that does not use text indexing for their log management tool.

Topics:
automation ,test ,java ,junit ,smtp ,integration

Published at DZone with permission of Sylvain Leroy. See the original article here.

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}