Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antonioribeiro/tddd
A Laravel Continuous Integration Package
https://github.com/antonioribeiro/tddd
codeception dashboard developer-tools laravel laravel-dusk php phpspec phpunit tester testing watcher
Last synced: 3 days ago
JSON representation
A Laravel Continuous Integration Package
- Host: GitHub
- URL: https://github.com/antonioribeiro/tddd
- Owner: antonioribeiro
- License: mit
- Created: 2014-11-23T15:59:02.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-09-06T20:35:11.000Z (over 1 year ago)
- Last Synced: 2024-12-14T12:03:58.509Z (10 days ago)
- Topics: codeception, dashboard, developer-tools, laravel, laravel-dusk, php, phpspec, phpunit, tester, testing, watcher
- Language: Vue
- Size: 4.46 MB
- Stars: 721
- Watchers: 30
- Forks: 57
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TDDD - Test Driven Development Dashboard
### A Self-Hosted TDD Dashboard & Tests Watcher
[](https://packagist.org/packages/pragmarx/tddd)
[](LICENSE.md)
[](https://packagist.org/packages/pragmarx/tddd)
[](https://scrutinizer-tddd.com/g/antonioribeiro/tddd/?branch=master)
[](https://scrutinizer-tddd.com/g/antonioribeiro/tddd/?branch=master)
[](https://styleci.io/repos/27037779)
## What is it?
TDD Dashboard, is an app (built as a Laravel PHP package) to watch and run all your tests during development. It supports any test framework working on terminal, and comes with some testers (PHPUnit, phpspec, behat, Jest, AVA...) preconfigured, but you can easily add yours, just tell it where the executable is and it's done. It also shows the progress of your tests, let you run a single test or all of them, and open your favorite code editor (PHPStorm, VSCode, Sublime Text, etc.) going right to the failing line of your test. If your test framework generate screenshots, it is also able to show it in the log page, with all the reds and greens you are used to see in your terminal.
It uses Laravel as motor, but supports (and has been tested with) many languages, frameworks and testing frameworks:
* [PHPUnit](https://phpunit.de/)
* [Laravel & Laravel Dusk](https://laravel.com/docs/5.5/dusk)
* [Codeception](http://codeception.com/)
* [phpspec](http://www.phpspec.net/en/stable/)
* [Behat](http://behat.org/en/latest/)
* [atoum](http://atoum.org/)
* [Jest](https://facebook.github.io/jest/)
* [AVA](https://github.com/avajs/ava)
* [React](https://reactjs.org/)
* [Ruby on Rails](http://guides.rubyonrails.org/testing.html)
* [Nette Tester](https://tester.nette.org/)
* [Symfony](https://symfony.com/doc/current/testing.html)
## Features
* Project List: click a project link to see all its tests.
* Open files directly in your source code editor (PHPStorm, Sublime Text...).
* Error log with source code linked, go strait to the error line in your source code.
* Enable/disable a test. Once disabled if the watcher catches a change in resources, that test will not fire.
* Real time test state: "idle", "running", "queued", "ok" and "failed".
* "Show" button, to display the error log of failed tests.
* Highly configurable, watch anything and test everything!
### Videos
- [Preview](https://www.youtube.com/watch?v=sO_aDf3xCgE)
- [Installing](https://youtu.be/AgkKCLNiV8w)
- [VueJS Preview](https://youtu.be/HAdfLYArk_A)
- [Laravel Dusk Preview](https://youtu.be/ooF4oLD9U7Q)
### Screenshots
#### Dashboard
#### Error Log
## Command Line Interface
The Artisan commands **Watcher** and **Tester** are responsible for watching resources and firing tests, respectively:
### Watcher
Keep track of your files and enqueue your tests every time a project or test file is changed. If a project file changes, it will enqueue all your tests, if a test file changes, it will enqueue only that particular test. This is how you run it:
``` bash
php artisan tddd:watch
```
### Tester
Responsible for taking tests from the run queue, execute it and log the results. Tester will only execute enabled tests. This is how you run it:
``` bash
php artisan tddd:test
```
### Notifications
It uses JoliNotif, so if it's not working on macOS, you can try installing terminal-notifier:
``` bash
brew install terminal-notifier
```
## Test Framework Compatibility
This package was tested and is known to be compatible with
* [Codeception](http://codeception.com/)
* [PHPUnit](https://phpunit.de/)
* [phpspec](http://www.phpspec.net/)
* [behat](http://docs.behat.org/)
* [atoum](https://github.com/atoum/atoum)
* [Nette Tester](http://tester.nette.org/en/)
## Installing
#### TL;DR
``` bash
laravel new tddd
cd tddd
composer require pragmarx/tddd
php artisan vendor:publish --provider="PragmaRX\Tddd\Package\ServiceProvider"
valet link tddd
# configure database on your .env
php artisan migrate
php artisan tddd:watch & php artisan tddd:work &
open http://tddd.dev/tests-watcher/dashboard
```
### Examples & Starter App
For lots of examples, check [this starter app](https://github.com/antonioribeiro/tests-watcher-starter), which will also help you create an independent dashboard for your tests.
### The long version
Require it with [Composer](http://getcomposer.org/):
``` bash
composer require pragmarx/tddd
```
Create a database, configure on your Laravel app and migrate it
``` bash
php artisan migrate
```
Publish Ci configuration:
On Laravel 4.*
Add the service provider to your app/config/app.php:
``` php
'PragmaRX\Tddd\Package\ServiceProvider',
```
``` bash
php artisan config:publish pragmarx/tddd
```
On Laravel 5.*
``` bash
php artisan vendor:publish --provider="PragmaRX\Tddd\Package\ServiceProvider"
```
## Example of projects
### Laravel Dusk
``` php
'project bar (dusk)' => [
'path' => $basePath,
'watch_folders' => [
'app',
'tests/Browser'
],
'exclude' => [
'tests/Browser/console/',
'tests/Browser/screenshots/',
],
'depends' => [],
'tests_path' => 'tests',
'suites' => [
'browser' => [
'tester' => 'dusk',
'tests_path' => 'Browser',
'command_options' => '',
'file_mask' => '*Test.php',
'retries' => 0,
],
],
],
```
## Troubleshooting
#### Tests are running fine in terminal but failing in the dashboard?
You have first to remember they are being executed in isolation, and, also, the environment is not exactly the same, so things like a cache and session may affect your results.
## Requirements
- Laravel 4.1+ or 5
- PHP 5.3.7+
## Author
[Antonio Carlos Ribeiro](http://twitter.com/iantonioribeiro)
## License
Laravel Ci is licensed under the BSD 3-Clause License - see the `LICENSE` file for details
## Contributing
Pull requests and issues are welcome.