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