Refactor DataStore readiness tracking
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / DistributedDataStoreTest.java
index 4ec035ee3b52308e6390d9a2e4dece6703438318..56bbbf5807d8b788e1411cb66f0e1f8ae4553414 100644 (file)
+/*
+ * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
 package org.opendaylight.controller.cluster.datastore;
 
+import static org.junit.Assert.assertTrue;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
+
+import akka.util.Timeout;
+import com.google.common.util.concurrent.Uninterruptibles;
+import java.util.concurrent.Executors;
+import java.util.concurrent.TimeUnit;
+import org.junit.AfterClass;
 import org.junit.Before;
+import org.junit.BeforeClass;
 import org.junit.Test;
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
-import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
+import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
+import org.opendaylight.controller.cluster.access.concepts.FrontendIdentifier;
+import org.opendaylight.controller.cluster.access.concepts.FrontendType;
+import org.opendaylight.controller.cluster.access.concepts.MemberName;
+import org.opendaylight.controller.cluster.datastore.utils.ActorUtils;
 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import scala.concurrent.duration.FiniteDuration;
 
 public class DistributedDataStoreTest extends AbstractActorTest {
+    private static final ClientIdentifier UNKNOWN_ID = ClientIdentifier.create(
+            FrontendIdentifier.create(MemberName.forName("local"), FrontendType.forName("unknown")), 0);
+
+    private static SchemaContext SCHEMA_CONTEXT;
 
-    private SchemaContext schemaContext;
+    @Mock
+    private ActorUtils actorUtils;
+
+    @Mock
+    private DatastoreContext datastoreContext;
 
     @Mock
-    private ActorContext actorContext;
+    private Timeout shardElectionTimeout;
+
+    @BeforeClass
+    public static void beforeClass() {
+        SCHEMA_CONTEXT = TestModel.createTestContext();
+    }
+
+    @AfterClass
+    public static void afterClass() {
+        SCHEMA_CONTEXT = null;
+    }
 
     @Before
-    public void setUp() throws Exception {
+    public void setUp() {
         MockitoAnnotations.initMocks(this);
 
-        schemaContext = TestModel.createTestContext();
-
-        doReturn(schemaContext).when(actorContext).getSchemaContext();
-        doReturn(DatastoreContext.newBuilder().build()).when(actorContext).getDatastoreContext();
+        doReturn(SCHEMA_CONTEXT).when(actorUtils).getSchemaContext();
+        doReturn(DatastoreContext.newBuilder().build()).when(actorUtils).getDatastoreContext();
     }
 
     @Test
-    public void testRateLimitingUsedInReadWriteTxCreation(){
-        DistributedDataStore distributedDataStore = new DistributedDataStore(actorContext);
+    public void testRateLimitingUsedInReadWriteTxCreation() {
+        try (DistributedDataStore distributedDataStore = new DistributedDataStore(actorUtils, UNKNOWN_ID)) {
 
-        distributedDataStore.newReadWriteTransaction();
+            distributedDataStore.newReadWriteTransaction();
 
-        verify(actorContext, times(1)).acquireTxCreationPermit();
+            verify(actorUtils, times(1)).acquireTxCreationPermit();
+        }
     }
 
     @Test
-    public void testRateLimitingUsedInWriteOnlyTxCreation(){
-        DistributedDataStore distributedDataStore = new DistributedDataStore(actorContext);
+    public void testRateLimitingUsedInWriteOnlyTxCreation() {
+        try (DistributedDataStore distributedDataStore = new DistributedDataStore(actorUtils, UNKNOWN_ID)) {
 
-        distributedDataStore.newWriteOnlyTransaction();
+            distributedDataStore.newWriteOnlyTransaction();
 
-        verify(actorContext, times(1)).acquireTxCreationPermit();
+            verify(actorUtils, times(1)).acquireTxCreationPermit();
+        }
     }
 
+    @Test
+    public void testRateLimitingNotUsedInReadOnlyTxCreation() {
+        try (DistributedDataStore distributedDataStore = new DistributedDataStore(actorUtils, UNKNOWN_ID)) {
+
+            distributedDataStore.newReadOnlyTransaction();
+            distributedDataStore.newReadOnlyTransaction();
+            distributedDataStore.newReadOnlyTransaction();
+
+            verify(actorUtils, times(0)).acquireTxCreationPermit();
+        }
+    }
 
     @Test
-    public void testRateLimitingNotUsedInReadOnlyTxCreation(){
-        DistributedDataStore distributedDataStore = new DistributedDataStore(actorContext);
+    public void testWaitTillReadyBlocking() {
+        doReturn(datastoreContext).when(actorUtils).getDatastoreContext();
+        doReturn(shardElectionTimeout).when(datastoreContext).getShardLeaderElectionTimeout();
+        doReturn(1).when(datastoreContext).getInitialSettleTimeoutMultiplier();
+        doReturn(FiniteDuration.apply(50, TimeUnit.MILLISECONDS)).when(shardElectionTimeout).duration();
+        try (DistributedDataStore distributedDataStore = new DistributedDataStore(actorUtils, UNKNOWN_ID)) {
 
-        distributedDataStore.newReadOnlyTransaction();
-        distributedDataStore.newReadOnlyTransaction();
-        distributedDataStore.newReadOnlyTransaction();
+            long start = System.currentTimeMillis();
 
-        verify(actorContext, times(0)).acquireTxCreationPermit();
+            distributedDataStore.waitTillReady();
+
+            long end = System.currentTimeMillis();
+
+            assertTrue("Expected to be blocked for 50 millis", end - start >= 50);
+        }
     }
 
-}
\ No newline at end of file
+    @Test
+    public void testWaitTillReadyCountDown() {
+        try (DistributedDataStore distributedDataStore = new DistributedDataStore(actorUtils, UNKNOWN_ID)) {
+            doReturn(datastoreContext).when(actorUtils).getDatastoreContext();
+            doReturn(shardElectionTimeout).when(datastoreContext).getShardLeaderElectionTimeout();
+            doReturn(FiniteDuration.apply(5000, TimeUnit.MILLISECONDS)).when(shardElectionTimeout).duration();
+
+            Executors.newSingleThreadExecutor().submit(() -> {
+                Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
+                distributedDataStore.readinessFuture().set(null);
+            });
+
+            long start = System.currentTimeMillis();
+
+            distributedDataStore.waitTillReady();
+
+            long end = System.currentTimeMillis();
+
+            assertTrue("Expected to be released in 500 millis", end - start < 5000);
+        }
+    }
+}