Improve snapshot tests assertion messages #7820

mamazu · 2025-02-24T14:33:00Z

The problem

When I create a test and assert that the output matches a given snapshot I write this:

$this->assertSnapshot('some-random-path.txt', $response->getContent(), 'Response content does not match');

If the file I specified does not exist however the error message was very cryptic and took some debugging to figure out what the real problem was.

Before I just got a

Failed asserting that false is of type string.

Now it says:

Failed asserting that file "/some-random-path.txt" exists.

mamazu changed the base branch from 2.6 to 3.0 February 24, 2025 14:33

mamazu force-pushed the more_helpful_errors branch 2 times, most recently from e2af500 to fa996f5 Compare February 24, 2025 14:43

Adding more helpful error messages to snapshot assertions

7393c80

mamazu force-pushed the more_helpful_errors branch from fa996f5 to 7393c80 Compare February 24, 2025 14:43

mamazu changed the title ~~More helpful errors~~ Improve snapshot tests assertion messages Mar 10, 2025

alexander-schranz approved these changes May 14, 2025

View reviewed changes

alexander-schranz merged commit 0f24fbf into sulu:3.0 May 14, 2025
9 checks passed

alexander-schranz added the DX Affecting the end developer label May 14, 2025

mamazu deleted the more_helpful_errors branch May 14, 2025 11:44