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.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.datastore.entityownership.EntityOwnersModel.ENTITY_ID_QNAME;
22 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNERS_PATH;
23 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_QNAME;
24 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.candidatePath;
25 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityEntryWithOwner;
26 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithCandidate;
27 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithEntityTypeEntry;
28 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
29 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityTypeEntryWithEntityEntry;
30 import akka.actor.ActorRef;
31 import com.google.common.base.Optional;
32 import com.google.common.collect.Sets;
33 import java.util.Collection;
34 import java.util.concurrent.TimeUnit;
35 import org.junit.After;
36 import org.junit.Before;
37 import org.junit.Test;
38 import org.mockito.ArgumentCaptor;
39 import org.mockito.Mockito;
40 import org.opendaylight.controller.cluster.access.concepts.MemberName;
41 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
42 import org.opendaylight.controller.cluster.datastore.DatastoreContextFactory;
43 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
44 import org.opendaylight.controller.cluster.datastore.Shard;
45 import org.opendaylight.controller.cluster.datastore.ShardDataTree;
46 import org.opendaylight.controller.cluster.datastore.config.Configuration;
47 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
48 import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
49 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal;
50 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal;
51 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
52 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
53 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
54 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
55 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
56 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
57 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
58 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
59 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration;
60 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
61 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListenerRegistration;
62 import org.opendaylight.yangtools.yang.common.QName;
63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
64 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
65 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
66 import scala.concurrent.Await;
67 import scala.concurrent.Future;
68 import scala.concurrent.duration.Duration;
71 * Unit tests for DistributedEntityOwnershipService.
73 * @author Thomas Pantelis
75 public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnershipTest {
76 static final String ENTITY_TYPE = "test";
77 static final String ENTITY_TYPE2 = "test2";
78 static final QName QNAME = QName.create("test", "2015-08-11", "foo");
79 static int ID_COUNTER = 1;
81 private final String dataStoreName = "config" + ID_COUNTER++;
82 private DistributedDataStore dataStore;
86 DatastoreContext datastoreContext = DatastoreContext.newBuilder().dataStoreName(dataStoreName).
87 shardInitializationTimeout(10, TimeUnit.SECONDS).build();
89 Configuration configuration = new ConfigurationImpl(new EmptyModuleShardConfigProvider()) {
91 public Collection<MemberName> getUniqueMemberNamesForAllShards() {
92 return Sets.newHashSet(MemberName.forName("member-1"));
96 DatastoreContextFactory mockContextFactory = mock(DatastoreContextFactory.class);
97 Mockito.doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext();
98 Mockito.doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString());
100 dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration, mockContextFactory, null);
102 dataStore.onGlobalContextUpdated(SchemaContextHelper.entityOwners());
106 public void tearDown() {
110 private static <T> T verifyMessage(final DistributedEntityOwnershipService mock, final Class<T> type) {
111 final ArgumentCaptor<T> message = ArgumentCaptor.forClass(type);
112 verify(mock).executeLocalEntityOwnershipShardOperation(message.capture());
113 return message.getValue();
117 public void testEntityOwnershipShardCreated() throws Exception {
118 DistributedEntityOwnershipService service = DistributedEntityOwnershipService.start(dataStore.getActorContext(),
119 EntityOwnerSelectionStrategyConfig.newBuilder().build());
121 Future<ActorRef> future = dataStore.getActorContext().findLocalShardAsync(
122 DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME);
123 ActorRef shardActor = Await.result(future, Duration.create(10, TimeUnit.SECONDS));
124 assertNotNull(DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME + " not found", shardActor);
130 public void testRegisterCandidate() throws Exception {
131 DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
132 dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
134 YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
135 DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
137 DOMEntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
138 verifyRegisterCandidateLocal(service, entity);
139 verifyEntityOwnershipCandidateRegistration(entity, reg);
140 verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE, entityId,
141 dataStore.getActorContext().getCurrentMemberName().getName());
143 // Register the same entity - should throw exception
146 service.registerCandidate(entity);
147 fail("Expected CandidateAlreadyRegisteredException");
148 } catch(CandidateAlreadyRegisteredException e) {
150 assertEquals("getEntity", entity, e.getEntity());
153 // Register a different entity - should succeed
156 DOMEntity entity2 = new DOMEntity(ENTITY_TYPE2, entityId);
157 DOMEntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
159 verifyEntityOwnershipCandidateRegistration(entity2, reg2);
160 verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
161 dataStore.getActorContext().getCurrentMemberName().getName());
167 public void testCloseCandidateRegistration() throws Exception {
168 DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
169 dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
171 DOMEntity entity = new DOMEntity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
173 DOMEntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
175 verifyEntityOwnershipCandidateRegistration(entity, reg);
176 verifyRegisterCandidateLocal(service, entity);
180 UnregisterCandidateLocal unregCandidate = verifyMessage(service, UnregisterCandidateLocal.class);
181 assertEquals("getEntity", entity, unregCandidate.getEntity());
183 // Re-register - should succeed.
185 service.registerCandidate(entity);
186 verifyRegisterCandidateLocal(service, entity);
192 public void testListenerRegistration() {
193 DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
194 dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
196 YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
197 DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
198 DOMEntityOwnershipListener listener = mock(DOMEntityOwnershipListener.class);
200 DOMEntityOwnershipListenerRegistration reg = service.registerListener(entity.getType(), listener);
202 assertNotNull("EntityOwnershipListenerRegistration null", reg);
203 assertEquals("getEntityType", entity.getType(), reg.getEntityType());
204 assertEquals("getInstance", listener, reg.getInstance());
206 RegisterListenerLocal regListener = verifyMessage(service, RegisterListenerLocal.class);
207 assertSame("getListener", listener, regListener.getListener());
208 assertEquals("getEntityType", entity.getType(), regListener.getEntityType());
212 UnregisterListenerLocal unregListener = verifyMessage(service, UnregisterListenerLocal.class);
213 assertEquals("getEntityType", entity.getType(), unregListener.getEntityType());
214 assertSame("getListener", listener, unregListener.getListener());
220 public void testGetOwnershipState() throws Exception {
221 DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
222 dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
224 final Shard mockShard = Mockito.mock(Shard.class);
225 ShardDataTree shardDataTree = new ShardDataTree(mockShard, SchemaContextHelper.entityOwners(),
226 TreeType.OPERATIONAL);
228 when(service.getLocalEntityOwnershipShardDataTree()).thenReturn(shardDataTree.getDataTree());
230 DOMEntity entity1 = new DOMEntity(ENTITY_TYPE, "one");
231 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity1.getIdentifier(), "member-1"), shardDataTree);
232 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithEntityTypeEntry(entityTypeEntryWithEntityEntry(entity1.getType(),
233 entityEntryWithOwner(entity1.getIdentifier(), "member-1"))), shardDataTree);
234 verifyGetOwnershipState(service, entity1, EntityOwnershipState.IS_OWNER);
236 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE,
237 entity1.getIdentifier(), "member-2"), shardDataTree);
238 writeNode(entityPath(entity1.getType(), entity1.getIdentifier()),
239 entityEntryWithOwner(entity1.getIdentifier(), "member-2"), shardDataTree);
240 verifyGetOwnershipState(service, entity1, EntityOwnershipState.OWNED_BY_OTHER);
242 writeNode(entityPath(entity1.getType(), entity1.getIdentifier()), entityEntryWithOwner(entity1.getIdentifier(), ""),
244 verifyGetOwnershipState(service, entity1, EntityOwnershipState.NO_OWNER);
246 DOMEntity entity2 = new DOMEntity(ENTITY_TYPE, "two");
247 Optional<EntityOwnershipState> state = service.getOwnershipState(entity2);
248 assertEquals("getOwnershipState present", false, state.isPresent());
250 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity2.getIdentifier(), "member-1"),
252 writeNode(entityPath(entity2.getType(), entity2.getIdentifier()), ImmutableNodes.mapEntry(ENTITY_QNAME,
253 ENTITY_ID_QNAME, entity2.getIdentifier()), shardDataTree);
254 verifyGetOwnershipState(service, entity2, EntityOwnershipState.NO_OWNER);
256 deleteNode(candidatePath(entityPath(entity2.getType(), entity2.getIdentifier()), "member-1"), shardDataTree);
257 Optional<EntityOwnershipState> state2 = service.getOwnershipState(entity2);
258 assertEquals("getOwnershipState present", false, state2.isPresent());
263 public void testIsCandidateRegistered() throws CandidateAlreadyRegisteredException {
264 DistributedEntityOwnershipService service = DistributedEntityOwnershipService.start(dataStore.getActorContext(),
265 EntityOwnerSelectionStrategyConfig.newBuilder().build());
267 final DOMEntity test = new DOMEntity("test-type", "test");
269 assertFalse(service.isCandidateRegistered(test));
271 service.registerCandidate(test);
273 assertTrue(service.isCandidateRegistered(test));
278 private static void verifyGetOwnershipState(final DistributedEntityOwnershipService service, final DOMEntity entity,
279 final EntityOwnershipState expState) {
280 Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
281 assertEquals("getOwnershipState present", true, state.isPresent());
282 assertEquals("EntityOwnershipState", expState, state.get());
285 private void verifyEntityCandidate(final ActorRef entityOwnershipShard, final String entityType,
286 final YangInstanceIdentifier entityId, final String candidateName) {
287 verifyEntityCandidate(entityType, entityId, candidateName,
290 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
291 } catch (Exception e) {
297 private static void verifyRegisterCandidateLocal(final DistributedEntityOwnershipService service, final DOMEntity entity) {
298 RegisterCandidateLocal regCandidate = verifyMessage(service, RegisterCandidateLocal.class);
299 assertEquals("getEntity", entity, regCandidate.getEntity());
302 private static void verifyEntityOwnershipCandidateRegistration(final DOMEntity entity,
303 final DOMEntityOwnershipCandidateRegistration reg) {
304 assertNotNull("EntityOwnershipCandidateRegistration null", reg);
305 assertEquals("getInstance", entity, reg.getInstance());