2 * Copyright (c) 2015 Brocade Communications 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.controller.cluster.datastore;
10 import static org.junit.Assert.assertEquals;
11 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.INNER_LIST_QNAME;
12 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.OUTER_CONTAINER_PATH;
13 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.OUTER_CONTAINER_QNAME;
14 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.OUTER_LIST_PATH;
15 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.OUTER_LIST_QNAME;
16 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.TEST_PATH;
17 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.TEST_QNAME;
18 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.innerEntryPath;
19 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.innerNode;
20 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.outerEntryKey;
21 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.outerEntryPath;
22 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.outerNode;
23 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.outerNodeEntry;
24 import static org.opendaylight.controller.md.cluster.datastore.model.TestModel.testNodeWithOuter;
25 import akka.actor.ActorRef;
26 import akka.testkit.TestActorRef;
27 import org.junit.After;
28 import org.junit.Before;
29 import org.junit.Test;
30 import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListener;
31 import org.opendaylight.controller.cluster.datastore.utils.MockDataChangeListener;
32 import org.opendaylight.controller.cluster.raft.TestActorFactory;
33 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
36 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
39 * Unit tests for DataChangeListenerSupport.
41 * @author Thomas Pantelis
43 public class DataChangeListenerSupportTest extends AbstractShardTest {
44 private final TestActorFactory actorFactory = new TestActorFactory(getSystem());
47 private DataChangeListenerSupport support;
51 shard = createShard();
52 support = new DataChangeListenerSupport(shard);
57 public void tearDown() {
63 public void testChangeListenerWithNoInitialData() throws Exception {
64 MockDataChangeListener listener = registerChangeListener(TEST_PATH, DataChangeScope.ONE, 0, true);
66 listener.expectNoMoreChanges("Unexpected initial change event");
70 public void testInitialChangeListenerEventWithContainerPath() throws Exception {
71 writeToStore(shard.getDataStore(), TEST_PATH, ImmutableNodes.containerNode(TEST_QNAME));
73 MockDataChangeListener listener = registerChangeListener(TEST_PATH, DataChangeScope.ONE, 1, true);
75 listener.waitForChangeEvents(TEST_PATH);
79 public void testInitialChangeListenerEventWithListPath() throws Exception {
80 mergeToStore(shard.getDataStore(), TEST_PATH, testNodeWithOuter(1, 2));
82 MockDataChangeListener listener = registerChangeListener(OUTER_LIST_PATH, DataChangeScope.ONE, 1, true);
84 listener.waitForChangeEvents();
85 assertEquals("Outer entry 1 present", true, NormalizedNodes.findNode(
86 listener.getCreatedData(0, OUTER_LIST_PATH), outerEntryKey(1)).isPresent());
87 assertEquals("Outer entry 2 present", true, NormalizedNodes.findNode(
88 listener.getCreatedData(0, OUTER_LIST_PATH), outerEntryKey(2)).isPresent());
92 public void testInitialChangeListenerEventWithWildcardedListPath() throws Exception {
93 mergeToStore(shard.getDataStore(), TEST_PATH, testNodeWithOuter(1, 2));
94 writeToStore(shard.getDataStore(), OUTER_CONTAINER_PATH, ImmutableNodes.containerNode(OUTER_CONTAINER_QNAME));
96 MockDataChangeListener listener = registerChangeListener(OUTER_LIST_PATH.node(OUTER_LIST_QNAME),
97 DataChangeScope.ONE, 1, true);
99 listener.waitForChangeEvents();
100 listener.verifyCreatedData(0, outerEntryPath(1));
101 listener.verifyCreatedData(0, outerEntryPath(2));
102 listener.verifyNoCreatedData(0, OUTER_CONTAINER_PATH);
106 public void testInitialChangeListenerEventWithNestedWildcardedListsPath() throws Exception {
107 mergeToStore(shard.getDataStore(), TEST_PATH, testNodeWithOuter(outerNode(
108 outerNodeEntry(1, innerNode("one", "two")), outerNodeEntry(2, innerNode("three", "four")))));
110 MockDataChangeListener listener = registerChangeListener(
111 OUTER_LIST_PATH.node(OUTER_LIST_QNAME).node(INNER_LIST_QNAME).node(INNER_LIST_QNAME),
112 DataChangeScope.ONE, 1, true);
114 listener.waitForChangeEvents();
115 listener.verifyCreatedData(0, innerEntryPath(1, "one"));
116 listener.verifyCreatedData(0, innerEntryPath(1, "two"));
117 listener.verifyCreatedData(0, innerEntryPath(2, "three"));
118 listener.verifyCreatedData(0, innerEntryPath(2, "four"));
120 // Register for a specific outer list entry
122 MockDataChangeListener listener2 = registerChangeListener(
123 OUTER_LIST_PATH.node(outerEntryKey(1)).node(INNER_LIST_QNAME).node(INNER_LIST_QNAME),
124 DataChangeScope.ONE, 1, true);
126 listener2.waitForChangeEvents();
127 listener2.verifyCreatedData(0, innerEntryPath(1, "one"));
128 listener2.verifyCreatedData(0, innerEntryPath(1, "two"));
129 listener2.verifyNoCreatedData(0, innerEntryPath(2, "three"));
130 listener2.verifyNoCreatedData(0, innerEntryPath(2, "four"));
134 public void testInitialChangeListenerEventWhenNotInitiallyLeader() throws Exception {
135 mergeToStore(shard.getDataStore(), TEST_PATH, testNodeWithOuter(outerNode(
136 outerNodeEntry(1, innerNode("one", "two")), outerNodeEntry(2, innerNode("three", "four")))));
138 MockDataChangeListener listener = registerChangeListener(
139 OUTER_LIST_PATH.node(OUTER_LIST_QNAME).node(INNER_LIST_QNAME).node(INNER_LIST_QNAME),
140 DataChangeScope.ONE, 0, false);
142 listener.expectNoMoreChanges("Unexpected initial change event");
145 support.onLeadershipChange(true, true);
147 listener.waitForChangeEvents();
148 listener.verifyCreatedData(0, innerEntryPath(1, "one"));
149 listener.verifyCreatedData(0, innerEntryPath(1, "two"));
150 listener.verifyCreatedData(0, innerEntryPath(2, "three"));
151 listener.verifyCreatedData(0, innerEntryPath(2, "four"));
154 private MockDataChangeListener registerChangeListener(YangInstanceIdentifier path, DataChangeScope scope,
155 int expectedEvents, boolean isLeader) {
156 MockDataChangeListener listener = new MockDataChangeListener(expectedEvents);
157 ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener));
159 support.onMessage(new RegisterChangeListener(path, dclActor, scope, false), isLeader, true);
163 private Shard createShard() {
164 TestActorRef<Shard> actor = actorFactory.createTestActor(newShardProps());
165 return actor.underlyingActor();