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.yangtools.yang.data.impl.schema.tree;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.fail;
13 import com.google.common.collect.ImmutableMap;
14 import org.junit.AfterClass;
15 import org.junit.BeforeClass;
16 import org.junit.Test;
17 import org.opendaylight.yangtools.yang.common.QName;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
21 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
22 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
23 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
24 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
25 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
26 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
27 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
28 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
29 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
30 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
32 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
34 public class Bug5968Test {
35 private static final String NS = "bug5968";
36 private static final String REV = "2016-07-28";
37 private static final QName ROOT = QName.create(NS, REV, "root");
38 private static final QName MY_LIST = QName.create(NS, REV, "my-list");
39 private static final QName LIST_ID = QName.create(NS, REV, "list-id");
40 private static final QName MANDATORY_LEAF = QName.create(NS, REV, "mandatory-leaf");
41 private static final QName COMMON_LEAF = QName.create(NS, REV, "common-leaf");
43 private static EffectiveModelContext SCHEMA_CONTEXT;
46 public static void beforeClass() {
47 SCHEMA_CONTEXT = TestModel.createTestContext("/bug5968.yang");
51 public static void afterClass() {
52 SCHEMA_CONTEXT = null;
55 private static DataTree initDataTree(final EffectiveModelContext schemaContext, final boolean withMapNode)
56 throws DataValidationFailedException {
57 final DataTree inMemoryDataTree = new InMemoryDataTreeFactory().create(
58 DataTreeConfiguration.DEFAULT_CONFIGURATION, schemaContext);
60 final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> root = Builders.containerBuilder()
61 .withNodeIdentifier(new NodeIdentifier(ROOT));
62 final DataTreeModification modificationTree = inMemoryDataTree.takeSnapshot().newModification();
63 modificationTree.write(
64 YangInstanceIdentifier.of(ROOT),
65 withMapNode ? root.withChild(
66 Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(MY_LIST)).build()).build() : root
68 modificationTree.ready();
70 inMemoryDataTree.validate(modificationTree);
71 final DataTreeCandidate prepare = inMemoryDataTree.prepare(modificationTree);
72 inMemoryDataTree.commit(prepare);
74 return inMemoryDataTree;
77 private static DataTree emptyDataTree(final EffectiveModelContext schemaContext)
78 throws DataValidationFailedException {
79 return new InMemoryDataTreeFactory().create(DataTreeConfiguration.DEFAULT_CONFIGURATION, schemaContext);
83 public void writeInvalidContainerTest() throws DataValidationFailedException {
84 final DataTree inMemoryDataTree = emptyDataTree(SCHEMA_CONTEXT);
86 final SystemMapNode myList = createMap(true);
87 final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> root = Builders.containerBuilder()
88 .withNodeIdentifier(new NodeIdentifier(ROOT)).withChild(myList);
90 final DataTreeModification modificationTree = inMemoryDataTree.takeSnapshot().newModification();
91 modificationTree.write(YangInstanceIdentifier.of(ROOT), root.build());
94 modificationTree.ready();
95 inMemoryDataTree.validate(modificationTree);
96 final DataTreeCandidate prepare = inMemoryDataTree.prepare(modificationTree);
97 inMemoryDataTree.commit(prepare);
98 fail("Should fail due to missing mandatory leaf.");
99 } catch (final IllegalArgumentException e) {
100 assertEquals("Node (bug5968?revision=2016-07-28)my-list[{(bug5968?revision=2016-07-28)list-id=1}] is "
101 + "missing mandatory descendant /(bug5968?revision=2016-07-28)mandatory-leaf", e.getMessage());
106 public void writeInvalidMapTest() throws DataValidationFailedException {
107 final DataTree inMemoryDataTree = emptyDataTree(SCHEMA_CONTEXT);
108 final DataTreeModification modificationTree = inMemoryDataTree.takeSnapshot().newModification();
109 writeMap(modificationTree, true);
112 modificationTree.ready();
113 inMemoryDataTree.validate(modificationTree);
114 final DataTreeCandidate prepare = inMemoryDataTree.prepare(modificationTree);
115 inMemoryDataTree.commit(prepare);
116 fail("Should fail due to missing mandatory leaf.");
117 } catch (final IllegalArgumentException e) {
118 assertEquals("Node (bug5968?revision=2016-07-28)my-list[{(bug5968?revision=2016-07-28)list-id=1}] is "
119 + "missing mandatory descendant /(bug5968?revision=2016-07-28)mandatory-leaf", e.getMessage());
124 public void writeInvalidMapEntryTest() throws DataValidationFailedException {
125 final DataTree inMemoryDataTree = initDataTree(SCHEMA_CONTEXT, true);
126 final DataTreeModification modificationTree = inMemoryDataTree.takeSnapshot().newModification();
128 writeMapEntry(modificationTree, "1", null, "common-value");
131 modificationTree.ready();
132 inMemoryDataTree.validate(modificationTree);
133 final DataTreeCandidate prepare = inMemoryDataTree.prepare(modificationTree);
134 inMemoryDataTree.commit(prepare);
135 fail("Should fail due to missing mandatory leaf.");
136 } catch (final IllegalArgumentException e) {
137 assertEquals("Node (bug5968?revision=2016-07-28)my-list[{(bug5968?revision=2016-07-28)list-id=1}] is "
138 + "missing mandatory descendant /(bug5968?revision=2016-07-28)mandatory-leaf", e.getMessage());
142 private static void writeMap(final DataTreeModification modificationTree, final boolean mandatoryDataMissing) {
143 modificationTree.write(YangInstanceIdentifier.of(ROOT).node(MY_LIST), createMap(mandatoryDataMissing));
146 private static SystemMapNode createMap(final boolean mandatoryDataMissing) {
147 return Builders.mapBuilder()
148 .withNodeIdentifier(new NodeIdentifier(MY_LIST))
149 .withChild(mandatoryDataMissing ? createMapEntry("1", "common-value")
150 : createMapEntry("1", "mandatory-value", "common-value"))
154 private static void writeMapEntry(final DataTreeModification modificationTree, final Object listIdValue,
155 final Object mandatoryLeafValue, final Object commonLeafValue) throws DataValidationFailedException {
156 final MapEntryNode taskEntryNode = mandatoryLeafValue == null ? createMapEntry(listIdValue, commonLeafValue)
157 : createMapEntry(listIdValue, mandatoryLeafValue, commonLeafValue);
159 modificationTree.write(
160 YangInstanceIdentifier.of(ROOT).node(MY_LIST)
161 .node(NodeIdentifierWithPredicates.of(MY_LIST, ImmutableMap.of(LIST_ID, listIdValue))),
165 private static MapEntryNode createMapEntry(final Object listIdValue, final Object mandatoryLeafValue,
166 final Object commonLeafValue) {
167 return Builders.mapEntryBuilder()
168 .withNodeIdentifier(NodeIdentifierWithPredicates.of(MY_LIST, ImmutableMap.of(LIST_ID, listIdValue)))
169 .withChild(ImmutableNodes.leafNode(LIST_ID, listIdValue))
170 .withChild(ImmutableNodes.leafNode(MANDATORY_LEAF, mandatoryLeafValue))
171 .withChild(ImmutableNodes.leafNode(COMMON_LEAF, commonLeafValue)).build();
174 private static MapEntryNode createMapEntry(final Object listIdValue, final Object commonLeafValue) {
175 return Builders.mapEntryBuilder()
176 .withNodeIdentifier(NodeIdentifierWithPredicates.of(MY_LIST, ImmutableMap.of(LIST_ID, listIdValue)))
177 .withChild(ImmutableNodes.leafNode(LIST_ID, listIdValue))
178 .withChild(ImmutableNodes.leafNode(COMMON_LEAF, commonLeafValue)).build();
182 public void writeValidContainerTest() throws DataValidationFailedException {
183 final DataTree inMemoryDataTree = emptyDataTree(SCHEMA_CONTEXT);
185 final SystemMapNode myList = createMap(false);
186 final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> root = Builders.containerBuilder()
187 .withNodeIdentifier(new NodeIdentifier(ROOT)).withChild(myList);
189 final DataTreeModification modificationTree = inMemoryDataTree.takeSnapshot().newModification();
190 modificationTree.write(YangInstanceIdentifier.of(ROOT), root.build());
191 modificationTree.ready();
192 inMemoryDataTree.validate(modificationTree);
193 final DataTreeCandidate prepare = inMemoryDataTree.prepare(modificationTree);
194 inMemoryDataTree.commit(prepare);
198 public void writeValidMapTest() throws DataValidationFailedException {
199 final DataTree inMemoryDataTree = emptyDataTree(SCHEMA_CONTEXT);
200 final DataTreeModification modificationTree = inMemoryDataTree.takeSnapshot().newModification();
201 writeMap(modificationTree, false);
203 modificationTree.ready();
204 inMemoryDataTree.validate(modificationTree);
205 final DataTreeCandidate prepare = inMemoryDataTree.prepare(modificationTree);
206 inMemoryDataTree.commit(prepare);
210 public void writeValidMapEntryTest() throws DataValidationFailedException {
211 final DataTree inMemoryDataTree = initDataTree(SCHEMA_CONTEXT, true);
212 final DataTreeModification modificationTree = inMemoryDataTree.takeSnapshot().newModification();
214 writeMapEntry(modificationTree, "1", "mandatory-value", "common-value");
216 modificationTree.ready();
217 inMemoryDataTree.validate(modificationTree);
218 final DataTreeCandidate prepare = inMemoryDataTree.prepare(modificationTree);
219 inMemoryDataTree.commit(prepare);