mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 23:05:45 +01:00
b701fac656This commit introduces a mechanism for validators to return early once the validation outcome is determined, rather than evaluating all child validators. The ShortCircuit validator evaluates validators sequentially and stops at the first failure, similar to how PHP's && operator works. This is useful when later validators depend on earlier ones passing, or when you want only the first error message. The ShortCircuitCapable interface allows composite validators (AllOf, AnyOf, OneOf, NoneOf, Each, All) to implement their own short-circuit logic. Why "ShortCircuit" instead of "FailFast": The name "FailFast" was initially considered but proved misleading. While AllOf stops on failure (fail fast), AnyOf stops on success (succeed fast), and OneOf stops on the second success. The common behavior is not about failing quickly, but about returning as soon as the outcome is determined—which is exactly what short-circuit evaluation means. This terminology is familiar to developers from boolean operators (&& and ||), making the behavior immediately understandable. Co-authored-by: Alexandre Gomes Gaigalas <alganet@gmail.com> Assisted-by: Claude Code (Opus 4.5)
361 lines
15 KiB
PHP
361 lines
15 KiB
PHP
<?php
|
|
|
|
/*
|
|
* SPDX-License-Identifier: MIT
|
|
* SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
* SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
|
|
* SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
test('one rule / one failed', catchAll(
|
|
fn() => v::keySet(v::key('foo', v::intType()))->assert(['foo' => 'string']),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.foo` must be an integer')
|
|
->and($fullMessage)->toBe('- `.foo` must be an integer')
|
|
->and($messages)->toBe(['foo' => '`.foo` must be an integer']),
|
|
));
|
|
|
|
test('one rule / one missing key', catchAll(
|
|
fn() => v::keySet(v::keyExists('foo'))->assert([]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.foo` must be present')
|
|
->and($fullMessage)->toBe('- `.foo` must be present')
|
|
->and($messages)->toBe(['foo' => '`.foo` must be present']),
|
|
));
|
|
|
|
test('one rule / one extra key', catchAll(
|
|
fn() => v::keySet(v::keyExists('foo'))->assert(['foo' => 42, 'bar' => 'string']),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.bar` must not be present')
|
|
->and($fullMessage)->toBe('- `.bar` must not be present')
|
|
->and($messages)->toBe(['bar' => '`.bar` must not be present']),
|
|
));
|
|
|
|
test('one rule / one extra key / one missing key', catchAll(
|
|
fn() => v::keySet(v::keyExists('foo'))->assert(['bar' => true]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.foo` must be present')
|
|
->and($fullMessage)->toBe(<<<'FULL_MESSAGE'
|
|
- `["bar": true]` contains both missing and extra keys
|
|
- `.foo` must be present
|
|
- `.bar` must not be present
|
|
FULL_MESSAGE)
|
|
->and($messages)->toBe([
|
|
'__root__' => '`["bar": true]` contains both missing and extra keys',
|
|
'foo' => '`.foo` must be present',
|
|
'bar' => '`.bar` must not be present',
|
|
]),
|
|
));
|
|
|
|
test('one rule / two extra keys', catchAll(
|
|
fn() => v::keySet(v::keyExists('foo'))->assert(['foo' => 42, 'bar' => 'string', 'baz' => true]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.bar` must not be present')
|
|
->and($fullMessage)->toBe(<<<'FULL_MESSAGE'
|
|
- `["foo": 42, "bar": "string", "baz": true]` contains extra keys
|
|
- `.bar` must not be present
|
|
- `.baz` must not be present
|
|
FULL_MESSAGE)
|
|
->and($messages)->toBe([
|
|
'__root__' => '`["foo": 42, "bar": "string", "baz": true]` contains extra keys',
|
|
'bar' => '`.bar` must not be present',
|
|
'baz' => '`.baz` must not be present',
|
|
]),
|
|
));
|
|
|
|
test('one rule / more than ten extra keys', catchAll(
|
|
fn() => v::keySet(v::keyExists('foo'))
|
|
->assert([
|
|
'foo' => 42,
|
|
'bar' => 'string',
|
|
'baz' => true,
|
|
'qux' => false,
|
|
'quux' => 42,
|
|
'corge' => 'string',
|
|
'grault' => true,
|
|
'garply' => false,
|
|
'waldo' => 42,
|
|
'fred' => 'string',
|
|
'plugh' => true,
|
|
'xyzzy' => false,
|
|
'thud' => 42,
|
|
]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.bar` must not be present')
|
|
->and($fullMessage)->toBe(<<<'FULL_MESSAGE'
|
|
- `["foo": 42, "bar": "string", "baz": true, "qux": false, "quux": 42, ...]` contains extra keys
|
|
- `.bar` must not be present
|
|
- `.baz` must not be present
|
|
- `.qux` must not be present
|
|
- `.quux` must not be present
|
|
- `.corge` must not be present
|
|
- `.grault` must not be present
|
|
- `.garply` must not be present
|
|
- `.waldo` must not be present
|
|
- `.fred` must not be present
|
|
- `.plugh` must not be present
|
|
FULL_MESSAGE)
|
|
->and($messages)->toBe([
|
|
'__root__' => '`["foo": 42, "bar": "string", "baz": true, "qux": false, "quux": 42, ...]` contains extra keys',
|
|
'bar' => '`.bar` must not be present',
|
|
'baz' => '`.baz` must not be present',
|
|
'qux' => '`.qux` must not be present',
|
|
'quux' => '`.quux` must not be present',
|
|
'corge' => '`.corge` must not be present',
|
|
'grault' => '`.grault` must not be present',
|
|
'garply' => '`.garply` must not be present',
|
|
'waldo' => '`.waldo` must not be present',
|
|
'fred' => '`.fred` must not be present',
|
|
'plugh' => '`.plugh` must not be present',
|
|
]),
|
|
));
|
|
|
|
test('multiple rules / one failed', catchAll(
|
|
fn() => v::keySet(v::keyExists('foo'), v::keyExists('bar'))->assert(['foo' => 42]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.bar` must be present')
|
|
->and($fullMessage)->toBe('- `.bar` must be present')
|
|
->and($messages)->toBe(['bar' => '`.bar` must be present']),
|
|
));
|
|
|
|
test('multiple rules / all failed', catchAll(
|
|
fn() => v::keySet(v::keyExists('foo'), v::keyExists('bar'))->assert([]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.foo` must be present')
|
|
->and($fullMessage)->toBe(<<<'FULL_MESSAGE'
|
|
- `[]` contains missing keys
|
|
- `.foo` must be present
|
|
- `.bar` must be present
|
|
FULL_MESSAGE)
|
|
->and($messages)->toBe([
|
|
'__root__' => '`[]` contains missing keys',
|
|
'foo' => '`.foo` must be present',
|
|
'bar' => '`.bar` must be present',
|
|
]),
|
|
));
|
|
|
|
test('multiple rules / one extra key', catchAll(
|
|
fn() => v::keySet(
|
|
v::keyExists('foo'),
|
|
v::keyExists('bar'),
|
|
)->assert(['foo' => 42, 'bar' => 'string', 'baz' => true]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.baz` must not be present')
|
|
->and($fullMessage)->toBe('- `.baz` must not be present')
|
|
->and($messages)->toBe(['baz' => '`.baz` must not be present']),
|
|
));
|
|
|
|
test('multiple rules / one extra key / one missing', catchAll(
|
|
fn() => v::keySet(
|
|
v::keyExists('foo'),
|
|
v::keyExists('bar'),
|
|
)->assert(['bar' => 'string', 'baz' => true]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.foo` must be present')
|
|
->and($fullMessage)->toBe(<<<'FULL_MESSAGE'
|
|
- `["bar": "string", "baz": true]` contains both missing and extra keys
|
|
- `.foo` must be present
|
|
- `.baz` must not be present
|
|
FULL_MESSAGE)
|
|
->and($messages)->toBe([
|
|
'__root__' => '`["bar": "string", "baz": true]` contains both missing and extra keys',
|
|
'foo' => '`.foo` must be present',
|
|
'baz' => '`.baz` must not be present',
|
|
]),
|
|
));
|
|
|
|
test('multiple rules / two extra keys', catchAll(
|
|
fn() => v::keySet(
|
|
v::keyExists('foo'),
|
|
v::keyExists('bar'),
|
|
v::keyOptional('qux', v::intType()),
|
|
)->assert(['foo' => 42, 'bar' => 'string', 'baz' => true, 'qux' => false]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.qux` must be an integer')
|
|
->and($fullMessage)->toBe(<<<'FULL_MESSAGE'
|
|
- `["foo": 42, "bar": "string", "baz": true, "qux": false]` contains extra keys
|
|
- `.qux` must be an integer
|
|
- `.baz` must not be present
|
|
FULL_MESSAGE)
|
|
->and($messages)->toBe([
|
|
'__root__' => '`["foo": 42, "bar": "string", "baz": true, "qux": false]` contains extra keys',
|
|
'qux' => '`.qux` must be an integer',
|
|
'baz' => '`.baz` must not be present',
|
|
]),
|
|
));
|
|
|
|
test('multiple rules / all failed validation', catchAll(
|
|
fn() => v::keySet(
|
|
v::key('foo', v::intType()),
|
|
v::key('bar', v::intType()),
|
|
v::key('baz', v::intType()),
|
|
)
|
|
->assert(['foo' => 42, 'bar' => 'string', 'baz' => true]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.bar` must be an integer')
|
|
->and($fullMessage)->toBe(<<<'FULL_MESSAGE'
|
|
- `["foo": 42, "bar": "string", "baz": true]` validation failed
|
|
- `.bar` must be an integer
|
|
- `.baz` must be an integer
|
|
FULL_MESSAGE)
|
|
->and($messages)->toBe([
|
|
'__root__' => '`["foo": 42, "bar": "string", "baz": true]` validation failed',
|
|
'bar' => '`.bar` must be an integer',
|
|
'baz' => '`.baz` must be an integer',
|
|
]),
|
|
));
|
|
|
|
test('multiple rules / single missing key / single failed validation', catchAll(
|
|
fn() => v::keySet(
|
|
v::init()
|
|
->key('foo', v::intType())
|
|
->key('bar', v::intType())
|
|
->key('baz', v::intType()),
|
|
)
|
|
->assert(['foo' => 42, 'bar' => 'string']),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.bar` must be an integer')
|
|
->and($fullMessage)->toBe(<<<'FULL_MESSAGE'
|
|
- `["foo": 42, "bar": "string"]` contains missing keys
|
|
- `.bar` must be an integer
|
|
- `.baz` must be present
|
|
FULL_MESSAGE)
|
|
->and($messages)->toBe([
|
|
'__root__' => '`["foo": 42, "bar": "string"]` contains missing keys',
|
|
'bar' => '`.bar` must be an integer',
|
|
'baz' => '`.baz` must be present',
|
|
]),
|
|
));
|
|
|
|
test('short-circuit / first key fails', catchAll(
|
|
fn() => v::shortCircuit(
|
|
v::keySet(
|
|
v::key('foo', v::intType()),
|
|
v::key('bar', v::intType()),
|
|
),
|
|
)
|
|
->assert(['foo' => 'string', 'bar' => 'string']),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.foo` must be an integer')
|
|
->and($fullMessage)->toBe('- `.foo` must be an integer')
|
|
->and($messages)->toBe(['foo' => '`.foo` must be an integer']),
|
|
));
|
|
|
|
test('short-circuit / extra key', catchAll(
|
|
fn() => v::shortCircuit(v::keySet(v::keyExists('foo')))->assert(['foo' => 42, 'bar' => 'extra']),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.bar` must not be present')
|
|
->and($fullMessage)->toBe('- `.bar` must not be present')
|
|
->and($messages)->toBe(['bar' => '`.bar` must not be present']),
|
|
));
|
|
|
|
test('short-circuit / not an array', catchAll(
|
|
fn() => v::shortCircuit(v::keySet(v::keyExists('foo')))->assert('not-an-array'),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('"not-an-array" must be an array')
|
|
->and($fullMessage)->toBe('- "not-an-array" must be an array')
|
|
->and($messages)->toBe(['arrayType' => '"not-an-array" must be an array']),
|
|
));
|
|
|
|
test('short-circuit / second key fails', catchAll(
|
|
fn() => v::shortCircuit(
|
|
v::keySet(
|
|
v::key('foo', v::intType()),
|
|
v::key('bar', v::intType()),
|
|
v::key('baz', v::intType()),
|
|
),
|
|
)
|
|
->assert(['foo' => 1, 'bar' => 'string', 'baz' => 3]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.bar` must be an integer')
|
|
->and($fullMessage)->toBe('- `.bar` must be an integer')
|
|
->and($messages)->toBe(['bar' => '`.bar` must be an integer']),
|
|
));
|
|
|
|
test('short-circuit / third key fails', catchAll(
|
|
fn() => v::shortCircuit(
|
|
v::keySet(
|
|
v::key('foo', v::intType()),
|
|
v::key('bar', v::intType()),
|
|
v::key('baz', v::intType()),
|
|
),
|
|
)
|
|
->assert(['foo' => 1, 'bar' => 2, 'baz' => 'string']),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.baz` must be an integer')
|
|
->and($fullMessage)->toBe('- `.baz` must be an integer')
|
|
->and($messages)->toBe(['baz' => '`.baz` must be an integer']),
|
|
));
|
|
|
|
test('short-circuit / extra key before third key', catchAll(
|
|
fn() => v::shortCircuit(
|
|
v::keySet(
|
|
v::key('foo', v::intType()),
|
|
v::key('bar', v::intType()),
|
|
),
|
|
)
|
|
->assert(['foo' => 1, 'bar' => 2, 'baz' => 'extra']),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.baz` must not be present')
|
|
->and($fullMessage)->toBe('- `.baz` must not be present')
|
|
->and($messages)->toBe(['baz' => '`.baz` must not be present']),
|
|
));
|
|
|
|
test('short-circuit / first extra key fails', catchAll(
|
|
fn() => v::shortCircuit(
|
|
v::keySet(
|
|
v::keyExists('foo'),
|
|
v::keyExists('bar'),
|
|
),
|
|
)
|
|
->assert(['foo' => 1, 'bar' => 2, 'extra1' => 'value', 'extra2' => 'value']),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.extra1` must not be present')
|
|
->and($fullMessage)->toBe('- `.extra1` must not be present')
|
|
->and($messages)->toBe(['extra1' => '`.extra1` must not be present']),
|
|
));
|
|
|
|
test('short-circuit / missing key before extra keys', catchAll(
|
|
fn() => v::shortCircuit(v::keySet(v::keyExists('foo'), v::keyExists('bar')))->assert(['foo' => 1, 'extra' => 'value']),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.bar` must be present')
|
|
->and($fullMessage)->toBe('- `.bar` must be present')
|
|
->and($messages)->toBe(['bar' => '`.bar` must be present']),
|
|
));
|
|
|
|
test('short-circuit / nested KeySet fails', catchAll(
|
|
fn() => v::shortCircuit(
|
|
v::keySet(
|
|
v::key('user', v::keySet(
|
|
v::key('name', v::stringType()),
|
|
v::key('email', v::email()),
|
|
)),
|
|
),
|
|
)
|
|
->assert([
|
|
'user' => [
|
|
'name' => 'John Doe',
|
|
'email' => 'invalid-email',
|
|
],
|
|
]),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.user.email` must be an email address')
|
|
->and($fullMessage)->toBe('- `.user.email` must be an email address')
|
|
->and($messages)->toBe(['email' => '`.user.email` must be an email address']),
|
|
));
|
|
|
|
test('short-circuit / with keyOptional that fails', catchAll(
|
|
fn() => v::shortCircuit(
|
|
v::keySet(
|
|
v::key('foo', v::stringType()),
|
|
v::keyOptional('bar', v::intType()),
|
|
),
|
|
)
|
|
->assert(['foo' => 1, 'bar' => 'string']),
|
|
fn(string $message, string $fullMessage, array $messages) => expect()
|
|
->and($message)->toBe('`.foo` must be a string')
|
|
->and($fullMessage)->toBe('- `.foo` must be a string')
|
|
->and($messages)->toBe(['foo' => '`.foo` must be a string']),
|
|
));
|