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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
package protocols.implementations;
import core.VSInternalProcess;
import core.VSMessage;
import core.VSTask;
import core.VSTaskManager;
import core.time.VSVectorTime;
import events.internal.VSProtocolScheduleEvent;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import prefs.VSPrefs;
import simulator.VSSimulatorVisualization;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.clearInvocations;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
/**
* Unit tests for VSRaftProtocol heartbeat behavior.
*/
class VSRaftProtocolTest {
@Mock
private VSInternalProcess mockProcess;
@Mock
private VSSimulatorVisualization mockCanvas;
@Mock
private VSTaskManager mockTaskManager;
@Mock
private VSPrefs mockPrefs;
@Mock
private VSVectorTime mockVectorTime;
private VSRaftProtocol protocol;
@BeforeEach
void setUp() {
MockitoAnnotations.openMocks(this);
protocol = new VSRaftProtocol();
protocol.process = mockProcess;
protocol.prefs = mockPrefs;
protocol.isServer(true);
when(mockProcess.getSimulatorCanvas()).thenReturn(mockCanvas);
when(mockCanvas.getTaskManager()).thenReturn(mockTaskManager);
when(mockProcess.getPrefs()).thenReturn(mockPrefs);
when(mockProcess.getVectorTime()).thenReturn(mockVectorTime);
when(mockVectorTime.getCopy()).thenReturn(mockVectorTime);
when(mockPrefs.getString(anyString())).thenReturn("TestString");
when(mockProcess.getTime()).thenReturn(100L);
when(mockProcess.getProcessID()).thenReturn(7);
when(mockProcess.getRandomPercentage()).thenReturn(25);
}
@Test
void testOnStartBecomesLeaderAndSendsHeartbeat() {
ArgumentCaptor<VSMessage> messageCaptor =
ArgumentCaptor.forClass(VSMessage.class);
ArgumentCaptor<VSTask> taskCaptor = ArgumentCaptor.forClass(VSTask.class);
protocol.onStart();
verify(mockProcess).sendMessage(messageCaptor.capture());
verify(mockTaskManager).addTask(taskCaptor.capture());
VSMessage heartbeat = messageCaptor.getValue();
assertEquals("heartbeat", heartbeat.getString("type"));
assertEquals(0, heartbeat.getInteger("term"));
assertEquals(7, heartbeat.getInteger("leaderId"));
assertEquals(1600L, taskCaptor.getValue().getTaskTime());
}
@Test
void testServerScheduleSendsHeartbeatWhenLeader() {
ArgumentCaptor<VSMessage> messageCaptor =
ArgumentCaptor.forClass(VSMessage.class);
ArgumentCaptor<VSTask> taskCaptor = ArgumentCaptor.forClass(VSTask.class);
protocol.onStart();
protocol.onServerScheduleStart();
verify(mockProcess, times(2)).sendMessage(messageCaptor.capture());
verify(mockTaskManager, times(2)).addTask(taskCaptor.capture());
assertEquals(2, messageCaptor.getAllValues().size());
assertEquals(2, taskCaptor.getAllValues().size());
VSMessage scheduledHeartbeat = messageCaptor.getAllValues().get(1);
assertEquals("heartbeat", scheduledHeartbeat.getString("type"));
assertEquals(0, scheduledHeartbeat.getInteger("term"));
assertEquals(7, scheduledHeartbeat.getInteger("leaderId"));
assertEquals(1600L, taskCaptor.getAllValues().get(1).getTaskTime());
}
@Test
void testServerScheduleDoesNothingWhenNotLeader() {
protocol.currentContextIsServer(true);
protocol.onServerSchedule();
verify(mockProcess, never()).sendMessage(any());
verify(mockTaskManager, never()).addTask(any());
}
@Test
void testOnClientInitSchedulesRandomizedElectionTimeout() {
protocol.currentContextIsServer(false);
ArgumentCaptor<VSTask> taskCaptor = ArgumentCaptor.forClass(VSTask.class);
protocol.onClientInit();
verify(mockTaskManager).removeAllTasks(any());
verify(mockTaskManager).addTask(taskCaptor.capture());
VSTask task = taskCaptor.getValue();
assertEquals(4600L, task.getTaskTime());
assertFalse(((VSProtocolScheduleEvent) task.getEvent()).isServerSchedule());
}
@Test
void testOnClientScheduleStartsElectionAfterTimeout() throws Exception {
protocol.currentContextIsServer(false);
protocol.onClientInit();
clearInvocations(mockProcess, mockTaskManager);
when(mockProcess.getTime()).thenReturn(4200L);
ArgumentCaptor<VSMessage> messageCaptor =
ArgumentCaptor.forClass(VSMessage.class);
ArgumentCaptor<VSTask> taskCaptor = ArgumentCaptor.forClass(VSTask.class);
protocol.onClientSchedule();
verify(mockProcess).sendMessage(messageCaptor.capture());
verify(mockTaskManager).removeAllTasks(any());
verify(mockTaskManager).addTask(taskCaptor.capture());
VSMessage voteRequest = messageCaptor.getValue();
assertEquals("voteRequest", voteRequest.getString("type"));
assertEquals(1, voteRequest.getInteger("term"));
assertEquals(7, voteRequest.getInteger("candidateId"));
assertTrue(getBooleanField("isCandidate"));
assertFalse(getBooleanField("isLeader"));
assertEquals(1, getIntField("votesReceived"));
assertEquals(7, getIntField("votedFor"));
assertEquals(8700L, taskCaptor.getValue().getTaskTime());
assertFalse(
((VSProtocolScheduleEvent) taskCaptor.getValue().getEvent())
.isServerSchedule());
}
@Test
void testOnClientScheduleDoesNotStartElectionBeforeTimeout() throws Exception {
protocol.currentContextIsServer(false);
protocol.onClientInit();
clearInvocations(mockProcess, mockTaskManager);
when(mockProcess.getTime()).thenReturn(2000L);
protocol.onClientSchedule();
verify(mockProcess, never()).sendMessage(any());
verify(mockTaskManager, never()).removeAllTasks(any());
verify(mockTaskManager, never()).addTask(any());
assertFalse(getBooleanField("isCandidate"));
assertFalse(getBooleanField("isLeader"));
assertEquals(0, getIntField("currentTerm"));
assertEquals(0, getIntField("votesReceived"));
assertEquals(-1, getIntField("votedFor"));
}
@Test
void testCandidateTimeoutStartsNewElectionAndReschedules() throws Exception {
protocol.currentContextIsServer(false);
protocol.onClientInit();
when(mockProcess.getTime()).thenReturn(4200L, 4200L, 4200L);
protocol.onClientSchedule();
clearInvocations(mockProcess, mockTaskManager);
when(mockProcess.getTime()).thenReturn(8401L, 8401L, 8401L);
ArgumentCaptor<VSMessage> messageCaptor =
ArgumentCaptor.forClass(VSMessage.class);
ArgumentCaptor<VSTask> taskCaptor = ArgumentCaptor.forClass(VSTask.class);
protocol.onClientSchedule();
verify(mockProcess).sendMessage(messageCaptor.capture());
verify(mockTaskManager).removeAllTasks(any());
verify(mockTaskManager).addTask(taskCaptor.capture());
VSMessage voteRequest = messageCaptor.getValue();
assertEquals("voteRequest", voteRequest.getString("type"));
assertEquals(2, voteRequest.getInteger("term"));
assertEquals(2, getIntField("currentTerm"));
assertEquals(1, getIntField("votesReceived"));
assertEquals(12901L, taskCaptor.getValue().getTaskTime());
}
@Test
void testBecomeFollowerFromServerContextCancelsHeartbeatsAndRearmsClientTimeout()
throws Exception {
protocol.currentContextIsServer(false);
protocol.onClientInit();
clearInvocations(mockProcess, mockTaskManager);
protocol.onStart();
clearInvocations(mockProcess, mockTaskManager);
protocol.currentContextIsServer(true);
when(mockProcess.getTime()).thenReturn(300L);
ArgumentCaptor<VSTask> taskCaptor = ArgumentCaptor.forClass(VSTask.class);
invokeBecomeFollower(4, 11);
verify(mockTaskManager, times(2)).removeAllTasks(any());
verify(mockTaskManager).addTask(taskCaptor.capture());
assertTrue(protocol.currentContextIsServer());
assertFalse(getBooleanField("isLeader"));
assertFalse(getBooleanField("isCandidate"));
assertEquals(4, getIntField("currentTerm"));
assertEquals(11, getIntField("leaderId"));
assertEquals(-1, getIntField("votedFor"));
assertEquals(4800L, taskCaptor.getValue().getTaskTime());
assertFalse(
((VSProtocolScheduleEvent) taskCaptor.getValue().getEvent())
.isServerSchedule());
}
private void invokeBecomeFollower(int term, int leaderId) throws Exception {
Method method = VSRaftProtocol.class.getDeclaredMethod(
"becomeFollower", int.class, int.class);
method.setAccessible(true);
method.invoke(protocol, term, leaderId);
}
private int getIntField(String fieldName) throws Exception {
Field field = VSRaftProtocol.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.getInt(protocol);
}
private boolean getBooleanField(String fieldName) throws Exception {
Field field = VSRaftProtocol.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.getBoolean(protocol);
}
}
|
