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