opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/admin/ClusterAdminRpcServiceTest.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.datastore.admin;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.fail;
  13 import static org.opendaylight.controller.cluster.datastore.MemberNode.verifyRaftPeersPresent;
  14 import static org.opendaylight.controller.cluster.datastore.MemberNode.verifyRaftState;
  15 import akka.actor.ActorRef;
  16 import akka.actor.PoisonPill;
  17 import akka.cluster.Cluster;
  18 import com.google.common.base.Optional;
  19 import com.google.common.collect.ImmutableMap;
  20 import com.google.common.collect.Iterables;
  21 import com.google.common.collect.Sets;
  22 import java.io.File;
  23 import java.io.FileInputStream;
  24 import java.util.ArrayList;
  25 import java.util.HashSet;
  26 import java.util.List;
  27 import java.util.Set;
  28 import java.util.concurrent.TimeUnit;
  29 import org.apache.commons.lang3.SerializationUtils;
  30 import org.junit.After;
  31 import org.junit.Before;
  32 import org.junit.Test;
  33 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
  34 import org.opendaylight.controller.cluster.datastore.MemberNode;
  35 import org.opendaylight.controller.cluster.datastore.MemberNode.RaftStateVerifier;
  36 import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot;
  37 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
  38 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  39 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
  40 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
  41 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  42 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.AddShardReplicaInputBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.BackupDatastoreInputBuilder;
  45 import org.opendaylight.yangtools.yang.common.RpcError;
  46 import org.opendaylight.yangtools.yang.common.RpcResult;
  47 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  48
  49 /**
  50  * Unit tests for ClusterAdminRpcService.
  51  *
  52  * @author Thomas Pantelis
  53  */
  54 public class ClusterAdminRpcServiceTest {
  55     private final List<MemberNode> memberNodes = new ArrayList<>();
  56
  57     @Before
  58     public void setUp() {
  59         InMemoryJournal.clear();
  60         InMemorySnapshotStore.clear();
  61     }
  62
  63     @After
  64     public void tearDown() {
  65         for(MemberNode m: memberNodes) {
  66             m.cleanup();
  67         }
  68     }
  69
  70     @Test
  71     public void testBackupDatastore() throws Exception {
  72         MemberNode node = MemberNode.builder(memberNodes).akkaConfig("Member1").
  73                 moduleShardsConfig("module-shards-member1.conf").
  74                 waitForShardLeader("cars", "people").testName("testBackupDatastore").build();
  75
  76         String fileName = "target/testBackupDatastore";
  77         new File(fileName).delete();
  78
  79         ClusterAdminRpcService service = new ClusterAdminRpcService(node.configDataStore(), node.operDataStore());
  80
  81         RpcResult<Void> rpcResult = service .backupDatastore(new BackupDatastoreInputBuilder().
  82                 setFilePath(fileName).build()).get(5, TimeUnit.SECONDS);
  83         checkSuccessfulRpcResult(rpcResult);
  84
  85         try(FileInputStream fis = new FileInputStream(fileName)) {
  86             List<DatastoreSnapshot> snapshots = SerializationUtils.deserialize(fis);
  87             assertEquals("DatastoreSnapshot size", 2, snapshots.size());
  88
  89             ImmutableMap<String, DatastoreSnapshot> map = ImmutableMap.of(snapshots.get(0).getType(), snapshots.get(0),
  90                     snapshots.get(1).getType(), snapshots.get(1));
  91             verifyDatastoreSnapshot(node.configDataStore().getActorContext().getDataStoreType(),
  92                     map.get(node.configDataStore().getActorContext().getDataStoreType()), "cars", "people");
  93         } finally {
  94             new File(fileName).delete();
  95         }
  96
  97         // Test failure by killing a shard.
  98
  99         node.configDataStore().getActorContext().getShardManager().tell(node.datastoreContextBuilder().
 100                 shardInitializationTimeout(200, TimeUnit.MILLISECONDS).build(), ActorRef.noSender());
 101
 102         ActorRef carsShardActor = node.configDataStore().getActorContext().findLocalShard("cars").get();
 103         node.kit().watch(carsShardActor);
 104         carsShardActor.tell(PoisonPill.getInstance(), ActorRef.noSender());
 105         node.kit().expectTerminated(carsShardActor);
 106
 107         rpcResult = service.backupDatastore(new BackupDatastoreInputBuilder().setFilePath(fileName).build()).
 108                 get(5, TimeUnit.SECONDS);
 109         assertEquals("isSuccessful", false, rpcResult.isSuccessful());
 110         assertEquals("getErrors", 1, rpcResult.getErrors().size());
 111
 112         service.close();
 113     }
 114
 115     private void verifyDatastoreSnapshot(String type, DatastoreSnapshot datastoreSnapshot, String... expShardNames) {
 116         assertNotNull("Missing DatastoreSnapshot for type " + type, datastoreSnapshot);
 117         Set<String> shardNames = new HashSet<>();
 118         for(DatastoreSnapshot.ShardSnapshot s: datastoreSnapshot.getShardSnapshots()) {
 119             shardNames.add(s.getName());
 120         }
 121
 122         assertEquals("DatastoreSnapshot shard names", Sets.newHashSet(expShardNames), shardNames);
 123     }
 124
 125     @Test
 126     public void testAddShardReplica() throws Exception {
 127         String name = "testAddShardReplica";
 128         String moduleShardsConfig = "module-shards-cars-member-1.conf";
 129         MemberNode leaderNode1 = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 130                 moduleShardsConfig(moduleShardsConfig).waitForShardLeader("cars").build();
 131
 132         MemberNode newReplicaNode2 = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name).
 133                 moduleShardsConfig(moduleShardsConfig).build();
 134
 135         leaderNode1.waitForMembersUp("member-2");
 136
 137         testAddShardReplica(newReplicaNode2, "cars", "member-1");
 138
 139         MemberNode newReplicaNode3 = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name).
 140                 moduleShardsConfig(moduleShardsConfig).build();
 141
 142         leaderNode1.waitForMembersUp("member-3");
 143         newReplicaNode2.waitForMembersUp("member-3");
 144
 145         testAddShardReplica(newReplicaNode3, "cars", "member-1", "member-2");
 146
 147         verifyRaftPeersPresent(newReplicaNode2.configDataStore(), "cars", "member-1", "member-3");
 148         verifyRaftPeersPresent(newReplicaNode2.operDataStore(), "cars", "member-1", "member-3");
 149
 150         // Write data to member-2's config datastore and read/verify via member-3
 151         NormalizedNode<?, ?> configCarsNode = writeCarsNodeAndVerify(newReplicaNode2.configDataStore(),
 152                 newReplicaNode3.configDataStore());
 153
 154         // Write data to member-3's oper datastore and read/verify via member-2
 155         writeCarsNodeAndVerify(newReplicaNode3.operDataStore(), newReplicaNode2.operDataStore());
 156
 157         // Verify all data has been replicated. We expect 3 log entries and thus last applied index of 2 -
 158         // 2 ServerConfigurationPayload entries and the transaction payload entry.
 159
 160         RaftStateVerifier verifier = new RaftStateVerifier() {
 161             @Override
 162             public void verify(OnDemandRaftState raftState) {
 163                 assertEquals("Commit index", 2, raftState.getCommitIndex());
 164                 assertEquals("Last applied index", 2, raftState.getLastApplied());
 165             }
 166         };
 167
 168         verifyRaftState(leaderNode1.configDataStore(), "cars", verifier);
 169         verifyRaftState(leaderNode1.operDataStore(), "cars", verifier);
 170
 171         verifyRaftState(newReplicaNode2.configDataStore(), "cars", verifier);
 172         verifyRaftState(newReplicaNode2.operDataStore(), "cars", verifier);
 173
 174         verifyRaftState(newReplicaNode3.configDataStore(), "cars", verifier);
 175         verifyRaftState(newReplicaNode3.operDataStore(), "cars", verifier);
 176
 177         // Restart member-3 and verify the cars config shard is re-instated.
 178
 179         Cluster.get(leaderNode1.kit().getSystem()).down(Cluster.get(newReplicaNode3.kit().getSystem()).selfAddress());
 180         newReplicaNode3.cleanup();
 181
 182         newReplicaNode3 = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name).
 183                 moduleShardsConfig(moduleShardsConfig).createOperDatastore(false).build();
 184
 185         verifyRaftState(newReplicaNode3.configDataStore(), "cars", verifier);
 186         readCarsNodeAndVerify(newReplicaNode3.configDataStore(), configCarsNode);
 187     }
 188
 189     private NormalizedNode<?, ?> writeCarsNodeAndVerify(DistributedDataStore writeToStore,
 190             DistributedDataStore readFromStore) throws Exception {
 191         DOMStoreWriteTransaction writeTx = writeToStore.newWriteOnlyTransaction();
 192         NormalizedNode<?, ?> carsNode = CarsModel.create();
 193         writeTx.write(CarsModel.BASE_PATH, carsNode);
 194
 195         DOMStoreThreePhaseCommitCohort cohort = writeTx.ready();
 196         Boolean canCommit = cohort .canCommit().get(7, TimeUnit.SECONDS);
 197         assertEquals("canCommit", true, canCommit);
 198         cohort.preCommit().get(5, TimeUnit.SECONDS);
 199         cohort.commit().get(5, TimeUnit.SECONDS);
 200
 201         readCarsNodeAndVerify(readFromStore, carsNode);
 202         return carsNode;
 203     }
 204
 205     private void readCarsNodeAndVerify(DistributedDataStore readFromStore,
 206             NormalizedNode<?, ?> expCarsNode) throws Exception {
 207         Optional<NormalizedNode<?, ?>> optional = readFromStore.newReadOnlyTransaction().
 208                 read(CarsModel.BASE_PATH).get(15, TimeUnit.SECONDS);
 209         assertEquals("isPresent", true, optional.isPresent());
 210         assertEquals("Data node", expCarsNode, optional.get());
 211     }
 212
 213     private void testAddShardReplica(MemberNode memberNode, String shardName, String... peerMemberNames)
 214             throws Exception {
 215         memberNode.waitForMembersUp(peerMemberNames);
 216
 217         ClusterAdminRpcService service = new ClusterAdminRpcService(memberNode.configDataStore(),
 218                 memberNode.operDataStore());
 219
 220         RpcResult<Void> rpcResult = service.addShardReplica(new AddShardReplicaInputBuilder().setShardName(shardName).
 221                 build()).get(10, TimeUnit.SECONDS);
 222         checkSuccessfulRpcResult(rpcResult);
 223
 224         verifyRaftPeersPresent(memberNode.configDataStore(), shardName, peerMemberNames);
 225         verifyRaftPeersPresent(memberNode.operDataStore(), shardName, peerMemberNames);
 226
 227         service.close();
 228     }
 229
 230     private void checkSuccessfulRpcResult(RpcResult<Void> rpcResult) {
 231         if(!rpcResult.isSuccessful()) {
 232             if(rpcResult.getErrors().size() > 0) {
 233                 RpcError error = Iterables.getFirst(rpcResult.getErrors(), null);
 234                 throw new AssertionError("Rpc failed with error: " + error, error.getCause());
 235             }
 236
 237             fail("Rpc failed with no error");
 238         }
 239     }
 240
 241     @Test
 242     public void testRemoveShardReplica() {
 243         // TODO implement
 244     }
 245
 246     @Test
 247     public void testAddReplicasForAllShards() {
 248         // TODO implement
 249     }
 250
 251     @Test
 252     public void testRemoveAllShardReplicas() {
 253         // TODO implement
 254     }
 255
 256     @Test
 257     public void testConvertMembersToVotingForAllShards() {
 258         // TODO implement
 259     }
 260
 261     @Test
 262     public void testConvertMembersToNonvotingForAllShards() {
 263         // TODO implement
 264     }
 265 }