3 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
11 package org.opendaylight.controller.cluster.datastore.util;
13 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntry;
14 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntryBuilder;
15 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapNodeBuilder;
16 import com.google.common.collect.ImmutableSet;
17 import java.io.InputStream;
18 import java.util.ArrayList;
19 import java.util.HashMap;
20 import java.util.HashSet;
21 import java.util.List;
24 import org.opendaylight.yangtools.yang.common.QName;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
35 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
36 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
45 import org.opendaylight.yangtools.yang.model.api.Module;
46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
47 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
49 public 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_DATE_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,
70 public static final QName MYIDENTITY_QNAME = QName.create(TEST_QNAME,
72 public static final QName SWITCH_FEATURES_QNAME = QName.create(TEST_QNAME,
75 public static final QName AUGMENTED_LIST_QNAME = QName.create(TEST_QNAME,
78 public static final QName OUTER_LIST_QNAME = QName.create(TEST_QNAME,
80 public static final QName INNER_LIST_QNAME = QName.create(TEST_QNAME,
82 public static final QName OUTER_CHOICE_QNAME = QName.create(TEST_QNAME,
84 public static final QName ID_QNAME = QName.create(TEST_QNAME, "id");
85 public static final QName NAME_QNAME = QName.create(TEST_QNAME, "name");
86 public static final QName VALUE_QNAME = QName.create(TEST_QNAME, "value");
87 private static final String DATASTORE_TEST_YANG = "/odl-datastore-test.yang";
88 private static final String DATASTORE_AUG_YANG =
89 "/odl-datastore-augmentation.yang";
90 private static final String DATASTORE_TEST_NOTIFICATION_YANG =
91 "/odl-datastore-test-notification.yang";
94 public static final YangInstanceIdentifier TEST_PATH = YangInstanceIdentifier
96 public static final YangInstanceIdentifier DESC_PATH = YangInstanceIdentifier
97 .builder(TEST_PATH).node(DESC_QNAME).build();
98 public static final YangInstanceIdentifier OUTER_LIST_PATH =
99 YangInstanceIdentifier.builder(TEST_PATH).node(OUTER_LIST_QNAME).build();
100 public static final QName TWO_QNAME = QName.create(TEST_QNAME, "two");
101 public static final QName THREE_QNAME = QName.create(TEST_QNAME, "three");
103 private static final Integer ONE_ID = 1;
104 private static final Integer TWO_ID = 2;
105 private static final String TWO_ONE_NAME = "one";
106 private static final String TWO_TWO_NAME = "two";
107 private static final String DESC = "Hello there";
108 private static final Long LONG_ID = 1L;
109 private static final Boolean ENABLED = false;
110 private static final Short SHORT_ID = 1;
111 private static final Byte BYTE_ID = 1;
112 // Family specific constants
113 public static final QName FAMILY_QNAME =
116 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:notification-test",
117 "2014-04-17", "family");
118 public static final QName CHILDREN_QNAME = QName.create(FAMILY_QNAME,
120 public static final QName GRAND_CHILDREN_QNAME = QName.create(FAMILY_QNAME,
122 public static final QName CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME,
124 public static final QName CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
126 public static final QName GRAND_CHILD_NUMBER_QNAME = QName.create(
127 FAMILY_QNAME, "grand-child-number");
128 public static final QName GRAND_CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
131 public static final YangInstanceIdentifier FAMILY_PATH =
132 YangInstanceIdentifier.of(FAMILY_QNAME);
133 public static final YangInstanceIdentifier FAMILY_DESC_PATH =
134 YangInstanceIdentifier.builder(FAMILY_PATH).node(DESC_QNAME).build();
135 public static final YangInstanceIdentifier CHILDREN_PATH =
136 YangInstanceIdentifier.builder(FAMILY_PATH).node(CHILDREN_QNAME).build();
138 private static final Integer FIRST_CHILD_ID = 1;
139 private static final Integer SECOND_CHILD_ID = 2;
141 private static final String FIRST_CHILD_NAME = "first child";
142 private static final String SECOND_CHILD_NAME = "second child";
144 private static final Integer FIRST_GRAND_CHILD_ID = 1;
145 private static final Integer SECOND_GRAND_CHILD_ID = 2;
147 private static final String FIRST_GRAND_CHILD_NAME = "first grand child";
148 private static final String SECOND_GRAND_CHILD_NAME = "second grand child";
152 private static final YangInstanceIdentifier CHILDREN_1_PATH =
153 YangInstanceIdentifier.builder(CHILDREN_PATH)
154 .nodeWithKey(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID) //
156 private static final YangInstanceIdentifier CHILDREN_1_NAME_PATH =
157 YangInstanceIdentifier.builder(CHILDREN_PATH)
158 .nodeWithKey(CHILDREN_QNAME, CHILD_NAME_QNAME, FIRST_CHILD_NAME) //
161 private static final YangInstanceIdentifier CHILDREN_2_PATH =
162 YangInstanceIdentifier.builder(CHILDREN_PATH)
163 .nodeWithKey(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID) //
165 private static final YangInstanceIdentifier CHILDREN_2_NAME_PATH =
166 YangInstanceIdentifier.builder(CHILDREN_PATH)
167 .nodeWithKey(CHILDREN_QNAME, CHILD_NAME_QNAME, SECOND_CHILD_NAME) //
171 private static final YangInstanceIdentifier GRAND_CHILD_1_PATH =
172 YangInstanceIdentifier
173 .builder(CHILDREN_1_PATH)
174 .node(GRAND_CHILDREN_QNAME)
176 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
177 FIRST_GRAND_CHILD_ID) //
180 private static final YangInstanceIdentifier GRAND_CHILD_1_NAME_PATH =
181 YangInstanceIdentifier
182 .builder(CHILDREN_1_PATH)
183 .node(GRAND_CHILDREN_QNAME)
185 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NAME_QNAME,
186 FIRST_GRAND_CHILD_NAME) //
189 private static final YangInstanceIdentifier GRAND_CHILD_2_PATH =
190 YangInstanceIdentifier
191 .builder(CHILDREN_2_PATH)
192 .node(GRAND_CHILDREN_QNAME)
194 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
195 SECOND_GRAND_CHILD_ID) //
198 private static final YangInstanceIdentifier GRAND_CHILD_2_NAME_PATH =
199 YangInstanceIdentifier
200 .builder(CHILDREN_2_PATH)
201 .node(GRAND_CHILDREN_QNAME)
203 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NAME_QNAME,
204 SECOND_GRAND_CHILD_NAME) //
207 private static final YangInstanceIdentifier DESC_PATH_ID =
208 YangInstanceIdentifier.builder(DESC_PATH).build();
209 private static final YangInstanceIdentifier OUTER_LIST_1_PATH =
210 YangInstanceIdentifier.builder(OUTER_LIST_PATH)
211 .nodeWithKey(OUTER_LIST_QNAME, ID_QNAME, ONE_ID) //
214 private static final YangInstanceIdentifier OUTER_LIST_2_PATH =
215 YangInstanceIdentifier.builder(OUTER_LIST_PATH)
216 .nodeWithKey(OUTER_LIST_QNAME, ID_QNAME, TWO_ID) //
219 private static final YangInstanceIdentifier TWO_TWO_PATH =
220 YangInstanceIdentifier.builder(OUTER_LIST_2_PATH).node(INNER_LIST_QNAME) //
221 .nodeWithKey(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME) //
224 private static final YangInstanceIdentifier TWO_TWO_VALUE_PATH =
225 YangInstanceIdentifier.builder(TWO_TWO_PATH).node(VALUE_QNAME) //
228 private static final MapEntryNode BAR_NODE = mapEntryBuilder(
229 OUTER_LIST_QNAME, ID_QNAME, TWO_ID) //
230 .withChild(mapNodeBuilder(INNER_LIST_QNAME) //
231 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_ONE_NAME)) //
232 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME)) //
236 public static final InputStream getDatastoreTestInputStream() {
237 return getInputStream(DATASTORE_TEST_YANG);
240 public static final InputStream getDatastoreAugInputStream() {
241 return getInputStream(DATASTORE_AUG_YANG);
244 public static final InputStream getDatastoreTestNotificationInputStream() {
245 return getInputStream(DATASTORE_TEST_NOTIFICATION_YANG);
248 private static InputStream getInputStream(final String resourceName) {
249 return TestModel.class.getResourceAsStream(resourceName);
252 public static SchemaContext createTestContext() {
253 List<InputStream> inputStreams = new ArrayList<>();
254 inputStreams.add(getDatastoreTestInputStream());
255 inputStreams.add(getDatastoreAugInputStream());
256 inputStreams.add(getDatastoreTestNotificationInputStream());
258 YangParserImpl parser = new YangParserImpl();
259 Set<Module> modules = parser.parseYangModelsFromStreams(inputStreams);
260 return parser.resolveSchemaContext(modules);
264 * Returns a test document
282 public static NormalizedNode<?, ?> createDocumentOne(
283 SchemaContext schemaContext) {
284 return ImmutableContainerNodeBuilder
287 new YangInstanceIdentifier.NodeIdentifier(schemaContext.getQName()))
288 .withChild(createTestContainer()).build();
292 public static DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> createBaseTestContainerBuilder() {
293 // Create a list of shoes
294 // This is to test leaf list entry
295 final LeafSetEntryNode<Object> nike =
296 ImmutableLeafSetEntryNodeBuilder
299 new YangInstanceIdentifier.NodeWithValue(QName.create(
300 TEST_QNAME, "shoe"), "nike")).withValue("nike").build();
302 final LeafSetEntryNode<Object> puma =
303 ImmutableLeafSetEntryNodeBuilder
306 new YangInstanceIdentifier.NodeWithValue(QName.create(
307 TEST_QNAME, "shoe"), "puma")).withValue("puma").build();
309 final LeafSetNode<Object> shoes =
310 ImmutableLeafSetNodeBuilder
313 new YangInstanceIdentifier.NodeIdentifier(QName.create(
314 TEST_QNAME, "shoe"))).withChild(nike).withChild(puma)
318 // Test a leaf-list where each entry contains an identity
319 final LeafSetEntryNode<Object> cap1 =
320 ImmutableLeafSetEntryNodeBuilder
323 new YangInstanceIdentifier.NodeWithValue(QName.create(
324 TEST_QNAME, "capability"), DESC_QNAME))
325 .withValue(DESC_QNAME).build();
327 final LeafSetNode<Object> capabilities =
328 ImmutableLeafSetNodeBuilder
331 new YangInstanceIdentifier.NodeIdentifier(QName.create(
332 TEST_QNAME, "capability"))).withChild(cap1).build();
334 ContainerNode switchFeatures =
335 ImmutableContainerNodeBuilder
338 new YangInstanceIdentifier.NodeIdentifier(SWITCH_FEATURES_QNAME))
339 .withChild(capabilities).build();
341 // Create a leaf list with numbers
342 final LeafSetEntryNode<Object> five =
343 ImmutableLeafSetEntryNodeBuilder
346 (new YangInstanceIdentifier.NodeWithValue(QName.create(
347 TEST_QNAME, "number"), 5))).withValue(5).build();
348 final LeafSetEntryNode<Object> fifteen =
349 ImmutableLeafSetEntryNodeBuilder
352 (new YangInstanceIdentifier.NodeWithValue(QName.create(
353 TEST_QNAME, "number"), 15))).withValue(15).build();
354 final LeafSetNode<Object> numbers =
355 ImmutableLeafSetNodeBuilder
358 new YangInstanceIdentifier.NodeIdentifier(QName.create(
359 TEST_QNAME, "number"))).withChild(five).withChild(fifteen)
363 // Create augmentations
364 MapEntryNode mapEntry = createAugmentedListEntry(1, "First Test");
366 // Create a bits leaf
367 NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>>
368 myBits = Builders.leafBuilder().withNodeIdentifier(
369 new YangInstanceIdentifier.NodeIdentifier(
370 QName.create(TEST_QNAME, "my-bits"))).withValue(
371 ImmutableSet.of("foo", "bar"));
373 // Create unkey list entry
374 UnkeyedListEntryNode binaryDataKey =
375 Builders.unkeyedListEntryBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME)).
376 withChild(ImmutableNodes.leafNode(SOME_BINARY_DATE_QNAME, DESC)).build();
378 Map<QName, Object> keyValues = new HashMap<>();
379 keyValues.put(CHILDREN_QNAME, FIRST_CHILD_NAME);
382 // Create the document
383 return ImmutableContainerNodeBuilder
386 new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME))
387 .withChild(myBits.build())
388 .withChild(ImmutableNodes.leafNode(DESC_QNAME, DESC))
389 .withChild(ImmutableNodes.leafNode(POINTER_QNAME, ENABLED))
390 .withChild(ImmutableNodes.leafNode(POINTER_QNAME, SHORT_ID))
391 .withChild(ImmutableNodes.leafNode(POINTER_QNAME, BYTE_ID))
393 ImmutableNodes.leafNode(SOME_REF_QNAME, GRAND_CHILD_1_PATH))
394 .withChild(ImmutableNodes.leafNode(MYIDENTITY_QNAME, DESC_QNAME))
395 .withChild(Builders.unkeyedListBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(OUTER_LIST_QNAME))
396 .withChild(binaryDataKey).build())
397 .withChild(Builders.orderedMapBuilder()
398 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME)).withChild(mapEntry).build())
399 .withChild(Builders.choiceBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME))
400 .withChild(ImmutableNodes.leafNode(DESC_QNAME, LONG_ID)).build())
401 // .withChild(augmentationNode)
404 .withChild(switchFeatures)
406 mapNodeBuilder(AUGMENTED_LIST_QNAME).withChild(mapEntry).build())
408 mapNodeBuilder(OUTER_LIST_QNAME)
409 .withChild(mapEntry(OUTER_LIST_QNAME, ID_QNAME, ONE_ID))
410 .withChild(BAR_NODE).build()
414 public static ContainerNode createTestContainer() {
415 return createBaseTestContainerBuilder().build();
418 public static MapEntryNode createAugmentedListEntry(int id, String name) {
420 Set<QName> childAugmentations = new HashSet<>();
421 childAugmentations.add(AUG_CONT_QNAME);
423 ContainerNode augCont =
424 ImmutableContainerNodeBuilder
427 new YangInstanceIdentifier.NodeIdentifier(AUG_CONT_QNAME))
428 .withChild(ImmutableNodes.leafNode(AUG_NAME_QNAME, name)).build();
431 final YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier =
432 new YangInstanceIdentifier.AugmentationIdentifier(childAugmentations);
434 final AugmentationNode augmentationNode =
435 Builders.augmentationBuilder()
436 .withNodeIdentifier(augmentationIdentifier).withChild(augCont)
439 return ImmutableMapEntryNodeBuilder
442 new YangInstanceIdentifier.NodeIdentifierWithPredicates(
443 AUGMENTED_LIST_QNAME, ID_QNAME, id))
444 .withChild(ImmutableNodes.leafNode(ID_QNAME, id))
445 .withChild(augmentationNode).build();
449 public static ContainerNode createFamily() {
450 final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> familyContainerBuilder =
451 ImmutableContainerNodeBuilder.create().withNodeIdentifier(
452 new YangInstanceIdentifier.NodeIdentifier(FAMILY_QNAME));
454 final CollectionNodeBuilder<MapEntryNode, MapNode> childrenBuilder =
455 mapNodeBuilder(CHILDREN_QNAME);
457 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstChildBuilder =
458 mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID);
459 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondChildBuilder =
460 mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID);
462 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstGrandChildBuilder =
463 mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
464 FIRST_GRAND_CHILD_ID);
465 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondGrandChildBuilder =
466 mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
467 SECOND_GRAND_CHILD_ID);
469 firstGrandChildBuilder
471 ImmutableNodes.leafNode(GRAND_CHILD_NUMBER_QNAME,
472 FIRST_GRAND_CHILD_ID)).withChild(
473 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
474 FIRST_GRAND_CHILD_NAME));
476 secondGrandChildBuilder.withChild(
478 .leafNode(GRAND_CHILD_NUMBER_QNAME, SECOND_GRAND_CHILD_ID))
480 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
481 SECOND_GRAND_CHILD_NAME));
484 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, FIRST_CHILD_ID))
485 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, FIRST_CHILD_NAME))
487 mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
488 firstGrandChildBuilder.build()).build());
492 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, SECOND_CHILD_ID))
493 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, SECOND_CHILD_NAME))
495 mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
496 firstGrandChildBuilder.build()).build());
498 childrenBuilder.withChild(firstChildBuilder.build());
499 childrenBuilder.withChild(secondChildBuilder.build());
501 return familyContainerBuilder.withChild(childrenBuilder.build()).build();