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.

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

Jump to bottom

feat: add support for custom snapshot names, close #555 #563

Merged
merged 13 commits into from
Nov 3, 2021
Merged

feat: add support for custom snapshot names, close #555 #563

merged 13 commits into from
Nov 3, 2021

Conversation

noahnu
Copy link
Collaborator

@noahnu noahnu commented Oct 26, 2021

Description

Based on #561.

Related Issues

obendidi and others added 10 commits October 24, 2021 17:02
@obendidi
Add snapshot_name_suffix property to AssertionResult class
b7bf6f9 
The snapshot_name_suffix will hold an optional suffix to be used instead
of index in the snapshot_name. teh suffix will be default be formatted to
be between brackets: "[<snapshot_name_suffix>]"
@obendidi
Update syrupy extensions to use snapshot_name_suffix when provided.
35782d1 
The snapshot_name_suffix will be used instead of index if it is provided
@obendidi
Update tests
bf37fd4
@obendidi
Update type of snapshot_name_suffix output to str
9550aa7
@obendidi
Add support for custom_suffix in image snapshot, and add test example
c695a46
@obendidi @noahnu
Apply suggestions from code review
138c293 
Update type of snapshot_name_suffix from str to Optional[str]

Co-authored-by: Noah <[email protected]>
@obendidi
(review) refactor index, and keep only snapshot_name_suffix, snapshot…
fc581c9 
…_name_suffix is resolved when it is called as property of SnapshotAssertion and keeps teh same convention as before
@obendidi
(review) remove forgotten default string values for snapshot_name_suf…
7bd9226 
…fix in tests
@obendidi
Fix isort on tests/examples/test_custom_image_name_suffix.py
3f8807e
refactor: reduce API changes
9b92bd0
@codecov
Copy link

codecov bot commented Oct 26, 2021 •
edited
Loading

Codecov Report

Merging #563 (f657109) into master (21cfed8) will decrease coverage by 0.26%.
The diff coverage is 100.00%.

❗ Current head f657109 differs from pull request most recent head b56c8c5. Consider uploading reports for the commit b56c8c5 to get more accurate results

@@            Coverage Diff             @@
##           master     #563      +/-   ##
==========================================
- Coverage   99.91%   99.64%   -0.27%     
==========================================
  Files          19       19              
  Lines        1130     1142      +12     
==========================================
+ Hits         1129     1138       +9     
- Misses          1        4       +3

@noahnu noahnu mentioned this pull request Oct 26, 2021
Closed
3 tasks
@iamogbz
Copy link
Collaborator

iamogbz commented Oct 27, 2021

Nice! This looks similar to stuff I had to do here https://github.com/tophat/syrupy/pull/526/files, can rebase after this gets merged in

@noahnu
Copy link
Collaborator Author

noahnu commented Oct 27, 2021

What's left on this PR: we need to address #561 (comment)

@noahnu
Copy link
Collaborator Author

noahnu commented Nov 3, 2021

For context: had to wrap the custom name in square brackets to prevent the "cannot relate snapshot name" warning. Reason this works is because https://github.com/tophat/syrupy/blob/818d405a85c2f1f5db9d673e632677c10cb52ad9/src/syrupy/location.py#L67 stops reading the name at the first non-valid python id character, which would be [ in this case. Being able to relate snapshots is critical for discovering unused snapshots.

In the next major version of syrupy, I'd propose including the index in the snapshot itself, separate from the snapshot name so we can better differentiate the two.

@noahnu noahnu mentioned this pull request Nov 3, 2021
Closed
@noahnu noahnu merged commit 81a8a45 into master Nov 3, 2021
@noahnu noahnu deleted the reduce_api_changes branch November 3, 2021 14:14
@noahnu
Copy link
Collaborator Author

noahnu commented Nov 3, 2021

@all-contributors add bendidi for code

@allcontributors allcontributors bot mentioned this pull request Nov 3, 2021
Merged
@allcontributors
Copy link
Contributor

@noahnu

I've put up a pull request to add @Bendidi! 🎉

tophat-opensource-bot pushed a commit that referenced this pull request Nov 3, 2021
@semantic-release-bot
chore(release): 1.5.0 [skip ci]
1a782ea 
# [1.5.0](v1.4.7...v1.5.0) (2021-11-03)

### Features

* add support for custom snapshot names, close [#555](#555) ([#563](#563)) ([81a8a45](81a8a45))
@tophat-opensource-bot
Copy link
Contributor

🎉 This PR is included in version 1.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Give custom name to image snapshot file
4 participants
@noahnu @iamogbz @tophat-opensource-bot @obendidi