Truthish
A testing API inspired by Google Truth but rewritten in Kotlin from the ground up, so it can be used in Kotlin multiplatform projects.
For example, you can write assertThat checks in tests like this:
import com.varabyte.truthish.*
fun isEven(num: Int) = (num % 2) == 0
fun square(num: Int) = (num * num)
@Test
fun testEvenOdd() {
assertThat(isEven(1234)).isTrue()
assertThat(isEven(1235)).isFalse()
}
@Test
fun testSum() {
val nums = listOf(1, 2, 3, 4, 5)
assertThat(nums.sum()).isEqualTo(15)
}
@Test
fun testMap() {
assertThat(listOf(1, 2, 3, 4, 5).map { square(it) })
.containsExactly(1, 4, 9, 16, 25)
.inOrder()
}
@Test
fun customMessage() {
assertWithMessage("Unexpected list size")
.that(listOf(1, 2, 3, 4, 5)).hasSize(5)
}
@Test
fun testDivideByZeroException() {
val ex = assertThrows<ArithmeticException> {
10 / 0
}
assertThat(ex.message).isEqualTo("/ by zero")
}
You can read the Google Truth documentation for why they believe their fluent approach to assertions is both more readable and produces cleaner error messages, but let's break one of the tests above to see a specific example error message:
@Test
fun testMapButIntentionallyBroken() {
assertThat(listOf(1, 2, 3, 4, 5).map { square(it) })
.containsExactly(1, 4, 9, 15, 26) // <-- Ooops, messed up 16 and 25 here
.inOrder()
}
Output:
A collection did not contain element(s)
Expected exactly all elements from: [ 1, 4, 9, 15, 26 ]
But was : [ 1, 4, 9, 16, 25 ]
Missing : [ 15, 26 ]
Extraneous : [ 16, 25 ]
Using Truthish in Your Project
Multiplatform
To use Truthish in your multiplatform application, declare the following dependencies:
// build.gradle
// Multiplatform
repositories {
mavenCentral()
}
kotlin {
jvm()
js(IR) {
browser()
}
// ...
sourceSets {
// ...
commonTest {
dependencies {
implementation kotlin("test-common")
implementation kotlin("test-annotations-common")
// ...
implementation "com.varabyte.truthish:truthish:0.6.3"
}
}
jmvTest {
dependencies {
implementation kotlin("test")
implementation "com.varabyte.truthish:truthish-jvm:0.6.3"
}
}
jsTest {
dependencies {
implementation kotlin("test-js")
implementation "com.varabyte.truthish:truthish-js:0.6.3"
}
}
}
}
Single platform
You can also use Truthish in non-multiplatform projects as well:
// build.gradle
// JVM
repositories {
/* ... */
maven { url 'https://us-central1-maven.pkg.dev/varabyte-repos/public' }
}
dependencies {
// ...
testImplementation "org.jetbrains.kotlin:kotlin-test"
testImplementation "com.varabyte.truthish:truthish:0.6.3"
}
8 Dec 6, 2022
3 Nov 17, 2022
98 Dec 15, 2022
326 Dec 23, 2022
220 Dec 28, 2022
32 Nov 10, 2022
51 Nov 21, 2022
235 Dec 29, 2022
39 Nov 4, 2022
56 Oct 4, 2022
20 Nov 19, 2022
4 Aug 18, 2022
1.4k Dec 23, 2022
61 Nov 13, 2022
1 Mar 22, 2022
3 Dec 31, 2021
2 Oct 17, 2022
31 Nov 29, 2021