Skip to content

Latest commit

 

History

History
109 lines (92 loc) · 6.37 KB

CHANGELOG.md

File metadata and controls

109 lines (92 loc) · 6.37 KB
Raw

Changelog

Changelog for the selfie JVM libraries.

[Unreleased]

Fixed

  • Do not remove stale snapshot files when readonly is true. (#367)

[2.0.2] - 2024-03-20

Fixed

  • toBeFile now checks for duplicate writes and throws a more helpful error message if the file doesn't exist. (#277)

[2.0.1] - 2024-02-24

Fixed

  • The coroutines methods used to eagerly throw an exception if they were ever called from anywhere besides a Kotest method. Now they wait until toMatchDisk() is called, because they can work just fine anywhere if you use toBe. (#247)

[2.0.0] - 2024-02-21

Added

  • Memoization (#219 implements #215)
    • like expectSelfie, all are available as Selfie.cacheSelfie or as suspend fun in com.diffplug.selfie.coroutines.
val cachedResult: ByteArray = Selfie.cacheSelfieBinary { dalleJpeg() }.toBeFile("example.jpg")
val cachedResult: String    = Selfie.cacheSelfie { someString() }.toBe("what it was earlier")
val cachedResult: T         = Selfie.cacheSelfieJson { anyKotlinxSerializable() }.toBe("""{"key": "value"}""")
val cachedResult: T         = Selfie.cacheSelfieBinarySerializable { anyJavaIoSerializable() }.toMatchDisk()
  • toBeBase64 and toBeFile for true binary comparison of binary snapshots and facets. (#224)
  • spaces in multiline string literals aren't always escaped. (#220)
    • if the leading spaces in the string literal match the file's existing indentation

Changed

  • BREAKING reordered a class hierarchy for better binary support. (#221)
    • most users won't need to make any changes at all
    • only exception is that expectSelfie(byte[]).toBe is now a compile error, must do toBeBase64

[1.2.0] - 2024-02-12

Added

  • Kotest support.
    • Add SelfieExtension to your AbstractProjectConfig.
    • Instead of calling Selfie.expectSelfie, call com.diffplug.selfie.coroutines.expectSelfie.
    • selfie-runner-junit5 supports snapshots in regular JUnit tests and Kotest tests in the same project.
    • selfie-runner-kotest is a new selfie implemented in Kotlin Multiplatform, but doesn't support snapshots within regular JUnit tests.
    • Full docs at https://selfie.dev/jvm/kotest.

Fixed

  • Swap thread-local cache for thread-ignorant LRU to improve performance when used with coroutines. (#191)

Changes

  • (no user-facing changes) replaced terrible platform-specific Path with TypedPath. (#184)
  • (no user-facing changes) replaced SnapshotStorage with SnapshotSystem + DiskStorage. (#198)
  • (no user-facing changes) replaced most synchronized with CAS. (#199)

[1.1.2] - 2024-01-30

Fixed

  • @ParameterizedTest no longer has. (#140)
  • If a test class contained package-private methods and a single test method was run without the others, selfie would erroneously garbage collect disk snapshots for the other methods, now fixed. (#175 fixes #174)

[1.1.1] - 2024-01-25

Fixed

  • Selfie was erroneously garbage collecting snapshots when a test class contained no @Test public methods. (#124 fixes #123)

[1.1.0] - 2024-01-21

Added

  • Support for @ParameterizedTest. (#118)
  • ArraySet<K> has been added to the standard library alongside ArrayMap<K, V>. (#119)
    • These have the strange property that if the key is String, then / characters are sorted to be the lowest possible character.

Fixed

  • We already smuggle errors from initialization to help debug them, and now we also smuggle errors that happen during test execution. (#117)
  • Fix a garbage collection bug which occurred when a test method's name was a prefix of another test method's name. (#119)

[1.0.1] - 2024-01-19

Fixed

  • Fix CompoundLens for Java users.

[1.0.0] - 2024-01-18

Added

  • Full support for binary snapshots. (#108)

Fixed

  • Groovy multiline string values just go into " strings instead of """ until we have a chance to implement them properly. (#107)

[0.3.0] - 2024-01-17

Added

  • toBe("mismatched") now gets rewritten in write mode
  • fully implemented the new control scheme (#74)
  • integers get _ separators for thousands, millions, etc

Known broken

  • Groovy multiline strings
  • Binary

[0.2.0] - 2023-12-27

Added

  • DiskSelfie.toMatchDisk now returns DiskSelfie so that we can fluently chain inline assertions on facets.

[0.1.3] - 2023-12-26

  • Publish selfie-lib-jvm and selfie-lib to Maven Central.

[0.1.2] - 2023-12-26

  • Publish selfie-lib-jvm instead of just selfie-lib to Maven Central.

[0.1.1] - 2023-12-24

  • Initial release, take 2.

[0.1.0] - 2023-12-24

  • Initial release.