https://github.com/cspray/database-testing
Framework-agnostic, low-level library to setup a database for automated testing
https://github.com/cspray/database-testing
Last synced: 6 months ago
JSON representation
Framework-agnostic, low-level library to setup a database for automated testing
- Host: GitHub
- URL: https://github.com/cspray/database-testing
- Owner: cspray
- License: mit
- Created: 2023-03-02T11:48:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-21T14:21:12.000Z (10 months ago)
- Last Synced: 2025-10-11T00:29:38.450Z (8 months ago)
- Language: PHP
- Homepage:
- Size: 48.8 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cspray/database-testing
A low-level, framework-agnostic library for setting up a database suitable
for automated tests. This library provides the following features:
- The `Cspray\DatabaseTesting\ConnectionAdapter` interface that defines how this library,
and those that extend it, interact with your database.
- Comprehensive, customizable strategies for cleaning up your database to ensure each
test works with a known state.
- Declare fixtures, sets of database records, that are loaded for each test.
- A simple interface to easily introspect the contents of a database
table in your test suite.
- Database and testing-framework agnostic approach
It cannot be emphasized enough; this library does not provide a turn-key, usable solution
out-of-the-box. If you use this library directly, instead of one of the extensions that
targets a specific database connection and testing framework, you'll need to ensure the
appropriate concrete implementations and framework integration points are created.
## Complete Libraries
Instead of installing this library directly, we recommend that you install one of the
available options from the "Connection Adapter" and "Testing Extension" list. Chances are,
you'll need both. If you don't see your database connection type or testing framework
listed, please submit an issue to this repository!
### Connection Adapter
- [cspray/database-testing-pdo](https://github.com/cspray/database-testing-pdo)
### Testing Extension
- [cspray/database-testing-phpunit](https://github.com/cspray/database-testing-phpunit)
## Quick Example
This example is intended to reflect what should be capable with this library. We're going to
use [cspray/database-testing-phpunit](https://github.com/cspray/databse-testing-phpunit) as our testing extension, it is ubiquitous and likely the framework you'll start off using with this library.
```php
pdo = self::$testDatabase->connection();
$this->myRepository = new MyRepository($this->pdo);
}
// populate with more appropriate data. recommended to implement your own
// Cspray\DatabaseTesting\Fixture\Fixture to reuse datasets across tests
#[LoadFixture(
new SingleRecordFixture('my_table', [
'name' => 'cspray',
'website' => 'https://cspray.io'
])
)]
public function testTableHasCorrectlyLoadedFixtures() : void {
$table = self::$testDatabase->table('my_table');
self::assertCount(1, $table);
self::assertSame('cspray', $table->row(0)->get('name'))
self::assertSame('website', $table->row(0)->get('website'));
}
public function testTableCanBeReloadedToGetNewlyInsertedRecords() : void {
$table = self::$testDatabase->table('my_table');
self::assertCount(0, $table);
$this->myRepository->save(new MyEntity());
$table->reload();
self::assertCount(1, $table);
}
}
```