Snapshot Testing

[Kayanski]

This PR aims at introducing snapshot testing for migrations of smart-contracts. This is used to make sure that no breaking change to underlying state is introduced my version modifications :

• Implementation
• Snapshot testing documentation

Implementation

We introduce a new snapshot_testing method on the Mock structure. We advise using it at the end of every test that need stabilizing. It dumps the whole contract states of your structures and snapshot tests it.

You can test it by:

• commenting out the line counter.increment()?; in the packages/cw-orch-mock/tests/conditional.rs file
• running cargo test

More information about snapshot testing here
https://insta.rs/docs/quickstart/

[cloudflare-workers-and-pages]

Deploying with    Cloudflare Pages

Latest commit:	1a3bc1b
Status:	⚡️  Build in progress...

View logs

[codecov]

Codecov Report

Merging #260 (fe97013) into main (f43ae81) will increase coverage by 0.2%.
The diff coverage is 100.0%.

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

Additional details and impacted files

Files	Coverage Δ
cw-orch/src/snapshots.rs	100.0% <100.0%> (ø)

... and 3 files with indirect coverage changes

[AndrewPochapsky]

This is great! I never knew that I wanted snapshot testing in cosmwasm but it seems like the perfect fit :)

[Kayanski]

Today, the take_storage_snapshot function is a member of the Mock and thus the snapshots have to be named to be recognized from one another.
We could prevent that by changing that function to a macro, which would allow to not input a name for the snaps.
However, that would remove the function from the Mock API and thus would make it harder to find. What do you think ?

[CyberHoward]

It's good that it needs a name but in the code it doesn't? See my comment above.

[Kayanski]

It's good that it needs a name but in the code it doesn't? See my comment above.

Oh yeah I have added a name after you suggested it

[CyberHoward]

Status on this? Really want Abstract snapshots for our next release!