dom/mdsal-dom-broker/src/test/java/org/opendaylight/mdsal/dom/broker/ShardedDOMDataTreeTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco 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.mdsal.dom.broker;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertTrue;
  13 import static org.junit.Assert.fail;
  14 import static org.mockito.Matchers.anyCollection;
  15 import static org.mockito.Matchers.anyMap;
  16 import static org.mockito.Mockito.doNothing;
  17 import static org.mockito.Mockito.timeout;
  18 import static org.mockito.Mockito.verify;
  19 import static org.mockito.Mockito.verifyNoMoreInteractions;
  20
  21 import java.util.Collection;
  22 import java.util.Collections;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.concurrent.ExecutorService;
  26 import java.util.concurrent.Executors;
  27 import org.junit.Before;
  28 import org.junit.Test;
  29 import org.mockito.ArgumentCaptor;
  30 import org.mockito.Captor;
  31 import org.mockito.Mockito;
  32 import org.mockito.MockitoAnnotations;
  33 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  34 import org.opendaylight.mdsal.dom.api.DOMDataTreeCursorAwareTransaction;
  35 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  36 import org.opendaylight.mdsal.dom.api.DOMDataTreeListener;
  37 import org.opendaylight.mdsal.dom.api.DOMDataTreeProducer;
  38 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteCursor;
  39 import org.opendaylight.mdsal.dom.broker.util.TestModel;
  40 import org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataTreeShard;
  41 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  45 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
  50 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  51 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 public class ShardedDOMDataTreeTest {
  56
  57     private static final Logger LOG = LoggerFactory.getLogger(ShardedDOMDataTreeProducerMultiShardTest.class);
  58
  59     private static SchemaContext schemaContext = null;
  60
  61     static {
  62         try {
  63             schemaContext = TestModel.createTestContext();
  64         } catch (final ReactorException e) {
  65             LOG.error("Unable to create schema context for TestModel", e);
  66         }
  67     }
  68
  69     private static final DOMDataTreeIdentifier ROOT_ID =
  70             new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY);
  71     private static final DOMDataTreeIdentifier TEST_ID =
  72             new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, TestModel.TEST_PATH);
  73
  74     private static final DOMDataTreeIdentifier INNER_CONTAINER_ID =
  75             new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, TestModel.INNER_CONTAINER_PATH);
  76
  77     private InMemoryDOMDataTreeShard rootShard;
  78
  79     private ShardedDOMDataTree dataTreeService;
  80     private ListenerRegistration<InMemoryDOMDataTreeShard> rootShardReg;
  81
  82     private final ExecutorService executor = Executors.newSingleThreadExecutor();
  83
  84     @Captor
  85     private ArgumentCaptor<Collection<DataTreeCandidate>> captorForChanges;
  86     @Captor
  87     private ArgumentCaptor<Map<DOMDataTreeIdentifier, NormalizedNode<?, ?>>> captorForSubtrees;
  88
  89     private final ContainerNode crossShardContainer = createCrossShardContainer();
  90
  91     @Before
  92     public void setUp() throws Exception {
  93         MockitoAnnotations.initMocks(this);
  94
  95         rootShard = InMemoryDOMDataTreeShard.create(ROOT_ID, executor, 1);
  96         rootShard.onGlobalContextUpdated(schemaContext);
  97
  98         final ShardedDOMDataTree dataTree = new ShardedDOMDataTree();
  99         final DOMDataTreeProducer shardRegProducer = dataTree.createProducer(Collections.singletonList(ROOT_ID));
 100         rootShardReg = dataTree.registerDataTreeShard(ROOT_ID, rootShard, shardRegProducer);
 101         shardRegProducer.close();
 102
 103         dataTreeService = dataTree;
 104     }
 105
 106     @Test(expected = IllegalArgumentException.class)
 107     public void testProducerPathContention() throws Exception {
 108         dataTreeService.createProducer(Collections.singletonList(ROOT_ID));
 109         dataTreeService.createProducer(Collections.singletonList(TEST_ID));
 110     }
 111
 112     @Test
 113     public void testShardRegistrationClose() throws Exception {
 114         rootShardReg.close();
 115
 116         final InMemoryDOMDataTreeShard newRootShard = InMemoryDOMDataTreeShard.create(ROOT_ID, executor, 1);
 117         newRootShard.onGlobalContextUpdated(schemaContext);
 118         final DOMDataTreeProducer shardRegProducer = dataTreeService.createProducer(Collections.singletonList(ROOT_ID));
 119
 120         final ListenerRegistration<InMemoryDOMDataTreeShard> newRootShardReg =
 121                 dataTreeService.registerDataTreeShard(ROOT_ID, rootShard, shardRegProducer);
 122         shardRegProducer.close();
 123
 124         final InMemoryDOMDataTreeShard innerShard = InMemoryDOMDataTreeShard.create(INNER_CONTAINER_ID, executor, 1);
 125         innerShard.onGlobalContextUpdated(schemaContext);
 126         final DOMDataTreeProducer shardRegProducer2 = dataTreeService.createProducer(Collections.singletonList(INNER_CONTAINER_ID));
 127         ListenerRegistration<InMemoryDOMDataTreeShard> innerShardReg = dataTreeService.registerDataTreeShard(INNER_CONTAINER_ID, innerShard, shardRegProducer2);
 128
 129         innerShardReg.close();
 130         // try to register the shard again
 131         innerShardReg = dataTreeService.registerDataTreeShard(INNER_CONTAINER_ID, innerShard, shardRegProducer2);
 132         final DOMDataTreeCursorAwareTransaction tx = shardRegProducer2.createTransaction(false);
 133         final DOMDataTreeWriteCursor cursor = tx.createCursor(INNER_CONTAINER_ID);
 134         assertNotNull(cursor);
 135
 136         cursor.close();
 137         tx.cancel();
 138         shardRegProducer2.close();
 139
 140         innerShardReg.close();
 141         newRootShardReg.close();
 142     }
 143
 144     @Test
 145     public void testSingleShardWrite() throws Exception {
 146         final DOMDataTreeListener mockedDataTreeListener = Mockito.mock(DOMDataTreeListener.class);
 147         doNothing().when(mockedDataTreeListener).onDataTreeChanged(anyCollection(), anyMap());
 148
 149         dataTreeService.registerListener(mockedDataTreeListener, Collections.singletonList(INNER_CONTAINER_ID), true, Collections.emptyList());
 150
 151         final DOMDataTreeProducer producer = dataTreeService.createProducer(Collections.singletonList(ROOT_ID));
 152         DOMDataTreeCursorAwareTransaction tx = producer.createTransaction(false);
 153         DOMDataTreeWriteCursor cursor = tx.createCursor(ROOT_ID);
 154         assertNotNull(cursor);
 155
 156         cursor.write(TEST_ID.getRootIdentifier().getLastPathArgument(), crossShardContainer);
 157
 158         try {
 159             tx.submit().checkedGet();
 160             fail("There's still an open cursor");
 161         } catch (final IllegalStateException e) {
 162             assertTrue(e.getMessage().contains("cursor open"));
 163         }
 164
 165         cursor.close();
 166         tx.submit().checkedGet();
 167
 168         tx = producer.createTransaction(false);
 169         cursor = tx.createCursor(TEST_ID);
 170         assertNotNull(cursor);
 171
 172         cursor.delete(TestModel.INNER_CONTAINER_PATH.getLastPathArgument());
 173         cursor.close();
 174         tx.submit().checkedGet();
 175
 176         verify(mockedDataTreeListener, timeout(1000).times(3)).onDataTreeChanged(captorForChanges.capture(), captorForSubtrees.capture());
 177         final List<Collection<DataTreeCandidate>> capturedValue = captorForChanges.getAllValues();
 178         assertTrue(capturedValue.size() == 3);
 179
 180         final ContainerNode capturedChange = (ContainerNode) capturedValue.get(1).iterator().next().getRootNode().getDataAfter().get();
 181         final ContainerNode innerContainerVerify = (ContainerNode) crossShardContainer.getChild(TestModel.INNER_CONTAINER_PATH.getLastPathArgument()).get();
 182         assertEquals(innerContainerVerify, capturedChange);
 183
 184         verifyNoMoreInteractions(mockedDataTreeListener);
 185     }
 186
 187     @Test
 188     public void testMultipleProducerCursorCreation() throws Exception {
 189
 190         final DOMDataTreeProducer rootProducer = dataTreeService.createProducer(Collections.singletonList(ROOT_ID));
 191         DOMDataTreeCursorAwareTransaction rootTx = rootProducer.createTransaction(false);
 192         //check if we can create cursor where the new producer will be
 193         DOMDataTreeWriteCursor rootTxCursor = rootTx.createCursor(INNER_CONTAINER_ID);
 194         assertNotNull(rootTxCursor);
 195         rootTxCursor.close();
 196
 197         try {
 198             rootProducer.createProducer(Collections.singletonList(INNER_CONTAINER_ID));
 199             fail("Should've failed there is still a tx open");
 200         } catch (final IllegalStateException e) {
 201             assertTrue(e.getMessage().contains("open"));
 202         }
 203
 204         assertTrue(rootTx.cancel());
 205
 206         final DOMDataTreeProducer innerContainerProducer = rootProducer.createProducer(Collections.singletonList(INNER_CONTAINER_ID));
 207
 208         rootTx = rootProducer.createTransaction(false);
 209         try {
 210             rootTx.createCursor(INNER_CONTAINER_ID);
 211             fail("Subtree should not be available to this producer");
 212         } catch (final IllegalArgumentException e) {
 213             assertTrue(e.getMessage().contains("delegated to child producer"));
 214         }
 215
 216         rootTxCursor = rootTx.createCursor(TEST_ID);
 217         assertNotNull(rootTxCursor);
 218         try {
 219             rootTxCursor.enter(INNER_CONTAINER_ID.getRootIdentifier().getLastPathArgument());
 220             fail("Cursor should not have this subtree available");
 221         } catch (final IllegalArgumentException e) {
 222             assertTrue(e.getMessage().contains("not available to this cursor"));
 223         }
 224
 225         try {
 226             rootTxCursor.write(TestModel.INNER_CONTAINER_PATH.getLastPathArgument(),
 227                     ImmutableContainerNodeBuilder.create()
 228                             .withNodeIdentifier(new NodeIdentifier(TestModel.INNER_CONTAINER))
 229                             .build());
 230             fail("Cursor should not have this subtree available");
 231         } catch (final IllegalArgumentException e) {
 232             assertTrue(e.getMessage().contains("not available to this cursor"));
 233         }
 234
 235         final DOMDataTreeCursorAwareTransaction innerShardTx = innerContainerProducer.createTransaction(false);
 236         final DOMDataTreeWriteCursor innerShardCursor = innerShardTx.createCursor(INNER_CONTAINER_ID);
 237         assertNotNull(innerShardCursor);
 238     }
 239
 240     private ContainerNode createCrossShardContainer() {
 241         final LeafNode<String> shardedValue1 =
 242                 ImmutableLeafNodeBuilder.<String>create().withNodeIdentifier(new NodeIdentifier(TestModel.SHARDED_VALUE_1)).withValue("sharded value 1").build();
 243         final LeafNode<String> shardedValue2 =
 244                 ImmutableLeafNodeBuilder.<String>create().withNodeIdentifier(new NodeIdentifier(TestModel.SHARDED_VALUE_2)).withValue("sharded value 2").build();
 245
 246
 247         final ContainerNode lowerShardContainer = ImmutableContainerNodeBuilder.create()
 248                 .withNodeIdentifier(new NodeIdentifier(TestModel.ANOTHER_SHARD_CONTAINER))
 249                 .withChild(ImmutableLeafNodeBuilder.create()
 250                         .withNodeIdentifier(new NodeIdentifier(TestModel.ANOTHER_SHARD_VALUE))
 251                         .withValue("testing-value")
 252                         .build())
 253                 .build();
 254
 255         final ContainerNode containerNode =
 256                 ImmutableContainerNodeBuilder.create()
 257                         .withNodeIdentifier(new NodeIdentifier(TestModel.INNER_CONTAINER))
 258                         .withChild(shardedValue1)
 259                         .withChild(shardedValue2)
 260                         .withChild(lowerShardContainer)
 261                         .build();
 262
 263         final ContainerNode testContainer = ImmutableContainerNodeBuilder.create()
 264                 .withNodeIdentifier(new NodeIdentifier(TestModel.TEST_QNAME))
 265                 .withChild(containerNode)
 266                 .build();
 267
 268         return testContainer;
 269     }
 270 }