2 * Copyright (c) 2015 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
9 package org.opendaylight.controller.cluster.datastore.node.utils.transformer;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNull;
13 import static org.junit.Assert.assertTrue;
14 import static org.mockito.Mockito.mock;
15 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntry;
16 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntryBuilder;
17 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapNodeBuilder;
19 import com.google.common.collect.Sets;
20 import java.io.IOException;
21 import java.util.concurrent.atomic.AtomicInteger;
22 import javax.xml.transform.dom.DOMSource;
23 import org.junit.Assert;
24 import org.junit.Before;
25 import org.junit.Test;
26 import org.mockito.MockitoAnnotations;
27 import org.opendaylight.controller.cluster.datastore.node.utils.NormalizedNodeNavigator;
28 import org.opendaylight.controller.cluster.datastore.util.TestModel;
29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
33 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
39 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
40 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
43 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
45 public class NormalizedNodePrunerTest {
46 private static final SchemaContext NO_TEST_SCHEMA = TestModel.createTestContextWithoutTestSchema();
47 private static final SchemaContext NO_AUG_SCHEMA = TestModel.createTestContextWithoutAugmentationSchema();
48 private static final SchemaContext FULL_SCHEMA = TestModel.createTestContext();
52 MockitoAnnotations.initMocks(this);
55 private static NormalizedNodePruner prunerFullSchema(final YangInstanceIdentifier path) {
56 return new NormalizedNodePruner(path, FULL_SCHEMA);
59 private static NormalizedNodePruner prunerNoAugSchema(final YangInstanceIdentifier path) {
60 return new NormalizedNodePruner(path, NO_AUG_SCHEMA);
63 private static NormalizedNodePruner prunerNoTestSchema(final YangInstanceIdentifier path) {
64 return new NormalizedNodePruner(path, NO_TEST_SCHEMA);
68 public void testNodesNotPrunedWhenSchemaPresent() throws IOException {
69 NormalizedNodePruner pruner = prunerFullSchema(TestModel.TEST_PATH);
71 NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(pruner);
73 NormalizedNode<?, ?> expected = createTestContainer();
75 normalizedNodeWriter.write(expected);
77 NormalizedNode<?, ?> actual = pruner.normalizedNode();
79 assertEquals(expected, actual);
83 @Test(expected = IllegalStateException.class)
84 public void testReusePruner() throws IOException {
85 NormalizedNodePruner pruner = prunerFullSchema(TestModel.TEST_PATH);
87 NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(pruner);
89 NormalizedNode<?, ?> expected = createTestContainer();
91 normalizedNodeWriter.write(expected);
93 NormalizedNode<?, ?> actual = pruner.normalizedNode();
95 assertEquals(expected, actual);
97 NormalizedNodeWriter.forStreamWriter(pruner).write(expected);
103 public void testNodesPrunedWhenAugmentationSchemaMissing() throws IOException {
104 NormalizedNodePruner pruner = prunerNoAugSchema(TestModel.TEST_PATH);
106 NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(pruner);
108 NormalizedNode<?, ?> expected = createTestContainer();
110 normalizedNodeWriter.write(expected);
112 NormalizedNode<?, ?> actual = pruner.normalizedNode();
114 Assert.assertNotEquals(expected, actual);
116 // Asserting true here instead of checking actual value because I don't want this assertion to be fragile
117 assertTrue(countNodes(expected, "store:aug") > 0);
119 // All nodes from the augmentation module are gone from the resulting node
120 assertEquals(0, countNodes(actual, "store:aug"));
124 public void testNodesPrunedWhenTestSchemaMissing() throws IOException {
125 NormalizedNodePruner pruner = prunerNoTestSchema(TestModel.TEST_PATH);
127 NormalizedNodeWriter normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(pruner);
129 NormalizedNode<?, ?> expected = createTestContainer();
131 normalizedNodeWriter.write(expected);
133 NormalizedNode<?, ?> actual = pruner.normalizedNode();
135 // Since top level schema is missing null is returned
138 // Asserting true here instead of checking actual value because I don't want this assertion to be fragile
139 assertTrue(countNodes(expected, "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:test") > 0);
143 private static int countNodes(final NormalizedNode<?,?> normalizedNode, final String namespaceFilter) {
144 if (normalizedNode == null) {
147 final AtomicInteger count = new AtomicInteger();
148 new NormalizedNodeNavigator((level, parentPath, normalizedNode1) -> {
149 if (!(normalizedNode1.getIdentifier() instanceof AugmentationIdentifier)) {
150 if (normalizedNode1.getIdentifier().getNodeType().getNamespace().toString().contains(namespaceFilter)) {
151 count.incrementAndGet();
154 }).navigate(YangInstanceIdentifier.empty().toString(), normalizedNode);
160 public void testLeafNodeNotPrunedWhenHasNoParent() throws IOException {
161 NormalizedNodePruner pruner = prunerFullSchema(TestModel.TEST_PATH.node(TestModel.DESC_QNAME));
162 NormalizedNode<?, ?> input = Builders.leafBuilder().withNodeIdentifier(
163 new NodeIdentifier(TestModel.DESC_QNAME)).withValue("test").build();
164 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
166 NormalizedNode<?, ?> actual = pruner.normalizedNode();
167 assertEquals("normalizedNode", input, actual);
171 public void testLeafNodePrunedWhenHasAugmentationParentAndSchemaMissing() throws IOException {
172 AugmentationIdentifier augId = new AugmentationIdentifier(Sets.newHashSet(TestModel.AUG_CONT_QNAME));
173 NormalizedNodePruner pruner = prunerFullSchema(YangInstanceIdentifier.builder()
174 .node(TestModel.TEST_QNAME).node(TestModel.AUGMENTED_LIST_QNAME)
175 .node(TestModel.AUGMENTED_LIST_QNAME).node(augId).build());
176 LeafNode<Object> child = Builders.leafBuilder().withNodeIdentifier(
177 new NodeIdentifier(TestModel.INVALID_QNAME)).withValue("test").build();
178 NormalizedNode<?, ?> input = Builders.augmentationBuilder().withNodeIdentifier(augId).withChild(child).build();
179 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
181 NormalizedNode<?, ?> actual = pruner.normalizedNode();
182 assertEquals("normalizedNode", Builders.augmentationBuilder().withNodeIdentifier(augId).build(), actual);
186 public void testLeafNodePrunedWhenHasNoParentAndSchemaMissing() throws IOException {
187 NormalizedNodePruner pruner = prunerFullSchema(TestModel.TEST_PATH.node(TestModel.INVALID_QNAME));
188 NormalizedNode<?, ?> input = Builders.leafBuilder().withNodeIdentifier(
189 new NodeIdentifier(TestModel.INVALID_QNAME)).withValue("test").build();
190 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
192 NormalizedNode<?, ?> actual = pruner.normalizedNode();
198 public void testLeafSetEntryNodeNotPrunedWhenHasNoParent() throws IOException {
199 NormalizedNodePruner pruner = prunerFullSchema(TestModel.TEST_PATH.node(TestModel.SHOE_QNAME));
200 NormalizedNode<?, ?> input = Builders.leafSetEntryBuilder().withValue("puma").withNodeIdentifier(
201 new NodeWithValue<>(TestModel.SHOE_QNAME, "puma")).build();
202 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
204 NormalizedNode<?, ?> actual = pruner.normalizedNode();
205 assertEquals("normalizedNode", input, actual);
209 public void testLeafSetEntryNodeNotPrunedWhenHasParent() throws IOException {
210 NormalizedNodePruner pruner = prunerFullSchema(TestModel.TEST_PATH.node(TestModel.SHOE_QNAME));
211 LeafSetEntryNode<Object> child = Builders.leafSetEntryBuilder().withValue("puma").withNodeIdentifier(
212 new NodeWithValue<>(TestModel.SHOE_QNAME, "puma")).build();
213 NormalizedNode<?, ?> input = Builders.leafSetBuilder().withNodeIdentifier(
214 new NodeIdentifier(TestModel.SHOE_QNAME)).withChild(child).build();
215 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
217 NormalizedNode<?, ?> actual = pruner.normalizedNode();
218 assertEquals("normalizedNode", input, actual);
222 public void testLeafSetEntryNodePrunedWhenHasNoParentAndSchemaMissing() throws IOException {
223 NormalizedNodePruner pruner = prunerFullSchema(TestModel.TEST_PATH.node(TestModel.INVALID_QNAME));
224 NormalizedNode<?, ?> input = Builders.leafSetEntryBuilder().withValue("test").withNodeIdentifier(
225 new NodeWithValue<>(TestModel.INVALID_QNAME, "test")).build();
226 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
228 NormalizedNode<?, ?> actual = pruner.normalizedNode();
233 public void testLeafSetEntryNodePrunedWhenHasParentAndSchemaMissing() throws IOException {
234 NormalizedNodePruner pruner = prunerFullSchema(TestModel.TEST_PATH.node(TestModel.INVALID_QNAME));
235 LeafSetEntryNode<Object> child = Builders.leafSetEntryBuilder().withValue("test").withNodeIdentifier(
236 new NodeWithValue<>(TestModel.INVALID_QNAME, "test")).build();
237 NormalizedNode<?, ?> input = Builders.leafSetBuilder().withNodeIdentifier(
238 new NodeIdentifier(TestModel.INVALID_QNAME)).withChild(child).build();
239 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
241 NormalizedNode<?, ?> actual = pruner.normalizedNode();
246 public void testAnyXMLNodeNotPrunedWhenHasNoParent() throws IOException {
247 NormalizedNodePruner pruner = prunerFullSchema(TestModel.TEST_PATH.node(TestModel.ANY_XML_QNAME));
248 NormalizedNode<?, ?> input = Builders.anyXmlBuilder().withNodeIdentifier(
249 new NodeIdentifier(TestModel.ANY_XML_QNAME)).withValue(mock(DOMSource.class)).build();
250 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
252 NormalizedNode<?, ?> actual = pruner.normalizedNode();
253 assertEquals("normalizedNode", input, actual);
258 public void testAnyXMLNodeNotPrunedWhenHasParent() throws IOException {
259 NormalizedNodePruner pruner = prunerFullSchema(TestModel.TEST_PATH);
260 DOMSourceAnyxmlNode child = Builders.anyXmlBuilder().withNodeIdentifier(
261 new NodeIdentifier(TestModel.ANY_XML_QNAME)).withValue(mock(DOMSource.class)).build();
262 NormalizedNode<?, ?> input = Builders.containerBuilder().withNodeIdentifier(
263 new NodeIdentifier(TestModel.TEST_QNAME)).withChild(child).build();
264 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
266 NormalizedNode<?, ?> actual = pruner.normalizedNode();
267 assertEquals("normalizedNode", input, actual);
271 public void testAnyXmlNodePrunedWhenHasNoParentAndSchemaMissing() throws IOException {
272 NormalizedNodePruner pruner = prunerNoTestSchema(TestModel.TEST_PATH.node(TestModel.ANY_XML_QNAME));
273 NormalizedNode<?, ?> input = Builders.anyXmlBuilder().withNodeIdentifier(
274 new NodeIdentifier(TestModel.ANY_XML_QNAME)).withValue(mock(DOMSource.class)).build();
275 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
277 NormalizedNode<?, ?> actual = pruner.normalizedNode();
282 public void testInnerContainerNodeWithFullPathPathNotPruned() throws IOException {
283 YangInstanceIdentifier path = YangInstanceIdentifier.builder().node(TestModel.TEST_QNAME)
284 .node(TestModel.OUTER_LIST_QNAME).nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)
285 .node(TestModel.INNER_LIST_QNAME).nodeWithKey(TestModel.INNER_LIST_QNAME, TestModel.NAME_QNAME, "one")
286 .node(TestModel.INNER_CONTAINER_QNAME).build();
287 NormalizedNodePruner pruner = prunerFullSchema(path);
289 NormalizedNode<?, ?> input = ImmutableNodes.containerNode(TestModel.INNER_CONTAINER_QNAME);
290 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
292 NormalizedNode<?, ?> actual = pruner.normalizedNode();
293 assertEquals("normalizedNode", input, actual);
297 public void testInnerContainerNodeWithFullPathPrunedWhenSchemaMissing() throws IOException {
298 YangInstanceIdentifier path = YangInstanceIdentifier.builder().node(TestModel.TEST_QNAME)
299 .node(TestModel.OUTER_LIST_QNAME).nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)
300 .node(TestModel.INNER_LIST_QNAME).nodeWithKey(TestModel.INNER_LIST_QNAME, TestModel.NAME_QNAME, "one")
301 .node(TestModel.INVALID_QNAME).build();
302 NormalizedNodePruner pruner = prunerFullSchema(path);
304 NormalizedNode<?, ?> input = ImmutableNodes.containerNode(TestModel.INVALID_QNAME);
305 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
307 NormalizedNode<?, ?> actual = pruner.normalizedNode();
312 public void testInnerContainerNodeWithParentPathPrunedWhenSchemaMissing() throws IOException {
313 YangInstanceIdentifier path = YangInstanceIdentifier.builder().node(TestModel.TEST_QNAME)
314 .node(TestModel.OUTER_LIST_QNAME).nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)
316 NormalizedNodePruner pruner = prunerFullSchema(path);
318 MapNode innerList = mapNodeBuilder(TestModel.INNER_LIST_QNAME).withChild(mapEntryBuilder(
319 TestModel.INNER_LIST_QNAME, TestModel.NAME_QNAME, "one").withChild(
320 ImmutableNodes.containerNode(TestModel.INVALID_QNAME)).build()).build();
321 NormalizedNode<?, ?> input = mapEntryBuilder(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)
322 .withChild(innerList).build();
323 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
325 NormalizedNode<?, ?> expected = mapEntryBuilder(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)
326 .withChild(mapNodeBuilder(TestModel.INNER_LIST_QNAME).withChild(mapEntryBuilder(
327 TestModel.INNER_LIST_QNAME, TestModel.NAME_QNAME, "one").build()).build()).build();
328 NormalizedNode<?, ?> actual = pruner.normalizedNode();
329 assertEquals("normalizedNode", expected, actual);
333 public void testInnerListNodeWithFullPathNotPruned() throws IOException {
334 YangInstanceIdentifier path = YangInstanceIdentifier.builder().node(TestModel.TEST_QNAME)
335 .node(TestModel.OUTER_LIST_QNAME).nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)
336 .node(TestModel.INNER_LIST_QNAME).build();
337 NormalizedNodePruner pruner = prunerFullSchema(path);
339 MapNode input = mapNodeBuilder(TestModel.INNER_LIST_QNAME).withChild(mapEntryBuilder(
340 TestModel.INNER_LIST_QNAME, TestModel.NAME_QNAME, "one").withChild(
341 ImmutableNodes.containerNode(TestModel.INNER_CONTAINER_QNAME)).build()).build();
342 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
344 NormalizedNode<?, ?> actual = pruner.normalizedNode();
345 assertEquals("normalizedNode", input, actual);
349 public void testInnerListNodeWithFullPathPrunedWhenSchemaMissing() throws IOException {
350 YangInstanceIdentifier path = YangInstanceIdentifier.builder().node(TestModel.TEST_QNAME)
351 .node(TestModel.OUTER_LIST_QNAME).nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)
352 .node(TestModel.INVALID_QNAME).build();
353 NormalizedNodePruner pruner = prunerFullSchema(path);
355 MapNode input = mapNodeBuilder(TestModel.INVALID_QNAME).withChild(mapEntryBuilder(
356 TestModel.INVALID_QNAME, TestModel.NAME_QNAME, "one").withChild(
357 ImmutableNodes.containerNode(TestModel.INNER_CONTAINER_QNAME)).build()).build();
358 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
360 NormalizedNode<?, ?> actual = pruner.normalizedNode();
365 public void testInnerListNodeWithParentPathPrunedWhenSchemaMissing() throws IOException {
366 YangInstanceIdentifier path = YangInstanceIdentifier.builder().node(TestModel.TEST_QNAME)
367 .node(TestModel.OUTER_LIST_QNAME).nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)
369 NormalizedNodePruner pruner = prunerFullSchema(path);
371 MapNode innerList = mapNodeBuilder(TestModel.INVALID_QNAME).withChild(mapEntryBuilder(
372 TestModel.INVALID_QNAME, TestModel.NAME_QNAME, "one").withChild(
373 ImmutableNodes.containerNode(TestModel.INNER_CONTAINER_QNAME)).build()).build();
374 NormalizedNode<?, ?> input = mapEntryBuilder(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)
375 .withChild(innerList).build();
376 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
378 NormalizedNode<?, ?> expected = mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1);
379 NormalizedNode<?, ?> actual = pruner.normalizedNode();
380 assertEquals("normalizedNode", expected, actual);
383 private static NormalizedNode<?, ?> createTestContainer() {
384 byte[] bytes1 = {1, 2, 3};
385 LeafSetEntryNode<Object> entry1 = ImmutableLeafSetEntryNodeBuilder.create().withNodeIdentifier(
386 new NodeWithValue<>(TestModel.BINARY_LEAF_LIST_QNAME, bytes1)).withValue(bytes1).build();
389 LeafSetEntryNode<Object> entry2 = ImmutableLeafSetEntryNodeBuilder.create().withNodeIdentifier(
390 new NodeWithValue<>(TestModel.BINARY_LEAF_LIST_QNAME, bytes2)).withValue(bytes2).build();
392 return TestModel.createBaseTestContainerBuilder()
393 .withChild(ImmutableLeafSetNodeBuilder.create().withNodeIdentifier(
394 new NodeIdentifier(TestModel.BINARY_LEAF_LIST_QNAME))
395 .withChild(entry1).withChild(entry2).build())
396 .withChild(ImmutableNodes.leafNode(TestModel.SOME_BINARY_DATA_QNAME, new byte[]{1, 2, 3, 4}))