https://github.com/selective-php/test-traits
Test Traits
https://github.com/selective-php/test-traits
php slim test
Last synced: about 2 months ago
JSON representation
Test Traits
- Host: GitHub
- URL: https://github.com/selective-php/test-traits
- Owner: selective-php
- License: mit
- Created: 2021-01-23T11:08:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T19:50:14.000Z (over 1 year ago)
- Last Synced: 2025-03-23T22:24:27.352Z (7 months ago)
- Topics: php, slim, test
- Language: PHP
- Homepage:
- Size: 58.6 KB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# selective/test-traits
A collection of PHPUnit test traits.
[](https://packagist.org/packages/selective/test-traits)
[](LICENSE)
[](https://github.com/selective-php/test-traits/actions)
[](https://packagist.org/packages/selective/test-traits/stats)
## Requirements
* PHP 8.1+
## Installation
```bash
composer require selective/test-traits --dev
```
## Traits
### MailerTestTrait
Requirements: `composer require symfony/mailer`
DI container setup example:
```php
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Mailer\EventListener\EnvelopeListener;
use Symfony\Component\Mailer\EventListener\MessageListener;
use Symfony\Component\Mailer\EventListener\MessageLoggerListener;
use Symfony\Component\Mailer\Mailer;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Mailer\Transport;
use Symfony\Component\Mailer\Transport\TransportInterface;
// ...
return [
// Mailer
MailerInterface::class => function (ContainerInterface $container) {
return new Mailer($container->get(TransportInterface::class));
},
// Mailer transport
TransportInterface::class => function (ContainerInterface $container) {
$settings = $container->get('settings')['smtp'];
// smtp://user:pass@smtp.example.com:25
$dsn = sprintf(
'%s://%s:%s@%s:%s',
$settings['type'],
$settings['username'],
$settings['password'],
$settings['host'],
$settings['port']
);
$eventDispatcher = $container->get(EventDispatcherInterface::class);
return Transport::fromDsn($dsn, $eventDispatcher);
},
EventDispatcherInterface::class => function () {
$eventDispatcher = new EventDispatcher();
$eventDispatcher->addSubscriber(new MessageListener());
$eventDispatcher->addSubscriber(new EnvelopeListener());
$eventDispatcher->addSubscriber(new MessageLoggerListener());
return $eventDispatcher;
},
// ...
],
```
**Usage**:
PHPUnit test case:
```php
container->get(MailerInterface::class);
// Send email
$email = (new Email())
->from('hello@example.com')
->to('you@example.com')
->subject('Time for Symfony Mailer!')
->text('Sending emails is fun again!')
->html('
My HTML content
');
$mailer->send($email);
$this->assertEmailCount(1);
$this->assertEmailTextBodyContains($this->getMailerMessage(), 'Sending emails is fun again!');
$this->assertEmailHtmlBodyContains($this->getMailerMessage(), '
My HTML content
');
}
}
```
### HttpTestTrait
Requirements
* Any PSR-7 and PSR-17 factory implementation.
```
composer require nyholm/psr7-server
composer require nyholm/psr7
```
**Provided methods**
* `createRequest(string $method, $uri, array $serverParams = []): ServerRequestInterface`
* `createFormRequest(string $method, $uri, array $data = null): ServerRequestInterface`
* `createResponse(int $code = 200, string $reasonPhrase = ''): ResponseInterface`
**Usage**
```php
createRequest('GET', '/api/users');
$response = $this->app->handle($request);
$this->assertSame(200, $response->getStatusCode());
}
}
```
Creating a request with query string parameters:
```php
$request = $this->createRequest('GET', '/api/users')
->withQueryParams($queryParams);
```
## RouteTestTrait
A Slim 4 framework router test trait.
Requirements
* A Slim 4 framework application
**Provided methods:**
* `urlFor(string $routeName, array $data = [], array $queryParams = []): string`
**Usage:**
```php
createRequest('GET', $this->urlFor('get-users'));
$response = $this->app->handle($request);
$this->assertSame(200, $response->getStatusCode());
}
}
```
Creating a request with a named route and query string parameters:
```php
$request = $this->createRequest('GET', $this->urlFor('get-users'))
->withQueryParams($queryParams);
```
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.