2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.raft;
10 import org.junit.After;
11 import org.junit.Before;
12 import org.junit.Test;
14 import java.util.HashMap;
15 import java.util.List;
18 import static org.junit.Assert.assertEquals;
19 import static org.junit.Assert.assertFalse;
20 import static org.junit.Assert.assertNull;
21 import static org.junit.Assert.assertTrue;
22 import static org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
23 import static org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockReplicatedLogEntry;
27 public class AbstractReplicatedLogImplTest {
29 private MockAbstractReplicatedLogImpl replicatedLogImpl;
33 replicatedLogImpl = new MockAbstractReplicatedLogImpl();
37 public void tearDown() {
38 replicatedLogImpl.journal.clear();
39 replicatedLogImpl.setSnapshotIndex(-1);
40 replicatedLogImpl.setSnapshotTerm(-1);
41 replicatedLogImpl = null;
45 public void testIndexOperations() {
46 // create a set of initial entries in the in-memory log
47 replicatedLogImpl.append(new MockReplicatedLogEntry(1, 0, new MockPayload("A")));
48 replicatedLogImpl.append(new MockReplicatedLogEntry(1, 1, new MockPayload("B")));
49 replicatedLogImpl.append(new MockReplicatedLogEntry(1, 2, new MockPayload("C")));
50 replicatedLogImpl.append(new MockReplicatedLogEntry(2, 3, new MockPayload("D")));
52 // check if the values returned are correct, with snapshotIndex = -1
53 assertEquals("B", replicatedLogImpl.get(1).getData().toString());
54 assertEquals("D", replicatedLogImpl.last().getData().toString());
55 assertEquals(3, replicatedLogImpl.lastIndex());
56 assertEquals(2, replicatedLogImpl.lastTerm());
57 assertEquals(2, replicatedLogImpl.getFrom(2).size());
58 assertEquals(4, replicatedLogImpl.size());
59 assertTrue(replicatedLogImpl.isPresent(2));
60 assertFalse(replicatedLogImpl.isPresent(4));
61 assertFalse(replicatedLogImpl.isInSnapshot(2));
63 // now create a snapshot of 3 entries, with 1 unapplied entry left in the log
64 // It removes the entries which have made it to snapshot
65 // and updates the snapshot index and term
66 Map state = takeSnapshot(3);
68 // check the values after the snapshot.
69 // each index value passed in the test is the logical index (log entry index)
70 // which gets mapped to the list's physical index
71 assertEquals("D", replicatedLogImpl.get(3).getData().toString());
72 assertEquals("D", replicatedLogImpl.last().getData().toString());
73 assertNull(replicatedLogImpl.get(1));
74 assertEquals(3, replicatedLogImpl.lastIndex());
75 assertEquals(2, replicatedLogImpl.lastTerm());
76 assertEquals(0, replicatedLogImpl.getFrom(2).size());
77 assertEquals(1, replicatedLogImpl.size());
78 assertFalse(replicatedLogImpl.isPresent(2));
79 assertTrue(replicatedLogImpl.isPresent(3));
80 assertFalse(replicatedLogImpl.isPresent(4));
81 assertTrue(replicatedLogImpl.isInSnapshot(2));
83 // append few more entries
84 replicatedLogImpl.append(new MockReplicatedLogEntry(2, 4, new MockPayload("E")));
85 replicatedLogImpl.append(new MockReplicatedLogEntry(2, 5, new MockPayload("F")));
86 replicatedLogImpl.append(new MockReplicatedLogEntry(3, 6, new MockPayload("G")));
87 replicatedLogImpl.append(new MockReplicatedLogEntry(3, 7, new MockPayload("H")));
89 // check their values as well
90 assertEquals(5, replicatedLogImpl.size());
91 assertEquals("D", replicatedLogImpl.get(3).getData().toString());
92 assertEquals("E", replicatedLogImpl.get(4).getData().toString());
93 assertEquals("H", replicatedLogImpl.last().getData().toString());
94 assertEquals(3, replicatedLogImpl.lastTerm());
95 assertEquals(7, replicatedLogImpl.lastIndex());
96 assertTrue(replicatedLogImpl.isPresent(7));
97 assertFalse(replicatedLogImpl.isInSnapshot(7));
98 assertEquals(1, replicatedLogImpl.getFrom(7).size());
99 assertEquals(2, replicatedLogImpl.getFrom(6).size());
101 // take a second snapshot with 5 entries with 0 unapplied entries left in the log
102 state = takeSnapshot(5);
104 assertEquals(0, replicatedLogImpl.size());
105 assertNull(replicatedLogImpl.last());
106 assertNull(replicatedLogImpl.get(7));
107 assertNull(replicatedLogImpl.get(1));
108 assertFalse(replicatedLogImpl.isPresent(7));
109 assertTrue(replicatedLogImpl.isInSnapshot(7));
110 assertEquals(0, replicatedLogImpl.getFrom(7).size());
111 assertEquals(0, replicatedLogImpl.getFrom(6).size());
115 // create a snapshot for test
116 public Map takeSnapshot(int numEntries) {
117 Map map = new HashMap(numEntries);
118 List<ReplicatedLogEntry> entries = replicatedLogImpl.getEntriesTill(numEntries);
119 for (ReplicatedLogEntry entry : entries) {
120 map.put(entry.getIndex(), entry.getData().toString());
123 int term = (int) replicatedLogImpl.lastTerm();
124 int lastIndex = (int) entries.get(entries.size() - 1).getIndex();
126 replicatedLogImpl.setSnapshotTerm(term);
127 replicatedLogImpl.setSnapshotIndex(lastIndex);
132 class MockAbstractReplicatedLogImpl extends AbstractReplicatedLogImpl {
134 public void appendAndPersist(ReplicatedLogEntry replicatedLogEntry) {
138 public void removeFromAndPersist(long index) {
141 public void setSnapshotIndex(long snapshotIndex) {
142 this.snapshotIndex = snapshotIndex;
145 public void setSnapshotTerm(long snapshotTerm) {
146 this.snapshotTerm = snapshotTerm;
149 public List<ReplicatedLogEntry> getEntriesTill(int index) {
150 return journal.subList(0, index);