Skip to content

Snapshot testing for Java, Kotlin, and the JVM

License

Notifications You must be signed in to change notification settings

lewchuk-span/selfie

 
 

Repository files navigation

Selfie: snapshot testing and memoizing for Java, Kotlin, and the JVM

gif demo of selfie in action

Key features

  • Just add a test dependency, zero setup, zero config.
  • Snapshots can be inline literals or on disk.
  • Use expectSelfie for testing or cacheSelfie 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

JVM only for now, python is in progress, other platforms on the way: js, .NET, go, ...

Documentation

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.

About

Snapshot testing for Java, Kotlin, and the JVM

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Kotlin 53.2%
  • Python 22.1%
  • MDX 11.4%
  • TypeScript 7.0%
  • Java 3.6%
  • JavaScript 1.3%
  • Other 1.4%