Tools for testing hurok-based applications

DSL for unit testing Action result

Functions for asserting com.ekezet.hurok.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 com.ekezet.hurok.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 com.ekezet.hurok.Renderer prepare a model, instantiate the com.ekezet.hurok.Renderer and call its com.ekezet.hurok.Renderer method to get the expected state. Then you can use assert methods like assertEquals() on the result.