commonMain.io.kotest.matchers.throwable.matchers.kt Maven / Gradle / Ivy

Go to download
package io.kotest.matchers.throwable

import io.kotest.assertions.show.show
import io.kotest.matchers.Matcher
import io.kotest.matchers.MatcherResult
import io.kotest.matchers.should
import io.kotest.matchers.shouldNot

infix fun Throwable.shouldHaveMessage(message: String) = this should haveMessage(message)
infix fun Throwable.shouldNotHaveMessage(message: String) = this shouldNot haveMessage(message)

fun haveMessage(message: String) = object : Matcher {
  override fun test(value: Throwable) = MatcherResult(
    value.message == message,
    "Throwable should have message ${message.show().value}, but instead got ${value.message.show().value}",
    "Throwable should not have message ${message.show().value}"
  )
}

fun Throwable.shouldHaveCause(block: (Throwable) -> Unit = {}) {
  this should haveCause()
  block.invoke(cause!!)
}

fun Throwable.shouldNotHaveCause() = this shouldNot haveCause()
fun haveCause() = object : Matcher {
  override fun test(value: Throwable) = resultForThrowable(value.cause)
}

inline fun  Throwable.shouldHaveCauseInstanceOf() = this should haveCauseInstanceOf()
inline fun  Throwable.shouldNotHaveCauseInstanceOf() = this shouldNot haveCauseInstanceOf()
inline fun  haveCauseInstanceOf() = object : Matcher {
  override fun test(value: Throwable) = when {
    value.cause == null -> resultForThrowable(value.cause)
    else -> MatcherResult(
        value.cause is T,
        "Throwable cause should be of type ${T::class}, but instead got ${value::class}",
        "Throwable cause should be of type ${T::class}"
    )
  }
}

inline fun  Throwable.shouldHaveCauseOfType() = this should haveCauseOfType()
inline fun  Throwable.shouldNotHaveCauseOfType() = this shouldNot haveCauseOfType()
inline fun  haveCauseOfType() = object : Matcher {
  override fun test(value: Throwable) = when (value.cause) {
      null -> resultForThrowable(value.cause)
      else -> MatcherResult(
         value.cause!!::class == T::class,
         "Throwable cause should be of type ${T::class}, but instead got ${value::class}",
         "Throwable cause should be of type ${T::class}"
      )
  }
}

@PublishedApi
internal fun resultForThrowable(value: Throwable?) = MatcherResult(
    value != null,
    "Throwable should have a cause",
    "Throwable should not have a cause"
)