punktde / codeception-maildev
Provides a module and gherkin steps to access a maildev api for codeception testing
Installs: 10 958
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 6
Forks: 1
Open Issues: 2
Requires
- codeception/codeception: ^4.0 || ^5.0
- codeception/module-webdriver: ^3.0
- neos/utility-arrays: *
README
Gherkin Steps and module functions to test using MailDev
How to use
Prequesits
You have to have MailDev installed and have your application configured to send mails to maildev. See https://github.com/maildev/maildev
Module
You have to add the Webdriver
module to your config to use the MailDev
module.
Use the module PunktDe\Codeception\MailDev\Module\MailDev
in your codeception.yaml
. You can configure under which uri the maildev client is reachable (default is http://127.0.0.1:8025)
modules: enabled: - WebDriver: url: 'http://acceptance.dev.punkt.de/' browser: chrome restart: true window_size: 1920x2080 capabilities: chromeOptions: args: - '--headless' - '--disable-gpu' - '--disable-dev-shm-usage' - '--no-sandbox' - PunktDe\Codeception\MailDev\Module\MailDev: base_uri: http://maildev.project
You can add authentication parameters to authenticate with the guzzle client when necessary. For futher details see https://docs.guzzlephp.org/en/latest/request-options.html#auth
modules: enabled: - PunktDe\Codeception\MailDev\Module\MailDev: base_uri: http://maildev.project username: 'user' password: 'secret' atheticationType: 'basic'
Gherkin steps
Just add the trait PunktDe\Codeception\MailDev\ActorTraits\MailDev
to your testing actor. Then you can use *.feature
files to write your gherkin tests with the new steps.
Example actor
<?php /* * (c) 2018 punkt.de GmbH - Karlsruhe, Germany - http://punkt.de * All rights reserved. */ /** * Inherited Methods * @method void wantToTest($text) * @method void wantTo($text) * @method void execute($callable) * @method void expectTo($prediction) * @method void expect($prediction) * @method void amGoingTo($argumentation) * @method void am($role) * @method void lookForwardTo($achieveValue) * @method void comment($description) * @method \Codeception\Lib\Friend haveFriend($name, $actorClass = NULL) * * @SuppressWarnings(PHPMD) */ class AcceptanceTester extends \Codeception\Actor { use _generated\AcceptanceTesterActions; use \PunktDe\Codeception\MailDev\ActorTraits\MailDev; // use the maildev steps trait }
Which steps are there?
To get all the steps available you can just run the following command:
vendor/bin/codecept -c path/to/codeception.yaml gherkin:steps suiteName
This will give you a table of all the steps available.