Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danilopolani/laravel-json-validation-testing
Better JSON validation errors testing
https://github.com/danilopolani/laravel-json-validation-testing
laravel laravel-package testing-tools validation-error
Last synced: 2 months ago
JSON representation
Better JSON validation errors testing
- Host: GitHub
- URL: https://github.com/danilopolani/laravel-json-validation-testing
- Owner: danilopolani
- License: mit
- Created: 2022-03-02T10:10:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T03:52:02.000Z (8 months ago)
- Last Synced: 2024-10-14T02:26:33.805Z (2 months ago)
- Topics: laravel, laravel-package, testing-tools, validation-error
- Language: PHP
- Homepage:
- Size: 42 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# JSON Validation errors testing helper
[](https://packagist.org/packages/danilopolani/laravel-json-validation-testing)
[](https://github.com/danilopolani/laravel-json-validation-testing/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/danilopolani/laravel-json-validation-testing/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/danilopolani/laravel-json-validation-testing)
A simple library to help testing JSON validation errors by rules.
The current way to test HTTP errors is **broken**: it tests that the validation fails or you have to manually specify the error message. With this package you'll just need to specify the validation rule that fails and it builds the error message to be sure at 100% that it fails and **what fails**. (Further reading [here](https://github.com/laravel/framework/pull/41239) in the old merge request for Laravel).
## Installation
You can install the package via composer:
```bash
composer require --dev danilopolani/laravel-json-validation-testing
```
## Usage
The package provides an helper to retrieve a compiled error message:
```php
use DaniloPolani\JsonValidation\JsonValidation;
JsonValidation::getRuleErrorMessage('foo', 'required');
// => ["The foo field is required."]
```
However, if you need to test that your HTTP APIs, the package ships with a brand new `assertJsonValidationErrorRule` assertion to make your life easier:
```php
it('throws validation error', function () {
$this->postJson('/')
->assertJsonValidationErrorRule('foo', 'required');
});
```
It supports as well dynamic rules, such as `between`, `size`, `max` etc. You just need to specify the type of rule you want to apply:
```php
it('throws validation error', function () {
$this->postJson('/')
->assertJsonValidationErrorRule('foo', 'between.string:1,5') // The foo must be between 1 and 5 characters.
->assertJsonValidationErrorRule('foo', 'size.array:3'); // The foo must contain 3 items.
});
```
You can even test multiple validation errors at once by providing an array of `field => rule` as argument:
```php
use DaniloPolani\JsonValidation\JsonValidation;
it('throws validation error', function () {
$this->postJson('/')
->assertJsonValidationErrorRule([
'foo' => 'required',
'bar' => 'required_array_keys:foo,baz',
]);
});
```
### Custom rules
If you want to test a custom rule, make sure it implements the interface `DaniloPolani\JsonValidation\Contracts\HasRuleMessage`, needed to extract the failing message to check against.
For example, a custom Rule would look like this:
```php
message());
}
}
public function message(): string
{
return 'The :attribute must be uppercase.';
}
}
```
And then you can use it in your assert function:
Of course you can provide your own custom validation Rules:
```php
it('throws validation error', function () {
$this->postJson('/')
->assertJsonValidationErrorRule('foo', new Uppercase());
});
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Danilo Polani](https://github.com/danilopolani)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.