Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zenstruck/foundry
A model factory library for creating expressive, auto-completable, on-demand dev/test fixtures with Symfony and Doctrine.
https://github.com/zenstruck/foundry
doctrine factory faker fixtures symfony test
Last synced: 4 days ago
JSON representation
A model factory library for creating expressive, auto-completable, on-demand dev/test fixtures with Symfony and Doctrine.
- Host: GitHub
- URL: https://github.com/zenstruck/foundry
- Owner: zenstruck
- License: mit
- Created: 2020-05-20T21:09:07.000Z (over 4 years ago)
- Default Branch: 2.x
- Last Pushed: 2024-12-05T17:50:08.000Z (7 days ago)
- Last Synced: 2024-12-06T23:31:26.120Z (5 days ago)
- Topics: doctrine, factory, faker, fixtures, symfony, test
- Language: PHP
- Homepage: https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html
- Size: 1.82 MB
- Stars: 674
- Watchers: 9
- Forks: 77
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-php - Foundry - A fixture factory generation library for Doctrine. (Table of Contents / Testing)
- awesome-projects - Foundry - A fixture factory generation library for Doctrine. (PHP / Testing)
- awesome-php - Foundry - A fixture factory generation library for Doctrine. (Table of Contents / Testing)
- awesome-php-cn - Foundry - 夹具厂一代图书馆为原则. (目录 / 测试 Testing)
README
# Foundry
[](https://github.com/zenstruck/foundry/actions?query=workflow%3ACI)
[](https://codecov.io/gh/zenstruck/foundry)
[](https://packagist.org/packages/zenstruck/foundry)
[](https://packagist.org/packages/zenstruck/foundry)
Foundry makes creating fixtures data fun again, via an expressive, auto-completable, on-demand fixtures system with
Symfony and Doctrine:
```php
$post = PostFactory::new() // Create the factory for Post objects
->published() // Make the post in a "published" state
->create([ // create & persist the Post object
'slug' => 'post-a' // This Post object only requires the slug field - all other fields are random data
])
;
```
The factories can be used inside [DoctrineFixturesBundle](https://symfony.com/bundles/DoctrineFixturesBundle/current/index.html)
to load fixtures or inside your tests, [where it has even more features](https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#using-in-your-tests).
Foundry supports `doctrine/orm` (with [doctrine/doctrine-bundle](https://github.com/doctrine/doctrinebundle)),
`doctrine/mongodb-odm` (with [doctrine/mongodb-odm-bundle](https://github.com/doctrine/DoctrineMongoDBBundle))
or a combination of these.
Want to watch a screencast 🎥 about it? Check out https://symfonycasts.com/foundry
**[Read the Documentation](https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html)**
**[Upgrade guide to v2](https://github.com/zenstruck/foundry/blob/v2.0.0/UPGRADE-2.0.md)**
## How to contribute
### Running the Test Suite
The test suite of this library needs one or more databases, then it comes with a docker compose configuration.
> [!NOTE]
> Docker and PHP installed locally (with `mysql`, `pgsql` & `mongodb` extensions) is required.
You can start the containers and run the test suite:
```bash
# start the container
$ docker compose up --detach
# install dependencies
$ composer update
# run test suite with all available permutations
$ composer test
# run only one permutation
$ ./phpunit
# run test suite with dama/doctrine-test-bundle
$ USE_DAMA_DOCTRINE_TEST_BUNDLE=1 vendor/bin/phpunit
# run test suite with postgreSQL instead of MySQL
$ DATABASE_URL="postgresql://zenstruck:[email protected]:5433/zenstruck_foundry?serverVersion=15" vendor/bin/phpunit
# run test suite with another PHPUnit version
$ PHPUNIT_VERSION=10 vendor/bin/phpunit
```
### Overriding the default configuration
You can override default environment variables by creating a `.env.local` file, to easily enable permutations:
```bash
# .env.local
DATABASE_URL="postgresql://zenstruck:[email protected]:5433/zenstruck_foundry?serverVersion=15" # enables postgreSQL instead of MySQL
MONGO_URL="" # disables Mongo
USE_DAMA_DOCTRINE_TEST_BUNDLE="1" # enables dama/doctrine-test-bundle
PHPUNIT_VERSION="11" # possible values: 9, 10, 11, 11.4
# run test suite with postgreSQL
$ vendor/bin/phpunit
```
The `.env.local` file can also be used to override the port of the database containers,
if it does not meet your local requirements. You'll also need to override docker compose configuration:
Here is an example to use MySQL on port `3308`:
```yaml
# docker-compose.override.yml
version: '3.9'
services:
mysql:
ports:
- "3308:3306"
```
```dotenv
# .env.local
DATABASE_URL="mysql://root:[email protected]:3308/foundry_test?serverVersion=5.7.42"
```
### Running the documentation linter locally
This section provides guidance on how to run the documentation linter, contained within a Docker image, locally on your machine. This linter is designed to verify and ensure that the document syntax adheres to the required standards.
The following command runs the linter in the local directory:
```shell
docker run --rm -it -e DOCS_DIR='/docs' -v ${PWD}/docs:/docs oskarstark/doctor-rst:latest
```
## Credit
The [AAA](https://www.thephilocoder.com/unit-testing-aaa-pattern/) style of testing was first introduced to me by
[Adam Wathan's](https://adamwathan.me/) excellent [Test Driven Laravel Course](https://course.testdrivenlaravel.com/).
The inspiration for this libraries API comes from [Laravel factories](https://laravel.com/docs/master/database-testing)
and [christophrumpel/laravel-factories-reloaded](https://github.com/christophrumpel/laravel-factories-reloaded).