2 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore;
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;
28 import java.util.concurrent.TimeUnit;
29 import org.opendaylight.controller.cluster.access.concepts.MemberName;
30 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
31 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
32 import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState;
33 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
34 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
35 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
36 import scala.concurrent.Await;
37 import scala.concurrent.Future;
38 import scala.concurrent.duration.Duration;
41 * Class that represents a cluster member node for unit tests. It encapsulates an actor system with
42 * config and (optional) operational data store instances. The Builder is used to specify the setup
43 * parameters and create the data store instances. The actor system is automatically joined to address
44 * 127.0.0.1:2558 so one member must specify an akka cluster configuration with that address.
46 * @author Thomas Pantelis
48 public class MemberNode {
49 static final Address MEMBER_1_ADDRESS = AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558");
51 private IntegrationTestKit kit;
52 private DistributedDataStore configDataStore;
53 private DistributedDataStore operDataStore;
54 private DatastoreContext.Builder datastoreContextBuilder;
55 private boolean cleanedUp;
58 * Constructs a Builder.
60 * @param members the list to which the resulting MemberNode will be added. This makes it easier for
61 * callers to cleanup instances on test completion.
62 * @return a Builder instance
64 public static Builder builder(List<MemberNode> members) {
65 return new Builder(members);
68 public IntegrationTestKit kit() {
73 public DistributedDataStore configDataStore() {
74 return configDataStore;
78 public DistributedDataStore operDataStore() {
82 public DatastoreContext.Builder datastoreContextBuilder() {
83 return datastoreContextBuilder;
86 public void waitForMembersUp(String... otherMembers) {
87 kit.waitForMembersUp(otherMembers);
90 public void waitForMemberDown(String member) {
91 Stopwatch sw = Stopwatch.createStarted();
92 while(sw.elapsed(TimeUnit.SECONDS) <= 10) {
93 CurrentClusterState state = Cluster.get(kit.getSystem()).state();
94 for(Member m: state.getUnreachable()) {
95 if(member.equals(m.getRoles().iterator().next())) {
100 for(Member m: state.getMembers()) {
101 if(m.status() != MemberStatus.up() && member.equals(m.getRoles().iterator().next())) {
106 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
109 fail("Member " + member + " is now down");
112 public void cleanup() {
115 kit.cleanup(configDataStore);
116 kit.cleanup(operDataStore);
117 IntegrationTestKit.shutdownActorSystem(kit.getSystem(), Boolean.TRUE);
121 public static void verifyRaftState(DistributedDataStore datastore, String shardName, RaftStateVerifier verifier)
123 ActorContext actorContext = datastore.getActorContext();
125 Future<ActorRef> future = actorContext.findLocalShardAsync(shardName);
126 ActorRef shardActor = Await.result(future, Duration.create(10, TimeUnit.SECONDS));
128 AssertionError lastError = null;
129 Stopwatch sw = Stopwatch.createStarted();
130 while(sw.elapsed(TimeUnit.SECONDS) <= 5) {
131 OnDemandRaftState raftState = (OnDemandRaftState)actorContext.
132 executeOperation(shardActor, GetOnDemandRaftState.INSTANCE);
135 verifier.verify(raftState);
137 } catch (AssertionError e) {
139 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
146 public static void verifyRaftPeersPresent(DistributedDataStore datastore, final String shardName,
147 String... peerMemberNames) throws Exception {
148 final Set<String> peerIds = Sets.newHashSet();
149 for(String p: peerMemberNames) {
150 peerIds.add(ShardIdentifier.create(shardName, MemberName.forName(p),
151 datastore.getActorContext().getDataStoreName()).toString());
154 verifyRaftState(datastore, shardName, raftState -> assertEquals("Peers for shard " + shardName, peerIds,
155 raftState.getPeerAddresses().keySet()));
158 public static void verifyNoShardPresent(DistributedDataStore datastore, String shardName) {
159 Stopwatch sw = Stopwatch.createStarted();
160 while(sw.elapsed(TimeUnit.SECONDS) <= 5) {
161 Optional<ActorRef> shardReply = datastore.getActorContext().findLocalShard(shardName);
162 if(!shardReply.isPresent()) {
166 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
169 fail("Shard " + shardName + " is present");
172 public static class Builder {
173 private final List<MemberNode> members;
174 private String moduleShardsConfig;
175 private String akkaConfig;
176 private String[] waitForshardLeader = new String[0];
177 private String testName;
178 private SchemaContext schemaContext;
179 private boolean createOperDatastore = true;
180 private DatastoreContext.Builder datastoreContextBuilder = DatastoreContext.newBuilder().
181 shardHeartbeatIntervalInMillis(300).shardElectionTimeoutFactor(30);
183 Builder(List<MemberNode> members) {
184 this.members = members;
188 * Specifies the name of the module shards config file. This is required.
190 * @return this Builder
192 public Builder moduleShardsConfig(String moduleShardsConfig) {
193 this.moduleShardsConfig = moduleShardsConfig;
198 * Specifies the name of the akka configuration. This is required.
200 * @return this Builder
202 public Builder akkaConfig(String akkaConfig) {
203 this.akkaConfig = akkaConfig;
208 * Specifies the name of the test that is appended to the data store names. This is required.
210 * @return this Builder
212 public Builder testName(String testName) {
213 this.testName = testName;
218 * Specifies the optional names of the shards to initially wait for a leader to be elected.
220 * @return this Builder
222 public Builder waitForShardLeader(String... shardNames) {
223 this.waitForshardLeader = shardNames;
228 * Specifies whether or not to create an operational data store. Defaults to true.
230 * @return this Builder
232 public Builder createOperDatastore(boolean value) {
233 this.createOperDatastore = value;
238 * Specifies the SchemaContext for the data stores. Defaults to SchemaContextHelper.full().
240 * @return this Builder
242 public Builder schemaContext(SchemaContext schemaContext) {
243 this.schemaContext = schemaContext;
248 * Specifies the DatastoreContext Builder. If not specified, a default instance is used.
250 * @return this Builder
252 public Builder datastoreContextBuilder(DatastoreContext.Builder builder) {
253 datastoreContextBuilder = builder;
257 public MemberNode build() {
258 Preconditions.checkNotNull(moduleShardsConfig, "moduleShardsConfig must be specified");
259 Preconditions.checkNotNull(akkaConfig, "akkaConfig must be specified");
260 Preconditions.checkNotNull(testName, "testName must be specified");
262 if(schemaContext == null) {
263 schemaContext = SchemaContextHelper.full();
266 MemberNode node = new MemberNode();
267 node.datastoreContextBuilder = datastoreContextBuilder;
269 ActorSystem system = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig(akkaConfig));
270 Cluster.get(system).join(MEMBER_1_ADDRESS);
272 node.kit = new IntegrationTestKit(system, datastoreContextBuilder);
274 String memberName = new ClusterWrapperImpl(system).getCurrentMemberName().getName();
275 node.kit.getDatastoreContextBuilder().shardManagerPersistenceId("shard-manager-config-" + memberName);
276 node.configDataStore = node.kit.setupDistributedDataStore("config_" + testName, moduleShardsConfig,
277 true, schemaContext, waitForshardLeader);
279 if(createOperDatastore) {
280 node.kit.getDatastoreContextBuilder().shardManagerPersistenceId("shard-manager-oper-" + memberName);
281 node.operDataStore = node.kit.setupDistributedDataStore("oper_" + testName, moduleShardsConfig,
282 true, schemaContext, waitForshardLeader);
290 public static interface RaftStateVerifier {
291 void verify(OnDemandRaftState raftState);