2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.dom.broker;
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.any;
15 import static org.mockito.Matchers.anyCollection;
16 import static org.mockito.Matchers.anyMap;
17 import static org.mockito.Mockito.doNothing;
18 import static org.mockito.Mockito.mock;
19 import static org.mockito.Mockito.timeout;
20 import static org.mockito.Mockito.times;
21 import static org.mockito.Mockito.verify;
22 import static org.mockito.Mockito.verifyNoMoreInteractions;
24 import com.google.common.util.concurrent.ListenableFuture;
25 import java.util.ArrayList;
26 import java.util.Collection;
27 import java.util.Collections;
28 import java.util.List;
30 import java.util.concurrent.ExecutorService;
31 import java.util.concurrent.Executors;
32 import org.junit.Before;
33 import org.junit.Test;
34 import org.mockito.ArgumentCaptor;
35 import org.mockito.Captor;
36 import org.mockito.MockitoAnnotations;
37 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
38 import org.opendaylight.mdsal.dom.api.DOMDataTreeCursorAwareTransaction;
39 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
40 import org.opendaylight.mdsal.dom.api.DOMDataTreeListener;
41 import org.opendaylight.mdsal.dom.api.DOMDataTreeProducer;
42 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteCursor;
43 import org.opendaylight.mdsal.dom.broker.util.TestModel;
44 import org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataTreeShard;
45 import org.opendaylight.yangtools.concepts.ListenerRegistration;
46 import org.opendaylight.yangtools.yang.common.QName;
47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
50 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
51 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
52 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
53 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
54 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
56 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
58 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
59 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
60 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
62 public class ShardedDOMDataTreeTest {
64 private static final SchemaContext SCHEMA_CONTEXT = TestModel.createTestContext();
66 private static final DOMDataTreeIdentifier ROOT_ID =
67 new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.EMPTY);
68 private static final DOMDataTreeIdentifier TEST_ID =
69 new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, TestModel.TEST_PATH);
71 private static final DOMDataTreeIdentifier INNER_CONTAINER_ID =
72 new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, TestModel.INNER_CONTAINER_PATH);
74 private static final YangInstanceIdentifier OUTER_LIST_YID = TestModel.OUTER_LIST_PATH.node(
75 new NodeIdentifierWithPredicates(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1));
76 private static final DOMDataTreeIdentifier OUTER_LIST_ID =
77 new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, OUTER_LIST_YID);
79 private InMemoryDOMDataTreeShard rootShard;
81 private ShardedDOMDataTree dataTreeService;
82 private ListenerRegistration<InMemoryDOMDataTreeShard> rootShardReg;
84 private final ExecutorService executor = Executors.newSingleThreadExecutor();
87 private ArgumentCaptor<Collection<DataTreeCandidate>> captorForChanges;
89 private ArgumentCaptor<Map<DOMDataTreeIdentifier, NormalizedNode<?, ?>>> captorForSubtrees;
91 private final ContainerNode crossShardContainer = createCrossShardContainer();
94 public void setUp() throws Exception {
95 MockitoAnnotations.initMocks(this);
97 rootShard = InMemoryDOMDataTreeShard.create(ROOT_ID, executor, 1);
98 rootShard.onGlobalContextUpdated(SCHEMA_CONTEXT);
100 final ShardedDOMDataTree dataTree = new ShardedDOMDataTree();
101 final DOMDataTreeProducer shardRegProducer = dataTree.createProducer(Collections.singletonList(ROOT_ID));
102 rootShardReg = dataTree.registerDataTreeShard(ROOT_ID, rootShard, shardRegProducer);
103 shardRegProducer.close();
105 dataTreeService = dataTree;
108 @Test(expected = IllegalArgumentException.class)
109 public void testProducerPathContention() throws Exception {
110 dataTreeService.createProducer(Collections.singletonList(ROOT_ID));
111 dataTreeService.createProducer(Collections.singletonList(TEST_ID));
115 public void testShardRegistrationClose() throws Exception {
116 rootShardReg.close();
118 final InMemoryDOMDataTreeShard newRootShard = InMemoryDOMDataTreeShard.create(ROOT_ID, executor, 1);
119 newRootShard.onGlobalContextUpdated(SCHEMA_CONTEXT);
120 final DOMDataTreeProducer shardRegProducer = dataTreeService.createProducer(Collections.singletonList(ROOT_ID));
122 final ListenerRegistration<InMemoryDOMDataTreeShard> newRootShardReg =
123 dataTreeService.registerDataTreeShard(ROOT_ID, rootShard, shardRegProducer);
124 shardRegProducer.close();
126 final InMemoryDOMDataTreeShard innerShard = InMemoryDOMDataTreeShard.create(INNER_CONTAINER_ID, executor, 1);
127 innerShard.onGlobalContextUpdated(SCHEMA_CONTEXT);
128 final DOMDataTreeProducer shardRegProducer2 =
129 dataTreeService.createProducer(Collections.singletonList(INNER_CONTAINER_ID));
130 ListenerRegistration<InMemoryDOMDataTreeShard> innerShardReg =
131 dataTreeService.registerDataTreeShard(INNER_CONTAINER_ID, innerShard, shardRegProducer2);
133 innerShardReg.close();
134 // try to register the shard again
135 innerShardReg = dataTreeService.registerDataTreeShard(INNER_CONTAINER_ID, innerShard, shardRegProducer2);
136 final DOMDataTreeCursorAwareTransaction tx = shardRegProducer2.createTransaction(false);
137 final DOMDataTreeWriteCursor cursor = tx.createCursor(INNER_CONTAINER_ID);
138 assertNotNull(cursor);
142 shardRegProducer2.close();
144 innerShardReg.close();
145 newRootShardReg.close();
148 @Test(expected = IllegalStateException.class)
149 public void testEmptyShardMapProducer() throws Exception {
150 final ShardedDOMDataTree dataTree = new ShardedDOMDataTree();
151 final DOMDataTreeProducer producer = dataTree.createProducer(Collections.singletonList(ROOT_ID));
152 producer.createTransaction(false);
156 public void testSingleShardWrite() throws Exception {
157 final DOMDataTreeListener mockedDataTreeListener = mock(DOMDataTreeListener.class);
158 doNothing().when(mockedDataTreeListener).onDataTreeChanged(anyCollection(), anyMap());
160 dataTreeService.registerListener(mockedDataTreeListener, Collections.singletonList(INNER_CONTAINER_ID),
161 true, Collections.emptyList());
163 final DOMDataTreeProducer producer = dataTreeService.createProducer(Collections.singletonList(ROOT_ID));
164 DOMDataTreeCursorAwareTransaction tx = producer.createTransaction(false);
165 DOMDataTreeWriteCursor cursor = tx.createCursor(ROOT_ID);
166 assertNotNull(cursor);
168 cursor.write(TEST_ID.getRootIdentifier().getLastPathArgument(), crossShardContainer);
172 fail("There's still an open cursor");
173 } catch (final IllegalStateException e) {
174 assertTrue(e.getMessage().contains("cursor open"));
180 tx = producer.createTransaction(false);
181 cursor = tx.createCursor(TEST_ID);
182 assertNotNull(cursor);
184 cursor.delete(TestModel.INNER_CONTAINER_PATH.getLastPathArgument());
188 verify(mockedDataTreeListener, timeout(1000).times(3)).onDataTreeChanged(captorForChanges.capture(),
189 captorForSubtrees.capture());
190 final List<Collection<DataTreeCandidate>> capturedValue = captorForChanges.getAllValues();
191 assertTrue(capturedValue.size() == 3);
193 final ContainerNode capturedChange =
194 (ContainerNode) capturedValue.get(1).iterator().next().getRootNode().getDataAfter().get();
195 final ContainerNode innerContainerVerify = (ContainerNode) crossShardContainer.getChild(
196 TestModel.INNER_CONTAINER_PATH.getLastPathArgument()).get();
197 assertEquals(innerContainerVerify, capturedChange);
199 verifyNoMoreInteractions(mockedDataTreeListener);
203 // TODO extract common logic from testSingleSubshardWrite and
204 // testSingleShardWrite tests
205 public void testSingleSubshardWrite() throws Exception {
206 final DOMDataTreeListener mockedDataTreeListener = mock(DOMDataTreeListener.class);
207 doNothing().when(mockedDataTreeListener).onDataTreeChanged(anyCollection(), anyMap());
209 InMemoryDOMDataTreeShard testShard = InMemoryDOMDataTreeShard.create(TEST_ID, executor, 1);
210 testShard.onGlobalContextUpdated(SCHEMA_CONTEXT);
212 final DOMDataTreeProducer regProducer = dataTreeService.createProducer(Collections.singleton(TEST_ID));
213 dataTreeService.registerDataTreeShard(TEST_ID, testShard, regProducer);
216 dataTreeService.registerListener(mockedDataTreeListener, Collections.singletonList(TEST_ID),
217 true, Collections.emptyList());
219 final DOMDataTreeProducer producer = dataTreeService.createProducer(Collections.singletonList(ROOT_ID));
220 DOMDataTreeCursorAwareTransaction tx = producer.createTransaction(false);
221 DOMDataTreeWriteCursor cursor = tx.createCursor(ROOT_ID);
222 assertNotNull(cursor);
224 cursor.write(TEST_ID.getRootIdentifier().getLastPathArgument(), crossShardContainer);
229 tx = producer.createTransaction(false);
230 cursor = tx.createCursor(TEST_ID);
231 assertNotNull(cursor);
233 cursor.delete(TestModel.INNER_CONTAINER_PATH.getLastPathArgument());
237 verify(mockedDataTreeListener, timeout(5000).times(3)).onDataTreeChanged(captorForChanges.capture(),
238 captorForSubtrees.capture());
240 final List<Collection<DataTreeCandidate>> capturedValue = captorForChanges.getAllValues();
241 final ContainerNode capturedChange =
242 (ContainerNode) capturedValue.get(1).iterator().next().getRootNode().getDataAfter().get();
243 final ContainerNode innerContainerVerify = crossShardContainer;
244 assertEquals(innerContainerVerify, capturedChange);
248 public void testMultipleWritesIntoSingleMapEntry() throws Exception {
250 final YangInstanceIdentifier oid1 = TestModel.OUTER_LIST_PATH.node(new NodeIdentifierWithPredicates(
251 TestModel.OUTER_LIST_QNAME, QName.create(TestModel.OUTER_LIST_QNAME, "id"), 0));
252 final DOMDataTreeIdentifier outerListPath = new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, oid1);
254 final DOMDataTreeProducer shardProducer = dataTreeService.createProducer(
255 Collections.singletonList(outerListPath));
256 final InMemoryDOMDataTreeShard outerListShard = InMemoryDOMDataTreeShard.create(outerListPath, executor, 1000);
257 outerListShard.onGlobalContextUpdated(SCHEMA_CONTEXT);
259 final ListenerRegistration<InMemoryDOMDataTreeShard> oid1ShardRegistration =
260 dataTreeService.registerDataTreeShard(outerListPath, outerListShard, shardProducer);
262 final DOMDataTreeCursorAwareTransaction tx = shardProducer.createTransaction(false);
263 final DOMDataTreeWriteCursor cursor =
264 tx.createCursor(new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, oid1));
265 assertNotNull(cursor);
267 MapNode innerList = ImmutableMapNodeBuilder
269 .withNodeIdentifier(new NodeIdentifier(TestModel.INNER_LIST_QNAME))
272 cursor.write(new NodeIdentifier(TestModel.INNER_LIST_QNAME), innerList);
276 final ArrayList<ListenableFuture<?>> futures = new ArrayList<>();
277 for (int i = 0; i < 1000; i++) {
278 final Collection<MapEntryNode> innerListMapEntries = createInnerListMapEntries(1000, "run-" + i);
279 for (final MapEntryNode innerListMapEntry : innerListMapEntries) {
280 final DOMDataTreeCursorAwareTransaction tx1 = shardProducer.createTransaction(false);
281 final DOMDataTreeWriteCursor cursor1 = tx1.createCursor(
282 new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION,
283 oid1.node(new NodeIdentifier(TestModel.INNER_LIST_QNAME))));
284 cursor1.write(innerListMapEntry.getIdentifier(), innerListMapEntry);
286 futures.add(tx1.commit());
290 futures.get(futures.size() - 1).get();
294 private static Collection<MapEntryNode> createInnerListMapEntries(final int amount, final String valuePrefix) {
295 final Collection<MapEntryNode> ret = new ArrayList<>();
296 for (int i = 0; i < amount; i++) {
297 ret.add(ImmutableNodes.mapEntryBuilder()
298 .withNodeIdentifier(new NodeIdentifierWithPredicates(TestModel.INNER_LIST_QNAME,
299 QName.create(TestModel.OUTER_LIST_QNAME, "name"), Integer.toString(i)))
300 .withChild(ImmutableNodes
301 .leafNode(QName.create(TestModel.INNER_LIST_QNAME, "name"), Integer.toString(i)))
302 .withChild(ImmutableNodes
303 .leafNode(QName.create(TestModel.INNER_LIST_QNAME, "value"), valuePrefix + "-" + i))
311 public void testMultipleProducerCursorCreation() throws Exception {
313 final DOMDataTreeProducer rootProducer = dataTreeService.createProducer(Collections.singletonList(ROOT_ID));
314 DOMDataTreeCursorAwareTransaction rootTx = rootProducer.createTransaction(false);
315 //check if we can create cursor where the new producer will be
316 DOMDataTreeWriteCursor rootTxCursor = rootTx.createCursor(INNER_CONTAINER_ID);
317 assertNotNull(rootTxCursor);
318 rootTxCursor.close();
321 rootProducer.createProducer(Collections.singletonList(INNER_CONTAINER_ID));
322 fail("Should've failed there is still a tx open");
323 } catch (final IllegalStateException e) {
324 assertTrue(e.getMessage().contains("open"));
327 assertTrue(rootTx.cancel());
329 final DOMDataTreeProducer innerContainerProducer = rootProducer.createProducer(
330 Collections.singletonList(INNER_CONTAINER_ID));
332 rootTx = rootProducer.createTransaction(false);
334 rootTx.createCursor(INNER_CONTAINER_ID);
335 fail("Subtree should not be available to this producer");
336 } catch (final IllegalArgumentException e) {
337 assertTrue(e.getMessage().contains("delegated to child producer"));
340 rootTxCursor = rootTx.createCursor(TEST_ID);
341 assertNotNull(rootTxCursor);
343 rootTxCursor.enter(INNER_CONTAINER_ID.getRootIdentifier().getLastPathArgument());
344 fail("Cursor should not have this subtree available");
345 } catch (final IllegalArgumentException e) {
346 assertTrue(e.getMessage().contains("not available to this cursor"));
350 rootTxCursor.write(TestModel.INNER_CONTAINER_PATH.getLastPathArgument(),
351 ImmutableContainerNodeBuilder.create()
352 .withNodeIdentifier(new NodeIdentifier(TestModel.INNER_CONTAINER))
354 fail("Cursor should not have this subtree available");
355 } catch (final IllegalArgumentException e) {
356 assertTrue(e.getMessage().contains("not available to this cursor"));
359 final DOMDataTreeCursorAwareTransaction innerShardTx = innerContainerProducer.createTransaction(false);
360 final DOMDataTreeWriteCursor innerShardCursor = innerShardTx.createCursor(INNER_CONTAINER_ID);
361 assertNotNull(innerShardCursor);
364 private static ContainerNode createCrossShardContainer() {
365 final LeafNode<String> shardedValue1 =
366 ImmutableLeafNodeBuilder.<String>create().withNodeIdentifier(new NodeIdentifier(
367 TestModel.SHARDED_VALUE_1)).withValue("sharded value 1").build();
368 final LeafNode<String> shardedValue2 =
369 ImmutableLeafNodeBuilder.<String>create().withNodeIdentifier(new NodeIdentifier(
370 TestModel.SHARDED_VALUE_2)).withValue("sharded value 2").build();
373 final ContainerNode lowerShardContainer = ImmutableContainerNodeBuilder.create()
374 .withNodeIdentifier(new NodeIdentifier(TestModel.ANOTHER_SHARD_CONTAINER))
375 .withChild(ImmutableLeafNodeBuilder.create()
376 .withNodeIdentifier(new NodeIdentifier(TestModel.ANOTHER_SHARD_VALUE))
377 .withValue("testing-value")
381 final ContainerNode containerNode =
382 ImmutableContainerNodeBuilder.create()
383 .withNodeIdentifier(new NodeIdentifier(TestModel.INNER_CONTAINER))
384 .withChild(shardedValue1)
385 .withChild(shardedValue2)
386 .withChild(lowerShardContainer)
389 final ContainerNode testContainer = ImmutableContainerNodeBuilder.create()
390 .withNodeIdentifier(new NodeIdentifier(TestModel.TEST_QNAME))
391 .withChild(containerNode)
394 return testContainer;
397 //test multiple vertical levels between the shards
399 public void testLargerSubshardSpace() throws Exception {
401 final InMemoryDOMDataTreeShard outerListShard = InMemoryDOMDataTreeShard.create(OUTER_LIST_ID, executor, 1, 1);
402 outerListShard.onGlobalContextUpdated(SCHEMA_CONTEXT);
404 try (DOMDataTreeProducer producer =
405 dataTreeService.createProducer(Collections.singletonList(OUTER_LIST_ID))) {
406 dataTreeService.registerDataTreeShard(OUTER_LIST_ID, outerListShard, producer);
409 final DOMDataTreeProducer producer = dataTreeService.createProducer(Collections.singletonList(ROOT_ID));
410 final DOMDataTreeCursorAwareTransaction tx = producer.createTransaction(false);
411 final DOMDataTreeWriteCursor cursor = tx.createCursor(ROOT_ID);
413 assertNotNull(cursor);
414 cursor.write(TestModel.TEST_PATH.getLastPathArgument(), createCrossShardContainer2());
419 final DOMDataTreeListener listener = mock(DOMDataTreeListener.class);
420 doNothing().when(listener).onDataTreeChanged(any(), any());
421 dataTreeService.registerListener(listener,
422 Collections.singletonList(
423 new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.EMPTY)),
424 false, Collections.emptyList());
426 verify(listener, times(2)).onDataTreeChanged(any(), any());
431 private static ContainerNode createCrossShardContainer2() {
434 innerListEntry1 = ImmutableNodes
435 .mapEntryBuilder(TestModel.INNER_LIST_QNAME, TestModel.NAME_QNAME, "name-1")
436 .withChild(ImmutableNodes.leafNode(TestModel.NAME_QNAME, "name-1"))
437 .withChild(ImmutableNodes.leafNode(TestModel.VALUE_QNAME, "value-1"))
439 final MapEntryNode innerListEntry2 = ImmutableNodes
440 .mapEntryBuilder(TestModel.INNER_LIST_QNAME, TestModel.NAME_QNAME, "name-2")
441 .withChild(ImmutableNodes.leafNode(TestModel.NAME_QNAME, "name-2"))
442 .withChild(ImmutableNodes.leafNode(TestModel.VALUE_QNAME, "value-2"))
445 final MapNode innerList1 = ImmutableNodes
446 .mapNodeBuilder(TestModel.INNER_LIST_QNAME).withChild(innerListEntry1).build();
447 final MapNode innerList2 = ImmutableNodes
448 .mapNodeBuilder(TestModel.INNER_LIST_QNAME).withChild(innerListEntry2).build();
450 final MapEntryNode outerListEntry1 = ImmutableNodes
451 .mapEntryBuilder(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)
452 .withChild(innerList1)
454 final MapEntryNode outerListEntry2 = ImmutableNodes
455 .mapEntryBuilder(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 2)
456 .withChild(innerList2)
459 final MapNode outerList = ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME)
460 .withChild(outerListEntry1)
461 .withChild(outerListEntry2)
464 final ContainerNode testContainer = ImmutableContainerNodeBuilder.create()
465 .withNodeIdentifier(new NodeIdentifier(TestModel.TEST_QNAME))
466 .withChild(outerList)
469 return testContainer;