punktde / codeception-mailhog
Provides a module and gherkin steps to access a mailhog api for codeception testing
Installs: 8 677
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 6
Forks: 1
Open Issues: 4
Requires
- codeception/codeception: ^5.0
- codeception/module-webdriver: ^3.0 | ^4.0
- neos/utility-arrays: *
This package is auto-updated.
Last update: 2024-12-02 14:33:56 UTC
README
Gherkin Steps and module functions to test using Mailhog
How to use
Prequesits
You have to have Mailhog installed and have your application configured to send mails to mailhog. See https://github.com/mailhog/MailHog
Module
You have to add the Webdriver
module to your config to use the Mailhog
module.
Use the module PunktDe\Codeception\Mailhog\Module\Mailhog
in your codeception.yaml
. You can configure under which uri the mailhog 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\Mailhog\Module\Mailhog: base_uri: http://mailhog.project
Gherkin steps
Just add the trait PunktDe\Codeception\Mailhog\ActorTraits\Mailhog
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\Mailhog\ActorTraits\Mailhog; // use the mailhog 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.