opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/MemberNode.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;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.fail;
  12 import akka.actor.ActorRef;
  13 import akka.actor.ActorSystem;
  14 import akka.actor.Address;
  15 import akka.actor.AddressFromURIString;
  16 import akka.cluster.Cluster;
  17 import akka.cluster.ClusterEvent.CurrentClusterState;
  18 import akka.cluster.Member;
  19 import akka.cluster.MemberStatus;
  20 import com.google.common.base.Optional;
  21 import com.google.common.base.Preconditions;
  22 import com.google.common.base.Stopwatch;
  23 import com.google.common.collect.Sets;
  24 import com.google.common.util.concurrent.Uninterruptibles;
  25 import com.typesafe.config.ConfigFactory;
  26 import java.util.List;
  27 import java.util.Set;
  28 import java.util.concurrent.TimeUnit;
  29 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
  30 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
  31 import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState;
  32 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
  33 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
  34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  35 import scala.concurrent.Await;
  36 import scala.concurrent.Future;
  37 import scala.concurrent.duration.Duration;
  38
  39 /**
  40  * Class that represents a cluster member node for unit tests. It encapsulates an actor system with
  41  * config and (optional) operational data store instances. The Builder is used to specify the setup
  42  * parameters and create the data store instances. The actor system is automatically joined to address
  43  * 127.0.0.1:2558 so one member must specify an akka cluster configuration with that address.
  44  *
  45  * @author Thomas Pantelis
  46  */
  47 public class MemberNode {
  48     static final Address MEMBER_1_ADDRESS = AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558");
  49
  50     private IntegrationTestKit kit;
  51     private DistributedDataStore configDataStore;
  52     private DistributedDataStore operDataStore;
  53     private DatastoreContext.Builder datastoreContextBuilder;
  54     private boolean cleanedUp;
  55
  56     /**
  57      * Constructs a Builder.
  58      *
  59      * @param members the list to which the resulting MemberNode will be added. This makes it easier for
  60      *                callers to cleanup instances on test completion.
  61      * @return a Builder instance
  62      */
  63     public static Builder builder(List<MemberNode> members) {
  64         return new Builder(members);
  65     }
  66
  67     public IntegrationTestKit kit() {
  68         return kit;
  69     }
  70
  71
  72     public DistributedDataStore configDataStore() {
  73         return configDataStore;
  74     }
  75
  76
  77     public DistributedDataStore operDataStore() {
  78         return operDataStore;
  79     }
  80
  81     public DatastoreContext.Builder datastoreContextBuilder() {
  82         return datastoreContextBuilder;
  83     }
  84
  85     public void waitForMembersUp(String... otherMembers) {
  86         kit.waitForMembersUp(otherMembers);
  87     }
  88
  89     public void waitForMemberDown(String member) {
  90         Stopwatch sw = Stopwatch.createStarted();
  91         while(sw.elapsed(TimeUnit.SECONDS) <= 10) {
  92             CurrentClusterState state = Cluster.get(kit.getSystem()).state();
  93             for(Member m: state.getUnreachable()) {
  94                 if(member.equals(m.getRoles().iterator().next())) {
  95                     return;
  96                 }
  97             }
  98
  99             for(Member m: state.getMembers()) {
 100                 if(m.status() != MemberStatus.up() && member.equals(m.getRoles().iterator().next())) {
 101                     return;
 102                 }
 103             }
 104
 105             Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
 106         }
 107
 108         fail("Member " + member + " is now down");
 109     }
 110
 111     public void cleanup() {
 112         if(!cleanedUp) {
 113             cleanedUp = true;
 114             kit.cleanup(configDataStore);
 115             kit.cleanup(operDataStore);
 116             IntegrationTestKit.shutdownActorSystem(kit.getSystem(), Boolean.TRUE);
 117         }
 118     }
 119
 120     public static void verifyRaftState(DistributedDataStore datastore, String shardName, RaftStateVerifier verifier)
 121             throws Exception {
 122         ActorContext actorContext = datastore.getActorContext();
 123
 124         Future<ActorRef> future = actorContext.findLocalShardAsync(shardName);
 125         ActorRef shardActor = Await.result(future, Duration.create(10, TimeUnit.SECONDS));
 126
 127         AssertionError lastError = null;
 128         Stopwatch sw = Stopwatch.createStarted();
 129         while(sw.elapsed(TimeUnit.SECONDS) <= 5) {
 130             OnDemandRaftState raftState = (OnDemandRaftState)actorContext.
 131                     executeOperation(shardActor, GetOnDemandRaftState.INSTANCE);
 132
 133             try {
 134                 verifier.verify(raftState);
 135                 return;
 136             } catch (AssertionError e) {
 137                 lastError = e;
 138                 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 139             }
 140         }
 141
 142         throw lastError;
 143     }
 144
 145     public static void verifyRaftPeersPresent(DistributedDataStore datastore, final String shardName,
 146             String... peerMemberNames) throws Exception {
 147         final Set<String> peerIds = Sets.newHashSet();
 148         for(String p: peerMemberNames) {
 149             peerIds.add(ShardIdentifier.builder().memberName(p).shardName(shardName).
 150                 type(datastore.getActorContext().getDataStoreName()).build().toString());
 151         }
 152
 153         verifyRaftState(datastore, shardName, raftState -> assertEquals("Peers for shard " + shardName, peerIds, raftState.getPeerAddresses().keySet()));
 154     }
 155
 156     public static void verifyNoShardPresent(DistributedDataStore datastore, String shardName) {
 157         Stopwatch sw = Stopwatch.createStarted();
 158         while(sw.elapsed(TimeUnit.SECONDS) <= 5) {
 159             Optional<ActorRef> shardReply = datastore.getActorContext().findLocalShard(shardName);
 160             if(!shardReply.isPresent()) {
 161                 return;
 162             }
 163
 164             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 165         }
 166
 167         fail("Shard " + shardName + " is present");
 168     }
 169
 170     public static class Builder {
 171         private final List<MemberNode> members;
 172         private String moduleShardsConfig;
 173         private String akkaConfig;
 174         private String[] waitForshardLeader = new String[0];
 175         private String testName;
 176         private SchemaContext schemaContext;
 177         private boolean createOperDatastore = true;
 178         private DatastoreContext.Builder datastoreContextBuilder = DatastoreContext.newBuilder().
 179                 shardHeartbeatIntervalInMillis(300).shardElectionTimeoutFactor(30);
 180
 181         Builder(List<MemberNode> members) {
 182             this.members = members;
 183         }
 184
 185         /**
 186          * Specifies the name of the module shards config file. This is required.
 187          *
 188          * @return this Builder
 189          */
 190         public Builder moduleShardsConfig(String moduleShardsConfig) {
 191             this.moduleShardsConfig = moduleShardsConfig;
 192             return this;
 193         }
 194
 195         /**
 196          * Specifies the name of the akka configuration. This is required.
 197          *
 198          * @return this Builder
 199          */
 200         public Builder akkaConfig(String akkaConfig) {
 201             this.akkaConfig = akkaConfig;
 202             return this;
 203         }
 204
 205         /**
 206          * Specifies the name of the test that is appended to the data store names. This is required.
 207          *
 208          * @return this Builder
 209          */
 210         public Builder testName(String testName) {
 211             this.testName = testName;
 212             return this;
 213         }
 214
 215         /**
 216          * Specifies the optional names of the shards to initially wait for a leader to be elected.
 217          *
 218          * @return this Builder
 219          */
 220         public Builder waitForShardLeader(String... shardNames) {
 221             this.waitForshardLeader = shardNames;
 222             return this;
 223         }
 224
 225         /**
 226          * Specifies whether or not to create an operational data store. Defaults to true.
 227          *
 228          * @return this Builder
 229          */
 230         public Builder createOperDatastore(boolean value) {
 231             this.createOperDatastore = value;
 232             return this;
 233         }
 234
 235         /**
 236          * Specifies the SchemaContext for the data stores. Defaults to SchemaContextHelper.full().
 237          *
 238          * @return this Builder
 239          */
 240         public Builder schemaContext(SchemaContext schemaContext) {
 241             this.schemaContext = schemaContext;
 242             return this;
 243         }
 244
 245         /**
 246          * Specifies the DatastoreContext Builder. If not specified, a default instance is used.
 247          *
 248          * @return this Builder
 249          */
 250         public Builder datastoreContextBuilder(DatastoreContext.Builder builder) {
 251             datastoreContextBuilder = builder;
 252             return this;
 253         }
 254
 255         public MemberNode build() {
 256             Preconditions.checkNotNull(moduleShardsConfig, "moduleShardsConfig must be specified");
 257             Preconditions.checkNotNull(akkaConfig, "akkaConfig must be specified");
 258             Preconditions.checkNotNull(testName, "testName must be specified");
 259
 260             if(schemaContext == null) {
 261                 schemaContext = SchemaContextHelper.full();
 262             }
 263
 264             MemberNode node = new MemberNode();
 265             node.datastoreContextBuilder = datastoreContextBuilder;
 266
 267             ActorSystem system = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig(akkaConfig));
 268             Cluster.get(system).join(MEMBER_1_ADDRESS);
 269
 270             node.kit = new IntegrationTestKit(system, datastoreContextBuilder);
 271
 272             String memberName = new ClusterWrapperImpl(system).getCurrentMemberName();
 273             node.kit.getDatastoreContextBuilder().shardManagerPersistenceId("shard-manager-config-" + memberName);
 274             node.configDataStore = node.kit.setupDistributedDataStore("config_" + testName, moduleShardsConfig,
 275                     true, schemaContext, waitForshardLeader);
 276
 277             if(createOperDatastore) {
 278                 node.kit.getDatastoreContextBuilder().shardManagerPersistenceId("shard-manager-oper-" + memberName);
 279                 node.operDataStore = node.kit.setupDistributedDataStore("oper_" + testName, moduleShardsConfig,
 280                         true, schemaContext, waitForshardLeader);
 281             }
 282
 283             members.add(node);
 284             return node;
 285         }
 286     }
 287
 288     public static interface RaftStateVerifier {
 289         void verify(OnDemandRaftState raftState);
 290     }
 291 }