KTTestExpectation

The purpose of this library is to provide simple Kotlin implementation of Swift's expectation to ease testing of asynchronous code that doesn't make use of Kotlin coroutines.

Table of contents

• Installation
• Basic usage
• Advanced usage
• Contributing
• License

Installation

Add the MavenCentral repository to your build.gradle (Gradle Groovy) or build.gradle.kts (Kotlin DSL):

repositories {
    mavenCentral()
}

Add the dependency to your build.gradle (Gradle Groovy):

dependencies {
    androidTestImplementation 'io.github.danielepantaleone:kttestexpectation:1.2.1'
}

or build.gradle.kts (Kotlin DSL):

dependencies {
    androidTestImplementation("io.github.danielepantaleone:kttestexpectation:1.2.1")
}

Basic usage

Awaiting on a single expectation:

@Test
fun testAwaitSingleExpectation() {
    val expectation = expectation("Expectation")
    asyncLongOperationWithCallback {
        expectation.fulfill()
    }
    waitForExpectation(
        expectation = expectation,
        time = 10,
        unit = TimeUnit.SECONDS
    )
}

Awaiting on multiple expectations:

@Test
fun testAwaitMultipleExpectations() {
    val expectation1 = expectation("Expectation 1")
    val expectation2 = expectation("Expectation 2")
    asyncLongOperationWithCallback {
        expectation1.fulfill()
    }
    asyncLongerOperationWithCallback {
        expectation2.fulfill()
    }
    waitForExpectations(
        expectations = listOf(expectation1, expectation2),
        time = 20,
        unit = TimeUnit.SECONDS
    )
}

Advanced usage

Awaiting on multiple expectations with different expected fulfillment count:

@Test
fun testAwaitMultipleExpectations() {
    val expectation1 = expectation("Expectation 1")
    val expectation2 = expectation("Expectation 2")
    expectation2.expectedFulfillmentCount = 2
    asyncLongOperationWithCallback {
        expectation1.fulfill()
    }
    asyncLongerOperationWithCallback {
        expectation2.fulfill()
        asyncLongestLongerOperationWithCallback {
            expectation2.fulfill()
        }   
    }
    waitForExpectations(
        expectations = listOf(expectation1, expectation2),
        time = 60,
        unit = TimeUnit.SECONDS
    )
}

Awaiting on multiple expectations of different types:

@Test
fun testAwaitMultipleExpectationsWithMixedTypes() {
    val expectation1 = expectation("Expectation 1")
    val expectation2 = expectation("Expectation 2") {  // no need to manually fulfill()
        somePredicateThatWillEventuallyEvaluateToTrue()
    }
    asyncLongOperationWithCallback {
        expectation1.fulfill()
    }
    waitForExpectations(
        expectations = listOf(expectation1, expectation2),
        time = 60,
        unit = TimeUnit.SECONDS
    )
}

Contributing

If you like this project you can contribute it by:

• Submit a bug report by opening an issue
• Submit code by opening a pull request

License

MIT License

Copyright (c) 2023 Daniele Pantaleone

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.