2 * Copyright (c) 2014, 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
8 package org.opendaylight.controller.cluster.datastore.util;
10 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntry;
11 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntryBuilder;
12 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapNodeBuilder;
14 import com.google.common.collect.ImmutableList;
15 import com.google.common.collect.ImmutableSet;
16 import java.io.InputStream;
17 import java.math.BigDecimal;
18 import java.util.HashMap;
19 import java.util.HashSet;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.common.Uint64;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
29 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
37 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
38 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
47 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
49 public final class TestModel {
51 public static final QName TEST_QNAME = QName.create(
52 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:test",
53 "2014-03-13", "test");
55 public static final QName AUG_NAME_QNAME = QName.create(
56 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug",
57 "2014-03-13", "name");
59 public static final QName AUG_CONT_QNAME = QName.create(
60 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug",
61 "2014-03-13", "cont");
64 public static final QName DESC_QNAME = QName.create(TEST_QNAME, "desc");
65 public static final QName POINTER_QNAME = QName.create(TEST_QNAME, "pointer");
66 public static final QName SOME_BINARY_DATA_QNAME = QName.create(TEST_QNAME, "some-binary-data");
67 public static final QName BINARY_LEAF_LIST_QNAME = QName.create(TEST_QNAME, "binary_leaf_list");
68 public static final QName SOME_REF_QNAME = QName.create(TEST_QNAME, "some-ref");
69 public static final QName MYIDENTITY_QNAME = QName.create(TEST_QNAME, "myidentity");
70 public static final QName SWITCH_FEATURES_QNAME = QName.create(TEST_QNAME, "switch-features");
72 public static final QName AUGMENTED_LIST_QNAME = QName.create(TEST_QNAME, "augmented-list");
73 public static final QName AUGMENTED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "augmented-list-entry");
75 public static final QName OUTER_LIST_QNAME = QName.create(TEST_QNAME, "outer-list");
76 public static final QName INNER_LIST_QNAME = QName.create(TEST_QNAME, "inner-list");
77 public static final QName INNER_CONTAINER_QNAME = QName.create(TEST_QNAME, "inner-container");
78 public static final QName OUTER_CHOICE_QNAME = QName.create(TEST_QNAME, "outer-choice");
79 public static final QName ID_QNAME = QName.create(TEST_QNAME, "id");
80 public static final QName NAME_QNAME = QName.create(TEST_QNAME, "name");
81 public static final QName VALUE_QNAME = QName.create(TEST_QNAME, "value");
82 public static final QName BOOLEAN_LEAF_QNAME = QName.create(TEST_QNAME, "boolean-leaf");
83 public static final QName SHORT_LEAF_QNAME = QName.create(TEST_QNAME, "short-leaf");
84 public static final QName BYTE_LEAF_QNAME = QName.create(TEST_QNAME, "byte-leaf");
85 public static final QName BIGINTEGER_LEAF_QNAME = QName.create(TEST_QNAME, "biginteger-leaf");
86 public static final QName BIGDECIMAL_LEAF_QNAME = QName.create(TEST_QNAME, "bigdecimal-leaf");
87 public static final QName ORDERED_LIST_QNAME = QName.create(TEST_QNAME, "ordered-list");
88 public static final QName ORDERED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "ordered-list-leaf");
89 public static final QName UNKEYED_LIST_QNAME = QName.create(TEST_QNAME, "unkeyed-list");
90 public static final QName UNKEYED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "unkeyed-list-entry");
91 public static final QName CHOICE_QNAME = QName.create(TEST_QNAME, "choice");
92 public static final QName SHOE_QNAME = QName.create(TEST_QNAME, "shoe");
93 public static final QName ANY_XML_QNAME = QName.create(TEST_QNAME, "any");
94 public static final QName EMPTY_QNAME = QName.create(TEST_QNAME, "empty-leaf");
95 public static final QName INVALID_QNAME = QName.create(TEST_QNAME, "invalid");
96 private static final String DATASTORE_TEST_YANG = "/odl-datastore-test.yang";
97 private static final String DATASTORE_AUG_YANG = "/odl-datastore-augmentation.yang";
98 private static final String DATASTORE_TEST_NOTIFICATION_YANG = "/odl-datastore-test-notification.yang";
100 public static final YangInstanceIdentifier TEST_PATH = YangInstanceIdentifier.of(TEST_QNAME);
101 public static final YangInstanceIdentifier DESC_PATH = YangInstanceIdentifier
102 .builder(TEST_PATH).node(DESC_QNAME).build();
103 public static final YangInstanceIdentifier OUTER_LIST_PATH =
104 YangInstanceIdentifier.builder(TEST_PATH).node(OUTER_LIST_QNAME).build();
105 public static final QName TWO_THREE_QNAME = QName.create(TEST_QNAME, "two");
106 public static final QName TWO_QNAME = QName.create(TEST_QNAME, "two");
107 public static final QName THREE_QNAME = QName.create(TEST_QNAME, "three");
109 private static final Integer ONE_ID = 1;
110 private static final Integer TWO_ID = 2;
111 private static final String TWO_ONE_NAME = "one";
112 private static final String TWO_TWO_NAME = "two";
113 private static final String DESC = "Hello there";
114 private static final Boolean ENABLED = true;
115 private static final Short SHORT_ID = 1;
116 private static final Byte BYTE_ID = 1;
117 // Family specific constants
118 public static final QName FAMILY_QNAME = QName.create(
119 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:notification-test", "2014-04-17", "family");
120 public static final QName CHILDREN_QNAME = QName.create(FAMILY_QNAME, "children");
121 public static final QName GRAND_CHILDREN_QNAME = QName.create(FAMILY_QNAME, "grand-children");
122 public static final QName CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME, "child-number");
123 public static final QName CHILD_NAME_QNAME = QName.create(FAMILY_QNAME, "child-name");
124 public static final QName GRAND_CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME, "grand-child-number");
125 public static final QName GRAND_CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,"grand-child-name");
127 public static final YangInstanceIdentifier FAMILY_PATH = YangInstanceIdentifier.of(FAMILY_QNAME);
128 public static final YangInstanceIdentifier FAMILY_DESC_PATH =
129 YangInstanceIdentifier.builder(FAMILY_PATH).node(DESC_QNAME).build();
130 public static final YangInstanceIdentifier CHILDREN_PATH =
131 YangInstanceIdentifier.builder(FAMILY_PATH).node(CHILDREN_QNAME).build();
133 private static final Integer FIRST_CHILD_ID = 1;
134 private static final Integer SECOND_CHILD_ID = 2;
136 private static final String FIRST_CHILD_NAME = "first child";
137 private static final String SECOND_CHILD_NAME = "second child";
139 private static final Integer FIRST_GRAND_CHILD_ID = 1;
140 private static final Integer SECOND_GRAND_CHILD_ID = 2;
142 private static final String FIRST_GRAND_CHILD_NAME = "first grand child";
143 private static final String SECOND_GRAND_CHILD_NAME = "second grand child";
145 private static final MapEntryNode BAR_NODE = mapEntryBuilder(
146 OUTER_LIST_QNAME, ID_QNAME, TWO_ID) //
147 .withChild(mapNodeBuilder(INNER_LIST_QNAME) //
148 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_ONE_NAME)) //
149 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME)) //
153 private TestModel() {
154 throw new UnsupportedOperationException();
157 public static InputStream getDatastoreTestInputStream() {
158 return getInputStream(DATASTORE_TEST_YANG);
161 public static InputStream getDatastoreAugInputStream() {
162 return getInputStream(DATASTORE_AUG_YANG);
165 public static InputStream getDatastoreTestNotificationInputStream() {
166 return getInputStream(DATASTORE_TEST_NOTIFICATION_YANG);
169 private static InputStream getInputStream(final String resourceName) {
170 return TestModel.class.getResourceAsStream(resourceName);
173 public static SchemaContext createTestContext() {
174 return YangParserTestUtils.parseYangResources(TestModel.class, DATASTORE_TEST_YANG, DATASTORE_AUG_YANG,
175 DATASTORE_TEST_NOTIFICATION_YANG);
178 public static SchemaContext createTestContextWithoutTestSchema() {
179 return YangParserTestUtils.parseYangResource(DATASTORE_TEST_NOTIFICATION_YANG);
182 public static SchemaContext createTestContextWithoutAugmentationSchema() {
183 return YangParserTestUtils.parseYangResources(TestModel.class, DATASTORE_TEST_YANG,
184 DATASTORE_TEST_NOTIFICATION_YANG);
187 public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> createBaseTestContainerBuilder() {
188 // Create a list of shoes
189 // This is to test leaf list entry
190 final LeafSetEntryNode<Object> nike = ImmutableLeafSetEntryNodeBuilder.create().withNodeIdentifier(
191 new NodeWithValue<>(SHOE_QNAME, "nike")).withValue("nike").build();
193 final LeafSetEntryNode<Object> puma = ImmutableLeafSetEntryNodeBuilder.create().withNodeIdentifier(
194 new NodeWithValue<>(SHOE_QNAME, "puma")).withValue("puma").build();
196 final LeafSetNode<Object> shoes = ImmutableLeafSetNodeBuilder.create().withNodeIdentifier(
197 new NodeIdentifier(SHOE_QNAME)).withChild(nike).withChild(puma).build();
199 // Test a leaf-list where each entry contains an identity
200 final LeafSetEntryNode<Object> cap1 =
201 ImmutableLeafSetEntryNodeBuilder
204 new NodeWithValue<>(QName.create(
205 TEST_QNAME, "capability"), DESC_QNAME))
206 .withValue(DESC_QNAME).build();
208 final LeafSetNode<Object> capabilities =
209 ImmutableLeafSetNodeBuilder
212 new NodeIdentifier(QName.create(
213 TEST_QNAME, "capability"))).withChild(cap1).build();
215 ContainerNode switchFeatures =
216 ImmutableContainerNodeBuilder
219 new NodeIdentifier(SWITCH_FEATURES_QNAME))
220 .withChild(capabilities).build();
222 // Create a leaf list with numbers
223 final LeafSetEntryNode<Object> five =
224 ImmutableLeafSetEntryNodeBuilder
227 new NodeWithValue<>(QName.create(
228 TEST_QNAME, "number"), 5)).withValue(5).build();
229 final LeafSetEntryNode<Object> fifteen =
230 ImmutableLeafSetEntryNodeBuilder
233 new NodeWithValue<>(QName.create(
234 TEST_QNAME, "number"), 15)).withValue(15).build();
235 final LeafSetNode<Object> numbers =
236 ImmutableLeafSetNodeBuilder
239 new NodeIdentifier(QName.create(
240 TEST_QNAME, "number"))).withChild(five).withChild(fifteen)
244 // Create augmentations
245 MapEntryNode augMapEntry = createAugmentedListEntry(1, "First Test");
247 // Create a bits leaf
248 NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>>
249 myBits = Builders.leafBuilder()
250 .withNodeIdentifier(new NodeIdentifier(QName.create(TEST_QNAME, "my-bits")))
251 .withValue(ImmutableSet.of("foo", "bar"));
253 // Create unkeyed list entry
254 UnkeyedListEntryNode unkeyedListEntry = Builders.unkeyedListEntryBuilder()
255 .withNodeIdentifier(new NodeIdentifier(UNKEYED_LIST_QNAME))
256 .withChild(ImmutableNodes.leafNode(NAME_QNAME, "unkeyed-entry-name"))
259 // Create YangInstanceIdentifier with all path arg types.
260 YangInstanceIdentifier instanceID = YangInstanceIdentifier.create(
261 new NodeIdentifier(QName.create(TEST_QNAME, "qname")),
262 NodeIdentifierWithPredicates.of(QName.create(TEST_QNAME, "list-entry"),
263 QName.create(TEST_QNAME, "key"), 10),
264 new AugmentationIdentifier(ImmutableSet.of(
265 QName.create(TEST_QNAME, "aug1"), QName.create(TEST_QNAME, "aug2"))),
266 new NodeWithValue<>(QName.create(TEST_QNAME, "leaf-list-entry"), "foo"));
268 Map<QName, Object> keyValues = new HashMap<>();
269 keyValues.put(CHILDREN_QNAME, FIRST_CHILD_NAME);
272 // Create the document
273 return ImmutableContainerNodeBuilder
275 .withNodeIdentifier(new NodeIdentifier(TEST_QNAME))
276 .withChild(myBits.build())
277 .withChild(ImmutableNodes.leafNode(DESC_QNAME, DESC))
278 .withChild(ImmutableNodes.leafNode(BOOLEAN_LEAF_QNAME, ENABLED))
279 .withChild(ImmutableNodes.leafNode(SHORT_LEAF_QNAME, SHORT_ID))
280 .withChild(ImmutableNodes.leafNode(BYTE_LEAF_QNAME, BYTE_ID))
281 .withChild(ImmutableNodes.leafNode(TestModel.BIGINTEGER_LEAF_QNAME, Uint64.valueOf(100)))
282 .withChild(ImmutableNodes.leafNode(TestModel.BIGDECIMAL_LEAF_QNAME, BigDecimal.valueOf(1.2)))
283 .withChild(ImmutableNodes.leafNode(SOME_REF_QNAME, instanceID))
284 .withChild(ImmutableNodes.leafNode(MYIDENTITY_QNAME, DESC_QNAME))
285 .withChild(Builders.unkeyedListBuilder()
286 .withNodeIdentifier(new NodeIdentifier(UNKEYED_LIST_QNAME))
287 .withChild(unkeyedListEntry).build())
288 .withChild(Builders.choiceBuilder()
289 .withNodeIdentifier(new NodeIdentifier(TWO_THREE_QNAME))
290 .withChild(ImmutableNodes.leafNode(TWO_QNAME, "two")).build())
291 .withChild(Builders.orderedMapBuilder()
292 .withNodeIdentifier(new NodeIdentifier(ORDERED_LIST_QNAME))
293 .withValue(ImmutableList.<MapEntryNode>builder().add(
294 mapEntryBuilder(ORDERED_LIST_QNAME, ORDERED_LIST_ENTRY_QNAME, "1").build(),
295 mapEntryBuilder(ORDERED_LIST_QNAME, ORDERED_LIST_ENTRY_QNAME, "2").build()).build())
299 .withChild(switchFeatures)
300 .withChild(mapNodeBuilder(AUGMENTED_LIST_QNAME).withChild(augMapEntry).build())
301 .withChild(mapNodeBuilder(OUTER_LIST_QNAME)
302 .withChild(mapEntry(OUTER_LIST_QNAME, ID_QNAME, ONE_ID))
303 .withChild(BAR_NODE).build()
307 public static ContainerNode createTestContainer() {
308 return createBaseTestContainerBuilder().build();
311 public static MapEntryNode createAugmentedListEntry(final int id, final String name) {
312 Set<QName> childAugmentations = new HashSet<>();
313 childAugmentations.add(AUG_CONT_QNAME);
315 ContainerNode augCont = ImmutableContainerNodeBuilder.create()
316 .withNodeIdentifier(new NodeIdentifier(AUG_CONT_QNAME))
317 .withChild(ImmutableNodes.leafNode(AUG_NAME_QNAME, name))
321 final AugmentationIdentifier augmentationIdentifier = new AugmentationIdentifier(childAugmentations);
322 final AugmentationNode augmentationNode =
323 Builders.augmentationBuilder()
324 .withNodeIdentifier(augmentationIdentifier).withChild(augCont)
327 return ImmutableMapEntryNodeBuilder.create()
328 .withNodeIdentifier(NodeIdentifierWithPredicates.of(AUGMENTED_LIST_QNAME, ID_QNAME, id))
329 .withChild(ImmutableNodes.leafNode(ID_QNAME, id))
330 .withChild(augmentationNode).build();
333 public static ContainerNode createFamily() {
334 final DataContainerNodeBuilder<NodeIdentifier, ContainerNode>
335 familyContainerBuilder = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
336 new NodeIdentifier(FAMILY_QNAME));
338 final CollectionNodeBuilder<MapEntryNode, MapNode> childrenBuilder =
339 mapNodeBuilder(CHILDREN_QNAME);
341 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode>
342 firstChildBuilder = mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID);
343 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode>
344 secondChildBuilder = mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID);
346 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode>
347 firstGrandChildBuilder = mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
348 FIRST_GRAND_CHILD_ID);
349 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode>
350 secondGrandChildBuilder = mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
351 SECOND_GRAND_CHILD_ID);
353 firstGrandChildBuilder
355 ImmutableNodes.leafNode(GRAND_CHILD_NUMBER_QNAME,
356 FIRST_GRAND_CHILD_ID)).withChild(
357 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
358 FIRST_GRAND_CHILD_NAME));
360 secondGrandChildBuilder.withChild(
361 ImmutableNodes.leafNode(GRAND_CHILD_NUMBER_QNAME, SECOND_GRAND_CHILD_ID))
362 .withChild(ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME, SECOND_GRAND_CHILD_NAME));
365 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, FIRST_CHILD_ID))
366 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, FIRST_CHILD_NAME))
367 .withChild(mapNodeBuilder(GRAND_CHILDREN_QNAME)
368 .withChild(firstGrandChildBuilder.build())
373 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, SECOND_CHILD_ID))
374 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, SECOND_CHILD_NAME))
375 .withChild(mapNodeBuilder(GRAND_CHILDREN_QNAME)
376 .withChild(firstGrandChildBuilder.build())
379 childrenBuilder.withChild(firstChildBuilder.build());
380 childrenBuilder.withChild(secondChildBuilder.build());
382 return familyContainerBuilder.withChild(childrenBuilder.build()).build();