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
9 package org.opendaylight.controller.cluster.datastore.util;
11 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntry;
12 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntryBuilder;
13 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapNodeBuilder;
15 import com.google.common.collect.ImmutableList;
16 import com.google.common.collect.ImmutableSet;
17 import java.io.InputStream;
18 import java.math.BigDecimal;
19 import java.math.BigInteger;
20 import java.util.ArrayList;
21 import java.util.HashMap;
22 import java.util.HashSet;
23 import java.util.List;
26 import org.opendaylight.yangtools.yang.common.QName;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
28 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
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.DataContainerNodeAttrBuilder;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
47 import org.opendaylight.yangtools.yang.model.api.Module;
48 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
49 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
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_DATA_QNAME = QName.create(TEST_QNAME, "some-binary-data");
69 public static final QName BINARY_LEAF_LIST_QNAME = QName.create(TEST_QNAME, "binary_leaf_list");
70 public static final QName SOME_REF_QNAME = QName.create(TEST_QNAME,
72 public static final QName MYIDENTITY_QNAME = QName.create(TEST_QNAME,
74 public static final QName SWITCH_FEATURES_QNAME = QName.create(TEST_QNAME,
77 public static final QName AUGMENTED_LIST_QNAME = QName.create(TEST_QNAME, "augmented-list");
78 public static final QName AUGMENTED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "augmented-list-entry");
80 public static final QName OUTER_LIST_QNAME = QName.create(TEST_QNAME,
82 public static final QName INNER_LIST_QNAME = QName.create(TEST_QNAME,
84 public static final QName OUTER_CHOICE_QNAME = QName.create(TEST_QNAME,
86 public static final QName ID_QNAME = QName.create(TEST_QNAME, "id");
87 public static final QName NAME_QNAME = QName.create(TEST_QNAME, "name");
88 public static final QName VALUE_QNAME = QName.create(TEST_QNAME, "value");
89 public static final QName BOOLEAN_LEAF_QNAME = QName.create(TEST_QNAME, "boolean-leaf");
90 public static final QName SHORT_LEAF_QNAME = QName.create(TEST_QNAME, "short-leaf");
91 public static final QName BYTE_LEAF_QNAME = QName.create(TEST_QNAME, "byte-leaf");
92 public static final QName BIGINTEGER_LEAF_QNAME = QName.create(TEST_QNAME, "biginteger-leaf");
93 public static final QName BIGDECIMAL_LEAF_QNAME = QName.create(TEST_QNAME, "bigdecimal-leaf");
94 public static final QName ORDERED_LIST_QNAME = QName.create(TEST_QNAME, "ordered-list");
95 public static final QName ORDERED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "ordered-list-entry");
96 public static final QName UNKEYED_LIST_QNAME = QName.create(TEST_QNAME, "unkeyed-list");
97 public static final QName UNKEYED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "unkeyed-list-entry");
98 public static final QName CHOICE_QNAME = QName.create(TEST_QNAME, "choice");
99 private static final String DATASTORE_TEST_YANG = "/odl-datastore-test.yang";
100 private static final String DATASTORE_AUG_YANG =
101 "/odl-datastore-augmentation.yang";
102 private static final String DATASTORE_TEST_NOTIFICATION_YANG =
103 "/odl-datastore-test-notification.yang";
106 public static final YangInstanceIdentifier TEST_PATH = YangInstanceIdentifier
108 public static final YangInstanceIdentifier DESC_PATH = YangInstanceIdentifier
109 .builder(TEST_PATH).node(DESC_QNAME).build();
110 public static final YangInstanceIdentifier OUTER_LIST_PATH =
111 YangInstanceIdentifier.builder(TEST_PATH).node(OUTER_LIST_QNAME).build();
112 public static final QName TWO_QNAME = QName.create(TEST_QNAME, "two");
113 public static final QName THREE_QNAME = QName.create(TEST_QNAME, "three");
115 private static final Integer ONE_ID = 1;
116 private static final Integer TWO_ID = 2;
117 private static final String TWO_ONE_NAME = "one";
118 private static final String TWO_TWO_NAME = "two";
119 private static final String DESC = "Hello there";
120 private static final Long LONG_ID = 1L;
121 private static final Boolean ENABLED = true;
122 private static final Short SHORT_ID = 1;
123 private static final Byte BYTE_ID = 1;
124 // Family specific constants
125 public static final QName FAMILY_QNAME =
128 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:notification-test",
129 "2014-04-17", "family");
130 public static final QName CHILDREN_QNAME = QName.create(FAMILY_QNAME,
132 public static final QName GRAND_CHILDREN_QNAME = QName.create(FAMILY_QNAME,
134 public static final QName CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME,
136 public static final QName CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
138 public static final QName GRAND_CHILD_NUMBER_QNAME = QName.create(
139 FAMILY_QNAME, "grand-child-number");
140 public static final QName GRAND_CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
143 public static final YangInstanceIdentifier FAMILY_PATH =
144 YangInstanceIdentifier.of(FAMILY_QNAME);
145 public static final YangInstanceIdentifier FAMILY_DESC_PATH =
146 YangInstanceIdentifier.builder(FAMILY_PATH).node(DESC_QNAME).build();
147 public static final YangInstanceIdentifier CHILDREN_PATH =
148 YangInstanceIdentifier.builder(FAMILY_PATH).node(CHILDREN_QNAME).build();
150 private static final Integer FIRST_CHILD_ID = 1;
151 private static final Integer SECOND_CHILD_ID = 2;
153 private static final String FIRST_CHILD_NAME = "first child";
154 private static final String SECOND_CHILD_NAME = "second child";
156 private static final Integer FIRST_GRAND_CHILD_ID = 1;
157 private static final Integer SECOND_GRAND_CHILD_ID = 2;
159 private static final String FIRST_GRAND_CHILD_NAME = "first grand child";
160 private static final String SECOND_GRAND_CHILD_NAME = "second grand child";
163 private static final MapEntryNode BAR_NODE = mapEntryBuilder(
164 OUTER_LIST_QNAME, ID_QNAME, TWO_ID) //
165 .withChild(mapNodeBuilder(INNER_LIST_QNAME) //
166 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_ONE_NAME)) //
167 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME)) //
171 public static final InputStream getDatastoreTestInputStream() {
172 return getInputStream(DATASTORE_TEST_YANG);
175 public static final InputStream getDatastoreAugInputStream() {
176 return getInputStream(DATASTORE_AUG_YANG);
179 public static final InputStream getDatastoreTestNotificationInputStream() {
180 return getInputStream(DATASTORE_TEST_NOTIFICATION_YANG);
183 private static InputStream getInputStream(final String resourceName) {
184 return TestModel.class.getResourceAsStream(resourceName);
187 public static SchemaContext createTestContext() {
188 List<InputStream> inputStreams = new ArrayList<>();
189 inputStreams.add(getDatastoreTestInputStream());
190 inputStreams.add(getDatastoreAugInputStream());
191 inputStreams.add(getDatastoreTestNotificationInputStream());
193 YangParserImpl parser = new YangParserImpl();
194 Set<Module> modules = parser.parseYangModelsFromStreams(inputStreams);
195 return parser.resolveSchemaContext(modules);
198 public static SchemaContext createTestContextWithoutTestSchema() {
199 List<InputStream> inputStreams = new ArrayList<>();
200 inputStreams.add(getDatastoreTestNotificationInputStream());
202 YangParserImpl parser = new YangParserImpl();
203 Set<Module> modules = parser.parseYangModelsFromStreams(inputStreams);
204 return parser.resolveSchemaContext(modules);
208 public static SchemaContext createTestContextWithoutAugmentationSchema() {
209 List<InputStream> inputStreams = new ArrayList<>();
210 inputStreams.add(getDatastoreTestInputStream());
211 inputStreams.add(getDatastoreTestNotificationInputStream());
213 YangParserImpl parser = new YangParserImpl();
214 Set<Module> modules = parser.parseYangModelsFromStreams(inputStreams);
215 return parser.resolveSchemaContext(modules);
220 * Returns a test document
238 public static NormalizedNode<?, ?> createDocumentOne(
239 SchemaContext schemaContext) {
240 return ImmutableContainerNodeBuilder
243 new YangInstanceIdentifier.NodeIdentifier(schemaContext.getQName()))
244 .withChild(createTestContainer()).build();
248 public static DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> createBaseTestContainerBuilder() {
249 // Create a list of shoes
250 // This is to test leaf list entry
251 final LeafSetEntryNode<Object> nike =
252 ImmutableLeafSetEntryNodeBuilder
255 new YangInstanceIdentifier.NodeWithValue(QName.create(
256 TEST_QNAME, "shoe"), "nike")).withValue("nike").build();
258 final LeafSetEntryNode<Object> puma =
259 ImmutableLeafSetEntryNodeBuilder
262 new YangInstanceIdentifier.NodeWithValue(QName.create(
263 TEST_QNAME, "shoe"), "puma")).withValue("puma").build();
265 final LeafSetNode<Object> shoes =
266 ImmutableLeafSetNodeBuilder
269 new YangInstanceIdentifier.NodeIdentifier(QName.create(
270 TEST_QNAME, "shoe"))).withChild(nike).withChild(puma)
274 // Test a leaf-list where each entry contains an identity
275 final LeafSetEntryNode<Object> cap1 =
276 ImmutableLeafSetEntryNodeBuilder
279 new YangInstanceIdentifier.NodeWithValue(QName.create(
280 TEST_QNAME, "capability"), DESC_QNAME))
281 .withValue(DESC_QNAME).build();
283 final LeafSetNode<Object> capabilities =
284 ImmutableLeafSetNodeBuilder
287 new YangInstanceIdentifier.NodeIdentifier(QName.create(
288 TEST_QNAME, "capability"))).withChild(cap1).build();
290 ContainerNode switchFeatures =
291 ImmutableContainerNodeBuilder
294 new YangInstanceIdentifier.NodeIdentifier(SWITCH_FEATURES_QNAME))
295 .withChild(capabilities).build();
297 // Create a leaf list with numbers
298 final LeafSetEntryNode<Object> five =
299 ImmutableLeafSetEntryNodeBuilder
302 (new YangInstanceIdentifier.NodeWithValue(QName.create(
303 TEST_QNAME, "number"), 5))).withValue(5).build();
304 final LeafSetEntryNode<Object> fifteen =
305 ImmutableLeafSetEntryNodeBuilder
308 (new YangInstanceIdentifier.NodeWithValue(QName.create(
309 TEST_QNAME, "number"), 15))).withValue(15).build();
310 final LeafSetNode<Object> numbers =
311 ImmutableLeafSetNodeBuilder
314 new YangInstanceIdentifier.NodeIdentifier(QName.create(
315 TEST_QNAME, "number"))).withChild(five).withChild(fifteen)
319 // Create augmentations
320 MapEntryNode augMapEntry = createAugmentedListEntry(1, "First Test");
322 // Create a bits leaf
323 NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>>
324 myBits = Builders.leafBuilder().withNodeIdentifier(
325 new YangInstanceIdentifier.NodeIdentifier(
326 QName.create(TEST_QNAME, "my-bits"))).withValue(
327 ImmutableSet.of("foo", "bar"));
329 // Create unkeyed list entry
330 UnkeyedListEntryNode unkeyedListEntry =
331 Builders.unkeyedListEntryBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(UNKEYED_LIST_ENTRY_QNAME)).
332 withChild(ImmutableNodes.leafNode(NAME_QNAME, "unkeyed-entry-name")).build();
334 // Create YangInstanceIdentifier with all path arg types.
335 YangInstanceIdentifier instanceID = YangInstanceIdentifier.create(
336 new YangInstanceIdentifier.NodeIdentifier(QName.create(TEST_QNAME, "qname")),
337 new YangInstanceIdentifier.NodeIdentifierWithPredicates(QName.create(TEST_QNAME, "list-entry"),
338 QName.create(TEST_QNAME, "key"), 10),
339 new YangInstanceIdentifier.AugmentationIdentifier(ImmutableSet.of(
340 QName.create(TEST_QNAME, "aug1"), QName.create(TEST_QNAME, "aug2"))),
341 new YangInstanceIdentifier.NodeWithValue(QName.create(TEST_QNAME, "leaf-list-entry"), "foo"));
343 Map<QName, Object> keyValues = new HashMap<>();
344 keyValues.put(CHILDREN_QNAME, FIRST_CHILD_NAME);
347 // Create the document
348 return ImmutableContainerNodeBuilder
350 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME))
351 .withChild(myBits.build())
352 .withChild(ImmutableNodes.leafNode(DESC_QNAME, DESC))
353 .withChild(ImmutableNodes.leafNode(BOOLEAN_LEAF_QNAME, ENABLED))
354 .withChild(ImmutableNodes.leafNode(SHORT_LEAF_QNAME, SHORT_ID))
355 .withChild(ImmutableNodes.leafNode(BYTE_LEAF_QNAME, BYTE_ID))
356 .withChild(ImmutableNodes.leafNode(TestModel.BIGINTEGER_LEAF_QNAME, BigInteger.valueOf(100)))
357 .withChild(ImmutableNodes.leafNode(TestModel.BIGDECIMAL_LEAF_QNAME, BigDecimal.valueOf(1.2)))
358 .withChild(ImmutableNodes.leafNode(SOME_REF_QNAME, instanceID))
359 .withChild(ImmutableNodes.leafNode(MYIDENTITY_QNAME, DESC_QNAME))
360 .withChild(Builders.unkeyedListBuilder()
361 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(UNKEYED_LIST_QNAME))
362 .withChild(unkeyedListEntry).build())
363 .withChild(Builders.choiceBuilder()
364 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(CHOICE_QNAME))
365 .withChild(ImmutableNodes.leafNode(DESC_QNAME, LONG_ID)).build())
366 .withChild(Builders.orderedMapBuilder().
367 withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(DESC_QNAME)).
368 withValue(ImmutableList.<MapEntryNode>builder().add(augMapEntry).build()).build())
369 // .withChild(augmentationNode)
372 .withChild(switchFeatures)
373 .withChild(mapNodeBuilder(AUGMENTED_LIST_QNAME).withChild(augMapEntry).build())
374 .withChild(mapNodeBuilder(OUTER_LIST_QNAME)
375 .withChild(mapEntry(OUTER_LIST_QNAME, ID_QNAME, ONE_ID))
376 .withChild(BAR_NODE).build()
380 public static ContainerNode createTestContainer() {
381 return createBaseTestContainerBuilder().build();
384 public static MapEntryNode createAugmentedListEntry(int id, String name) {
386 Set<QName> childAugmentations = new HashSet<>();
387 childAugmentations.add(AUG_CONT_QNAME);
389 ContainerNode augCont =
390 ImmutableContainerNodeBuilder
393 new YangInstanceIdentifier.NodeIdentifier(AUG_CONT_QNAME))
394 .withChild(ImmutableNodes.leafNode(AUG_NAME_QNAME, name)).build();
397 final YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier =
398 new YangInstanceIdentifier.AugmentationIdentifier(childAugmentations);
400 final AugmentationNode augmentationNode =
401 Builders.augmentationBuilder()
402 .withNodeIdentifier(augmentationIdentifier).withChild(augCont)
405 return ImmutableMapEntryNodeBuilder
408 new YangInstanceIdentifier.NodeIdentifierWithPredicates(
409 AUGMENTED_LIST_ENTRY_QNAME, ID_QNAME, id))
410 .withChild(ImmutableNodes.leafNode(ID_QNAME, id))
411 .withChild(augmentationNode).build();
415 public static ContainerNode createFamily() {
416 final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> familyContainerBuilder =
417 ImmutableContainerNodeBuilder.create().withNodeIdentifier(
418 new YangInstanceIdentifier.NodeIdentifier(FAMILY_QNAME));
420 final CollectionNodeBuilder<MapEntryNode, MapNode> childrenBuilder =
421 mapNodeBuilder(CHILDREN_QNAME);
423 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstChildBuilder =
424 mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID);
425 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondChildBuilder =
426 mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID);
428 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstGrandChildBuilder =
429 mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
430 FIRST_GRAND_CHILD_ID);
431 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondGrandChildBuilder =
432 mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
433 SECOND_GRAND_CHILD_ID);
435 firstGrandChildBuilder
437 ImmutableNodes.leafNode(GRAND_CHILD_NUMBER_QNAME,
438 FIRST_GRAND_CHILD_ID)).withChild(
439 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
440 FIRST_GRAND_CHILD_NAME));
442 secondGrandChildBuilder.withChild(
444 .leafNode(GRAND_CHILD_NUMBER_QNAME, SECOND_GRAND_CHILD_ID))
446 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
447 SECOND_GRAND_CHILD_NAME));
450 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, FIRST_CHILD_ID))
451 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, FIRST_CHILD_NAME))
453 mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
454 firstGrandChildBuilder.build()).build());
458 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, SECOND_CHILD_ID))
459 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, SECOND_CHILD_NAME))
461 mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
462 firstGrandChildBuilder.build()).build());
464 childrenBuilder.withChild(firstChildBuilder.build());
465 childrenBuilder.withChild(secondChildBuilder.build());
467 return familyContainerBuilder.withChild(childrenBuilder.build()).build();