Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. - Githubissues

knuckleswtf / scribe

Generate API documentation for humans from your Laravel codebase.✍

https://scribe.knuckles.wtf/laravel/

MIT License

1.58k stars 280 forks source link

Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. #762

Closed ArclightHub closed 6 months ago

ArclightHub commented 7 months ago

Whats changed?

Added a docker-compose setup to allow project contributors to quickly run the test suite on their local machines without needing to install the test stack onto their environment.

How do I run the tests in the new docker container?

Simply run clear && docker-compose up -d && docker logs -f scribe_app_1 and the tests are run and results printed into your terminal!

What should the expected output in my terminal be if the tests are passing?

For the lint step (PHPStan) you should see something like this

composer lint
> phpstan analyse -c ./phpstan.neon src camel --memory-limit 1G
111/111 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

[OK] No errors

For the test step (PHPUnit) you should see something like this
```
Tests:  245 passed
Time:   2.24s

Cov:    79.55%
```