Skip to content
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.

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

Migrate to syrupy snapshot testing #1005

Merged
merged 1 commit into from
Nov 10, 2021

Conversation

sliverc
Copy link
Member

@sliverc sliverc commented Oct 28, 2021

Description of the Change

snapshottest is not really maintained anymore and causes issue in showing the diff as recent versions changed ordering (see #1003). Therefore suggesting that we move to syrupy which is well maintained, has better pytest integration, has a proper serialization format (instead of simply writing python code as snapshottest does) and is extensible.

For now this PR is a simple migration without any changes in testing. In the future also when working on #468 we might create our own syrupy extensions to simplify our testing (e.g. in test_openapi there a quite a few json.dumps).

Checklist

  • PR only contains one change (considered splitting up PR)
  • unit-test added
  • documentation updated
  • CHANGELOG.md updated (only for user relevant changes)
  • author name in AUTHORS

@sliverc sliverc requested a review from n2ygk October 28, 2021 18:28
Copy link
Contributor

@n2ygk n2ygk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Sorry for the long delay.

@n2ygk n2ygk merged commit f32e823 into django-json-api:master Nov 10, 2021
@sliverc sliverc deleted the intro_syrupy branch November 10, 2021 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants