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