1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
/*
* MIT License
*
* Copyright (c) 2019 atlarge-research
*
* 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.
*/
package com.atlarge.odcsim.testkit
import com.atlarge.odcsim.ActorRef
import com.atlarge.odcsim.Envelope
/**
* A helper class for testing messages sent to an [ActorRef].
*
* @param T The shape of the messages the inbox accepts.
*/
interface TestInbox<T : Any> {
/**
* The actor reference of this inbox.
*/
val ref: ActorRef<T>
/**
* A flag to indicate whether the inbox contains any messages.
*/
val hasMessages: Boolean
/**
* Receive the oldest message from the inbox and remove it.
*
* @return The message that has been received.
* @throws NoSuchElementException if the inbox is empty.
*/
fun receiveMessage(): T = receiveEnvelope().message
/**
* Receive the oldest message from the inbox and remove it.
*
* @return The envelope containing the message that has been received.
* @throws NoSuchElementException if the inbox is empty.
*/
fun receiveEnvelope(): Envelope<T>
/**
* Receive all messages from the inbox and empty it.
*
* @return The list of messages in the inbox.
*/
fun receiveAll(): List<Envelope<T>>
/**
* Clear all messages from the inbox.
*/
fun clear()
/**
* Assert that the oldest message is equal to the [expected] message and remove
* it from the inbox.
*
* @param expected The expected message to be the oldest in the inbox.
*/
fun expectMessage(expected: T)
/**
* Assert that the oldest message is equal to the [expected] message and remove
* it from the inbox.
*
* @param expected The expected message to be the oldest in the inbox.
* @param message The failure message to fail with.
*/
fun expectMessage(expected: T, message: String)
}
|
