2 * Copyright (c) 2017 Pantheon Technologies s.r.o. 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.databroker.actors.dds;
10 import static org.mockito.Mockito.mock;
11 import static org.mockito.Mockito.when;
13 import akka.actor.ActorRef;
14 import akka.actor.ActorSelection;
15 import akka.actor.ActorSystem;
16 import akka.testkit.JavaTestKit;
17 import akka.testkit.TestProbe;
18 import java.util.Collections;
19 import java.util.concurrent.CompletionStage;
20 import java.util.concurrent.ExecutionException;
21 import org.junit.After;
22 import org.junit.Assert;
23 import org.junit.Before;
24 import org.junit.Test;
25 import org.mockito.Mock;
26 import org.mockito.MockitoAnnotations;
27 import org.opendaylight.controller.cluster.access.commands.ConnectClientFailure;
28 import org.opendaylight.controller.cluster.access.commands.ConnectClientRequest;
29 import org.opendaylight.controller.cluster.access.commands.ConnectClientSuccess;
30 import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
31 import org.opendaylight.controller.cluster.access.concepts.FrontendIdentifier;
32 import org.opendaylight.controller.cluster.access.concepts.FrontendType;
33 import org.opendaylight.controller.cluster.access.concepts.MemberName;
34 import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
35 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
36 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategy;
37 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
38 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
39 import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache;
40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
41 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
42 import scala.concurrent.Promise;
44 public class ModuleShardBackendResolverTest {
46 private static final MemberName MEMBER_NAME = MemberName.forName("member-1");
47 private static final FrontendType FRONTEND_TYPE = FrontendType.forName("type-1");
48 private static final FrontendIdentifier FRONTEND_ID = FrontendIdentifier.create(MEMBER_NAME, FRONTEND_TYPE);
49 private static final ClientIdentifier CLIENT_ID = ClientIdentifier.create(FRONTEND_ID, 0);
51 private ActorSystem system;
52 private ModuleShardBackendResolver moduleShardBackendResolver;
53 private TestProbe contextProbe;
56 private ShardStrategyFactory shardStrategyFactory;
58 private ShardStrategy shardStrategy;
60 private DataTree dataTree;
63 public void setUp() throws Exception {
64 MockitoAnnotations.initMocks(this);
65 system = ActorSystem.apply();
66 contextProbe = new TestProbe(system, "context");
67 final ActorContext actorContext = createActorContextMock(system, contextProbe.ref());
68 moduleShardBackendResolver = new ModuleShardBackendResolver(CLIENT_ID, actorContext);
69 when(actorContext.getShardStrategyFactory()).thenReturn(shardStrategyFactory);
70 when(shardStrategyFactory.getStrategy(YangInstanceIdentifier.EMPTY)).thenReturn(shardStrategy);
71 final PrimaryShardInfoFutureCache cache = new PrimaryShardInfoFutureCache();
72 when(actorContext.getPrimaryShardInfoCache()).thenReturn(cache);
76 public void tearDown() throws Exception {
77 JavaTestKit.shutdownActorSystem(system);
81 public void testResolveShardForPathNonNullCookie() throws Exception {
82 when(shardStrategy.findShard(YangInstanceIdentifier.EMPTY)).thenReturn("default");
83 final Long cookie = moduleShardBackendResolver.resolveShardForPath(YangInstanceIdentifier.EMPTY);
84 Assert.assertEquals(0L, cookie.longValue());
88 public void testResolveShardForPathNullCookie() throws Exception {
89 when(shardStrategy.findShard(YangInstanceIdentifier.EMPTY)).thenReturn("foo");
90 final Long cookie = moduleShardBackendResolver.resolveShardForPath(YangInstanceIdentifier.EMPTY);
91 Assert.assertEquals(1L, cookie.longValue());
95 public void testGetBackendInfo() throws Exception {
96 final CompletionStage<ShardBackendInfo> i = moduleShardBackendResolver.getBackendInfo(0L);
97 contextProbe.expectMsgClass(ConnectClientRequest.class);
98 final TestProbe backendProbe = new TestProbe(system, "backend");
99 final ConnectClientSuccess msg = new ConnectClientSuccess(CLIENT_ID, 0L, backendProbe.ref(),
100 Collections.emptyList(), dataTree, 3);
101 contextProbe.reply(msg);
102 final CompletionStage<ShardBackendInfo> stage = moduleShardBackendResolver.getBackendInfo(0L);
103 final ShardBackendInfo shardBackendInfo = TestUtils.getWithTimeout(stage.toCompletableFuture());
104 Assert.assertEquals(0L, shardBackendInfo.getCookie().longValue());
105 Assert.assertEquals(dataTree, shardBackendInfo.getDataTree().get());
106 Assert.assertEquals("default", shardBackendInfo.getShardName());
110 public void testGetBackendInfoFail() throws Exception {
111 final CompletionStage<ShardBackendInfo> i = moduleShardBackendResolver.getBackendInfo(0L);
112 final ConnectClientRequest req = contextProbe.expectMsgClass(ConnectClientRequest.class);
113 final RuntimeRequestException cause = new RuntimeRequestException("fail", new RuntimeException());
114 final ConnectClientFailure response =
115 req.toRequestFailure(cause);
116 contextProbe.reply(response);
117 final CompletionStage<ShardBackendInfo> stage = moduleShardBackendResolver.getBackendInfo(0L);
118 final ExecutionException caught =
119 TestUtils.assertOperationThrowsException(() -> TestUtils.getWithTimeout(stage.toCompletableFuture()),
120 ExecutionException.class);
121 Assert.assertNotNull(caught.getCause());
122 Assert.assertEquals(cause, caught.getCause().getCause());
126 public void testRefreshBackendInfo() throws Exception {
127 final CompletionStage<ShardBackendInfo> backendInfo = moduleShardBackendResolver.getBackendInfo(0L);
128 //handle first connect
129 contextProbe.expectMsgClass(ConnectClientRequest.class);
130 final TestProbe staleBackendProbe = new TestProbe(system, "staleBackend");
131 final ConnectClientSuccess msg = new ConnectClientSuccess(CLIENT_ID, 0L, staleBackendProbe.ref(),
132 Collections.emptyList(), dataTree, 3);
133 contextProbe.reply(msg);
135 final ShardBackendInfo staleBackendInfo = TestUtils.getWithTimeout(backendInfo.toCompletableFuture());
137 final CompletionStage<ShardBackendInfo> refreshed =
138 moduleShardBackendResolver.refreshBackendInfo(0L, staleBackendInfo);
139 //stale backend info should be removed and new connect request issued to the context
140 contextProbe.expectMsgClass(ConnectClientRequest.class);
141 final TestProbe refreshedBackendProbe = new TestProbe(system, "refreshedBackend");
142 final ConnectClientSuccess msg2 = new ConnectClientSuccess(CLIENT_ID, 1L, refreshedBackendProbe.ref(),
143 Collections.emptyList(), dataTree, 3);
144 contextProbe.reply(msg2);
145 final ShardBackendInfo refreshedBackendInfo = TestUtils.getWithTimeout(refreshed.toCompletableFuture());
146 Assert.assertEquals(staleBackendInfo.getCookie(), refreshedBackendInfo.getCookie());
147 Assert.assertEquals(refreshedBackendProbe.ref(), refreshedBackendInfo.getActor());
150 private static ActorContext createActorContextMock(final ActorSystem system, final ActorRef actor) {
151 final ActorContext mock = mock(ActorContext.class);
152 final Promise<PrimaryShardInfo> promise = new scala.concurrent.impl.Promise.DefaultPromise<>();
153 final ActorSelection selection = system.actorSelection(actor.path());
154 final PrimaryShardInfo shardInfo = new PrimaryShardInfo(selection, (short) 0);
155 promise.success(shardInfo);
156 when(mock.findPrimaryShardAsync("default")).thenReturn(promise.future());