README

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 in the old merge request for Laravel).

Installation

You can install the package via composer:

composer require --dev danilopolani/laravel-json-validation-testing

Usage

The package provides an helper to retrieve a compiled error message:

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:

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:

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:

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
 
namespace App\Rules;
 
use Closure;
use DaniloPolani\JsonValidation\Contracts\HasRuleMessage;
use Illuminate\Contracts\Validation\ValidationRule;
 
class Uppercase implements ValidationRule, HasRuleMessage
{
    /**
     * Run the validation rule.
     */
    public function validate(string $attribute, mixed $value, Closure $fail): void
    {
        if (strtoupper($value) !== $value) {
            $fail($this->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:

it('throws validation error', function () {
    $this->postJson('/')
        ->assertJsonValidationErrorRule('foo', new Uppercase());
});

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Danilo Polani
• All Contributors

License

The MIT License (MIT). Please see License File for more information.