opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipIntegrationTest.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.cluster.datastore.entityownership;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertTrue;
  12 import static org.mockito.AdditionalMatchers.or;
  13 import static org.mockito.Mockito.atMost;
  14 import static org.mockito.Mockito.doNothing;
  15 import static org.mockito.Mockito.reset;
  16 import static org.mockito.Mockito.timeout;
  17 import static org.mockito.Mockito.verify;
  18 import static org.opendaylight.controller.cluster.datastore.entityownership.AbstractEntityOwnershipTest.ownershipChange;
  19 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID;
  20 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
  21 import akka.actor.ActorSystem;
  22 import akka.actor.Address;
  23 import akka.actor.AddressFromURIString;
  24 import akka.cluster.Cluster;
  25 import akka.testkit.JavaTestKit;
  26 import com.google.common.base.Function;
  27 import com.google.common.base.Optional;
  28 import com.google.common.base.Stopwatch;
  29 import com.google.common.util.concurrent.Uninterruptibles;
  30 import com.typesafe.config.ConfigFactory;
  31 import java.util.ArrayList;
  32 import java.util.Arrays;
  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.Mock;
  40 import org.mockito.Mockito;
  41 import org.mockito.MockitoAnnotations;
  42 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
  43 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
  44 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
  45 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
  46 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
  47 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
  48 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  49 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
  50 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
  51 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
  52 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
  53 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;
  54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  55 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  56 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  57 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  58 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  59
  60 /**
  61  * End-to-end integration tests for the entity ownership functionality.
  62  *
  63  * @author Thomas Pantelis
  64  */
  65 public class DistributedEntityOwnershipIntegrationTest {
  66     private static final Address MEMBER_1_ADDRESS = AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558");
  67     private static final String MODULE_SHARDS_CONFIG = "module-shards-default.conf";
  68     private static final String ENTITY_TYPE1 = "entityType1";
  69     private static final String ENTITY_TYPE2 = "entityType2";
  70     private static final Entity ENTITY1 = new Entity(ENTITY_TYPE1, "entity1");
  71     private static final Entity ENTITY1_2 = new Entity(ENTITY_TYPE2, "entity1");
  72     private static final Entity ENTITY2 = new Entity(ENTITY_TYPE1, "entity2");
  73     private static final Entity ENTITY3 = new Entity(ENTITY_TYPE1, "entity3");
  74     private static final Entity ENTITY4 = new Entity(ENTITY_TYPE1, "entity4");
  75     private static final SchemaContext SCHEMA_CONTEXT = SchemaContextHelper.entityOwners();
  76
  77     private ActorSystem leaderSystem;
  78     private ActorSystem follower1System;
  79     private ActorSystem follower2System;
  80
  81     private final DatastoreContext.Builder leaderDatastoreContextBuilder =
  82             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5);
  83
  84     private final DatastoreContext.Builder followerDatastoreContextBuilder =
  85             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10000);
  86
  87     private DistributedDataStore leaderDistributedDataStore;
  88     private DistributedDataStore follower1DistributedDataStore;
  89     private DistributedDataStore follower2DistributedDataStore;
  90     private DistributedEntityOwnershipService leaderEntityOwnershipService;
  91     private DistributedEntityOwnershipService follower1EntityOwnershipService;
  92     private DistributedEntityOwnershipService follower2EntityOwnershipService;
  93     private IntegrationTestKit leaderTestKit;
  94     private IntegrationTestKit follower1TestKit;
  95     private IntegrationTestKit follower2TestKit;
  96
  97     @Mock
  98     private EntityOwnershipListener leaderMockListener;
  99
 100     @Mock
 101     private EntityOwnershipListener leaderMockListener2;
 102
 103     @Mock
 104     private EntityOwnershipListener follower1MockListener;
 105
 106     @Mock
 107     private EntityOwnershipListener follower2MockListener;
 108
 109     @Before
 110     public void setUp() {
 111         MockitoAnnotations.initMocks(this);
 112
 113         leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
 114         Cluster.get(leaderSystem).join(MEMBER_1_ADDRESS);
 115
 116         follower1System = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
 117         Cluster.get(follower1System).join(MEMBER_1_ADDRESS);
 118
 119         follower2System = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member3"));
 120         Cluster.get(follower2System).join(MEMBER_1_ADDRESS);
 121     }
 122
 123     @After
 124     public void tearDown() {
 125         JavaTestKit.shutdownActorSystem(leaderSystem);
 126         JavaTestKit.shutdownActorSystem(follower1System);
 127         JavaTestKit.shutdownActorSystem(follower2System);
 128     }
 129
 130     private void initDatastores(String type) {
 131         leaderTestKit = new IntegrationTestKit(leaderSystem, leaderDatastoreContextBuilder);
 132         leaderDistributedDataStore = leaderTestKit.setupDistributedDataStore(
 133                 type, MODULE_SHARDS_CONFIG, false, SCHEMA_CONTEXT);
 134
 135         follower1TestKit = new IntegrationTestKit(follower1System, followerDatastoreContextBuilder);
 136         follower1DistributedDataStore = follower1TestKit.setupDistributedDataStore(
 137                 type, MODULE_SHARDS_CONFIG, false, SCHEMA_CONTEXT);
 138
 139         follower2TestKit = new IntegrationTestKit(follower2System, followerDatastoreContextBuilder);
 140         follower2DistributedDataStore = follower2TestKit.setupDistributedDataStore(
 141                 type, MODULE_SHARDS_CONFIG, false, SCHEMA_CONTEXT);
 142
 143         leaderDistributedDataStore.waitTillReady();
 144         follower1DistributedDataStore.waitTillReady();
 145         follower2DistributedDataStore.waitTillReady();
 146
 147         leaderEntityOwnershipService = new DistributedEntityOwnershipService(leaderDistributedDataStore, EntityOwnerSelectionStrategyConfig.newBuilder().build());
 148         leaderEntityOwnershipService.start();
 149
 150         follower1EntityOwnershipService = new DistributedEntityOwnershipService(follower1DistributedDataStore, EntityOwnerSelectionStrategyConfig.newBuilder().build());
 151         follower1EntityOwnershipService.start();
 152
 153         follower2EntityOwnershipService = new DistributedEntityOwnershipService(follower2DistributedDataStore, EntityOwnerSelectionStrategyConfig.newBuilder().build());
 154         follower2EntityOwnershipService.start();
 155
 156         leaderTestKit.waitUntilLeader(leaderDistributedDataStore.getActorContext(),
 157                 DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME);
 158     }
 159
 160     @Test
 161     public void test() throws Exception {
 162         initDatastores("test");
 163
 164         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 165         leaderEntityOwnershipService.registerListener(ENTITY_TYPE2, leaderMockListener2);
 166         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
 167
 168         // Register leader candidate for entity1 and verify it becomes owner
 169
 170         leaderEntityOwnershipService.registerCandidate(ENTITY1);
 171         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
 172         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 173         reset(leaderMockListener, follower1MockListener);
 174
 175         verifyGetOwnershipState(leaderEntityOwnershipService, ENTITY1, true, true);
 176         verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, false, true);
 177
 178         // Register leader candidate for entity1_2 (same id, different type) and verify it becomes owner
 179
 180         leaderEntityOwnershipService.registerCandidate(ENTITY1_2);
 181         verify(leaderMockListener2, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1_2, false, true, true));
 182         verify(leaderMockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1_2));
 183         reset(leaderMockListener2);
 184
 185         // Register follower1 candidate for entity1 and verify it gets added but doesn't become owner
 186
 187         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 188         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
 189         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
 190         verify(leaderMockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1));
 191         verify(follower1MockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1));
 192
 193         // Register follower1 candidate for entity2 and verify it becomes owner
 194
 195         follower1EntityOwnershipService.registerCandidate(ENTITY2);
 196         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 197         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 198         reset(leaderMockListener, follower1MockListener);
 199
 200         // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
 201
 202         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
 203         follower2EntityOwnershipService.registerCandidate(ENTITY2);
 204         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
 205         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
 206
 207         // Unregister follower1 candidate for entity2 and verify follower2 becomes owner
 208
 209         follower1EntityOwnershipService.unregisterCandidate(ENTITY2);
 210         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
 211         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
 212         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
 213         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 214
 215         // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
 216         // if the original ownership change with "member-2 is replicated to follower2 after the listener is
 217         // registered.
 218         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 219         verify(follower2MockListener, atMost(1)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 220         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 221
 222         // Register follower1 candidate for entity3 and verify it becomes owner
 223
 224         follower1EntityOwnershipService.registerCandidate(ENTITY3);
 225         verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
 226         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
 227         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
 228         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
 229
 230         // Register follower2 candidate for entity4 and verify it becomes owner
 231
 232         follower2EntityOwnershipService.registerCandidate(ENTITY4);
 233         verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
 234         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
 235         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
 236         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
 237         reset(follower1MockListener, follower2MockListener);
 238
 239         // Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
 240
 241         follower1EntityOwnershipService.registerCandidate(ENTITY4);
 242         verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
 243         verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
 244
 245         // Shutdown follower2 and verify it's owned entities (entity 2 & 4) get re-assigned
 246
 247         reset(leaderMockListener, follower1MockListener);
 248         JavaTestKit.shutdownActorSystem(follower2System);
 249
 250         verify(follower1MockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, true, true),
 251                 ownershipChange(ENTITY2, false, false, false)));
 252         verify(leaderMockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, false, true),
 253                 ownershipChange(ENTITY2, false, false, false)));
 254         verifyOwner(leaderDistributedDataStore, ENTITY2, ""); // no other candidate
 255
 256         // Register leader candidate for entity2 and verify it becomes owner
 257
 258         leaderEntityOwnershipService.registerCandidate(ENTITY2);
 259         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 260         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 261
 262         // Unregister leader candidate for entity2 and verify the owner is cleared
 263
 264         leaderEntityOwnershipService.unregisterCandidate(ENTITY2);
 265         verifyOwner(leaderDistributedDataStore, ENTITY2, "");
 266         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
 267         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
 268     }
 269
 270     /**
 271      * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>
 272      *
 273      * @throws CandidateAlreadyRegisteredException
 274      */
 275     @Test
 276     public void testCloseCandidateRegistrationInQuickSuccession() throws CandidateAlreadyRegisteredException {
 277         initDatastores("testCloseCandidateRegistrationInQuickSuccession");
 278
 279         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 280         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
 281         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
 282
 283         final EntityOwnershipCandidateRegistration candidate1 = leaderEntityOwnershipService.registerCandidate(ENTITY1);
 284         final EntityOwnershipCandidateRegistration candidate2 = follower1EntityOwnershipService.registerCandidate(ENTITY1);
 285         final EntityOwnershipCandidateRegistration candidate3 = follower2EntityOwnershipService.registerCandidate(ENTITY1);
 286
 287         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
 288
 289         Mockito.reset(leaderMockListener);
 290
 291         candidate1.close();
 292         candidate2.close();
 293         candidate3.close();
 294
 295         ArgumentCaptor<EntityOwnershipChange> leaderChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
 296         ArgumentCaptor<EntityOwnershipChange> follower1ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
 297         ArgumentCaptor<EntityOwnershipChange> follower2ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
 298         doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
 299         doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
 300         doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
 301
 302         boolean passed = false;
 303         for(int i=0;i<100;i++) {
 304             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 305             if(!leaderEntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
 306                     !follower1EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
 307                     !follower2EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
 308                     leaderChangeCaptor.getValue() != null && !leaderChangeCaptor.getValue().hasOwner() &&
 309                     follower1ChangeCaptor.getValue() != null && !follower1ChangeCaptor.getValue().hasOwner() &&
 310                     follower2ChangeCaptor.getValue() != null && !follower2ChangeCaptor.getValue().hasOwner()) {
 311                 passed = true;
 312                 break;
 313             }
 314         }
 315
 316         assertTrue("No ownership change message was sent with hasOwner=false", passed);
 317     }
 318
 319     private void verifyGetOwnershipState(DistributedEntityOwnershipService service, Entity entity,
 320             boolean isOwner, boolean hasOwner) {
 321         Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
 322         assertEquals("getOwnershipState present", true, state.isPresent());
 323         assertEquals("isOwner", isOwner, state.get().isOwner());
 324         assertEquals("hasOwner", hasOwner, state.get().hasOwner());
 325     }
 326
 327     private void verifyCandidates(DistributedDataStore dataStore, Entity entity, String... expCandidates) throws Exception {
 328         AssertionError lastError = null;
 329         Stopwatch sw = Stopwatch.createStarted();
 330         while(sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) {
 331             Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction().read(
 332                     entityPath(entity.getType(), entity.getId()).node(Candidate.QNAME)).get(5, TimeUnit.SECONDS);
 333             try {
 334                 assertEquals("Candidates not found for " + entity, true, possible.isPresent());
 335                 Collection<String> actual = new ArrayList<>();
 336                 for(MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
 337                     actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
 338                 }
 339
 340                 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
 341                 return;
 342             } catch (AssertionError e) {
 343                 lastError = e;
 344                 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 345             }
 346         }
 347
 348         throw lastError;
 349     }
 350
 351     private void verifyOwner(final DistributedDataStore dataStore, Entity entity, String expOwner) throws Exception {
 352         AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getId(),
 353                 new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
 354                     @Override
 355                     public NormalizedNode<?, ?> apply(YangInstanceIdentifier path) {
 356                         try {
 357                             return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
 358                         } catch (Exception e) {
 359                             return null;
 360                         }
 361                     }
 362                 });
 363     }
 364 }