Скачать или смотреть How to Fix assertJsonValidationErrors in Lumen Testing

Learn how to successfully handle validation tests in Lumen by understanding the differences in error response formats, and find out how to resolve the 'Failed to find a validation error' issue when using PHPUnit.
---
This video is based on the question https://stackoverflow.com/q/71561136/ asked by the user 'Pezhvak' ( https://stackoverflow.com/u/2396674/ ) and on the answer https://stackoverflow.com/a/71561137/ provided by the user 'Pezhvak' ( https://stackoverflow.com/u/2396674/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Cannot test validation errors in Lumen

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Solving Validation Errors in Lumen Testing

When you're working on a Lumen application and trying to implement validation on your controller responses, you may encounter a frustrating problem. You might receive an error message like this:

[[See Video to Reveal this Text or Code Snippet]]

This typically occurs when using PHPUnit's assertJsonValidationErrors method in your tests. Why does this happen, and how can you fix it? Let’s dive into the details.

Understanding the Issue

Lumen's response handling for validation errors differs significantly from Laravel. In Laravel, validation errors are wrapped inside an errors key of the JSON response. However, in Lumen, this format is not applicable. The absence of this wrapping leads to PHPUnit assertions failing, as it cannot locate the expected error under the specified key.

Example of the Problematic Test

Here’s an example of how a typical test might be written that could lead to the aforementioned error:

[[See Video to Reveal this Text or Code Snippet]]

In this test, when PostgreSQL tries to validate the response for the 'name' field, it throws the error because it cannot find the validation message in the standard Laravel response format.

The Solution

The good news is that the solution to this problem is straightforward! You need to tweak how you call the assertJsonValidationErrors method.

Key Changes to Implement

To fix the validation error assertion, you can simply pass null as the second parameter to the assertJsonValidationErrors method. This change acknowledges Lumen's formatting and effectively avoids the assertion error.

Here's How to Update Your Test

Here’s how you should modify your test:

[[See Video to Reveal this Text or Code Snippet]]

Step-by-Step Breakdown

Run Your Test: Start by running your test as is to see the original error.

Modify the Assertion: Change the assertJsonValidationErrors line to include null as the second parameter.

Test Again: Run your tests again to verify that they pass without issues.

By implementing this small change, you should find that Lumen's testing now correctly validates your input and won't throw errors regarding the validation key anymore.

Conclusion

Testing validation in Lumen can be tricky because of the difference in error formatting compared to Laravel. However, by understanding this key difference and adjusting your assertions accordingly, you can avoid the common pitfalls. Using null as the second parameter in assertJsonValidationErrors resolves the issue effectively.

With this knowledge in hand, you can now confidently write and maintain your Lumen tests without fear of running into validation error assertions.