Skip to content

Improved exception content (invalid field) #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
osteel merged 1 commit into from
Jul 1, 2022
Merged

Improved exception content (invalid field) #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/Exceptions/ValidationException.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@

use Exception;
use League\OpenAPIValidation\PSR7\Exception\ValidationFailed;
use League\OpenAPIValidation\Schema\Exception\SchemaMismatch;

class ValidationException extends Exception
{
/**
* Build a new exception based on a ValidationFailed one.
* Build a new exception from a ValidationFailed exception.
*
* @param ValidationFailed $exception
* @return ValidationException
Expand All @@ -22,6 +23,10 @@ public static function fromValidationFailed(ValidationFailed $exception): Valida

while ($exception = $exception->getPrevious()) {
$message .= sprintf(': %s', $exception->getMessage());

if ($exception instanceof SchemaMismatch && ! empty($breadCrumb = $exception->dataBreadCrumb())) {
$message .= sprintf(' Field: %s', implode('.', $breadCrumb->buildChain()));
}
}

return new ValidationException($message, 0, $previous);
Expand Down
10 changes: 7 additions & 3 deletions tests/Exceptions/ValidationExceptionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,21 @@

use Exception;
use League\OpenAPIValidation\PSR7\Exception\ValidationFailed;
use League\OpenAPIValidation\Schema\BreadCrumb;
use League\OpenAPIValidation\Schema\Exception\SchemaMismatch;
use Osteel\OpenApi\Testing\Exceptions\ValidationException;
use Osteel\OpenApi\Testing\Tests\TestCase;

class ValidationExceptionTest extends TestCase
{
public function testItCreatesAnExceptionFromAValidationFailedException()
{
$exception = new ValidationFailed('foo', 0, new Exception('bar', 0, new Exception('baz')));
$sut = ValidationException::fromValidationFailed($exception);
$breadCrumb = new BreadCrumb('qux');
$previous = (new SchemaMismatch('baz'))->withBreadCrumb($breadCrumb);
$exception = new ValidationFailed('foo', 0, new Exception('bar', 0, $previous));
$sut = ValidationException::fromValidationFailed($exception);

$this->assertEquals('foo: bar: baz', $sut->getMessage());
$this->assertEquals('foo: bar: baz Field: qux', $sut->getMessage());
$this->assertEquals($exception, $sut->getPrevious());
}
}