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 com.google.common.collect.ImmutableSet;
14 import org.opendaylight.yangtools.yang.common.QName;
15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
16 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
17 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
18 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
19 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
20 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
21 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
22 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
23 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
24 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
25 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
26 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
27 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
28 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
29 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
35 import org.opendaylight.yangtools.yang.model.api.Module;
36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
37 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
39 import java.io.InputStream;
40 import java.util.ArrayList;
41 import java.util.HashMap;
42 import java.util.HashSet;
43 import java.util.List;
47 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntry;
48 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntryBuilder;
49 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapNodeBuilder;
51 public class TestModel {
53 public static final QName TEST_QNAME = QName.create(
54 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:test",
55 "2014-03-13", "test");
57 public static final QName AUG_NAME_QNAME = QName.create(
58 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug",
59 "2014-03-13", "name");
61 public static final QName AUG_CONT_QNAME = QName.create(
62 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug",
63 "2014-03-13", "cont");
66 public static final QName DESC_QNAME = QName.create(TEST_QNAME, "desc");
67 public static final QName POINTER_QNAME = QName.create(TEST_QNAME, "pointer");
68 public static final QName SOME_BINARY_DATE_QNAME = QName.create(TEST_QNAME, "some-binary-data");
69 public static final QName SOME_REF_QNAME = QName.create(TEST_QNAME,
71 public static final QName MYIDENTITY_QNAME = QName.create(TEST_QNAME,
73 public static final QName SWITCH_FEATURES_QNAME = QName.create(TEST_QNAME,
76 public static final QName AUGMENTED_LIST_QNAME = QName.create(TEST_QNAME,
79 public static final QName OUTER_LIST_QNAME = QName.create(TEST_QNAME,
81 public static final QName INNER_LIST_QNAME = QName.create(TEST_QNAME,
83 public static final QName OUTER_CHOICE_QNAME = QName.create(TEST_QNAME,
85 public static final QName ID_QNAME = QName.create(TEST_QNAME, "id");
86 public static final QName NAME_QNAME = QName.create(TEST_QNAME, "name");
87 public static final QName VALUE_QNAME = QName.create(TEST_QNAME, "value");
88 private static final String DATASTORE_TEST_YANG = "/odl-datastore-test.yang";
89 private static final String DATASTORE_AUG_YANG =
90 "/odl-datastore-augmentation.yang";
91 private static final String DATASTORE_TEST_NOTIFICATION_YANG =
92 "/odl-datastore-test-notification.yang";
95 public static final YangInstanceIdentifier TEST_PATH = YangInstanceIdentifier
97 public static final YangInstanceIdentifier DESC_PATH = YangInstanceIdentifier
98 .builder(TEST_PATH).node(DESC_QNAME).build();
99 public static final YangInstanceIdentifier OUTER_LIST_PATH =
100 YangInstanceIdentifier.builder(TEST_PATH).node(OUTER_LIST_QNAME).build();
101 public static final QName TWO_QNAME = QName.create(TEST_QNAME, "two");
102 public static final QName THREE_QNAME = QName.create(TEST_QNAME, "three");
104 private static final Integer ONE_ID = 1;
105 private static final Integer TWO_ID = 2;
106 private static final String TWO_ONE_NAME = "one";
107 private static final String TWO_TWO_NAME = "two";
108 private static final String DESC = "Hello there";
109 private static final Long LONG_ID = 1L;
110 private static final Boolean ENABLED = false;
111 private static final Short SHORT_ID = 1;
112 private static final Byte BYTE_ID = 1;
113 // Family specific constants
114 public static final QName FAMILY_QNAME =
117 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:notification-test",
118 "2014-04-17", "family");
119 public static final QName CHILDREN_QNAME = QName.create(FAMILY_QNAME,
121 public static final QName GRAND_CHILDREN_QNAME = QName.create(FAMILY_QNAME,
123 public static final QName CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME,
125 public static final QName CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
127 public static final QName GRAND_CHILD_NUMBER_QNAME = QName.create(
128 FAMILY_QNAME, "grand-child-number");
129 public static final QName GRAND_CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
132 public static final YangInstanceIdentifier FAMILY_PATH =
133 YangInstanceIdentifier.of(FAMILY_QNAME);
134 public static final YangInstanceIdentifier FAMILY_DESC_PATH =
135 YangInstanceIdentifier.builder(FAMILY_PATH).node(DESC_QNAME).build();
136 public static final YangInstanceIdentifier CHILDREN_PATH =
137 YangInstanceIdentifier.builder(FAMILY_PATH).node(CHILDREN_QNAME).build();
139 private static final Integer FIRST_CHILD_ID = 1;
140 private static final Integer SECOND_CHILD_ID = 2;
142 private static final String FIRST_CHILD_NAME = "first child";
143 private static final String SECOND_CHILD_NAME = "second child";
145 private static final Integer FIRST_GRAND_CHILD_ID = 1;
146 private static final Integer SECOND_GRAND_CHILD_ID = 2;
148 private static final String FIRST_GRAND_CHILD_NAME = "first grand child";
149 private static final String SECOND_GRAND_CHILD_NAME = "second grand child";
153 private static final YangInstanceIdentifier CHILDREN_1_PATH =
154 YangInstanceIdentifier.builder(CHILDREN_PATH)
155 .nodeWithKey(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID) //
157 private static final YangInstanceIdentifier CHILDREN_1_NAME_PATH =
158 YangInstanceIdentifier.builder(CHILDREN_PATH)
159 .nodeWithKey(CHILDREN_QNAME, CHILD_NAME_QNAME, FIRST_CHILD_NAME) //
162 private static final YangInstanceIdentifier CHILDREN_2_PATH =
163 YangInstanceIdentifier.builder(CHILDREN_PATH)
164 .nodeWithKey(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID) //
166 private static final YangInstanceIdentifier CHILDREN_2_NAME_PATH =
167 YangInstanceIdentifier.builder(CHILDREN_PATH)
168 .nodeWithKey(CHILDREN_QNAME, CHILD_NAME_QNAME, SECOND_CHILD_NAME) //
172 private static final YangInstanceIdentifier GRAND_CHILD_1_PATH =
173 YangInstanceIdentifier
174 .builder(CHILDREN_1_PATH)
175 .node(GRAND_CHILDREN_QNAME)
177 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
178 FIRST_GRAND_CHILD_ID) //
181 private static final YangInstanceIdentifier GRAND_CHILD_1_NAME_PATH =
182 YangInstanceIdentifier
183 .builder(CHILDREN_1_PATH)
184 .node(GRAND_CHILDREN_QNAME)
186 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NAME_QNAME,
187 FIRST_GRAND_CHILD_NAME) //
190 private static final YangInstanceIdentifier GRAND_CHILD_2_PATH =
191 YangInstanceIdentifier
192 .builder(CHILDREN_2_PATH)
193 .node(GRAND_CHILDREN_QNAME)
195 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
196 SECOND_GRAND_CHILD_ID) //
199 private static final YangInstanceIdentifier GRAND_CHILD_2_NAME_PATH =
200 YangInstanceIdentifier
201 .builder(CHILDREN_2_PATH)
202 .node(GRAND_CHILDREN_QNAME)
204 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NAME_QNAME,
205 SECOND_GRAND_CHILD_NAME) //
208 private static final YangInstanceIdentifier DESC_PATH_ID =
209 YangInstanceIdentifier.builder(DESC_PATH).build();
210 private static final YangInstanceIdentifier OUTER_LIST_1_PATH =
211 YangInstanceIdentifier.builder(OUTER_LIST_PATH)
212 .nodeWithKey(OUTER_LIST_QNAME, ID_QNAME, ONE_ID) //
215 private static final YangInstanceIdentifier OUTER_LIST_2_PATH =
216 YangInstanceIdentifier.builder(OUTER_LIST_PATH)
217 .nodeWithKey(OUTER_LIST_QNAME, ID_QNAME, TWO_ID) //
220 private static final YangInstanceIdentifier TWO_TWO_PATH =
221 YangInstanceIdentifier.builder(OUTER_LIST_2_PATH).node(INNER_LIST_QNAME) //
222 .nodeWithKey(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME) //
225 private static final YangInstanceIdentifier TWO_TWO_VALUE_PATH =
226 YangInstanceIdentifier.builder(TWO_TWO_PATH).node(VALUE_QNAME) //
229 private static final MapEntryNode BAR_NODE = mapEntryBuilder(
230 OUTER_LIST_QNAME, ID_QNAME, TWO_ID) //
231 .withChild(mapNodeBuilder(INNER_LIST_QNAME) //
232 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_ONE_NAME)) //
233 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME)) //
237 public static final InputStream getDatastoreTestInputStream() {
238 return getInputStream(DATASTORE_TEST_YANG);
241 public static final InputStream getDatastoreAugInputStream() {
242 return getInputStream(DATASTORE_AUG_YANG);
245 public static final InputStream getDatastoreTestNotificationInputStream() {
246 return getInputStream(DATASTORE_TEST_NOTIFICATION_YANG);
249 private static InputStream getInputStream(final String resourceName) {
250 return TestModel.class.getResourceAsStream(resourceName);
253 public static SchemaContext createTestContext() {
254 List<InputStream> inputStreams = new ArrayList<>();
255 inputStreams.add(getDatastoreTestInputStream());
256 inputStreams.add(getDatastoreAugInputStream());
257 inputStreams.add(getDatastoreTestNotificationInputStream());
259 YangParserImpl parser = new YangParserImpl();
260 Set<Module> modules = parser.parseYangModelsFromStreams(inputStreams);
261 return parser.resolveSchemaContext(modules);
265 * Returns a test document
283 public static NormalizedNode<?, ?> createDocumentOne(
284 SchemaContext schemaContext) {
285 return ImmutableContainerNodeBuilder
288 new YangInstanceIdentifier.NodeIdentifier(schemaContext.getQName()))
289 .withChild(createTestContainer()).build();
293 public static DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> createBaseTestContainerBuilder() {
294 // Create a list of shoes
295 // This is to test leaf list entry
296 final LeafSetEntryNode<Object> nike =
297 ImmutableLeafSetEntryNodeBuilder
300 new YangInstanceIdentifier.NodeWithValue(QName.create(
301 TEST_QNAME, "shoe"), "nike")).withValue("nike").build();
303 final LeafSetEntryNode<Object> puma =
304 ImmutableLeafSetEntryNodeBuilder
307 new YangInstanceIdentifier.NodeWithValue(QName.create(
308 TEST_QNAME, "shoe"), "puma")).withValue("puma").build();
310 final LeafSetNode<Object> shoes =
311 ImmutableLeafSetNodeBuilder
314 new YangInstanceIdentifier.NodeIdentifier(QName.create(
315 TEST_QNAME, "shoe"))).withChild(nike).withChild(puma)
319 // Test a leaf-list where each entry contains an identity
320 final LeafSetEntryNode<Object> cap1 =
321 ImmutableLeafSetEntryNodeBuilder
324 new YangInstanceIdentifier.NodeWithValue(QName.create(
325 TEST_QNAME, "capability"), DESC_QNAME))
326 .withValue(DESC_QNAME).build();
328 final LeafSetNode<Object> capabilities =
329 ImmutableLeafSetNodeBuilder
332 new YangInstanceIdentifier.NodeIdentifier(QName.create(
333 TEST_QNAME, "capability"))).withChild(cap1).build();
335 ContainerNode switchFeatures =
336 ImmutableContainerNodeBuilder
339 new YangInstanceIdentifier.NodeIdentifier(SWITCH_FEATURES_QNAME))
340 .withChild(capabilities).build();
342 // Create a leaf list with numbers
343 final LeafSetEntryNode<Object> five =
344 ImmutableLeafSetEntryNodeBuilder
347 (new YangInstanceIdentifier.NodeWithValue(QName.create(
348 TEST_QNAME, "number"), 5))).withValue(5).build();
349 final LeafSetEntryNode<Object> fifteen =
350 ImmutableLeafSetEntryNodeBuilder
353 (new YangInstanceIdentifier.NodeWithValue(QName.create(
354 TEST_QNAME, "number"), 15))).withValue(15).build();
355 final LeafSetNode<Object> numbers =
356 ImmutableLeafSetNodeBuilder
359 new YangInstanceIdentifier.NodeIdentifier(QName.create(
360 TEST_QNAME, "number"))).withChild(five).withChild(fifteen)
364 // Create augmentations
365 MapEntryNode mapEntry = createAugmentedListEntry(1, "First Test");
367 // Create a bits leaf
368 NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>>
369 myBits = Builders.leafBuilder().withNodeIdentifier(
370 new YangInstanceIdentifier.NodeIdentifier(
371 QName.create(TEST_QNAME, "my-bits"))).withValue(
372 ImmutableSet.of("foo", "bar"));
374 // Create unkey list entry
375 UnkeyedListEntryNode binaryDataKey =
376 Builders.unkeyedListEntryBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME)).
377 withChild(ImmutableNodes.leafNode(SOME_BINARY_DATE_QNAME, DESC)).build();
379 Map<QName, Object> keyValues = new HashMap<>();
380 keyValues.put(CHILDREN_QNAME, FIRST_CHILD_NAME);
383 // Create the document
384 return ImmutableContainerNodeBuilder
387 new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME))
388 .withChild(myBits.build())
389 .withChild(ImmutableNodes.leafNode(DESC_QNAME, DESC))
390 .withChild(ImmutableNodes.leafNode(POINTER_QNAME, ENABLED))
391 .withChild(ImmutableNodes.leafNode(POINTER_QNAME, SHORT_ID))
392 .withChild(ImmutableNodes.leafNode(POINTER_QNAME, BYTE_ID))
394 ImmutableNodes.leafNode(SOME_REF_QNAME, GRAND_CHILD_1_PATH))
395 .withChild(ImmutableNodes.leafNode(MYIDENTITY_QNAME, DESC_QNAME))
396 .withChild(Builders.unkeyedListBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(OUTER_LIST_QNAME))
397 .withChild(binaryDataKey).build())
398 .withChild(Builders.orderedMapBuilder()
399 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME)).withChild(mapEntry).build())
400 .withChild(Builders.choiceBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME))
401 .withChild(ImmutableNodes.leafNode(DESC_QNAME, LONG_ID)).build())
402 // .withChild(augmentationNode)
405 .withChild(switchFeatures)
407 mapNodeBuilder(AUGMENTED_LIST_QNAME).withChild(mapEntry).build())
409 mapNodeBuilder(OUTER_LIST_QNAME)
410 .withChild(mapEntry(OUTER_LIST_QNAME, ID_QNAME, ONE_ID))
411 .withChild(BAR_NODE).build()
415 public static ContainerNode createTestContainer() {
416 return createBaseTestContainerBuilder().build();
419 public static MapEntryNode createAugmentedListEntry(int id, String name) {
421 Set<QName> childAugmentations = new HashSet<>();
422 childAugmentations.add(AUG_CONT_QNAME);
424 ContainerNode augCont =
425 ImmutableContainerNodeBuilder
428 new YangInstanceIdentifier.NodeIdentifier(AUG_CONT_QNAME))
429 .withChild(ImmutableNodes.leafNode(AUG_NAME_QNAME, name)).build();
432 final YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier =
433 new YangInstanceIdentifier.AugmentationIdentifier(childAugmentations);
435 final AugmentationNode augmentationNode =
436 Builders.augmentationBuilder()
437 .withNodeIdentifier(augmentationIdentifier).withChild(augCont)
440 return ImmutableMapEntryNodeBuilder
443 new YangInstanceIdentifier.NodeIdentifierWithPredicates(
444 AUGMENTED_LIST_QNAME, ID_QNAME, id))
445 .withChild(ImmutableNodes.leafNode(ID_QNAME, id))
446 .withChild(augmentationNode).build();
450 public static ContainerNode createFamily() {
451 final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> familyContainerBuilder =
452 ImmutableContainerNodeBuilder.create().withNodeIdentifier(
453 new YangInstanceIdentifier.NodeIdentifier(FAMILY_QNAME));
455 final CollectionNodeBuilder<MapEntryNode, MapNode> childrenBuilder =
456 mapNodeBuilder(CHILDREN_QNAME);
458 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstChildBuilder =
459 mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID);
460 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondChildBuilder =
461 mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID);
463 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstGrandChildBuilder =
464 mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
465 FIRST_GRAND_CHILD_ID);
466 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondGrandChildBuilder =
467 mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
468 SECOND_GRAND_CHILD_ID);
470 firstGrandChildBuilder
472 ImmutableNodes.leafNode(GRAND_CHILD_NUMBER_QNAME,
473 FIRST_GRAND_CHILD_ID)).withChild(
474 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
475 FIRST_GRAND_CHILD_NAME));
477 secondGrandChildBuilder.withChild(
479 .leafNode(GRAND_CHILD_NUMBER_QNAME, SECOND_GRAND_CHILD_ID))
481 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
482 SECOND_GRAND_CHILD_NAME));
485 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, FIRST_CHILD_ID))
486 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, FIRST_CHILD_NAME))
488 mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
489 firstGrandChildBuilder.build()).build());
493 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, SECOND_CHILD_ID))
494 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, SECOND_CHILD_NAME))
496 mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
497 firstGrandChildBuilder.build()).build());
499 childrenBuilder.withChild(firstChildBuilder.build());
500 childrenBuilder.withChild(secondChildBuilder.build());
502 return familyContainerBuilder.withChild(childrenBuilder.build()).build();