Snapshot testing #793
Merged
Snapshot testing #793
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
darrenburns
commented
Sep 22, 2022
Comment on lines
+46
to
+51
| - name: Upload snapshot report | ||
| if: always() | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: snapshot-report-textual | ||
| path: tests/snapshot_tests/output/snapshot_report.html |
There was a problem hiding this comment.
This runs on both failure and success. On success, there's no snapshot report, but the step still succeeds.
darrenburns
commented
Sep 22, 2022
Comment on lines
+5
to
+6
| test-snapshot-update: | ||
| pytest --cov-report term-missing --cov=textual tests/ -vv --snapshot-update |
There was a problem hiding this comment.
Since this runs all tests, it'll update all snapshots.
darrenburns
commented
Sep 22, 2022
| @@ -0,0 +1,43 @@ | |||
| # Snapshot Testing | |||
darrenburns
commented
Sep 22, 2022
| @@ -48,13 +48,15 @@ pre-commit = "^2.13.0" | |||
| pytest-aiohttp = "^1.0.4" | |||
| time-machine = "^2.6.0" | |||
| Jinja2 = "<3.1.0" | |||
| syrupy = "^3.0.0" | |||
There was a problem hiding this comment.
This is the snapshot testing library we're wrapping which handles associating pytest test functions with snapshots on disk.
darrenburns
commented
Sep 22, 2022
|
|
||
| [tool.black] | ||
| includes = "src" | ||
|
|
||
| [tool.pytest.ini_options] | ||
| asyncio_mode = "auto" | ||
| testpaths = ["tests"] | ||
| addopts = "--strict-markers" |
There was a problem hiding this comment.
IMO this should be the default - if you use an undefined marker it'll fail fast - good for catching typos.
darrenburns
commented
Sep 22, 2022
| @@ -0,0 +1,30 @@ | |||
| def test_grid_layout_basic(snap_compare): | |||
There was a problem hiding this comment.
A selection of layout related tests to get us started.
willmcgugan
approved these changes
Sep 23, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds snapshot testing features to the test suite, and a set of layout-related example tests. We can craft better example apps to do snapshots on in the future.
Basic view:
After toggling the "show difference" switch:
Link to the report will be written to your terminal in the event of a snapshot mismatch:
If you're running in CI, it'll be saved as a build artifact which you can download and view: