Matchers

A Matcher is the Kotest term for an assertion that performs a specific test. For example, a matcher may test that a double is greater than zero. Or it it may test that a file is not empty.

Kotest currently has approximately 400 matchers split across several modules. Most of these matchers are for standard library types. Others are project specific. Additionally, there are matchers provided by third party libraries.

Kotest matchers are framework agnostic. You can use them with the Kotest framework, or with any other framework, such as JUnit.

Matchers can be used in two styles:

• Extension functions like a.shouldBe(b) or a.shouldStartWith("foo")
• Infix functions like a shouldBe b or a should startWith("foo")

Both styles are supported. The advantage of the extension function style is that the IDE can autocomplete for you, but some people may prefer the infix style as it is slightly cleaner.

Matchers can be negated by using shouldNot instead of should for the infix style. For example, a shouldNot startWith("boo"). For the extension function style, each function has an equivalent negated version, for example, a.shouldNotStartWith("boo").

Kotest Matcher Modules

These modules provide the core matcher experience. They are hosted in the main Kotest repo, and are released on the same cadence as the Kotest framework.

Module	Description	Type
kotest-assertions-core	Provides matchers for standard libary types.	Multiplatform
kotest-assertions-arrow	Provides matchers for the Arrow functional programming library.	Multiplatform
kotest-assertions-compiler	Provides matchers that test for compilable code.	JVM
kotest-assertions-json	Provides matchers for testing JSON files.	Multiplatform
kotest-assertions-ktor	Provides matchers for Ktor server test and client libraries.	Multiplatform
kotest-assertions-konform	Provides matchers for Konform.	Multiplatform
kotest-assertions-kotlinx-time	Provides matchers for Kotlin's date / time library.	Multiplatform
kotest-assertions-ktor	Provides matchers for Jetbrains' KTor HTTP library.	Multiplatform
kotest-assertions-table	Provides backwards compatibility for the Kotest 4.x table test style	Multiplatform
kotest-assertions-yaml	Provides matchers for testing YAML files	Multiplatform

Community Provided Matchers

This is a list of projects that provide Kotest matchers. They are maintained outside of the Kotest organization.

Library	Description
Android	Toolbox for working with Kotest and Android
Http4k	Functional toolkit for Kotlin HTTP applications
Micronaut	JVM-based, full-stack framework for building modular, easily testable microservice

To add your library to this list, please open a PR.