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.entityownership;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertFalse;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertSame;
14 import static org.junit.Assert.assertTrue;
15 import static org.junit.Assert.fail;
16 import static org.mockito.Mockito.mock;
17 import static org.mockito.Mockito.reset;
18 import static org.mockito.Mockito.spy;
19 import static org.mockito.Mockito.verify;
20 import static org.mockito.Mockito.when;
21 import static org.opendaylight.controller.cluster.entityownership.EntityOwnersModel.ENTITY_ID_QNAME;
22 import static org.opendaylight.controller.cluster.entityownership.EntityOwnersModel.ENTITY_OWNERS_PATH;
23 import static org.opendaylight.controller.cluster.entityownership.EntityOwnersModel.ENTITY_QNAME;
24 import static org.opendaylight.controller.cluster.entityownership.EntityOwnersModel.candidatePath;
25 import static org.opendaylight.controller.cluster.entityownership.EntityOwnersModel.entityEntryWithOwner;
26 import static org.opendaylight.controller.cluster.entityownership.EntityOwnersModel.entityOwnersWithCandidate;
27 import static org.opendaylight.controller.cluster.entityownership.EntityOwnersModel.entityOwnersWithEntityTypeEntry;
28 import static org.opendaylight.controller.cluster.entityownership.EntityOwnersModel.entityPath;
29 import static org.opendaylight.controller.cluster.entityownership.EntityOwnersModel.entityTypeEntryWithEntityEntry;
31 import akka.actor.ActorRef;
32 import com.google.common.collect.Sets;
33 import java.util.Collection;
34 import java.util.Optional;
35 import java.util.concurrent.TimeUnit;
36 import org.junit.After;
37 import org.junit.Before;
38 import org.junit.Test;
39 import org.mockito.ArgumentCaptor;
40 import org.mockito.Mockito;
41 import org.opendaylight.controller.cluster.access.concepts.MemberName;
42 import org.opendaylight.controller.cluster.datastore.AbstractDataStore;
43 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
44 import org.opendaylight.controller.cluster.datastore.DatastoreContextFactory;
45 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
46 import org.opendaylight.controller.cluster.datastore.Shard;
47 import org.opendaylight.controller.cluster.datastore.ShardDataTree;
48 import org.opendaylight.controller.cluster.datastore.config.Configuration;
49 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
50 import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
51 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
52 import org.opendaylight.controller.cluster.entityownership.messages.RegisterCandidateLocal;
53 import org.opendaylight.controller.cluster.entityownership.messages.RegisterListenerLocal;
54 import org.opendaylight.controller.cluster.entityownership.messages.UnregisterCandidateLocal;
55 import org.opendaylight.controller.cluster.entityownership.messages.UnregisterListenerLocal;
56 import org.opendaylight.controller.cluster.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
57 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
58 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
59 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
60 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration;
61 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
62 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListenerRegistration;
63 import org.opendaylight.yangtools.yang.common.QName;
64 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
65 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
66 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
67 import scala.concurrent.Await;
68 import scala.concurrent.Future;
69 import scala.concurrent.duration.FiniteDuration;
72 * Unit tests for DistributedEntityOwnershipService.
74 * @author Thomas Pantelis
76 public class DistributedEntityOwnershipServiceTest extends AbstractClusterRefEntityOwnershipTest {
77 static final String ENTITY_TYPE = "test";
78 static final String ENTITY_TYPE2 = "test2";
79 static final QName QNAME = QName.create("test", "2015-08-11", "foo");
80 static int ID_COUNTER = 1;
82 private final String dataStoreName = "config" + ID_COUNTER++;
83 private AbstractDataStore dataStore;
87 DatastoreContext datastoreContext = DatastoreContext.newBuilder().dataStoreName(dataStoreName)
88 .shardInitializationTimeout(10, TimeUnit.SECONDS).build();
90 Configuration configuration = new ConfigurationImpl(new EmptyModuleShardConfigProvider()) {
92 public Collection<MemberName> getUniqueMemberNamesForAllShards() {
93 return Sets.newHashSet(MemberName.forName("member-1"));
97 DatastoreContextFactory mockContextFactory = mock(DatastoreContextFactory.class);
98 Mockito.doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext();
99 Mockito.doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString());
101 dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration,
102 mockContextFactory, null);
104 dataStore.onGlobalContextUpdated(EOSTestUtils.SCHEMA_CONTEXT);
108 public void tearDown() {
112 private static <T> T verifyMessage(final DistributedEntityOwnershipService mock, final Class<T> type) {
113 final ArgumentCaptor<T> message = ArgumentCaptor.forClass(type);
114 verify(mock).executeLocalEntityOwnershipShardOperation(message.capture());
115 return message.getValue();
119 public void testEntityOwnershipShardCreated() throws Exception {
120 DistributedEntityOwnershipService service = DistributedEntityOwnershipService.start(dataStore.getActorUtils(),
121 EntityOwnerSelectionStrategyConfig.newBuilder().build());
123 Future<ActorRef> future = dataStore.getActorUtils().findLocalShardAsync(
124 DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME);
125 ActorRef shardActor = Await.result(future, FiniteDuration.create(10, TimeUnit.SECONDS));
126 assertNotNull(DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME + " not found", shardActor);
132 public void testRegisterCandidate() throws Exception {
133 DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
134 dataStore.getActorUtils(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
136 YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
137 DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
139 DOMEntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
140 verifyRegisterCandidateLocal(service, entity);
141 verifyEntityOwnershipCandidateRegistration(entity, reg);
142 verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE, entityId,
143 dataStore.getActorUtils().getCurrentMemberName().getName());
145 // Register the same entity - should throw exception
148 service.registerCandidate(entity);
149 fail("Expected CandidateAlreadyRegisteredException");
150 } catch (CandidateAlreadyRegisteredException e) {
152 assertEquals("getEntity", entity, e.getEntity());
155 // Register a different entity - should succeed
158 DOMEntity entity2 = new DOMEntity(ENTITY_TYPE2, entityId);
159 DOMEntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
161 verifyEntityOwnershipCandidateRegistration(entity2, reg2);
162 verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
163 dataStore.getActorUtils().getCurrentMemberName().getName());
169 public void testCloseCandidateRegistration() throws Exception {
170 DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
171 dataStore.getActorUtils(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
173 DOMEntity entity = new DOMEntity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
175 DOMEntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
177 verifyEntityOwnershipCandidateRegistration(entity, reg);
178 verifyRegisterCandidateLocal(service, entity);
182 UnregisterCandidateLocal unregCandidate = verifyMessage(service, UnregisterCandidateLocal.class);
183 assertEquals("getEntity", entity, unregCandidate.getEntity());
185 // Re-register - should succeed.
187 service.registerCandidate(entity);
188 verifyRegisterCandidateLocal(service, entity);
194 public void testListenerRegistration() {
195 DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
196 dataStore.getActorUtils(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
198 YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
199 DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
200 DOMEntityOwnershipListener listener = mock(DOMEntityOwnershipListener.class);
202 DOMEntityOwnershipListenerRegistration reg = service.registerListener(entity.getType(), listener);
204 assertNotNull("EntityOwnershipListenerRegistration null", reg);
205 assertEquals("getEntityType", entity.getType(), reg.getEntityType());
206 assertEquals("getInstance", listener, reg.getInstance());
208 RegisterListenerLocal regListener = verifyMessage(service, RegisterListenerLocal.class);
209 assertSame("getListener", listener, regListener.getListener());
210 assertEquals("getEntityType", entity.getType(), regListener.getEntityType());
214 UnregisterListenerLocal unregListener = verifyMessage(service, UnregisterListenerLocal.class);
215 assertEquals("getEntityType", entity.getType(), unregListener.getEntityType());
216 assertSame("getListener", listener, unregListener.getListener());
222 public void testGetOwnershipState() throws Exception {
223 DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
224 dataStore.getActorUtils(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
226 final Shard mockShard = Mockito.mock(Shard.class);
227 ShardDataTree shardDataTree = new ShardDataTree(mockShard, EOSTestUtils.SCHEMA_CONTEXT, TreeType.OPERATIONAL);
229 when(service.getLocalEntityOwnershipShardDataTree()).thenReturn(shardDataTree.getDataTree());
231 DOMEntity entity1 = new DOMEntity(ENTITY_TYPE, "one");
232 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity1.getIdentifier(), "member-1"),
234 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithEntityTypeEntry(entityTypeEntryWithEntityEntry(entity1.getType(),
235 entityEntryWithOwner(entity1.getIdentifier(), "member-1"))), shardDataTree);
236 verifyGetOwnershipState(service, entity1, EntityOwnershipState.IS_OWNER);
238 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE,
239 entity1.getIdentifier(), "member-2"), shardDataTree);
240 writeNode(entityPath(entity1.getType(), entity1.getIdentifier()),
241 entityEntryWithOwner(entity1.getIdentifier(), "member-2"), shardDataTree);
242 verifyGetOwnershipState(service, entity1, EntityOwnershipState.OWNED_BY_OTHER);
244 writeNode(entityPath(entity1.getType(), entity1.getIdentifier()), entityEntryWithOwner(entity1.getIdentifier(),
246 verifyGetOwnershipState(service, entity1, EntityOwnershipState.NO_OWNER);
248 DOMEntity entity2 = new DOMEntity(ENTITY_TYPE, "two");
249 Optional<EntityOwnershipState> state = service.getOwnershipState(entity2);
250 assertFalse("getOwnershipState present", state.isPresent());
252 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity2.getIdentifier(), "member-1"),
254 writeNode(entityPath(entity2.getType(), entity2.getIdentifier()), ImmutableNodes.mapEntry(ENTITY_QNAME,
255 ENTITY_ID_QNAME, entity2.getIdentifier()), shardDataTree);
256 verifyGetOwnershipState(service, entity2, EntityOwnershipState.NO_OWNER);
258 deleteNode(candidatePath(entityPath(entity2.getType(), entity2.getIdentifier()), "member-1"), shardDataTree);
259 Optional<EntityOwnershipState> state2 = service.getOwnershipState(entity2);
260 assertFalse("getOwnershipState present", state2.isPresent());
265 public void testIsCandidateRegistered() throws CandidateAlreadyRegisteredException {
266 DistributedEntityOwnershipService service = DistributedEntityOwnershipService.start(dataStore.getActorUtils(),
267 EntityOwnerSelectionStrategyConfig.newBuilder().build());
269 final DOMEntity test = new DOMEntity("test-type", "test");
271 assertFalse(service.isCandidateRegistered(test));
273 service.registerCandidate(test);
275 assertTrue(service.isCandidateRegistered(test));
280 private static void verifyGetOwnershipState(final DistributedEntityOwnershipService service, final DOMEntity entity,
281 final EntityOwnershipState expState) {
282 Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
283 assertTrue("getOwnershipState present", state.isPresent());
284 assertEquals("EntityOwnershipState", expState, state.get());
287 @SuppressWarnings("checkstyle:IllegalCatch")
288 private void verifyEntityCandidate(final ActorRef entityOwnershipShard, final String entityType,
289 final YangInstanceIdentifier entityId, final String candidateName) {
290 verifyEntityCandidate(entityType, entityId, candidateName, path -> {
292 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
293 } catch (Exception e) {
299 private static void verifyRegisterCandidateLocal(final DistributedEntityOwnershipService service,
300 final DOMEntity entity) {
301 RegisterCandidateLocal regCandidate = verifyMessage(service, RegisterCandidateLocal.class);
302 assertEquals("getEntity", entity, regCandidate.getEntity());
305 private static void verifyEntityOwnershipCandidateRegistration(final DOMEntity entity,
306 final DOMEntityOwnershipCandidateRegistration reg) {
307 assertNotNull("EntityOwnershipCandidateRegistration null", reg);
308 assertEquals("getInstance", entity, reg.getInstance());