KLIP
Kotlin Multiplatform (pending KSP support) snapshot (klip) manager for tests
Modules
- core - runtime library
- processor - ksp-based annotation processor to enable runtime work
- gradle-plugin - a gradle plugin to manage dependencies, config and ksp
- sandbox - a preconfigured sandbox to try out the setup without having to publish stuff
Usage
- Apply the plugin
plugins {
id("dev.petuska.klip") version "<version>"
}
- (Optional) Configure the plugin extension
klip {
root = File("some/custom/sources/root/src") // Unlikely to ever be anything but "./src" (default)
update = false // If set to true will overwrite the klips when running tests. Avoid hard-coding this.
}
- Annotate your test classes where you want to use klips with
@dev.petuska.klip.Klippable
Properties
Most of the DSL configuration options can also be set/overridden via gradle properties ./gradlew <some-task> -Pprop.name=propValue, gradle.properties or ~/.gradle/gradle.properties. Bellow is the full list of supported properties:
klip.rootklip.update
Basic Flow
- Run tests as normal and use generated klip assertions such as
assertKlip(id = "some id unique in test class scope", actual = MyActualValue()). New klips will always be written to files, whereas existing ones (identified by test class scope and given id) will be read and used for assertions. - When the actual value changes, tests will fail since they do not match previous klip. In such cases inspect the differences and if everything is as expected, re-run test(s) with klip updates enabled. This is done by either passing a gradle prop
./gradlew test -Pklip.updateor setting an environment variableKLIP_UPDATE=true ./gradlew test.
236 Dec 30, 2022
1 Feb 3, 2022
8 Jan 2, 2023
2.3k Dec 29, 2022
3 Sep 20, 2022
853 Dec 21, 2022
345 Dec 10, 2022
6 Jul 29, 2022
72 Dec 7, 2022
155 Dec 10, 2022
3 Dec 16, 2021
3 Dec 19, 2021
9 Dec 3, 2022
13 Oct 3, 2022
5 Dec 29, 2022
73 Nov 8, 2022
3 May 8, 2022
6 Dec 2, 2022
11 Dec 27, 2022