Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dereuromark/cakephp-test-helper
Helper plugin around CakePHP testing and TDD as browser backend
https://github.com/dereuromark/cakephp-test-helper
Last synced: 13 days ago
JSON representation
Helper plugin around CakePHP testing and TDD as browser backend
- Host: GitHub
- URL: https://github.com/dereuromark/cakephp-test-helper
- Owner: dereuromark
- License: mit
- Created: 2018-02-24T21:23:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T11:42:21.000Z (about 2 months ago)
- Last Synced: 2024-10-11T06:32:43.648Z (29 days ago)
- Language: PHP
- Size: 259 KB
- Stars: 7
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cakephp - TestHelper plugin - Provides testing enhancements and TDD support as browser backend. (Code Analysis)
README
# CakePHP TestHelper plugin
[](https://github.com/dereuromark/cakephp-test-helper/actions/workflows/ci.yml?query=branch%3Amaster)
[](https://codecov.io/github/dereuromark/cakephp-test-helper/branch/master)
[](https://packagist.org/packages/dereuromark/cakephp-test-helper)
[](https://php.net/)
[](LICENSE)
[](https://packagist.org/packages/dereuromark/cakephp-test-helper)
[](https://github.com/php-fig-rectified/fig-rectified-standards)
Browser based addons for your test driven development.
Note: This branch is for **CakePHP 5.0+**. See [version map](https://github.com/dereuromark/cakephp-test-helper/wiki#cakephp-version-map) for details.
## Motivation
After 2.x=>3.x, the "web-tester" has been removed. It was, for certain cases, however, quite useful.
This aims to bring back a part of it.
The CLI also doesn't allow a good overview. Even with auto-complete, you have to type almost everything out.
With a browser backend generating tests or running them is just a simple mouse click.
You have an overview of your classes and the test classes to it. If there is one missing, you can easily "bake" it from this web backend. It internally uses [Bake](https://github.com/cakephp/bake/) plugin as well as your preferred theme.
### Further useful addons
- URL array generation from string URLs (respects routing, so it is basically also a reverse lookup)
- Fixture validation tool (compares actual DB with the schema files: fields and attributes, constraints and indexes)
- GUI for fixture comparison and generation of missing ones per mouse click.
## Installation
You can install this plugin into your CakePHP application using [composer](https://getcomposer.org):
```
composer require --dev dereuromark/cakephp-test-helper
```
Note: This is not meant for production, so make sure you use the `--dev` flag and install it as development-only tool.
## Setup
Don't forget to load it under your bootstrap function in `Application.php`:
```php
if (Configure::read('debug')) {
$this->addPlugin('TestHelper');
}
```
This will also load the routes.
### non-dev mode
In certain apps it can be useful to have some of the helper functionality available also for staging and prod.
Here you must make sure then to not load the routes, though:
```php
$this->addPlugin('TestHelper', ['routes' => Configure::read('debug')]);
```
And here you must use `composer require` without `--dev` flag then.
## Usage
Navigate to `/test-helper` backend and select the app or plugin you want to check.
You can then with a single click
- check what classes do not yet have a test case
- generate a test case for them (or copy and paste a generated code into CLI)
- run test case
- check coverage on a tested class, as overall and in detail
Supported class types:
- [x] Controllers
- [x] Models (Tables/Entities)
- [x] Components
- [x] Behavior
- [x] Helpers
- [x] Commands
- [x] Tasks
- [ ] Cells
- [ ] CommandHelpers
- [ ] Forms
- [ ] Mailers
Feel free to help out improving and completing this test helper plugin.
- [Full Documentation](docs/README.md)
## Limitations
Executing the tests and coverage from the web backend usually can not work for long-running tests due to the timeout issues.
Make sure you raise the apache/nginx settings here if you want to use this functionality here.
The focus is on providing an overview and quickly generating the desired classes with a single mouse click.