https://github.com/punktde/codeception-maildev
https://github.com/punktde/codeception-maildev
codece maildev
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/punktde/codeception-maildev
- Owner: punktDe
- License: gpl-3.0
- Created: 2021-07-08T10:34:53.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-17T15:38:34.000Z (over 1 year ago)
- Last Synced: 2025-03-23T20:05:32.512Z (about 1 year ago)
- Topics: codece, maildev
- Language: PHP
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 6
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# punktde/codeception-maildev
## 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)
```yaml
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
```yaml
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