kibao/behat-mailcatcher-extension

MailCatcher extension for Behat

MailCatcher Extension

, _(*1)

MailCatcher is a super simple SMTP server which catches any message sent to it., _(*2)

MailCatcherExtension provides:, _(*3)

• Kibao\Behat\MailCatcherExtension\Context\MailCatcherAwareContext, which provides MailCatcher Client instance for your context.
• MailCatcherContext context which provides base step definitions for your contexts.

Installation

This extension requires:, _(*4)

• Behat 3.0+

Through Composer

1. Add MailCatcherExtension to your composer.json:, _(*5)

   {
       "require-dev": {
           ...
           "kibao/mailcatcher": "*@dev",
           "kibao/behat-mailcatcher-extension": "0.2.*@dev"
       }
   }
   

2. Install or update vendors:, _(*6)

   $ composer update kibao/mailcatcher kibao/behat-mailcatcher-extension
   

3. Activate extension in your behat.yml:, _(*7)

   default:
      # ...
      extensions:
           Kibao\Behat\MailCatcherExtension\Extension: ~
   

Configuration

Default configuration:, _(*8)

default:
    # ...
    extensions:
        Kibao\Behat\MailCatcherExtension\Extension:
            client:
                url:    http://localhost    # MailCatcher http url
                port:   1080                # MailCatcher http port
            purge_before_scenario:      true
            mailcatcher_client:         kibao.mailcatcher.client.default    # client service
            mailcatcher_connection:     kibao.mailcatcher.connection.guzzle # connection service

Usage

First of all you need to have installed MailCatcher., _(*9)

There are few options:, _(*10)

1. Extending RawMailCatcherContext in your feature suite. It provides you preconfigured MailCatcher with basic methods. RawMailCatcherContext doesn't provide any step definitions, so you can extend it in many contexts., _(*11)

2. Extending MailCatcherContext with one of your contexts. It provides you same things as RawMailCatcherContext and also predefined steps out of the box., _(*12)

3. Adding MailCatcherContext as context in your suite., _(*13)

   default:
     suites:
       my_suite:
         contexts:
           - FeatureContext
           - Kibao\Behat\MailCatcherExtension\Context\MailCatcherContext
   

4. Implementing MailCatcherAwareContext with your context. Target context must implement setMailCatcher(ClientInterface $mailcatcher). This method would be automatically called immediately after each context creation before each scenario. $mailcatcher will be preconfigured client based on your settings., _(*14)