selfie

Snapshot testing and memoization tool for efficient API call management, featuring zero-config setup, inline or disk snapshots, and automatic garbage collection. Supports multiple facets for comprehensive testing.

#scala

Suggest an edit

JVMJS

GitHub stars90

Authorsdiffplug

Open issues50

LicenseApache License 2.0

Creation datealmost 3 years ago

Last activity23 days ago

Latest release2.5.5 (3 months ago)

Homepage GitHub repository

Selfie: snapshot testing and memoizing for Python, JVM, and (your PR here)

Key features

Just add a test dependency (py, jvm), zero setup, zero config.
Snapshots can be inline literals or on disk.
Use expect_selfie for testing or cache_selfie for memoizing expensive API calls.
Disk snapshots are automatically garbage collected when the test class or test method is removed.
Snapshots are just strings. Use html, json, markdown, whatever. No magic serializers.
Record multiple facets of the entity under test, e.g. for a web request...
- store the HTML as one facet
- store HTML-rendered-to-markdown as another facet
- store cookies in another facet
- assert some facets on disk, others inline
- see gif above for live demo, detailed example here

Python and JVM ports are both production-ready, other platforms on the way: js, .NET, go, ...

Documentation

Quickstart (py, jvm)
Facets (py, jvm)
Caching / memoizing (py, jvm)
Why selfie (py, jvm)
API reference (py, jvm)

Contributing

PRs welcome! Horror stories and glory stories too, share your experience! See CONTRIBUTING.md.

Acknowledgements

Heavily inspired by origin-energy's java-snapshot-testing, which in turn is heavily inspired by Facebook's jest-snapshot.