2 * Copyright (c) 2014, 2015 Cisco 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
9 package org.opendaylight.controller.cluster.datastore.utils;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNotEquals;
13 import static org.junit.Assert.assertNotNull;
14 import static org.junit.Assert.assertNull;
15 import static org.junit.Assert.assertSame;
16 import static org.junit.Assert.assertTrue;
17 import static org.junit.Assert.fail;
18 import static org.mockito.Mockito.doReturn;
19 import static org.mockito.Mockito.mock;
21 import akka.actor.ActorRef;
22 import akka.actor.ActorSelection;
23 import akka.actor.ActorSystem;
24 import akka.actor.Address;
25 import akka.actor.Props;
26 import akka.actor.UntypedActor;
27 import akka.dispatch.Futures;
28 import akka.japi.Creator;
29 import akka.testkit.JavaTestKit;
30 import akka.testkit.TestActorRef;
31 import akka.util.Timeout;
32 import com.google.common.base.Optional;
33 import com.google.common.collect.Maps;
34 import com.google.common.collect.Sets;
35 import com.typesafe.config.ConfigFactory;
36 import java.util.Arrays;
38 import java.util.concurrent.TimeUnit;
39 import org.junit.Assert;
40 import org.junit.Test;
41 import org.mockito.Mockito;
42 import org.opendaylight.controller.cluster.datastore.AbstractActorTest;
43 import org.opendaylight.controller.cluster.datastore.ClusterWrapper;
44 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
45 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
46 import org.opendaylight.controller.cluster.datastore.DatastoreContextFactory;
47 import org.opendaylight.controller.cluster.datastore.config.Configuration;
48 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
49 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
50 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
51 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
52 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
53 import org.opendaylight.controller.cluster.datastore.messages.LocalPrimaryShardFound;
54 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
55 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
56 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
57 import org.opendaylight.controller.cluster.datastore.messages.RemotePrimaryShardFound;
58 import org.opendaylight.controller.cluster.raft.utils.EchoActor;
59 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
60 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
61 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
62 import org.slf4j.Logger;
63 import org.slf4j.LoggerFactory;
64 import scala.concurrent.Await;
65 import scala.concurrent.Future;
66 import scala.concurrent.duration.Duration;
67 import scala.concurrent.duration.FiniteDuration;
69 public class ActorContextTest extends AbstractActorTest {
71 static final Logger LOG = LoggerFactory.getLogger(ActorContextTest.class);
73 private static class TestMessage {
76 private static class MockShardManager extends UntypedActor {
78 private final boolean found;
79 private final ActorRef actorRef;
80 private final Map<String,Object> findPrimaryResponses = Maps.newHashMap();
82 private MockShardManager(final boolean found, final ActorRef actorRef) {
85 this.actorRef = actorRef;
88 @Override public void onReceive(final Object message) throws Exception {
89 if (message instanceof FindPrimary) {
90 FindPrimary fp = (FindPrimary)message;
91 Object resp = findPrimaryResponses.get(fp.getShardName());
93 LOG.error("No expected FindPrimary response found for shard name {}", fp.getShardName());
95 getSender().tell(resp, getSelf());
102 getSender().tell(new LocalShardFound(actorRef), getSelf());
104 getSender().tell(new LocalShardNotFound(((FindLocalShard) message).getShardName()), getSelf());
108 void addFindPrimaryResp(final String shardName, final Object resp) {
109 findPrimaryResponses.put(shardName, resp);
112 private static Props props(final boolean found, final ActorRef actorRef) {
113 return Props.create(new MockShardManagerCreator(found, actorRef));
116 private static Props props() {
117 return Props.create(new MockShardManagerCreator());
120 @SuppressWarnings("serial")
121 private static class MockShardManagerCreator implements Creator<MockShardManager> {
123 final ActorRef actorRef;
125 MockShardManagerCreator() {
127 this.actorRef = null;
130 MockShardManagerCreator(final boolean found, final ActorRef actorRef) {
132 this.actorRef = actorRef;
136 public MockShardManager create() throws Exception {
137 return new MockShardManager(found, actorRef);
143 public void testFindLocalShardWithShardFound() {
144 new JavaTestKit(getSystem()) {
146 new Within(duration("1 seconds")) {
148 protected void run() {
150 ActorRef shardActorRef = getSystem().actorOf(Props.create(EchoActor.class));
152 ActorRef shardManagerActorRef = getSystem()
153 .actorOf(MockShardManager.props(true, shardActorRef));
155 ActorContext actorContext = new ActorContext(getSystem(), shardManagerActorRef,
156 mock(ClusterWrapper.class), mock(Configuration.class));
158 Optional<ActorRef> out = actorContext.findLocalShard("default");
160 assertEquals(shardActorRef, out.get());
171 public void testFindLocalShardWithShardNotFound() {
172 new JavaTestKit(getSystem()) {
174 ActorRef shardManagerActorRef = getSystem().actorOf(MockShardManager.props(false, null));
176 ActorContext actorContext = new ActorContext(getSystem(), shardManagerActorRef,
177 mock(ClusterWrapper.class), mock(Configuration.class));
179 Optional<ActorRef> out = actorContext.findLocalShard("default");
180 assertTrue(!out.isPresent());
187 public void testExecuteRemoteOperation() {
188 new JavaTestKit(getSystem()) {
190 ActorRef shardActorRef = getSystem().actorOf(Props.create(EchoActor.class));
192 ActorRef shardManagerActorRef = getSystem().actorOf(MockShardManager.props(true, shardActorRef));
194 ActorContext actorContext = new ActorContext(getSystem(), shardManagerActorRef,
195 mock(ClusterWrapper.class), mock(Configuration.class));
197 ActorSelection actor = actorContext.actorSelection(shardActorRef.path());
199 Object out = actorContext.executeOperation(actor, "hello");
201 assertEquals("hello", out);
207 @SuppressWarnings("checkstyle:IllegalCatch")
208 public void testExecuteRemoteOperationAsync() {
209 new JavaTestKit(getSystem()) {
211 ActorRef shardActorRef = getSystem().actorOf(Props.create(EchoActor.class));
213 ActorRef shardManagerActorRef = getSystem().actorOf(MockShardManager.props(true, shardActorRef));
215 ActorContext actorContext = new ActorContext(getSystem(), shardManagerActorRef,
216 mock(ClusterWrapper.class), mock(Configuration.class));
218 ActorSelection actor = actorContext.actorSelection(shardActorRef.path());
220 Future<Object> future = actorContext.executeOperationAsync(actor, "hello");
223 Object result = Await.result(future, Duration.create(3, TimeUnit.SECONDS));
224 assertEquals("Result", "hello", result);
225 } catch (Exception e) {
226 throw new AssertionError(e);
233 public void testIsPathLocal() {
234 MockClusterWrapper clusterWrapper = new MockClusterWrapper();
235 ActorContext actorContext = null;
237 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
238 assertEquals(false, actorContext.isPathLocal(null));
239 assertEquals(false, actorContext.isPathLocal(""));
241 clusterWrapper.setSelfAddress(null);
242 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
243 assertEquals(false, actorContext.isPathLocal(""));
245 // even if the path is in local format, match the primary path (first 3 elements) and return true
246 clusterWrapper.setSelfAddress(new Address("akka", "test"));
247 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
248 assertEquals(true, actorContext.isPathLocal("akka://test/user/$a"));
250 clusterWrapper.setSelfAddress(new Address("akka", "test"));
251 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
252 assertEquals(true, actorContext.isPathLocal("akka://test/user/$a"));
254 clusterWrapper.setSelfAddress(new Address("akka", "test"));
255 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
256 assertEquals(true, actorContext.isPathLocal("akka://test/user/token2/token3/$a"));
258 // self address of remote format,but Tx path local format.
259 clusterWrapper.setSelfAddress(new Address("akka", "system", "127.0.0.1", 2550));
260 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
261 assertEquals(true, actorContext.isPathLocal(
262 "akka://system/user/shardmanager/shard/transaction"));
264 // self address of local format,but Tx path remote format.
265 clusterWrapper.setSelfAddress(new Address("akka", "system"));
266 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
267 assertEquals(false, actorContext.isPathLocal(
268 "akka://system@127.0.0.1:2550/user/shardmanager/shard/transaction"));
270 //local path but not same
271 clusterWrapper.setSelfAddress(new Address("akka", "test"));
272 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
273 assertEquals(true, actorContext.isPathLocal("akka://test1/user/$a"));
276 clusterWrapper.setSelfAddress(new Address("akka", "system", "127.0.0.1", 2550));
277 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
278 assertEquals(true, actorContext.isPathLocal("akka://system@127.0.0.1:2550/"));
280 // forward-slash missing in address
281 clusterWrapper.setSelfAddress(new Address("akka", "system", "127.0.0.1", 2550));
282 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
283 assertEquals(false, actorContext.isPathLocal("akka://system@127.0.0.1:2550"));
286 clusterWrapper.setSelfAddress(new Address("akka", "system", "127.0.0.1", 2550));
287 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
288 assertEquals(false, actorContext.isPathLocal("akka://system@127.1.0.1:2550/"));
291 clusterWrapper.setSelfAddress(new Address("akka", "system", "127.0.0.1", 2550));
292 actorContext = new ActorContext(getSystem(), null, clusterWrapper, mock(Configuration.class));
293 assertEquals(false, actorContext.isPathLocal("akka://system@127.0.0.1:2551/"));
297 public void testClientDispatcherIsGlobalDispatcher() {
298 ActorContext actorContext = new ActorContext(getSystem(), mock(ActorRef.class), mock(ClusterWrapper.class),
299 mock(Configuration.class), DatastoreContext.newBuilder().build(), new PrimaryShardInfoFutureCache());
301 assertEquals(getSystem().dispatchers().defaultGlobalDispatcher(), actorContext.getClientDispatcher());
305 public void testClientDispatcherIsNotGlobalDispatcher() {
306 ActorSystem actorSystem = ActorSystem.create("with-custom-dispatchers",
307 ConfigFactory.load("application-with-custom-dispatchers.conf"));
309 ActorContext actorContext = new ActorContext(actorSystem, mock(ActorRef.class), mock(ClusterWrapper.class),
310 mock(Configuration.class), DatastoreContext.newBuilder().build(), new PrimaryShardInfoFutureCache());
312 assertNotEquals(actorSystem.dispatchers().defaultGlobalDispatcher(), actorContext.getClientDispatcher());
314 actorSystem.terminate();
318 public void testSetDatastoreContext() {
319 new JavaTestKit(getSystem()) {
321 ActorContext actorContext = new ActorContext(getSystem(), getRef(),
322 mock(ClusterWrapper.class), mock(Configuration.class), DatastoreContext.newBuilder()
323 .operationTimeoutInSeconds(5).shardTransactionCommitTimeoutInSeconds(7).build(),
324 new PrimaryShardInfoFutureCache());
326 assertEquals("getOperationDuration", 5, actorContext.getOperationDuration().toSeconds());
327 assertEquals("getTransactionCommitOperationTimeout", 7,
328 actorContext.getTransactionCommitOperationTimeout().duration().toSeconds());
330 DatastoreContext newContext = DatastoreContext.newBuilder().operationTimeoutInSeconds(6)
331 .shardTransactionCommitTimeoutInSeconds(8).build();
333 DatastoreContextFactory mockContextFactory = mock(DatastoreContextFactory.class);
334 Mockito.doReturn(newContext).when(mockContextFactory).getBaseDatastoreContext();
336 actorContext.setDatastoreContext(mockContextFactory);
338 expectMsgClass(duration("5 seconds"), DatastoreContextFactory.class);
340 Assert.assertSame("getDatastoreContext", newContext, actorContext.getDatastoreContext());
342 assertEquals("getOperationDuration", 6, actorContext.getOperationDuration().toSeconds());
343 assertEquals("getTransactionCommitOperationTimeout", 8,
344 actorContext.getTransactionCommitOperationTimeout().duration().toSeconds());
350 public void testFindPrimaryShardAsyncRemotePrimaryFound() throws Exception {
352 ActorRef shardManager = getSystem().actorOf(MessageCollectorActor.props());
354 DatastoreContext dataStoreContext = DatastoreContext.newBuilder()
355 .logicalStoreType(LogicalDatastoreType.CONFIGURATION)
356 .shardLeaderElectionTimeout(100, TimeUnit.MILLISECONDS).build();
358 final String expPrimaryPath = "akka://test-system/find-primary-shard";
359 final short expPrimaryVersion = DataStoreVersions.CURRENT_VERSION;
360 ActorContext actorContext = new ActorContext(getSystem(), shardManager, mock(ClusterWrapper.class),
361 mock(Configuration.class), dataStoreContext, new PrimaryShardInfoFutureCache()) {
363 protected Future<Object> doAsk(final ActorRef actorRef, final Object message, final Timeout timeout) {
364 return Futures.successful((Object) new RemotePrimaryShardFound(expPrimaryPath, expPrimaryVersion));
368 Future<PrimaryShardInfo> foobar = actorContext.findPrimaryShardAsync("foobar");
369 PrimaryShardInfo actual = Await.result(foobar, Duration.apply(5000, TimeUnit.MILLISECONDS));
371 assertNotNull(actual);
372 assertEquals("LocalShardDataTree present", false, actual.getLocalShardDataTree().isPresent());
373 assertTrue("Unexpected PrimaryShardActor path " + actual.getPrimaryShardActor().path(),
374 expPrimaryPath.endsWith(actual.getPrimaryShardActor().pathString()));
375 assertEquals("getPrimaryShardVersion", expPrimaryVersion, actual.getPrimaryShardVersion());
377 Future<PrimaryShardInfo> cached = actorContext.getPrimaryShardInfoCache().getIfPresent("foobar");
379 PrimaryShardInfo cachedInfo = Await.result(cached, FiniteDuration.apply(1, TimeUnit.MILLISECONDS));
381 assertEquals(cachedInfo, actual);
383 actorContext.getPrimaryShardInfoCache().remove("foobar");
385 cached = actorContext.getPrimaryShardInfoCache().getIfPresent("foobar");
391 public void testFindPrimaryShardAsyncLocalPrimaryFound() throws Exception {
393 ActorRef shardManager = getSystem().actorOf(MessageCollectorActor.props());
395 DatastoreContext dataStoreContext = DatastoreContext.newBuilder()
396 .logicalStoreType(LogicalDatastoreType.CONFIGURATION)
397 .shardLeaderElectionTimeout(100, TimeUnit.MILLISECONDS).build();
399 final DataTree mockDataTree = Mockito.mock(DataTree.class);
400 final String expPrimaryPath = "akka://test-system/find-primary-shard";
401 ActorContext actorContext = new ActorContext(getSystem(), shardManager, mock(ClusterWrapper.class),
402 mock(Configuration.class), dataStoreContext, new PrimaryShardInfoFutureCache()) {
404 protected Future<Object> doAsk(final ActorRef actorRef, final Object message, final Timeout timeout) {
405 return Futures.successful((Object) new LocalPrimaryShardFound(expPrimaryPath, mockDataTree));
409 Future<PrimaryShardInfo> foobar = actorContext.findPrimaryShardAsync("foobar");
410 PrimaryShardInfo actual = Await.result(foobar, Duration.apply(5000, TimeUnit.MILLISECONDS));
412 assertNotNull(actual);
413 assertEquals("LocalShardDataTree present", true, actual.getLocalShardDataTree().isPresent());
414 assertSame("LocalShardDataTree", mockDataTree, actual.getLocalShardDataTree().get());
415 assertTrue("Unexpected PrimaryShardActor path " + actual.getPrimaryShardActor().path(),
416 expPrimaryPath.endsWith(actual.getPrimaryShardActor().pathString()));
417 assertEquals("getPrimaryShardVersion", DataStoreVersions.CURRENT_VERSION, actual.getPrimaryShardVersion());
419 Future<PrimaryShardInfo> cached = actorContext.getPrimaryShardInfoCache().getIfPresent("foobar");
421 PrimaryShardInfo cachedInfo = Await.result(cached, FiniteDuration.apply(1, TimeUnit.MILLISECONDS));
423 assertEquals(cachedInfo, actual);
425 actorContext.getPrimaryShardInfoCache().remove("foobar");
427 cached = actorContext.getPrimaryShardInfoCache().getIfPresent("foobar");
433 public void testFindPrimaryShardAsyncPrimaryNotFound() throws Exception {
434 testFindPrimaryExceptions(new PrimaryNotFoundException("not found"));
438 public void testFindPrimaryShardAsyncActorNotInitialized() throws Exception {
439 testFindPrimaryExceptions(new NotInitializedException("not initialized"));
442 @SuppressWarnings("checkstyle:IllegalCatch")
443 private static void testFindPrimaryExceptions(final Object expectedException) throws Exception {
444 ActorRef shardManager = getSystem().actorOf(MessageCollectorActor.props());
446 DatastoreContext dataStoreContext = DatastoreContext.newBuilder()
447 .logicalStoreType(LogicalDatastoreType.CONFIGURATION)
448 .shardLeaderElectionTimeout(100, TimeUnit.MILLISECONDS).build();
450 ActorContext actorContext =
451 new ActorContext(getSystem(), shardManager, mock(ClusterWrapper.class),
452 mock(Configuration.class), dataStoreContext, new PrimaryShardInfoFutureCache()) {
454 protected Future<Object> doAsk(final ActorRef actorRef, final Object message, final Timeout timeout) {
455 return Futures.successful(expectedException);
459 Future<PrimaryShardInfo> foobar = actorContext.findPrimaryShardAsync("foobar");
462 Await.result(foobar, Duration.apply(100, TimeUnit.MILLISECONDS));
463 fail("Expected" + expectedException.getClass().toString());
464 } catch (Exception e) {
465 if (!expectedException.getClass().isInstance(e)) {
466 fail("Expected Exception of type " + expectedException.getClass().toString());
470 Future<PrimaryShardInfo> cached = actorContext.getPrimaryShardInfoCache().getIfPresent("foobar");
476 public void testBroadcast() {
477 new JavaTestKit(getSystem()) {
479 ActorRef shardActorRef1 = getSystem().actorOf(MessageCollectorActor.props());
480 ActorRef shardActorRef2 = getSystem().actorOf(MessageCollectorActor.props());
482 TestActorRef<MockShardManager> shardManagerActorRef = TestActorRef.create(getSystem(),
483 MockShardManager.props());
484 MockShardManager shardManagerActor = shardManagerActorRef.underlyingActor();
485 shardManagerActor.addFindPrimaryResp("shard1", new RemotePrimaryShardFound(
486 shardActorRef1.path().toString(), DataStoreVersions.CURRENT_VERSION));
487 shardManagerActor.addFindPrimaryResp("shard2", new RemotePrimaryShardFound(
488 shardActorRef2.path().toString(), DataStoreVersions.CURRENT_VERSION));
489 shardManagerActor.addFindPrimaryResp("shard3", new NoShardLeaderException("not found"));
491 Configuration mockConfig = mock(Configuration.class);
492 doReturn(Sets.newLinkedHashSet(Arrays.asList("shard1", "shard2", "shard3"))).when(mockConfig)
495 ActorContext actorContext = new ActorContext(getSystem(), shardManagerActorRef,
496 mock(ClusterWrapper.class), mockConfig,
497 DatastoreContext.newBuilder().shardInitializationTimeout(200, TimeUnit.MILLISECONDS).build(),
498 new PrimaryShardInfoFutureCache());
500 actorContext.broadcast(v -> new TestMessage(), TestMessage.class);
502 MessageCollectorActor.expectFirstMatching(shardActorRef1, TestMessage.class);
503 MessageCollectorActor.expectFirstMatching(shardActorRef2, TestMessage.class);