respect-validation/tests/feature/Rules/PropertyTest.php
Henrique Moody 1915b6fff7
Use paths to identify when a rule fails
When nested-structural validation fails, it's challenging to identify
which rule failed from the main exception message. A great example is
the `Issue796Test.php` file. The exception message says:

host must be a string

But you're left unsure whether it's the `host` key from the `mysql` key
or the `postgresql` key.

This commit changes that behaviour by introducing the concept of "Path."
The `path` represents the path that a rule has taken, and we can use it
in structural rules to identify the path of an array or object.

Here's what it looks like before and after:

```diff
-host must be a string
+`.mysql.host` must be a string
```

Because paths are a specific concept, I added a dot (`.`) at the
beginning of all paths when displaying them. I was inspired by the `jq`
syntax. I also added backticks around paths to distinguish them from any
other value.

I didn't manage to fix a test, and I skipped it instead of fixing it
because I want to make changes in how we display error messages as
arrays, and it will be easier to fix it then.
2024-12-27 23:28:35 +01:00

106 lines
3.8 KiB
PHP

<?php
/*
* Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
* SPDX-License-Identifier: MIT
*/
declare(strict_types=1);
test('Missing property', expectAll(
fn() => v::property('foo', v::intType())->assert(new stdClass()),
'`.foo` must be present',
'- `.foo` must be present',
['foo' => '`.foo` must be present'],
));
test('Default', expectAll(
fn() => v::property('foo', v::intType())->assert((object) ['foo' => 'string']),
'`.foo` must be an integer',
'- `.foo` must be an integer',
['foo' => '`.foo` must be an integer'],
));
test('Inverted', expectAll(
fn() => v::not(v::property('foo', v::intType()))->assert((object) ['foo' => 12]),
'`.foo` must not be an integer',
'- `.foo` must not be an integer',
['foo' => '`.foo` must not be an integer'],
));
test('Double-inverted with missing property', expectAll(
fn() => v::not(v::not(v::property('foo', v::intType())))->assert(new stdClass()),
'`.foo` must be present',
'- `.foo` must be present',
['foo' => '`.foo` must be present'],
));
test('With wrapped name, missing property', expectAll(
fn() => v::property('foo', v::intType()->setName('Wrapped'))->assert(new stdClass()),
'Wrapped must be present',
'- Wrapped must be present',
['foo' => 'Wrapped must be present'],
));
test('With wrapped name, default', expectAll(
fn() => v::property('foo', v::intType()->setName('Wrapped'))->setName('Wrapper')->assert((object) ['foo' => 'string']),
'Wrapped must be an integer',
'- Wrapped must be an integer',
['foo' => 'Wrapped must be an integer'],
));
test('With wrapped name, inverted', expectAll(
fn() => v::not(
v::property('foo', v::intType()->setName('Wrapped'))->setName('Wrapper'),
)
->setName('Not')
->assert((object) ['foo' => 12]),
'Wrapped must not be an integer',
'- Wrapped must not be an integer',
['foo' => 'Wrapped must not be an integer'],
));
test('With wrapper name, default', expectAll(
fn() => v::property('foo', v::intType())->setName('Wrapper')->assert((object) ['foo' => 'string']),
'Wrapper must be an integer',
'- Wrapper must be an integer',
['foo' => 'Wrapper must be an integer'],
));
test('With wrapper name, missing property', expectAll(
fn() => v::property('foo', v::intType())->setName('Wrapper')->assert(new stdClass()),
'Wrapper must be present',
'- Wrapper must be present',
['foo' => 'Wrapper must be present'],
));
test('With wrapper name, inverted', expectAll(
fn() => v::not(v::property('foo', v::intType())->setName('Wrapper'))->setName('Not')
->assert((object) ['foo' => 12]),
'Wrapper must not be an integer',
'- Wrapper must not be an integer',
['foo' => 'Wrapper must not be an integer'],
));
test('With "Not" name, inverted', expectAll(
fn() => v::not(v::property('foo', v::intType()))->setName('Not')->assert((object) ['foo' => 12]),
'Not must not be an integer',
'- Not must not be an integer',
['foo' => 'Not must not be an integer'],
));
test('With template, default', expectAll(
fn() => v::property('foo', v::intType())
->assert((object) ['foo' => 'string'], 'Particularly precautions perplexing property'),
'Particularly precautions perplexing property',
'- Particularly precautions perplexing property',
['foo' => 'Particularly precautions perplexing property'],
));
test('With template, inverted', expectAll(
fn() => v::not(v::property('foo', v::intType()))
->assert((object) ['foo' => 12], 'Not a prompt prospect of a particularly primitive property'),
'Not a prompt prospect of a particularly primitive property',
'- Not a prompt prospect of a particularly primitive property',
['foo' => 'Not a prompt prospect of a particularly primitive property'],
));