package org.opendaylight.controller.cluster.datastore.entityownership;
import static org.junit.Assert.assertEquals;
-import static org.mockito.Matchers.any;
-import static org.mockito.Matchers.anyBoolean;
-import static org.mockito.Mockito.never;
+import static org.mockito.AdditionalMatchers.or;
+import static org.mockito.Mockito.atMost;
import static org.mockito.Mockito.reset;
import static org.mockito.Mockito.timeout;
import static org.mockito.Mockito.verify;
+import static org.opendaylight.controller.cluster.datastore.entityownership.AbstractEntityOwnershipTest.ownershipChange;
import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID;
import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
import akka.actor.ActorSystem;
import org.opendaylight.controller.cluster.datastore.DatastoreContext;
import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
+import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
-import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidate;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.entity.owners.entity.type.entity.Candidate;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
private IntegrationTestKit follower2TestKit;
@Mock
- private EntityOwnershipCandidate leaderMockCandidate;
+ private EntityOwnershipListener leaderMockListener;
@Mock
- private EntityOwnershipCandidate follower1MockCandidate;
+ private EntityOwnershipListener leaderMockListener2;
@Mock
- private EntityOwnershipCandidate follower2MockCandidate;
+ private EntityOwnershipListener follower1MockListener;
+
+ @Mock
+ private EntityOwnershipListener follower2MockListener;
@Before
public void setUp() {
follower1DistributedDataStore.waitTillReady();
follower2DistributedDataStore.waitTillReady();
- leaderEntityOwnershipService = new DistributedEntityOwnershipService(leaderDistributedDataStore);
+ leaderEntityOwnershipService = new DistributedEntityOwnershipService(leaderDistributedDataStore, EntityOwnerSelectionStrategyConfig.newBuilder().build());
leaderEntityOwnershipService.start();
- follower1EntityOwnershipService = new DistributedEntityOwnershipService(follower1DistributedDataStore);
+ follower1EntityOwnershipService = new DistributedEntityOwnershipService(follower1DistributedDataStore, EntityOwnerSelectionStrategyConfig.newBuilder().build());
follower1EntityOwnershipService.start();
- follower2EntityOwnershipService = new DistributedEntityOwnershipService(follower2DistributedDataStore);
+ follower2EntityOwnershipService = new DistributedEntityOwnershipService(follower2DistributedDataStore, EntityOwnerSelectionStrategyConfig.newBuilder().build());
follower2EntityOwnershipService.start();
leaderTestKit.waitUntilLeader(leaderDistributedDataStore.getActorContext(),
public void test() throws Exception {
initDatastores("test");
+ leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
+ leaderEntityOwnershipService.registerListener(ENTITY_TYPE2, leaderMockListener2);
+ follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
+
// Register leader candidate for entity1 and verify it becomes owner
- leaderEntityOwnershipService.registerCandidate(ENTITY1, leaderMockCandidate);
- verify(leaderMockCandidate, timeout(5000)).ownershipChanged(ENTITY1, false, true);
- reset(leaderMockCandidate);
+ leaderEntityOwnershipService.registerCandidate(ENTITY1);
+ verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
+ verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
+ reset(leaderMockListener, follower1MockListener);
+
+ verifyGetOwnershipState(leaderEntityOwnershipService, ENTITY1, true, true);
+ verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, false, true);
// Register leader candidate for entity1_2 (same id, different type) and verify it becomes owner
- leaderEntityOwnershipService.registerCandidate(ENTITY1_2, leaderMockCandidate);
- verify(leaderMockCandidate, timeout(5000)).ownershipChanged(ENTITY1_2, false, true);
- reset(leaderMockCandidate);
+ leaderEntityOwnershipService.registerCandidate(ENTITY1_2);
+ verify(leaderMockListener2, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1_2, false, true, true));
+ verify(leaderMockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1_2));
+ reset(leaderMockListener2);
// Register follower1 candidate for entity1 and verify it gets added but doesn't become owner
- follower1EntityOwnershipService.registerCandidate(ENTITY1, follower1MockCandidate);
+ follower1EntityOwnershipService.registerCandidate(ENTITY1);
verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
- verify(follower1MockCandidate, never()).ownershipChanged(any(Entity.class), anyBoolean(), anyBoolean());
+ verify(leaderMockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1));
+ verify(follower1MockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1));
// Register follower1 candidate for entity2 and verify it becomes owner
- follower1EntityOwnershipService.registerCandidate(ENTITY2, follower1MockCandidate);
- verify(follower1MockCandidate, timeout(5000)).ownershipChanged(ENTITY2, false, true);
- reset(follower1MockCandidate);
+ follower1EntityOwnershipService.registerCandidate(ENTITY2);
+ verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
+ verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
+ reset(leaderMockListener, follower1MockListener);
// Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
- follower2EntityOwnershipService.registerCandidate(ENTITY2, follower2MockCandidate);
+ follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
+ follower2EntityOwnershipService.registerCandidate(ENTITY2);
verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
- verify(follower2MockCandidate, never()).ownershipChanged(any(Entity.class), anyBoolean(), anyBoolean());
// Unregister follower1 candidate for entity2 and verify follower2 becomes owner
- follower1EntityOwnershipService.unregisterCandidate(ENTITY2, follower1MockCandidate);
- verify(follower2MockCandidate, timeout(5000)).ownershipChanged(ENTITY2, false, true);
+ follower1EntityOwnershipService.unregisterCandidate(ENTITY2);
+ verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
+ verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
+ verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
+ verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
+
+ // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
+ // if the original ownership change with "member-2 is replicated to follower2 after the listener is
+ // registered.
+ Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
+ verify(follower2MockListener, atMost(1)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
+ verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
// Register follower1 candidate for entity3 and verify it becomes owner
- follower1EntityOwnershipService.registerCandidate(ENTITY3, follower1MockCandidate);
- verify(follower1MockCandidate, timeout(5000)).ownershipChanged(ENTITY3, false, true);
+ follower1EntityOwnershipService.registerCandidate(ENTITY3);
verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
+ verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
+ verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
+ verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
// Register follower2 candidate for entity4 and verify it becomes owner
- follower2EntityOwnershipService.registerCandidate(ENTITY4, follower2MockCandidate);
- verify(follower2MockCandidate, timeout(5000)).ownershipChanged(ENTITY4, false, true);
- reset(follower2MockCandidate);
+ follower2EntityOwnershipService.registerCandidate(ENTITY4);
+ verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
+ verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
+ verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
+ verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
+ reset(follower1MockListener, follower2MockListener);
// Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
- reset(follower1MockCandidate);
- follower1EntityOwnershipService.registerCandidate(ENTITY4, follower1MockCandidate);
+ follower1EntityOwnershipService.registerCandidate(ENTITY4);
verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
- verify(follower1MockCandidate, never()).ownershipChanged(any(Entity.class), anyBoolean(), anyBoolean());
// Shutdown follower2 and verify it's owned entities (entity 2 & 4) get re-assigned
- reset(follower1MockCandidate);
+ reset(leaderMockListener, follower1MockListener);
JavaTestKit.shutdownActorSystem(follower2System);
- verify(follower1MockCandidate, timeout(15000)).ownershipChanged(ENTITY4, false, true);
+ verify(follower1MockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, true, true),
+ ownershipChange(ENTITY2, false, false, false)));
+ verify(leaderMockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, false, true),
+ ownershipChange(ENTITY2, false, false, false)));
verifyOwner(leaderDistributedDataStore, ENTITY2, ""); // no other candidate
// Register leader candidate for entity2 and verify it becomes owner
- leaderEntityOwnershipService.registerCandidate(ENTITY2, leaderMockCandidate);
- verify(leaderMockCandidate, timeout(5000)).ownershipChanged(ENTITY2, false, true);
+ leaderEntityOwnershipService.registerCandidate(ENTITY2);
+ verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
// Unregister leader candidate for entity2 and verify the owner is cleared
- leaderEntityOwnershipService.unregisterCandidate(ENTITY2, leaderMockCandidate);
+ leaderEntityOwnershipService.unregisterCandidate(ENTITY2);
verifyOwner(leaderDistributedDataStore, ENTITY2, "");
+ verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
+ verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
+ }
+
+ private static void verifyGetOwnershipState(DistributedEntityOwnershipService service, Entity entity,
+ boolean isOwner, boolean hasOwner) {
+ Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
+ assertEquals("getOwnershipState present", true, state.isPresent());
+ assertEquals("isOwner", isOwner, state.get().isOwner());
+ assertEquals("hasOwner", hasOwner, state.get().hasOwner());
}
- private void verifyCandidates(DistributedDataStore dataStore, Entity entity, String... expCandidates) throws Exception {
+ private static void verifyCandidates(DistributedDataStore dataStore, Entity entity, String... expCandidates) throws Exception {
AssertionError lastError = null;
Stopwatch sw = Stopwatch.createStarted();
while(sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) {
throw lastError;
}
- private void verifyOwner(final DistributedDataStore dataStore, Entity entity, String expOwner) throws Exception {
+ private static void verifyOwner(final DistributedDataStore dataStore, Entity entity, String expOwner) {
AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getId(),
new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
@Override