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

   1 /*
   2  * Copyright (c) 2015 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.test;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertFalse;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.mockito.Matchers.any;
  14 import static org.mockito.Matchers.eq;
  15 import static org.mockito.Mockito.doNothing;
  16 import static org.mockito.Mockito.doReturn;
  17 import static org.mockito.Mockito.times;
  18 import static org.mockito.Mockito.verify;
  19
  20 import java.util.Collection;
  21 import java.util.Collections;
  22 import java.util.Map;
  23 import org.junit.Before;
  24 import org.junit.Test;
  25 import org.mockito.ArgumentCaptor;
  26 import org.mockito.Mock;
  27 import org.mockito.Mockito;
  28 import org.mockito.MockitoAnnotations;
  29 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  30 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
  31 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  32 import org.opendaylight.mdsal.dom.api.DOMDataTreeListener;
  33 import org.opendaylight.mdsal.dom.api.DOMDataTreeLoopException;
  34 import org.opendaylight.mdsal.dom.api.DOMDataTreeProducer;
  35 import org.opendaylight.mdsal.dom.api.DOMDataTreeService;
  36 import org.opendaylight.mdsal.dom.api.DOMDataTreeShard;
  37 import org.opendaylight.mdsal.dom.api.DOMDataTreeShardingConflictException;
  38 import org.opendaylight.mdsal.dom.broker.ShardedDOMDataTree;
  39 import org.opendaylight.mdsal.dom.broker.test.util.TestModel;
  40 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher;
  41 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  45 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  46 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidates;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  48
  49 public class ShardedDOMDataTreeListenerTest {
  50
  51
  52     private static final DOMDataTreeIdentifier ROOT_ID = new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL,
  53             YangInstanceIdentifier.EMPTY);
  54     private static final DOMDataTreeIdentifier TEST_ID = new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL,
  55             TestModel.TEST_PATH);
  56
  57     private static final Collection<DOMDataTreeIdentifier> SUBTREES_ROOT = Collections.singleton(ROOT_ID);
  58     private static final Collection<DOMDataTreeIdentifier> SUBTREES_TEST = Collections.singleton(TEST_ID);
  59     private static final ContainerNode TEST_CONTAINER = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
  60
  61     private interface ListenableShard extends DOMDataTreeShard, DOMStoreTreeChangePublisher {
  62
  63
  64     }
  65
  66     @Mock(name = "rootShard")
  67     private ListenableShard rootShard;
  68
  69     @Mock(name = "childShard")
  70     private ListenableShard childShard;
  71
  72     @Mock(name = "listener")
  73     private DOMDataTreeListener listener;
  74
  75     @Mock
  76     private ListenerRegistration<?> storeListenerReg;
  77
  78     private DOMDataTreeService treeService;
  79     private ListenerRegistration<ListenableShard> shardReg;
  80
  81     @Before
  82     public void setUp() throws DOMDataTreeShardingConflictException {
  83         MockitoAnnotations.initMocks(this);
  84         final ShardedDOMDataTree impl = new ShardedDOMDataTree();
  85         treeService = impl;
  86         shardReg = impl.registerDataTreeShard(ROOT_ID, rootShard);
  87         doReturn("rootShard").when(rootShard).toString();
  88         doReturn("childShard").when(childShard).toString();
  89
  90         doReturn(storeListenerReg).when(rootShard).registerTreeChangeListener(any(YangInstanceIdentifier.class),
  91                 any(DOMDataTreeChangeListener.class));
  92         doNothing().when(storeListenerReg).close();
  93     }
  94
  95     @Test(expected = IllegalArgumentException.class)
  96     public void registerListenerWithEmptySubtrees() throws DOMDataTreeLoopException {
  97         treeService.registerListener(listener, Collections.<DOMDataTreeIdentifier>emptyList(), true,
  98                 Collections.<DOMDataTreeProducer>emptyList());
  99     }
 100
 101     @Test
 102     public void registerRootListener() throws DOMDataTreeLoopException {
 103         treeService.registerListener(listener, SUBTREES_ROOT, true, Collections.<DOMDataTreeProducer>emptyList());
 104         verify(rootShard, times(1)).registerTreeChangeListener(eq(ROOT_ID.getRootIdentifier()),
 105                 any(DOMDataTreeChangeListener.class));
 106     }
 107
 108     @Test
 109     public void registerTreeListener() throws DOMDataTreeLoopException {
 110         treeService.registerListener(listener, SUBTREES_TEST, true, Collections.<DOMDataTreeProducer>emptyList());
 111         verify(rootShard, times(1)).registerTreeChangeListener(eq(TEST_ID.getRootIdentifier()),
 112                 any(DOMDataTreeChangeListener.class));
 113     }
 114
 115     @Test
 116     public void registerAndCloseListener() throws DOMDataTreeLoopException {
 117         ListenerRegistration<DOMDataTreeListener> reg =
 118                 treeService.registerListener(listener, SUBTREES_TEST, true,
 119                         Collections.<DOMDataTreeProducer>emptyList());
 120         reg.close();
 121         verify(storeListenerReg, times(1)).close();
 122     }
 123
 124     @Test
 125     public void receiveChangeEvent() throws DOMDataTreeLoopException {
 126         ArgumentCaptor<DOMDataTreeChangeListener> storeListener =
 127                 ArgumentCaptor.forClass(DOMDataTreeChangeListener.class);
 128
 129         treeService.registerListener(listener, SUBTREES_TEST, true, Collections.<DOMDataTreeProducer>emptyList());
 130         verify(rootShard, times(1)).registerTreeChangeListener(eq(TEST_ID.getRootIdentifier()),
 131                 storeListener.capture());
 132
 133         DataTreeCandidate sentStoreCandidate =
 134                 DataTreeCandidates.fromNormalizedNode(TEST_ID.getRootIdentifier(), TEST_CONTAINER);
 135         Collection<DataTreeCandidate> changes = Collections.singleton(sentStoreCandidate);
 136
 137         doNothing().when(listener).onDataTreeChanged(Mockito.<Collection<DataTreeCandidate>>any(), Mockito.anyMap());
 138         storeListener.getValue().onDataTreeChanged(changes);
 139
 140         ArgumentCaptor<Collection<DataTreeCandidate>> candidateCapture = captorFor(Collection.class);
 141         ArgumentCaptor<Map<DOMDataTreeIdentifier, NormalizedNode<?, ?>>> mapCapture = captorFor(Map.class);
 142         verify(listener, times(1)).onDataTreeChanged(candidateCapture.capture(), mapCapture.capture());
 143
 144         Collection<DataTreeCandidate> receivedCandidate = candidateCapture.getValue();
 145         Map<DOMDataTreeIdentifier, NormalizedNode<?, ?>> receivedMap = mapCapture.getValue();
 146
 147         assertNotNull("receivedCandidate", receivedCandidate);
 148         assertNotNull("receivedMap", receivedMap);
 149         assertFalse("candidate collection must not be empty", receivedCandidate.isEmpty());
 150         assertEquals(1, receivedCandidate.size());
 151         DataTreeCandidate firstItem = receivedCandidate.iterator().next();
 152         assertEquals(TEST_ID.getRootIdentifier(), firstItem.getRootPath());
 153         assertEquals(TEST_CONTAINER, receivedMap.get(TEST_ID));
 154     }
 155
 156     @SuppressWarnings("unchecked")
 157     private static <T, F extends T> ArgumentCaptor<F> captorFor(Class<T> rawClass) {
 158         return (ArgumentCaptor) ArgumentCaptor.forClass(rawClass);
 159     }
 160
 161 }