Bug 2890: Chunk AppendEntries when single payload size exceeds threshold
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / test / java / org / opendaylight / controller / cluster / raft / behaviors / SnapshotTrackerTest.java
1 /*
2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8
9 package org.opendaylight.controller.cluster.raft.behaviors;
10
11 import static org.junit.Assert.assertEquals;
12 import static org.mockito.Mockito.doReturn;
13 import static org.mockito.Mockito.mock;
14 import static org.mockito.Mockito.spy;
15 import static org.mockito.Mockito.verify;
16
17 import com.google.common.base.Optional;
18 import com.google.common.io.ByteSource;
19 import com.google.protobuf.ByteString;
20 import java.io.IOException;
21 import java.io.Serializable;
22 import java.util.Arrays;
23 import java.util.HashMap;
24 import java.util.Map;
25 import org.apache.commons.lang3.SerializationUtils;
26 import org.junit.Before;
27 import org.junit.Test;
28 import org.mockito.Mock;
29 import org.mockito.MockitoAnnotations;
30 import org.opendaylight.controller.cluster.io.FileBackedOutputStream;
31 import org.opendaylight.controller.cluster.io.FileBackedOutputStreamFactory;
32 import org.opendaylight.controller.cluster.raft.RaftActorContext;
33 import org.slf4j.Logger;
34 import org.slf4j.LoggerFactory;
35
36 public class SnapshotTrackerTest {
37     private static final Logger LOG = LoggerFactory.getLogger(SnapshotTrackerTest.class);
38
39     @Mock
40     private RaftActorContext mockContext;
41     private FileBackedOutputStream fbos;
42     private Map<String, String> data;
43     private ByteString byteString;
44     private byte[] chunk1;
45     private byte[] chunk2;
46     private byte[] chunk3;
47
48     @Before
49     public void setup() {
50         MockitoAnnotations.initMocks(this);
51
52         data = new HashMap<>();
53         data.put("key1", "value1");
54         data.put("key2", "value2");
55         data.put("key3", "value3");
56
57         byteString = ByteString.copyFrom(SerializationUtils.serialize((Serializable) data));
58         chunk1 = getNextChunk(byteString, 0, 10);
59         chunk2 = getNextChunk(byteString, 10, 10);
60         chunk3 = getNextChunk(byteString, 20, byteString.size());
61
62         fbos = spy(new FileBackedOutputStream(100000000, "target"));
63         FileBackedOutputStreamFactory mockFactory = mock(FileBackedOutputStreamFactory.class);
64         doReturn(fbos).when(mockFactory).newInstance();
65         doReturn(mockFactory).when(mockContext).getFileBackedOutputStreamFactory();
66     }
67
68     @Test
69     public void testAddChunks() throws IOException {
70         try (SnapshotTracker tracker = new SnapshotTracker(LOG, 3, "leader", mockContext)) {
71             tracker.addChunk(1, chunk1, Optional.of(LeaderInstallSnapshotState.INITIAL_LAST_CHUNK_HASH_CODE));
72             tracker.addChunk(2, chunk2, Optional.of(Arrays.hashCode(chunk1)));
73             tracker.addChunk(3, chunk3, Optional.of(Arrays.hashCode(chunk2)));
74
75             ByteSource snapshotBytes = tracker.getSnapshotBytes();
76             assertEquals("Deserialized", data, SerializationUtils.deserialize(snapshotBytes.read()));
77         }
78
79         verify(fbos).cleanup();
80     }
81
82     @Test(expected = SnapshotTracker.InvalidChunkException.class)
83     public void testAddChunkWhenAlreadySealed() throws IOException {
84         try (SnapshotTracker tracker = new SnapshotTracker(LOG, 2, "leader", mockContext)) {
85             tracker.addChunk(1, chunk1, Optional.<Integer>absent());
86             tracker.addChunk(2, chunk2, Optional.<Integer>absent());
87             tracker.addChunk(3, chunk3, Optional.<Integer>absent());
88         }
89     }
90
91     @Test(expected = SnapshotTracker.InvalidChunkException.class)
92     public void testInvalidFirstChunkIndex() throws IOException {
93         try (SnapshotTracker tracker = new SnapshotTracker(LOG, 2, "leader", mockContext)) {
94             tracker.addChunk(LeaderInstallSnapshotState.FIRST_CHUNK_INDEX - 1, chunk1, Optional.<Integer>absent());
95         }
96     }
97
98     @Test(expected = SnapshotTracker.InvalidChunkException.class)
99     public void testOutOfSequenceChunk() throws IOException {
100         try (SnapshotTracker tracker = new SnapshotTracker(LOG, 2, "leader", mockContext)) {
101             tracker.addChunk(1, chunk1, Optional.<Integer>absent());
102             tracker.addChunk(3, chunk3, Optional.<Integer>absent());
103         }
104     }
105
106     @Test(expected = SnapshotTracker.InvalidChunkException.class)
107     public void testInvalidLastChunkHashCode() throws IOException {
108         try (SnapshotTracker tracker = new SnapshotTracker(LOG, 2, "leader", mockContext)) {
109             tracker.addChunk(1, chunk1, Optional.of(LeaderInstallSnapshotState.INITIAL_LAST_CHUNK_HASH_CODE));
110             tracker.addChunk(2, chunk2, Optional.of(1));
111         }
112     }
113
114     @Test(expected = IllegalStateException.class)
115     public void testGetSnapshotBytesWhenNotSealed() throws IOException {
116         try (SnapshotTracker tracker = new SnapshotTracker(LOG, 2, "leader", mockContext)) {
117             tracker.addChunk(1, chunk1, Optional.<Integer>absent());
118             tracker.getSnapshotBytes();
119         }
120     }
121
122     private byte[] getNextChunk(ByteString bs, int offset, int size) {
123         int snapshotLength = bs.size();
124         int start = offset;
125         if (size > snapshotLength) {
126             size = snapshotLength;
127         } else {
128             if (start + size > snapshotLength) {
129                 size = snapshotLength - start;
130             }
131         }
132
133         byte[] nextChunk = new byte[size];
134         bs.copyTo(nextChunk, start, 0, size);
135         return nextChunk;
136     }
137 }