Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! 
How to use CompletableFuture.shouldBeCompletedExceptionally method of io.kotest.matchers.future.matchers class
Best Kotest code snippet using io.kotest.matchers.future.matchers.CompletableFuture.shouldBeCompletedExceptionally
FutureMatcherTest.kt
Source:FutureMatcherTest.kt 
1package com.sksamuel.kotest.matchers.future2import io.kotest.assertions.throwables.shouldThrowMessage3import io.kotest.core.spec.style.StringSpec4import io.kotest.matchers.future.*5import kotlinx.coroutines.delay6import java.util.concurrent.CompletableFuture7import java.util.concurrent.Executors8class FutureMatcherTest : StringSpec({9 "test future is completed" {10 val completableFuture = CompletableFuture<Int>()11 completableFuture.complete(2)12 completableFuture.shouldBeCompleted()13 }14 "test future is not completed" {15 val completableFuture = CompletableFuture<Int>()16 completableFuture.shouldNotBeCompleted()17 }18 "test future is cancelled" {19 val completableFuture = CompletableFuture<Int>()20 completableFuture.cancel(true)21 completableFuture.shouldBeCancelled()22 }23 "test future is not cancelled" {24 val completableFuture = CompletableFuture<Int>()25 completableFuture.shouldNotBeCancelled()26 }27 "test future is completed exceptionally" {28 val completableFuture = CompletableFuture<Int>()29 Executors.newFixedThreadPool(1).submit {30 completableFuture.cancel(false)31 }32 delay(200)33 completableFuture.shouldBeCompletedExceptionally()34 }35 "test future is not completed exceptionally" {36 val completableFuture = CompletableFuture<Int>()37 completableFuture.complete(2)38 completableFuture.shouldNotBeCompletedExceptionally()39 }40 "test future completes exceptionally with the given exception"{41 val completableFuture = CompletableFuture<Int>()42 val exception = RuntimeException("Boom Boom")43 Executors.newFixedThreadPool(1).submit {44 completableFuture.completeExceptionally(exception)45 }46 completableFuture shouldCompleteExceptionallyWith exception47 }48 "test future does not completes exceptionally with given exception " {49 val completableFuture = CompletableFuture<Int>()50 Executors.newFixedThreadPool(1).submit {51 completableFuture.completeExceptionally(RuntimeException("Boom Boom"))52 }53 completableFuture shouldNotCompleteExceptionallyWith RuntimeException("Bang Bang")54 }55 "test error message for shouldCompleteExceptionallyWith when completable future does not complete with exception" {56 val completableFuture = CompletableFuture<Int>()57 val exception = RuntimeException("Boom Boom")58 completableFuture.complete(2)59 shouldThrowMessage("Expected future to fail with $exception, but it did not failed with any exception") {60 completableFuture shouldCompleteExceptionallyWith exception61 }62 }63 "test error message for shouldCompleteExceptionallyWith when completable future fail with some other exception" {64 val completableFuture = CompletableFuture<Int>()65 val expectedException = RuntimeException("Boom Boom")66 val actualException = RuntimeException("Bang Bang")67 completableFuture.completeExceptionally(actualException)68 shouldThrowMessage("Expected future to fail with $expectedException, but it failed with $actualException") {69 completableFuture shouldCompleteExceptionallyWith expectedException70 }71 }72 "test error message for shouldNotCompleteExceptionallyWith when completable future completes with given exception" {73 val completableFuture = CompletableFuture<Int>()74 val exception = RuntimeException("Boom Boom")75 completableFuture.completeExceptionally(exception)76 shouldThrowMessage("Expected future not to fail with $exception, but it did fail with it.") {77 completableFuture shouldNotCompleteExceptionallyWith exception78 }79 }80 "test shouldNotCompleteExceptionallyWith passes when completable future completes without any exception" {81 val completableFuture = CompletableFuture<Int>()82 completableFuture.complete(2)83 completableFuture shouldNotCompleteExceptionallyWith RuntimeException("Bang Bang")84 }85})...
matchers.kt
Source:matchers.kt
1package io.kotest.matchers.future2import io.kotest.matchers.Matcher3import io.kotest.matchers.MatcherResult4import io.kotest.matchers.should5import io.kotest.matchers.shouldBe6import io.kotest.matchers.shouldNot7import io.kotest.matchers.shouldNotBe8import java.util.concurrent.CompletableFuture9fun <T> CompletableFuture<T>.shouldBeCompletedExceptionally() = this shouldBe completedExceptionally<T>()10fun <T> CompletableFuture<T>.shouldNotBeCompletedExceptionally() = this shouldNotBe completedExceptionally<T>()11fun <T> completedExceptionally() = object : Matcher<CompletableFuture<T>> {12 override fun test(value: CompletableFuture<T>): MatcherResult =13 MatcherResult(14 value.isCompletedExceptionally,15 { "Future should be completed exceptionally" },16 {17 "Future should not be completed exceptionally"18 })19}20fun <T> CompletableFuture<T>.shouldBeCompleted() = this shouldBe completed<T>()21fun <T> CompletableFuture<T>.shouldNotBeCompleted() = this shouldNotBe completed<T>()22fun <T> completed() = object : Matcher<CompletableFuture<T>> {23 override fun test(value: CompletableFuture<T>): MatcherResult =24 MatcherResult(25 value.isDone,26 { "Future should be completed" },27 {28 "Future should not be completed"29 })30}31fun <T> CompletableFuture<T>.shouldBeCancelled() = this shouldBe cancelled<T>()32fun <T> CompletableFuture<T>.shouldNotBeCancelled() = this shouldNotBe cancelled<T>()33fun <T> cancelled() = object : Matcher<CompletableFuture<T>> {34 override fun test(value: CompletableFuture<T>): MatcherResult =35 MatcherResult(36 value.isCancelled,37 { "Future should be completed" },38 {39 "Future should not be completed"40 })41}42infix fun CompletableFuture<*>.shouldCompleteExceptionallyWith(throwable: Throwable) =43 this should completeExceptionallyWith(throwable)44infix fun CompletableFuture<*>.shouldNotCompleteExceptionallyWith(throwable: Throwable) =45 this shouldNot completeExceptionallyWith(throwable)46internal fun completeExceptionallyWith(throwable: Throwable) = object : Matcher<CompletableFuture<*>> {47 override fun test(value: CompletableFuture<*>): MatcherResult {48 val exception = value.runCatching { get() }.exceptionOrNull()49 return MatcherResult(50 exception != null && exception.cause == throwable,51 { errorMessageForTestFailure(exception?.cause, throwable) },52 { "Expected future not to fail with ${exception?.cause}, but it did fail with it." }53 )54 }55}56internal fun errorMessageForTestFailure(actualException: Throwable?, expectedException: Throwable): String {57 if (actualException == null) {58 return "Expected future to fail with $expectedException, but it did not failed with any exception"59 }60 return "Expected future to fail with $expectedException, but it failed with $actualException"61}...
CompletableFuture.shouldBeCompletedExceptionally
Using AI Code Generation
1val future = CompletableFuture<String>() future.shouldBeCompletedExceptionally()2val future = CompletableFuture<String>() future.shouldBeCancelled()3val future = CompletableFuture<String>() future.shouldBeCompletedWithNull()4val future = CompletableFuture<String>() future.shouldBeCompletedWith("Hello")5val future = CompletableFuture<String>() future.shouldBeCompletedWithValue("Hello")6val future = CompletableFuture<String>() future.shouldBeCompletedWithAnyOf("Hello", "World")7val future = CompletableFuture<String>() future.shouldBeCompletedWithAllOf("Hello", "World")8val future = CompletableFuture<String>() future.shouldBeCompletedWithNoneOf("Hello", "World")9val future = CompletableFuture<String>() future.shouldBeCompletedWithOneOf("Hello", "World")10val future = CompletableFuture<String>() future.shouldBeCompletedWithOneOf("Hello", "World")11val future = CompletableFuture<String>() future.shouldBeCompletedWithAnyOf("Hello", "World")12val future = CompletableFuture<String>() future.shouldBeCompletedWithAllOf("Hello", "World")13val future = CompletableFuture<String>() future.shouldBeCompletedWithNoneOf("Hello", "World")
CompletableFuture.shouldBeCompletedExceptionally
Using AI Code Generation
1import io.kotest.assertions.throwables.shouldThrow2import io.kotest.matchers.future.shouldBeCompletedExceptionally3import io.kotest.matchers.future.shouldBeCompletedWith4import io.kotest.matchers.future.shouldBeRunning5import io.kotest.matchers.future.shouldBeTerminated6import io.kotest.matchers.future.shouldBeWaiting7import io.kotest.matchers.future.shouldBeWaitingFor8import io.kotest.matchers.future.shouldBeWaitingForAnyOf9import io.kotest.matchers.future.shouldBeWaitingForAllOf10import io.kotest.matchers.future.shouldBeWaitingForEither11import io.kotest.matchers.future.shouldBeWaitingForEitherOf12import io.kotest.matchers.future.shouldBeWaitingForNoneOf13import io.kotest.matchers.future.shouldBeWaitingForNot14import io.kotest.matchers.future.shouldBeWaitingForSequence15import io.kotest.matchers.future.shouldBeWaitingForSomeOf16import io.kotest.matchers.future.shouldBeWaitingForTermination17import io.kotest.matchers.future.shouldBeWaitingForTimeout18import io.kotest.matchers.future.shouldBeWaitingForUnit19import io.kotest.matchers.future.shouldBeWaitingForValue20import io.kotest.matchers.future.shouldBeWaitingForValueAtMost21import io.kotest.matchers.future.shouldBeWaitingForValueOrNull22import io.kotest.matchers.future.shouldBeWaitingForValueOrNullAtMost23import io.kotest.matchers.future.shouldBeWaitingForValueOrThrow24import io.kotest.matchers.future.shouldBeWaitingForValueOrThrowAtMost25import io.kotest.matchers.future.shouldBeWaitingForValueUninterruptibly26import io.kotest.matchers.future.shouldBeWaitingForValueUninterruptiblyAtMost27import io.kotest.matchers.future.shouldBeWaitingForValueUninterruptiblyOrNull28import io.kotest.matchers.future.shouldBeWaitingForValueUninterruptiblyOrNullAtMost29import io.kotest.matchers.future.shouldBeWaitingForValueUninterruptiblyOrThrow30import io.kotest.matchers.future.shouldBeWaitingForValueUninterruptiblyOrThrowAtMost31import io.kotest.matchers.future.shouldBeWaitingUntil32import io.kotest.matchers.future.shouldNotBeCompletedExceptionally
CompletableFuture.shouldBeCompletedExceptionally
Using AI Code Generation
1val future = CompletableFuture.supplyAsync { throw RuntimeException("Oops") }2future.shouldBeCompletedExceptionally()3val future = CompletableFuture.supplyAsync { "Hello" }4future.shouldBeCompletedWith("Hello")5val future = CompletableFuture.supplyAsync { "Hello" }6future.shouldBeCompletedWithValue("Hello")7val future = CompletableFuture.supplyAsync { "Hello" }8future.shouldBeCompletedWithValueMatching { it.startsWith("H") }9val future = CompletableFuture.supplyAsync { "Hello" }10future.shouldBeCompletedWithValueSatisfying { it.startsWith("H") }11val future = CompletableFuture.supplyAsync { "Hello" }12future.shouldBeCompletedWithValueWithin(100.milliseconds, "Hello")13val future = CompletableFuture.supplyAsync { "Hello" }14future.shouldBeCompletedWithValueWithin(100.milliseconds, "Hello")15val future = CompletableFuture.supplyAsync { "Hello" }16future.shouldBeCompletedWithin(100.milliseconds)17val future = CompletableFuture.supplyAsync { "" }
CompletableFuture.shouldBeCompletedExceptionally
Using AI Code Generation
1fun `test future completed exceptionally` () { val future = CompletableFuture . failedFuture ( Exception ( "boom" )) future . shouldBeCompletedExceptionally () }2fun `test future cancelled` () { val future = CompletableFuture . runAsync { Thread . sleep ( 1000 ) } future . cancel ( true ) future . shouldBeCancelled () }3fun `test future cancelled with exception` () { val future = CompletableFuture . runAsync { Thread . sleep ( 1000 ) } future . cancel ( true , Exception ( "boom" )) future . shouldBeCancelledWith ( Exception ( "boom" )) }4fun `test future completed with value` () { val future = CompletableFuture . supplyAsync { "Hello World" } future . shouldBeCompletedWith ( "Hello World" ) }5fun `test future completed with null` () { val future = CompletableFuture . supplyAsync { null } future . shouldBeCompletedWithNull () }6fun `test future completed with any of the given values` () { val future = CompletableFuture . supplyAsync { "Hello World" } future . shouldBeCompletedWithAnyOf ( "Hello" , "World" ) }7fun `test future completed with all of the given values` () { val future = CompletableFuture . supplyAsync { "Hello World" } future . shouldBeCompletedWithAllOf ( "Hello" , "World" ) }
CompletableFuture.shouldBeCompletedExceptionally
Using AI Code Generation
1fun `should be completed exceptionally with exception` () {2 val future = CompletableFuture. failedFuture < String > ( RuntimeException ( "exception" ))3 future . shouldBeCompletedExceptionally ( RuntimeException ( "exception" ))4}5fun `should be completed exceptionally with exception type` () {6 val future = CompletableFuture. failedFuture < String > ( RuntimeException ( "exception" ))7 future . shouldBeCompletedExceptionally < RuntimeException > ()8}9fun `should be completed with value` () {10 val future = CompletableFuture. completedFuture < String > ( "value" )11 future . shouldBeCompletedWith ( "value" )12}13fun `should be completed with value type` () {14 val future = CompletableFuture. completedFuture < String > ( "value" )15 future . shouldBeCompletedWith < String > ()16}17fun `should be completed with value type and value` () {18 val future = CompletableFuture. completedFuture < String > ( "value" )19 future . shouldBeCompletedWith < String > ( "value" )20}21fun `should be completed with value type and value predicate` () {22 val future = CompletableFuture. completedFuture < String > ( "value" )23 future . shouldBeCompletedWith < String > ( { it == "value" })24}
Automation Testing Tutorials
Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.
LambdaTest Learning Hubs:
- JUnit Tutorial
- TestNG Tutorial
- Webdriver Tutorial
- WebDriverIO Tutorial
- Protractor Tutorial
- Selenium 4 Tutorial
- Jenkins Tutorial
- NUnit Tutorial
- Jest Tutorial
- Playwright Tutorial
- Cypress Tutorial
- PyTest Tutorial
YouTube
You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.
Run Kotest automation tests on LambdaTest cloud grid
Perform automation testing on 3000+ real desktop and mobile devices online.
Most used method in matchers
- CompletableFuture.shouldBeCompletedExceptionally
- CompletableFuture.shouldNotBeCompletedExceptionally
- completedExceptionally
- test
- CompletableFuture.shouldBeCompleted
- CompletableFuture.shouldNotBeCompleted
- completed
- CompletableFuture.shouldBeCancelled
- CompletableFuture.shouldNotBeCancelled
- cancelled
- completeExceptionallyWith
- errorMessageForTestFailure
Try LambdaTest Now !!
Get 100 minutes of automation test minutes FREE!!
Was this article helpful?
