hurok-test/com.ekezet.hurok.test

Package-level declarations

Tools for testing hurok-based applications

DSL for unit testing Action result

Functions for asserting Action results:

assertSkipped - assert no change at all
assertModel - assert the expected model change
assertEffects - assert triggering the expected effect(s)
assertModelNotChanged - assert the model not changed
assertNoEffects - assert no effects triggered

Example:

@Test
fun `Making a move works correctly`() {
    // set up init model and expected model
    // ...

    initModel after OnMoveMade(position) matches {
        assertModel(expectedModel)
        assertNoEffects()
    }
}

DSL for unit testing Effect

To test an Effect inherit from EffectTest and mock the dependency if there's one. Use com.ekezet.hurok.test.EffectTest.runWith to test and assert the subject against the mocked dependency.

Functions for asserting effect results:

com.ekezet.hurok.test.EmitAsserter.assertActions can be used to assert which actions were emitted
com.ekezet.hurok.test.EmitAsserter.assertNoActions can be used to assert that no actions ere emitted

Example:

class GameBoardEffectTest : EffectTest() {
    // ...

    @Test
    fun `WaitBeforeNextTurn works correctly`() = runTest {
        val nextMove: Position = mockk()

        dependency runWith WaitBeforeNextTurn(nextMove) matches {
            assertActions(listOf(OnMoveMade(nextMove)))
        }
    }
}

Testing the Renderer

To unit test a Renderer prepare a model, instantiate the Renderer and call its renderState() method to get the expected state. Then you can use assert methods like assertEquals() on the result.

Tools for testing hurok-based applications

DSL for unit testing Action result

Functions for asserting Action results:

assertSkipped - assert no change at all
assertModel - assert the expected model change
assertEffects - assert triggering the expected effect(s)
assertModelNotChanged - assert the model not changed
assertNoEffects - assert no effects triggered

Example:

@Test
fun `Making a move works correctly`() {
    // set up init model and expected model
    // ...

    initModel after OnMoveMade(position) matches {
        assertModel(expectedModel)
        assertNoEffects()
    }
}

DSL for unit testing Effect

To test an Effect inherit from EffectTest and mock the dependency if there's one. Use runWith to test and assert the subject against the mocked dependency.

Functions for asserting effect results:

assertActions can be used to assert which actions were emitted
assertNoActions can be used to assert that no actions ere emitted

Example:

class GameBoardEffectTest : EffectTest() {
    // ...

    @Test
    fun `WaitBeforeNextTurn works correctly`() = runTest {
        val nextMove: Position = mockk()

        dependency runWith WaitBeforeNextTurn(nextMove) matches {
            assertActions(listOf(OnMoveMade(nextMove)))
        }
    }
}

Testing the Renderer

To unit test a Renderer prepare a model, instantiate the Renderer and call its renderState() method to get the expected state. Then you can use assert methods like assertEquals() on the result.

Types

EffectTest

abstract class EffectTest(testContext: CoroutineContext = UnconfinedTestDispatcher(), testScope: CoroutineScope = TestScope(testContext)) : CoroutineScope

Base class for Effect tests.

EmitAsserter

class EmitAsserter<TModel : Any, TDependency> : ActionEmitter<TModel, TDependency>

Action emitter used for testing.

NextAsserter

class NextAsserter<TModel : Any, TDependency> : Asserter

Asserter for action results.

Functions

after

infix fun <TModel : Any, TDependency> TModel.after(action: Action<TModel, TDependency>): Action.Next<TModel, TDependency>

Apply the action to a model.

matches

infix fun <TModel : Any, TDependency> Action.Next<TModel, TDependency>.matches(block: NextAsserter<TModel, TDependency>.(next: Action.Next<TModel, TDependency>) -> Unit)

Assert the result of an action.

infix inline fun <TModel : Any, TDependency> EmitAsserter<TModel, TDependency>.matches(crossinline block: EmitAsserter<TModel, TDependency>.() -> Unit)

Assert emitted actions by the Effect.