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.assertNull;
  13 import static org.junit.Assert.fail;
  14 import static org.opendaylight.controller.cluster.datastore.MemberNode.verifyRaftPeersPresent;
  15 import static org.opendaylight.controller.cluster.datastore.MemberNode.verifyRaftState;
  16 import akka.actor.ActorRef;
  17 import akka.actor.PoisonPill;
  18 import akka.actor.Status.Success;
  19 import akka.cluster.Cluster;
  20 import com.google.common.base.Optional;
  21 import com.google.common.collect.ImmutableMap;
  22 import com.google.common.collect.Iterables;
  23 import com.google.common.collect.Sets;
  24 import java.io.File;
  25 import java.io.FileInputStream;
  26 import java.net.URI;
  27 import java.util.ArrayList;
  28 import java.util.Arrays;
  29 import java.util.HashMap;
  30 import java.util.HashSet;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Set;
  34 import java.util.concurrent.TimeUnit;
  35 import org.apache.commons.lang3.SerializationUtils;
  36 import org.junit.After;
  37 import org.junit.Before;
  38 import org.junit.Test;
  39 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
  40 import org.opendaylight.controller.cluster.datastore.MemberNode;
  41 import org.opendaylight.controller.cluster.datastore.MemberNode.RaftStateVerifier;
  42 import org.opendaylight.controller.cluster.datastore.Shard;
  43 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration;
  44 import org.opendaylight.controller.cluster.datastore.messages.CreateShard;
  45 import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot;
  46 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
  47 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  48 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
  49 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
  50 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  51 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.AddReplicasForAllShardsOutput;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.AddShardReplicaInputBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.BackupDatastoreInputBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.DataStoreType;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.add.replicas._for.all.shards.output.ShardResult;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.add.replicas._for.all.shards.output.ShardResultBuilder;
  58 import org.opendaylight.yangtools.yang.common.RpcError;
  59 import org.opendaylight.yangtools.yang.common.RpcResult;
  60 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  61
  62 /**
  63  * Unit tests for ClusterAdminRpcService.
  64  *
  65  * @author Thomas Pantelis
  66  */
  67 public class ClusterAdminRpcServiceTest {
  68     private final List<MemberNode> memberNodes = new ArrayList<>();
  69
  70     @Before
  71     public void setUp() {
  72         InMemoryJournal.clear();
  73         InMemorySnapshotStore.clear();
  74     }
  75
  76     @After
  77     public void tearDown() {
  78         for(MemberNode m: memberNodes) {
  79             m.cleanup();
  80         }
  81     }
  82
  83     @Test
  84     public void testBackupDatastore() throws Exception {
  85         MemberNode node = MemberNode.builder(memberNodes).akkaConfig("Member1").
  86                 moduleShardsConfig("module-shards-member1.conf").
  87                 waitForShardLeader("cars", "people").testName("testBackupDatastore").build();
  88
  89         String fileName = "target/testBackupDatastore";
  90         new File(fileName).delete();
  91
  92         ClusterAdminRpcService service = new ClusterAdminRpcService(node.configDataStore(), node.operDataStore());
  93
  94         RpcResult<Void> rpcResult = service .backupDatastore(new BackupDatastoreInputBuilder().
  95                 setFilePath(fileName).build()).get(5, TimeUnit.SECONDS);
  96         verifySuccessfulRpcResult(rpcResult);
  97
  98         try(FileInputStream fis = new FileInputStream(fileName)) {
  99             List<DatastoreSnapshot> snapshots = SerializationUtils.deserialize(fis);
 100             assertEquals("DatastoreSnapshot size", 2, snapshots.size());
 101
 102             ImmutableMap<String, DatastoreSnapshot> map = ImmutableMap.of(snapshots.get(0).getType(), snapshots.get(0),
 103                     snapshots.get(1).getType(), snapshots.get(1));
 104             verifyDatastoreSnapshot(node.configDataStore().getActorContext().getDataStoreType(),
 105                     map.get(node.configDataStore().getActorContext().getDataStoreType()), "cars", "people");
 106         } finally {
 107             new File(fileName).delete();
 108         }
 109
 110         // Test failure by killing a shard.
 111
 112         node.configDataStore().getActorContext().getShardManager().tell(node.datastoreContextBuilder().
 113                 shardInitializationTimeout(200, TimeUnit.MILLISECONDS).build(), ActorRef.noSender());
 114
 115         ActorRef carsShardActor = node.configDataStore().getActorContext().findLocalShard("cars").get();
 116         node.kit().watch(carsShardActor);
 117         carsShardActor.tell(PoisonPill.getInstance(), ActorRef.noSender());
 118         node.kit().expectTerminated(carsShardActor);
 119
 120         rpcResult = service.backupDatastore(new BackupDatastoreInputBuilder().setFilePath(fileName).build()).
 121                 get(5, TimeUnit.SECONDS);
 122         assertEquals("isSuccessful", false, rpcResult.isSuccessful());
 123         assertEquals("getErrors", 1, rpcResult.getErrors().size());
 124
 125         service.close();
 126     }
 127
 128     private void verifyDatastoreSnapshot(String type, DatastoreSnapshot datastoreSnapshot, String... expShardNames) {
 129         assertNotNull("Missing DatastoreSnapshot for type " + type, datastoreSnapshot);
 130         Set<String> shardNames = new HashSet<>();
 131         for(DatastoreSnapshot.ShardSnapshot s: datastoreSnapshot.getShardSnapshots()) {
 132             shardNames.add(s.getName());
 133         }
 134
 135         assertEquals("DatastoreSnapshot shard names", Sets.newHashSet(expShardNames), shardNames);
 136     }
 137
 138     @Test
 139     public void testAddShardReplica() throws Exception {
 140         String name = "testAddShardReplica";
 141         String moduleShardsConfig = "module-shards-cars-member-1.conf";
 142         MemberNode leaderNode1 = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 143                 moduleShardsConfig(moduleShardsConfig).waitForShardLeader("cars").build();
 144
 145         MemberNode newReplicaNode2 = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name).
 146                 moduleShardsConfig(moduleShardsConfig).build();
 147
 148         leaderNode1.waitForMembersUp("member-2");
 149
 150         doAddShardReplica(newReplicaNode2, "cars", "member-1");
 151
 152         MemberNode newReplicaNode3 = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name).
 153                 moduleShardsConfig(moduleShardsConfig).build();
 154
 155         leaderNode1.waitForMembersUp("member-3");
 156         newReplicaNode2.waitForMembersUp("member-3");
 157
 158         doAddShardReplica(newReplicaNode3, "cars", "member-1", "member-2");
 159
 160         verifyRaftPeersPresent(newReplicaNode2.configDataStore(), "cars", "member-1", "member-3");
 161         verifyRaftPeersPresent(newReplicaNode2.operDataStore(), "cars", "member-1", "member-3");
 162
 163         // Write data to member-2's config datastore and read/verify via member-3
 164         NormalizedNode<?, ?> configCarsNode = writeCarsNodeAndVerify(newReplicaNode2.configDataStore(),
 165                 newReplicaNode3.configDataStore());
 166
 167         // Write data to member-3's oper datastore and read/verify via member-2
 168         writeCarsNodeAndVerify(newReplicaNode3.operDataStore(), newReplicaNode2.operDataStore());
 169
 170         // Verify all data has been replicated. We expect 3 log entries and thus last applied index of 2 -
 171         // 2 ServerConfigurationPayload entries and the transaction payload entry.
 172
 173         RaftStateVerifier verifier = new RaftStateVerifier() {
 174             @Override
 175             public void verify(OnDemandRaftState raftState) {
 176                 assertEquals("Commit index", 2, raftState.getCommitIndex());
 177                 assertEquals("Last applied index", 2, raftState.getLastApplied());
 178             }
 179         };
 180
 181         verifyRaftState(leaderNode1.configDataStore(), "cars", verifier);
 182         verifyRaftState(leaderNode1.operDataStore(), "cars", verifier);
 183
 184         verifyRaftState(newReplicaNode2.configDataStore(), "cars", verifier);
 185         verifyRaftState(newReplicaNode2.operDataStore(), "cars", verifier);
 186
 187         verifyRaftState(newReplicaNode3.configDataStore(), "cars", verifier);
 188         verifyRaftState(newReplicaNode3.operDataStore(), "cars", verifier);
 189
 190         // Restart member-3 and verify the cars config shard is re-instated.
 191
 192         Cluster.get(leaderNode1.kit().getSystem()).down(Cluster.get(newReplicaNode3.kit().getSystem()).selfAddress());
 193         newReplicaNode3.cleanup();
 194
 195         newReplicaNode3 = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name).
 196                 moduleShardsConfig(moduleShardsConfig).createOperDatastore(false).build();
 197
 198         verifyRaftState(newReplicaNode3.configDataStore(), "cars", verifier);
 199         readCarsNodeAndVerify(newReplicaNode3.configDataStore(), configCarsNode);
 200     }
 201
 202     @Test
 203     public void testAddShardReplicaFailures() throws Exception {
 204         String name = "testAddShardReplicaFailures";
 205         MemberNode memberNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name).
 206                 moduleShardsConfig("module-shards-cars-member-1.conf").build();
 207
 208         ClusterAdminRpcService service = new ClusterAdminRpcService(memberNode.configDataStore(),
 209                 memberNode.operDataStore());
 210
 211         RpcResult<Void> rpcResult = service.addShardReplica(new AddShardReplicaInputBuilder().
 212                 setDataStoreType(DataStoreType.Config).build()).get(10, TimeUnit.SECONDS);
 213         verifyFailedRpcResult(rpcResult);
 214
 215         rpcResult = service.addShardReplica(new AddShardReplicaInputBuilder().setShardName("cars").
 216                 build()).get(10, TimeUnit.SECONDS);
 217         verifyFailedRpcResult(rpcResult);
 218
 219         rpcResult = service.addShardReplica(new AddShardReplicaInputBuilder().setShardName("people").
 220                 setDataStoreType(DataStoreType.Config).build()).get(10, TimeUnit.SECONDS);
 221         verifyFailedRpcResult(rpcResult);
 222
 223         service.close();
 224     }
 225
 226     private NormalizedNode<?, ?> writeCarsNodeAndVerify(DistributedDataStore writeToStore,
 227             DistributedDataStore readFromStore) throws Exception {
 228         DOMStoreWriteTransaction writeTx = writeToStore.newWriteOnlyTransaction();
 229         NormalizedNode<?, ?> carsNode = CarsModel.create();
 230         writeTx.write(CarsModel.BASE_PATH, carsNode);
 231
 232         DOMStoreThreePhaseCommitCohort cohort = writeTx.ready();
 233         Boolean canCommit = cohort .canCommit().get(7, TimeUnit.SECONDS);
 234         assertEquals("canCommit", true, canCommit);
 235         cohort.preCommit().get(5, TimeUnit.SECONDS);
 236         cohort.commit().get(5, TimeUnit.SECONDS);
 237
 238         readCarsNodeAndVerify(readFromStore, carsNode);
 239         return carsNode;
 240     }
 241
 242     private void readCarsNodeAndVerify(DistributedDataStore readFromStore,
 243             NormalizedNode<?, ?> expCarsNode) throws Exception {
 244         Optional<NormalizedNode<?, ?>> optional = readFromStore.newReadOnlyTransaction().
 245                 read(CarsModel.BASE_PATH).get(15, TimeUnit.SECONDS);
 246         assertEquals("isPresent", true, optional.isPresent());
 247         assertEquals("Data node", expCarsNode, optional.get());
 248     }
 249
 250     private void doAddShardReplica(MemberNode memberNode, String shardName, String... peerMemberNames)
 251             throws Exception {
 252         memberNode.waitForMembersUp(peerMemberNames);
 253
 254         ClusterAdminRpcService service = new ClusterAdminRpcService(memberNode.configDataStore(),
 255                 memberNode.operDataStore());
 256
 257         RpcResult<Void> rpcResult = service.addShardReplica(new AddShardReplicaInputBuilder().setShardName(shardName).
 258                 setDataStoreType(DataStoreType.Config).build()).get(10, TimeUnit.SECONDS);
 259         verifySuccessfulRpcResult(rpcResult);
 260
 261         verifyRaftPeersPresent(memberNode.configDataStore(), shardName, peerMemberNames);
 262
 263         Optional<ActorRef> optional = memberNode.operDataStore().getActorContext().findLocalShard(shardName);
 264         assertEquals("Oper shard present", false, optional.isPresent());
 265
 266         rpcResult = service.addShardReplica(new AddShardReplicaInputBuilder().setShardName(shardName).
 267                 setDataStoreType(DataStoreType.Operational).build()).get(10, TimeUnit.SECONDS);
 268         verifySuccessfulRpcResult(rpcResult);
 269
 270         verifyRaftPeersPresent(memberNode.operDataStore(), shardName, peerMemberNames);
 271
 272         service.close();
 273     }
 274
 275     private <T> T verifySuccessfulRpcResult(RpcResult<T> rpcResult) {
 276         if(!rpcResult.isSuccessful()) {
 277             if(rpcResult.getErrors().size() > 0) {
 278                 RpcError error = Iterables.getFirst(rpcResult.getErrors(), null);
 279                 throw new AssertionError("Rpc failed with error: " + error, error.getCause());
 280             }
 281
 282             fail("Rpc failed with no error");
 283         }
 284
 285         return rpcResult.getResult();
 286     }
 287
 288     private void verifyFailedRpcResult(RpcResult<Void> rpcResult) {
 289         assertEquals("RpcResult", false, rpcResult.isSuccessful());
 290         assertEquals("RpcResult errors size", 1, rpcResult.getErrors().size());
 291         RpcError error = Iterables.getFirst(rpcResult.getErrors(), null);
 292         assertNotNull("RpcResult error message null", error.getMessage());
 293     }
 294
 295     @Test
 296     public void testRemoveShardReplica() {
 297         // TODO implement
 298     }
 299
 300     @Test
 301     public void testAddReplicasForAllShards() throws Exception {
 302         String name = "testAddReplicasForAllShards";
 303         String moduleShardsConfig = "module-shards-member1.conf";
 304         MemberNode leaderNode1 = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 305                 moduleShardsConfig(moduleShardsConfig).waitForShardLeader("cars", "people").build();
 306
 307         ModuleShardConfiguration petsModuleConfig = new ModuleShardConfiguration(URI.create("pets-ns"), "pets-module",
 308                 "pets", null, Arrays.asList("member-1"));
 309         leaderNode1.configDataStore().getActorContext().getShardManager().tell(
 310                 new CreateShard(petsModuleConfig, Shard.builder(), null), leaderNode1.kit().getRef());
 311         leaderNode1.kit().expectMsgClass(Success.class);
 312         leaderNode1.kit().waitUntilLeader(leaderNode1.configDataStore().getActorContext(), "pets");
 313
 314         MemberNode newReplicaNode2 = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name).
 315                 moduleShardsConfig(moduleShardsConfig).build();
 316
 317         leaderNode1.waitForMembersUp("member-2");
 318         newReplicaNode2.waitForMembersUp("member-1");
 319
 320         newReplicaNode2.configDataStore().getActorContext().getShardManager().tell(
 321                 new CreateShard(petsModuleConfig, Shard.builder(), null), newReplicaNode2.kit().getRef());
 322         newReplicaNode2.kit().expectMsgClass(Success.class);
 323
 324         newReplicaNode2.operDataStore().getActorContext().getShardManager().tell(
 325                 new CreateShard(new ModuleShardConfiguration(URI.create("no-leader-ns"), "no-leader-module",
 326                         "no-leader", null, Arrays.asList("member-1")), Shard.builder(), null),
 327                                 newReplicaNode2.kit().getRef());
 328         newReplicaNode2.kit().expectMsgClass(Success.class);
 329
 330         ClusterAdminRpcService service = new ClusterAdminRpcService(newReplicaNode2.configDataStore(),
 331                 newReplicaNode2.operDataStore());
 332
 333         RpcResult<AddReplicasForAllShardsOutput> rpcResult = service.addReplicasForAllShards().get(10, TimeUnit.SECONDS);
 334         AddReplicasForAllShardsOutput result = verifySuccessfulRpcResult(rpcResult);
 335         verifyShardResults(result.getShardResult(), successShardResult("cars", DataStoreType.Config),
 336                 successShardResult("people", DataStoreType.Config),
 337                 successShardResult("pets", DataStoreType.Config),
 338                 successShardResult("cars", DataStoreType.Operational),
 339                 successShardResult("people", DataStoreType.Operational),
 340                 failedShardResult("no-leader", DataStoreType.Operational));
 341
 342         verifyRaftPeersPresent(newReplicaNode2.configDataStore(), "cars", "member-1");
 343         verifyRaftPeersPresent(newReplicaNode2.configDataStore(), "people", "member-1");
 344         verifyRaftPeersPresent(newReplicaNode2.configDataStore(), "pets", "member-1");
 345         verifyRaftPeersPresent(newReplicaNode2.operDataStore(), "cars", "member-1");
 346         verifyRaftPeersPresent(newReplicaNode2.operDataStore(), "people", "member-1");
 347
 348         service.close();
 349     }
 350
 351     @Test
 352     public void testRemoveAllShardReplicas() {
 353         // TODO implement
 354     }
 355
 356     @Test
 357     public void testConvertMembersToVotingForAllShards() {
 358         // TODO implement
 359     }
 360
 361     @Test
 362     public void testConvertMembersToNonvotingForAllShards() {
 363         // TODO implement
 364     }
 365
 366     private void verifyShardResults(List<ShardResult> shardResults, ShardResult... expShardResults) {
 367         Map<String, ShardResult> expResultsMap = new HashMap<>();
 368         for(ShardResult r: expShardResults) {
 369             expResultsMap.put(r.getShardName() + "-" + r.getDataStoreType(), r);
 370         }
 371
 372         for(ShardResult result: shardResults) {
 373             ShardResult exp = expResultsMap.remove(result.getShardName() + "-" + result.getDataStoreType());
 374             assertNotNull(String.format("Unexpected result for shard %s, type %s", result.getShardName(),
 375                     result.getDataStoreType()), exp);
 376             assertEquals("isSucceeded", exp.isSucceeded(), result.isSucceeded());
 377             if(exp.isSucceeded()) {
 378                 assertNull("Expected null error message", result.getErrorMessage());
 379             } else {
 380                 assertNotNull("Expected error message", result.getErrorMessage());
 381             }
 382         }
 383
 384         if(!expResultsMap.isEmpty()) {
 385             fail("Missing shard results for " + expResultsMap.keySet());
 386         }
 387     }
 388
 389     private ShardResult successShardResult(String shardName, DataStoreType type) {
 390         return new ShardResultBuilder().setDataStoreType(type).setShardName(shardName).setSucceeded(true).build();
 391     }
 392
 393     private ShardResult failedShardResult(String shardName, DataStoreType type) {
 394         return new ShardResultBuilder().setDataStoreType(type).setShardName(shardName).setSucceeded(false).build();
 395     }
 396 }