opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/messages/AppendEntriesTest.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications 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 package org.opendaylight.controller.cluster.raft.messages;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertFalse;
  12
  13 import java.util.Iterator;
  14 import java.util.List;
  15 import org.apache.commons.lang3.SerializationUtils;
  16 import org.junit.Test;
  17 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
  18 import org.opendaylight.controller.cluster.raft.RaftVersions;
  19 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
  20 import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry;
  21
  22 /**
  23  * Unit tests for AppendEntries.
  24  *
  25  * @author Thomas Pantelis
  26  */
  27 public class AppendEntriesTest {
  28     @Test
  29     public void testSerialization() {
  30         ReplicatedLogEntry entry1 = new SimpleReplicatedLogEntry(1, 2, new MockPayload("payload1"));
  31
  32         ReplicatedLogEntry entry2 = new SimpleReplicatedLogEntry(3, 4, new MockPayload("payload2"));
  33
  34         short payloadVersion = 5;
  35
  36         // Without leader address
  37
  38         var expected = new AppendEntries(5L, "node1", 7L, 8L, List.of(entry1, entry2), 10L, -1, payloadVersion,
  39             RaftVersions.CURRENT_VERSION, null);
  40
  41         var bytes = SerializationUtils.serialize(expected);
  42         assertEquals(285, bytes.length);
  43         var cloned = (AppendEntries) SerializationUtils.deserialize(bytes);
  44
  45         verifyAppendEntries(expected, cloned, RaftVersions.CURRENT_VERSION);
  46
  47         // With leader address
  48
  49         expected = new AppendEntries(5L, "node1", 7L, 8L, List.of(entry1, entry2), 10L, -1, payloadVersion,
  50             RaftVersions.CURRENT_VERSION, "leader address");
  51
  52         bytes = SerializationUtils.serialize(expected);
  53         assertEquals(301, bytes.length);
  54         cloned = (AppendEntries) SerializationUtils.deserialize(bytes);
  55
  56         verifyAppendEntries(expected, cloned, RaftVersions.CURRENT_VERSION);
  57     }
  58
  59     @Test
  60     @Deprecated
  61     public void testPreFluorineSerialization() {
  62         ReplicatedLogEntry entry1 = new SimpleReplicatedLogEntry(1, 2, new MockPayload("payload1"));
  63
  64         ReplicatedLogEntry entry2 = new SimpleReplicatedLogEntry(3, 4, new MockPayload("payload2"));
  65
  66         short payloadVersion = 5;
  67
  68         final var expected = new AppendEntries(5L, "node1", 7L, 8L, List.of(entry1, entry2), 10L, -1,
  69             payloadVersion, RaftVersions.BORON_VERSION, "leader address");
  70
  71         final var bytes = SerializationUtils.serialize(expected);
  72         assertEquals(350, bytes.length);
  73         final var cloned = (AppendEntries) SerializationUtils.deserialize(bytes);
  74
  75         verifyAppendEntries(expected, cloned, RaftVersions.BORON_VERSION);
  76     }
  77
  78     private static void verifyAppendEntries(final AppendEntries expected, final AppendEntries actual,
  79             final short recipientRaftVersion) {
  80         assertEquals("getLeaderId", expected.getLeaderId(), actual.getLeaderId());
  81         assertEquals("getTerm", expected.getTerm(), actual.getTerm());
  82         assertEquals("getLeaderCommit", expected.getLeaderCommit(), actual.getLeaderCommit());
  83         assertEquals("getPrevLogIndex", expected.getPrevLogIndex(), actual.getPrevLogIndex());
  84         assertEquals("getPrevLogTerm", expected.getPrevLogTerm(), actual.getPrevLogTerm());
  85         assertEquals("getReplicatedToAllIndex", expected.getReplicatedToAllIndex(), actual.getReplicatedToAllIndex());
  86         assertEquals("getPayloadVersion", expected.getPayloadVersion(), actual.getPayloadVersion());
  87
  88         assertEquals("getEntries size", expected.getEntries().size(), actual.getEntries().size());
  89         Iterator<ReplicatedLogEntry> iter = expected.getEntries().iterator();
  90         for (ReplicatedLogEntry e: actual.getEntries()) {
  91             verifyReplicatedLogEntry(iter.next(), e);
  92         }
  93
  94         if (recipientRaftVersion > RaftVersions.BORON_VERSION) {
  95             assertEquals("getLeaderAddress", expected.getLeaderAddress(), actual.getLeaderAddress());
  96             assertEquals("getLeaderRaftVersion", RaftVersions.CURRENT_VERSION, actual.getLeaderRaftVersion());
  97         } else {
  98             assertFalse(actual.getLeaderAddress().isPresent());
  99             assertEquals("getLeaderRaftVersion", RaftVersions.BORON_VERSION, actual.getLeaderRaftVersion());
 100         }
 101     }
 102
 103     private static void verifyReplicatedLogEntry(final ReplicatedLogEntry expected, final ReplicatedLogEntry actual) {
 104         assertEquals("getIndex", expected.getIndex(), actual.getIndex());
 105         assertEquals("getTerm", expected.getTerm(), actual.getTerm());
 106         assertEquals("getData", expected.getData().toString(), actual.getData().toString());
 107     }
 108 }