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.impl.schema.Builders;
25 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
26 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
27 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
28 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
29 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
34 import org.opendaylight.yangtools.yang.model.api.Module;
35 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
36 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
38 import java.io.InputStream;
39 import java.util.ArrayList;
40 import java.util.HashSet;
41 import java.util.List;
44 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntry;
45 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntryBuilder;
46 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapNodeBuilder;
48 public class TestModel {
50 public static final QName TEST_QNAME = QName.create(
51 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:test",
52 "2014-03-13", "test");
54 public static final QName AUG_NAME_QNAME = QName.create(
55 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug",
56 "2014-03-13", "name");
58 public static final QName AUG_CONT_QNAME = QName.create(
59 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug",
60 "2014-03-13", "cont");
63 public static final QName DESC_QNAME = QName.create(TEST_QNAME, "desc");
64 public static final QName POINTER_QNAME = QName.create(TEST_QNAME, "pointer");
65 public static final QName SOME_REF_QNAME = QName.create(TEST_QNAME,
67 public static final QName MYIDENTITY_QNAME = QName.create(TEST_QNAME,
69 public static final QName SWITCH_FEATURES_QNAME = QName.create(TEST_QNAME,
72 public static final QName AUGMENTED_LIST_QNAME = QName.create(TEST_QNAME,
75 public static final QName OUTER_LIST_QNAME = QName.create(TEST_QNAME,
77 public static final QName INNER_LIST_QNAME = QName.create(TEST_QNAME,
79 public static final QName OUTER_CHOICE_QNAME = QName.create(TEST_QNAME,
81 public static final QName ID_QNAME = QName.create(TEST_QNAME, "id");
82 public static final QName NAME_QNAME = QName.create(TEST_QNAME, "name");
83 public static final QName VALUE_QNAME = QName.create(TEST_QNAME, "value");
84 private static final String DATASTORE_TEST_YANG = "/odl-datastore-test.yang";
85 private static final String DATASTORE_AUG_YANG =
86 "/odl-datastore-augmentation.yang";
87 private static final String DATASTORE_TEST_NOTIFICATION_YANG =
88 "/odl-datastore-test-notification.yang";
91 public static final YangInstanceIdentifier TEST_PATH = YangInstanceIdentifier
93 public static final YangInstanceIdentifier DESC_PATH = YangInstanceIdentifier
94 .builder(TEST_PATH).node(DESC_QNAME).build();
95 public static final YangInstanceIdentifier OUTER_LIST_PATH =
96 YangInstanceIdentifier.builder(TEST_PATH).node(OUTER_LIST_QNAME).build();
97 public static final QName TWO_QNAME = QName.create(TEST_QNAME, "two");
98 public static final QName THREE_QNAME = QName.create(TEST_QNAME, "three");
100 private static final Integer ONE_ID = 1;
101 private static final Integer TWO_ID = 2;
102 private static final String TWO_ONE_NAME = "one";
103 private static final String TWO_TWO_NAME = "two";
104 private static final String DESC = "Hello there";
106 // Family specific constants
107 public static final QName FAMILY_QNAME =
110 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:notification-test",
111 "2014-04-17", "family");
112 public static final QName CHILDREN_QNAME = QName.create(FAMILY_QNAME,
114 public static final QName GRAND_CHILDREN_QNAME = QName.create(FAMILY_QNAME,
116 public static final QName CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME,
118 public static final QName CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
120 public static final QName GRAND_CHILD_NUMBER_QNAME = QName.create(
121 FAMILY_QNAME, "grand-child-number");
122 public static final QName GRAND_CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
125 public static final YangInstanceIdentifier FAMILY_PATH =
126 YangInstanceIdentifier.of(FAMILY_QNAME);
127 public static final YangInstanceIdentifier FAMILY_DESC_PATH =
128 YangInstanceIdentifier.builder(FAMILY_PATH).node(DESC_QNAME).build();
129 public static final YangInstanceIdentifier CHILDREN_PATH =
130 YangInstanceIdentifier.builder(FAMILY_PATH).node(CHILDREN_QNAME).build();
132 private static final Integer FIRST_CHILD_ID = 1;
133 private static final Integer SECOND_CHILD_ID = 2;
135 private static final String FIRST_CHILD_NAME = "first child";
136 private static final String SECOND_CHILD_NAME = "second child";
138 private static final Integer FIRST_GRAND_CHILD_ID = 1;
139 private static final Integer SECOND_GRAND_CHILD_ID = 2;
141 private static final String FIRST_GRAND_CHILD_NAME = "first grand child";
142 private static final String SECOND_GRAND_CHILD_NAME = "second grand child";
145 private static final YangInstanceIdentifier CHILDREN_1_PATH =
146 YangInstanceIdentifier.builder(CHILDREN_PATH)
147 .nodeWithKey(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID) //
149 private static final YangInstanceIdentifier CHILDREN_1_NAME_PATH =
150 YangInstanceIdentifier.builder(CHILDREN_PATH)
151 .nodeWithKey(CHILDREN_QNAME, CHILD_NAME_QNAME, FIRST_CHILD_NAME) //
154 private static final YangInstanceIdentifier CHILDREN_2_PATH =
155 YangInstanceIdentifier.builder(CHILDREN_PATH)
156 .nodeWithKey(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID) //
158 private static final YangInstanceIdentifier CHILDREN_2_NAME_PATH =
159 YangInstanceIdentifier.builder(CHILDREN_PATH)
160 .nodeWithKey(CHILDREN_QNAME, CHILD_NAME_QNAME, SECOND_CHILD_NAME) //
164 private static final YangInstanceIdentifier GRAND_CHILD_1_PATH =
165 YangInstanceIdentifier
166 .builder(CHILDREN_1_PATH)
167 .node(GRAND_CHILDREN_QNAME)
169 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
170 FIRST_GRAND_CHILD_ID) //
173 private static final YangInstanceIdentifier GRAND_CHILD_1_NAME_PATH =
174 YangInstanceIdentifier
175 .builder(CHILDREN_1_PATH)
176 .node(GRAND_CHILDREN_QNAME)
178 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NAME_QNAME,
179 FIRST_GRAND_CHILD_NAME) //
182 private static final YangInstanceIdentifier GRAND_CHILD_2_PATH =
183 YangInstanceIdentifier
184 .builder(CHILDREN_2_PATH)
185 .node(GRAND_CHILDREN_QNAME)
187 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
188 SECOND_GRAND_CHILD_ID) //
191 private static final YangInstanceIdentifier GRAND_CHILD_2_NAME_PATH =
192 YangInstanceIdentifier
193 .builder(CHILDREN_2_PATH)
194 .node(GRAND_CHILDREN_QNAME)
196 .nodeWithKey(GRAND_CHILDREN_QNAME, GRAND_CHILD_NAME_QNAME,
197 SECOND_GRAND_CHILD_NAME) //
200 private static final YangInstanceIdentifier DESC_PATH_ID =
201 YangInstanceIdentifier.builder(DESC_PATH).build();
202 private static final YangInstanceIdentifier OUTER_LIST_1_PATH =
203 YangInstanceIdentifier.builder(OUTER_LIST_PATH)
204 .nodeWithKey(OUTER_LIST_QNAME, ID_QNAME, ONE_ID) //
207 private static final YangInstanceIdentifier OUTER_LIST_2_PATH =
208 YangInstanceIdentifier.builder(OUTER_LIST_PATH)
209 .nodeWithKey(OUTER_LIST_QNAME, ID_QNAME, TWO_ID) //
212 private static final YangInstanceIdentifier TWO_TWO_PATH =
213 YangInstanceIdentifier.builder(OUTER_LIST_2_PATH).node(INNER_LIST_QNAME) //
214 .nodeWithKey(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME) //
217 private static final YangInstanceIdentifier TWO_TWO_VALUE_PATH =
218 YangInstanceIdentifier.builder(TWO_TWO_PATH).node(VALUE_QNAME) //
221 private static final MapEntryNode BAR_NODE = mapEntryBuilder(
222 OUTER_LIST_QNAME, ID_QNAME, TWO_ID) //
223 .withChild(mapNodeBuilder(INNER_LIST_QNAME) //
224 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_ONE_NAME)) //
225 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME)) //
229 public static final InputStream getDatastoreTestInputStream() {
230 return getInputStream(DATASTORE_TEST_YANG);
233 public static final InputStream getDatastoreAugInputStream() {
234 return getInputStream(DATASTORE_AUG_YANG);
237 public static final InputStream getDatastoreTestNotificationInputStream() {
238 return getInputStream(DATASTORE_TEST_NOTIFICATION_YANG);
241 private static InputStream getInputStream(final String resourceName) {
242 return TestModel.class.getResourceAsStream(resourceName);
245 public static SchemaContext createTestContext() {
246 List<InputStream> inputStreams = new ArrayList<>();
247 inputStreams.add(getDatastoreTestInputStream());
248 inputStreams.add(getDatastoreAugInputStream());
249 inputStreams.add(getDatastoreTestNotificationInputStream());
251 YangParserImpl parser = new YangParserImpl();
252 Set<Module> modules = parser.parseYangModelsFromStreams(inputStreams);
253 return parser.resolveSchemaContext(modules);
257 * Returns a test document
275 public static NormalizedNode<?, ?> createDocumentOne(
276 SchemaContext schemaContext) {
277 return ImmutableContainerNodeBuilder
280 new YangInstanceIdentifier.NodeIdentifier(schemaContext.getQName()))
281 .withChild(createTestContainer()).build();
285 public static ContainerNode createTestContainer() {
288 // Create a list of shoes
289 // This is to test leaf list entry
290 final LeafSetEntryNode<Object> nike =
291 ImmutableLeafSetEntryNodeBuilder
294 new YangInstanceIdentifier.NodeWithValue(QName.create(
295 TEST_QNAME, "shoe"), "nike")).withValue("nike").build();
297 final LeafSetEntryNode<Object> puma =
298 ImmutableLeafSetEntryNodeBuilder
301 new YangInstanceIdentifier.NodeWithValue(QName.create(
302 TEST_QNAME, "shoe"), "puma")).withValue("puma").build();
304 final LeafSetNode<Object> shoes =
305 ImmutableLeafSetNodeBuilder
308 new YangInstanceIdentifier.NodeIdentifier(QName.create(
309 TEST_QNAME, "shoe"))).withChild(nike).withChild(puma)
313 // Test a leaf-list where each entry contains an identity
314 final LeafSetEntryNode<Object> cap1 =
315 ImmutableLeafSetEntryNodeBuilder
318 new YangInstanceIdentifier.NodeWithValue(QName.create(
319 TEST_QNAME, "capability"), DESC_QNAME))
320 .withValue(DESC_QNAME).build();
322 final LeafSetNode<Object> capabilities =
323 ImmutableLeafSetNodeBuilder
326 new YangInstanceIdentifier.NodeIdentifier(QName.create(
327 TEST_QNAME, "capability"))).withChild(cap1).build();
329 ContainerNode switchFeatures =
330 ImmutableContainerNodeBuilder
333 new YangInstanceIdentifier.NodeIdentifier(SWITCH_FEATURES_QNAME))
334 .withChild(capabilities).build();
336 // Create a leaf list with numbers
337 final LeafSetEntryNode<Object> five =
338 ImmutableLeafSetEntryNodeBuilder
341 (new YangInstanceIdentifier.NodeWithValue(QName.create(
342 TEST_QNAME, "number"), 5))).withValue(5).build();
343 final LeafSetEntryNode<Object> fifteen =
344 ImmutableLeafSetEntryNodeBuilder
347 (new YangInstanceIdentifier.NodeWithValue(QName.create(
348 TEST_QNAME, "number"), 15))).withValue(15).build();
349 final LeafSetNode<Object> numbers =
350 ImmutableLeafSetNodeBuilder
353 new YangInstanceIdentifier.NodeIdentifier(QName.create(
354 TEST_QNAME, "number"))).withChild(five).withChild(fifteen)
358 // Create augmentations
359 MapEntryNode mapEntry = createAugmentedListEntry(1, "First Test");
361 // Create a bits leaf
362 NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>>
363 myBits = Builders.leafBuilder().withNodeIdentifier(
364 new YangInstanceIdentifier.NodeIdentifier(
365 QName.create(TEST_QNAME, "my-bits"))).withValue(
366 ImmutableSet.of("foo", "bar"));
369 // Create the document
370 return ImmutableContainerNodeBuilder
373 new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME))
374 .withChild(myBits.build())
375 .withChild(ImmutableNodes.leafNode(DESC_QNAME, DESC))
376 .withChild(ImmutableNodes.leafNode(POINTER_QNAME, "pointer"))
378 ImmutableNodes.leafNode(SOME_REF_QNAME, YangInstanceIdentifier
380 .withChild(ImmutableNodes.leafNode(MYIDENTITY_QNAME, DESC_QNAME))
382 // .withChild(augmentationNode)
385 .withChild(switchFeatures)
387 mapNodeBuilder(AUGMENTED_LIST_QNAME).withChild(mapEntry).build())
389 mapNodeBuilder(OUTER_LIST_QNAME)
390 .withChild(mapEntry(OUTER_LIST_QNAME, ID_QNAME, ONE_ID))
391 .withChild(BAR_NODE).build()).build();
395 public static MapEntryNode createAugmentedListEntry(int id, String name) {
397 Set<QName> childAugmentations = new HashSet<>();
398 childAugmentations.add(AUG_CONT_QNAME);
400 ContainerNode augCont =
401 ImmutableContainerNodeBuilder
404 new YangInstanceIdentifier.NodeIdentifier(AUG_CONT_QNAME))
405 .withChild(ImmutableNodes.leafNode(AUG_NAME_QNAME, name)).build();
408 final YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier =
409 new YangInstanceIdentifier.AugmentationIdentifier(childAugmentations);
411 final AugmentationNode augmentationNode =
412 Builders.augmentationBuilder()
413 .withNodeIdentifier(augmentationIdentifier).withChild(augCont)
416 return ImmutableMapEntryNodeBuilder
419 new YangInstanceIdentifier.NodeIdentifierWithPredicates(
420 AUGMENTED_LIST_QNAME, ID_QNAME, id))
421 .withChild(ImmutableNodes.leafNode(ID_QNAME, id))
422 .withChild(augmentationNode).build();
426 public static ContainerNode createFamily() {
427 final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> familyContainerBuilder =
428 ImmutableContainerNodeBuilder.create().withNodeIdentifier(
429 new YangInstanceIdentifier.NodeIdentifier(FAMILY_QNAME));
431 final CollectionNodeBuilder<MapEntryNode, MapNode> childrenBuilder =
432 mapNodeBuilder(CHILDREN_QNAME);
434 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstChildBuilder =
435 mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID);
436 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondChildBuilder =
437 mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID);
439 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstGrandChildBuilder =
440 mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
441 FIRST_GRAND_CHILD_ID);
442 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondGrandChildBuilder =
443 mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
444 SECOND_GRAND_CHILD_ID);
446 firstGrandChildBuilder
448 ImmutableNodes.leafNode(GRAND_CHILD_NUMBER_QNAME,
449 FIRST_GRAND_CHILD_ID)).withChild(
450 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
451 FIRST_GRAND_CHILD_NAME));
453 secondGrandChildBuilder.withChild(
455 .leafNode(GRAND_CHILD_NUMBER_QNAME, SECOND_GRAND_CHILD_ID))
457 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
458 SECOND_GRAND_CHILD_NAME));
461 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, FIRST_CHILD_ID))
462 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, FIRST_CHILD_NAME))
464 mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
465 firstGrandChildBuilder.build()).build());
469 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, SECOND_CHILD_ID))
470 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, SECOND_CHILD_NAME))
472 mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
473 firstGrandChildBuilder.build()).build());
475 childrenBuilder.withChild(firstChildBuilder.build());
476 childrenBuilder.withChild(secondChildBuilder.build());
478 return familyContainerBuilder.withChild(childrenBuilder.build()).build();