Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brettmc/eloqunit
An eloquent-based database testing library for phpunit
https://github.com/brettmc/eloqunit
eloquent phpunit-extension
Last synced: about 2 months ago
JSON representation
An eloquent-based database testing library for phpunit
- Host: GitHub
- URL: https://github.com/brettmc/eloqunit
- Owner: brettmc
- License: mit
- Created: 2018-09-28T02:08:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-10T05:41:05.000Z (almost 4 years ago)
- Last Synced: 2024-05-02T01:57:59.703Z (8 months ago)
- Topics: eloquent, phpunit-extension
- Language: PHP
- Size: 18.6 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eloqunit
[](https://packagist.org/packages/eloqunit/eloqunit)
[](https://travis-ci.com/brettmc/eloqunit)
[](https://coveralls.io/github/brettmc/eloqunit?branch=master)
An eloquent-based database testing library for phpunit, inspired by dbunit.
This works well with Slim Framework (and possibly others) which allows you to create an application, then dispatch multiple requests
to it. By using database transactions for each test, you do not need to "tear down" data from prior tests, nor deal with artifacts
left over from failed tests.
## Features
* runs test cases inside a database transaction
* provides assertions
* provides a `seed` method to quickly populate database tables
* support for null/not null on assertions
## Installation
Install via composer:
```
$ composer require eloqunit/eloqunit
```
## Usage
Instead of extending `PHPUnit\Framework\TestCase`, have your tests extend `Eloqunit\TestCase`.
You need to provide a `getDatabase()` method, which returns a `Illuminate\Database\Capsule\Manager`, assertions, seeding etc
are executed against this database.
This only works if the database is the same one as used in the the system under test (eg, they are shared through a DI container).
## Methods
### `seed(string $table, array $data)`:
Seed $table with rows contained in $data.
```php
$this->seed('mytable', [
['id' => '1', 'name' => 'row.one', 'active' => true, 'foo' => null],
['2', 'row.two', false, 'bar'],
]);
```
### `seedTables(array $data)`:
Seed multiple tables. Array keys represent table names, and array values represent table rows.
```php
$this->seedTables(
'mytable' => [
['id' => 1, 'name' => 'row.one', 'active' => true],
[2, 'row.two', true],
[3, 'row.three', true],
],
'myothertable' => [
['key' => 'foo', 'description' => 'description of foo'],
['bar', 'bar description'],
['baz', 'baz description'],
],
);
```
### `assertRowCount(int $expected, string $table, array $where, string $message)`:
Assert that `$table` contains `$expected` number of rows. Optionally, filtered by $where.
```php
$this->assertRowCount(1, 'mytable', ['active' => true, 'foo' => Eloqunit\Constraint::IsNull]);
$this->assertRowCount(1, 'mytable', ['active' => false, 'foo' => ELoqunit\Constraint::IsNotNull];
$this->assertRowCount(2, 'mytable');
```
### `assertRowExists(string $table, array $where, string $message)`
Assert that a row exists in $table. Optionally, filtered by $where.
```php
$this->assertRowExists('mytable', ['id' => 1]);
$this->assertRowExists('mytable', ['foo' => Eloqunit\Constraint::IsNotNull]);
```
### `assertRowMatches(string $table, array $where, array $fields)`
Assert that the first row in $table which matches $where, contains fields matching $fields.
```php
$this->assertRowMatches('mytable', ['id' => 1], ['name' => 'row.one', 'active' => true]);
```