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;
17 import com.google.common.collect.ImmutableList;
18 import com.google.common.collect.ImmutableSet;
19 import java.io.InputStream;
20 import java.math.BigDecimal;
21 import java.math.BigInteger;
22 import java.util.ArrayList;
23 import java.util.HashMap;
24 import java.util.HashSet;
25 import java.util.List;
28 import org.opendaylight.yangtools.yang.common.QName;
29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
30 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
39 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
40 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
49 import org.opendaylight.yangtools.yang.model.api.Module;
50 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
51 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
53 public class TestModel {
55 public static final QName TEST_QNAME = QName.create(
56 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:test",
57 "2014-03-13", "test");
59 public static final QName AUG_NAME_QNAME = QName.create(
60 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug",
61 "2014-03-13", "name");
63 public static final QName AUG_CONT_QNAME = QName.create(
64 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug",
65 "2014-03-13", "cont");
68 public static final QName DESC_QNAME = QName.create(TEST_QNAME, "desc");
69 public static final QName POINTER_QNAME = QName.create(TEST_QNAME, "pointer");
70 public static final QName SOME_BINARY_DATA_QNAME = QName.create(TEST_QNAME, "some-binary-data");
71 public static final QName BINARY_LEAF_LIST_QNAME = QName.create(TEST_QNAME, "binary_leaf_list");
72 public static final QName SOME_REF_QNAME = QName.create(TEST_QNAME,
74 public static final QName MYIDENTITY_QNAME = QName.create(TEST_QNAME,
76 public static final QName SWITCH_FEATURES_QNAME = QName.create(TEST_QNAME,
79 public static final QName AUGMENTED_LIST_QNAME = QName.create(TEST_QNAME, "augmented-list");
80 public static final QName AUGMENTED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "augmented-list-entry");
82 public static final QName OUTER_LIST_QNAME = QName.create(TEST_QNAME,
84 public static final QName INNER_LIST_QNAME = QName.create(TEST_QNAME,
86 public static final QName OUTER_CHOICE_QNAME = QName.create(TEST_QNAME,
88 public static final QName ID_QNAME = QName.create(TEST_QNAME, "id");
89 public static final QName NAME_QNAME = QName.create(TEST_QNAME, "name");
90 public static final QName VALUE_QNAME = QName.create(TEST_QNAME, "value");
91 public static final QName BOOLEAN_LEAF_QNAME = QName.create(TEST_QNAME, "boolean-leaf");
92 public static final QName SHORT_LEAF_QNAME = QName.create(TEST_QNAME, "short-leaf");
93 public static final QName BYTE_LEAF_QNAME = QName.create(TEST_QNAME, "byte-leaf");
94 public static final QName BIGINTEGER_LEAF_QNAME = QName.create(TEST_QNAME, "biginteger-leaf");
95 public static final QName BIGDECIMAL_LEAF_QNAME = QName.create(TEST_QNAME, "bigdecimal-leaf");
96 public static final QName ORDERED_LIST_QNAME = QName.create(TEST_QNAME, "ordered-list");
97 public static final QName ORDERED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "ordered-list-entry");
98 public static final QName UNKEYED_LIST_QNAME = QName.create(TEST_QNAME, "unkeyed-list");
99 public static final QName UNKEYED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "unkeyed-list-entry");
100 public static final QName CHOICE_QNAME = QName.create(TEST_QNAME, "choice");
101 private static final String DATASTORE_TEST_YANG = "/odl-datastore-test.yang";
102 private static final String DATASTORE_AUG_YANG =
103 "/odl-datastore-augmentation.yang";
104 private static final String DATASTORE_TEST_NOTIFICATION_YANG =
105 "/odl-datastore-test-notification.yang";
108 public static final YangInstanceIdentifier TEST_PATH = YangInstanceIdentifier
110 public static final YangInstanceIdentifier DESC_PATH = YangInstanceIdentifier
111 .builder(TEST_PATH).node(DESC_QNAME).build();
112 public static final YangInstanceIdentifier OUTER_LIST_PATH =
113 YangInstanceIdentifier.builder(TEST_PATH).node(OUTER_LIST_QNAME).build();
114 public static final QName TWO_QNAME = QName.create(TEST_QNAME, "two");
115 public static final QName THREE_QNAME = QName.create(TEST_QNAME, "three");
117 private static final Integer ONE_ID = 1;
118 private static final Integer TWO_ID = 2;
119 private static final String TWO_ONE_NAME = "one";
120 private static final String TWO_TWO_NAME = "two";
121 private static final String DESC = "Hello there";
122 private static final Long LONG_ID = 1L;
123 private static final Boolean ENABLED = true;
124 private static final Short SHORT_ID = 1;
125 private static final Byte BYTE_ID = 1;
126 // Family specific constants
127 public static final QName FAMILY_QNAME =
130 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:notification-test",
131 "2014-04-17", "family");
132 public static final QName CHILDREN_QNAME = QName.create(FAMILY_QNAME,
134 public static final QName GRAND_CHILDREN_QNAME = QName.create(FAMILY_QNAME,
136 public static final QName CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME,
138 public static final QName CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
140 public static final QName GRAND_CHILD_NUMBER_QNAME = QName.create(
141 FAMILY_QNAME, "grand-child-number");
142 public static final QName GRAND_CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
145 public static final YangInstanceIdentifier FAMILY_PATH =
146 YangInstanceIdentifier.of(FAMILY_QNAME);
147 public static final YangInstanceIdentifier FAMILY_DESC_PATH =
148 YangInstanceIdentifier.builder(FAMILY_PATH).node(DESC_QNAME).build();
149 public static final YangInstanceIdentifier CHILDREN_PATH =
150 YangInstanceIdentifier.builder(FAMILY_PATH).node(CHILDREN_QNAME).build();
152 private static final Integer FIRST_CHILD_ID = 1;
153 private static final Integer SECOND_CHILD_ID = 2;
155 private static final String FIRST_CHILD_NAME = "first child";
156 private static final String SECOND_CHILD_NAME = "second child";
158 private static final Integer FIRST_GRAND_CHILD_ID = 1;
159 private static final Integer SECOND_GRAND_CHILD_ID = 2;
161 private static final String FIRST_GRAND_CHILD_NAME = "first grand child";
162 private static final String SECOND_GRAND_CHILD_NAME = "second grand child";
165 private static final MapEntryNode BAR_NODE = mapEntryBuilder(
166 OUTER_LIST_QNAME, ID_QNAME, TWO_ID) //
167 .withChild(mapNodeBuilder(INNER_LIST_QNAME) //
168 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_ONE_NAME)) //
169 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME)) //
173 public static final InputStream getDatastoreTestInputStream() {
174 return getInputStream(DATASTORE_TEST_YANG);
177 public static final InputStream getDatastoreAugInputStream() {
178 return getInputStream(DATASTORE_AUG_YANG);
181 public static final InputStream getDatastoreTestNotificationInputStream() {
182 return getInputStream(DATASTORE_TEST_NOTIFICATION_YANG);
185 private static InputStream getInputStream(final String resourceName) {
186 return TestModel.class.getResourceAsStream(resourceName);
189 public static SchemaContext createTestContext() {
190 List<InputStream> inputStreams = new ArrayList<>();
191 inputStreams.add(getDatastoreTestInputStream());
192 inputStreams.add(getDatastoreAugInputStream());
193 inputStreams.add(getDatastoreTestNotificationInputStream());
195 YangParserImpl parser = new YangParserImpl();
196 Set<Module> modules = parser.parseYangModelsFromStreams(inputStreams);
197 return parser.resolveSchemaContext(modules);
201 * Returns a test document
219 public static NormalizedNode<?, ?> createDocumentOne(
220 SchemaContext schemaContext) {
221 return ImmutableContainerNodeBuilder
224 new YangInstanceIdentifier.NodeIdentifier(schemaContext.getQName()))
225 .withChild(createTestContainer()).build();
229 public static DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> createBaseTestContainerBuilder() {
230 // Create a list of shoes
231 // This is to test leaf list entry
232 final LeafSetEntryNode<Object> nike =
233 ImmutableLeafSetEntryNodeBuilder
236 new YangInstanceIdentifier.NodeWithValue(QName.create(
237 TEST_QNAME, "shoe"), "nike")).withValue("nike").build();
239 final LeafSetEntryNode<Object> puma =
240 ImmutableLeafSetEntryNodeBuilder
243 new YangInstanceIdentifier.NodeWithValue(QName.create(
244 TEST_QNAME, "shoe"), "puma")).withValue("puma").build();
246 final LeafSetNode<Object> shoes =
247 ImmutableLeafSetNodeBuilder
250 new YangInstanceIdentifier.NodeIdentifier(QName.create(
251 TEST_QNAME, "shoe"))).withChild(nike).withChild(puma)
255 // Test a leaf-list where each entry contains an identity
256 final LeafSetEntryNode<Object> cap1 =
257 ImmutableLeafSetEntryNodeBuilder
260 new YangInstanceIdentifier.NodeWithValue(QName.create(
261 TEST_QNAME, "capability"), DESC_QNAME))
262 .withValue(DESC_QNAME).build();
264 final LeafSetNode<Object> capabilities =
265 ImmutableLeafSetNodeBuilder
268 new YangInstanceIdentifier.NodeIdentifier(QName.create(
269 TEST_QNAME, "capability"))).withChild(cap1).build();
271 ContainerNode switchFeatures =
272 ImmutableContainerNodeBuilder
275 new YangInstanceIdentifier.NodeIdentifier(SWITCH_FEATURES_QNAME))
276 .withChild(capabilities).build();
278 // Create a leaf list with numbers
279 final LeafSetEntryNode<Object> five =
280 ImmutableLeafSetEntryNodeBuilder
283 (new YangInstanceIdentifier.NodeWithValue(QName.create(
284 TEST_QNAME, "number"), 5))).withValue(5).build();
285 final LeafSetEntryNode<Object> fifteen =
286 ImmutableLeafSetEntryNodeBuilder
289 (new YangInstanceIdentifier.NodeWithValue(QName.create(
290 TEST_QNAME, "number"), 15))).withValue(15).build();
291 final LeafSetNode<Object> numbers =
292 ImmutableLeafSetNodeBuilder
295 new YangInstanceIdentifier.NodeIdentifier(QName.create(
296 TEST_QNAME, "number"))).withChild(five).withChild(fifteen)
300 // Create augmentations
301 MapEntryNode augMapEntry = createAugmentedListEntry(1, "First Test");
303 // Create a bits leaf
304 NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>>
305 myBits = Builders.leafBuilder().withNodeIdentifier(
306 new YangInstanceIdentifier.NodeIdentifier(
307 QName.create(TEST_QNAME, "my-bits"))).withValue(
308 ImmutableSet.of("foo", "bar"));
310 // Create unkeyed list entry
311 UnkeyedListEntryNode unkeyedListEntry =
312 Builders.unkeyedListEntryBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(UNKEYED_LIST_ENTRY_QNAME)).
313 withChild(ImmutableNodes.leafNode(NAME_QNAME, "unkeyed-entry-name")).build();
315 // Create YangInstanceIdentifier with all path arg types.
316 YangInstanceIdentifier instanceID = YangInstanceIdentifier.create(
317 new YangInstanceIdentifier.NodeIdentifier(QName.create(TEST_QNAME, "qname")),
318 new YangInstanceIdentifier.NodeIdentifierWithPredicates(QName.create(TEST_QNAME, "list-entry"),
319 QName.create(TEST_QNAME, "key"), 10),
320 new YangInstanceIdentifier.AugmentationIdentifier(ImmutableSet.of(
321 QName.create(TEST_QNAME, "aug1"), QName.create(TEST_QNAME, "aug2"))),
322 new YangInstanceIdentifier.NodeWithValue(QName.create(TEST_QNAME, "leaf-list-entry"), "foo"));
324 Map<QName, Object> keyValues = new HashMap<>();
325 keyValues.put(CHILDREN_QNAME, FIRST_CHILD_NAME);
328 // Create the document
329 return ImmutableContainerNodeBuilder
331 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME))
332 .withChild(myBits.build())
333 .withChild(ImmutableNodes.leafNode(DESC_QNAME, DESC))
334 .withChild(ImmutableNodes.leafNode(BOOLEAN_LEAF_QNAME, ENABLED))
335 .withChild(ImmutableNodes.leafNode(SHORT_LEAF_QNAME, SHORT_ID))
336 .withChild(ImmutableNodes.leafNode(BYTE_LEAF_QNAME, BYTE_ID))
337 .withChild(ImmutableNodes.leafNode(TestModel.BIGINTEGER_LEAF_QNAME, BigInteger.valueOf(100)))
338 .withChild(ImmutableNodes.leafNode(TestModel.BIGDECIMAL_LEAF_QNAME, BigDecimal.valueOf(1.2)))
339 .withChild(ImmutableNodes.leafNode(SOME_REF_QNAME, instanceID))
340 .withChild(ImmutableNodes.leafNode(MYIDENTITY_QNAME, DESC_QNAME))
341 .withChild(Builders.unkeyedListBuilder()
342 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(UNKEYED_LIST_QNAME))
343 .withChild(unkeyedListEntry).build())
344 .withChild(Builders.choiceBuilder()
345 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(CHOICE_QNAME))
346 .withChild(ImmutableNodes.leafNode(DESC_QNAME, LONG_ID)).build())
347 .withChild(Builders.orderedMapBuilder().
348 withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(DESC_QNAME)).
349 withValue(ImmutableList.<MapEntryNode>builder().add(augMapEntry).build()).build())
350 // .withChild(augmentationNode)
353 .withChild(switchFeatures)
354 .withChild(mapNodeBuilder(AUGMENTED_LIST_QNAME).withChild(augMapEntry).build())
355 .withChild(mapNodeBuilder(OUTER_LIST_QNAME)
356 .withChild(mapEntry(OUTER_LIST_QNAME, ID_QNAME, ONE_ID))
357 .withChild(BAR_NODE).build()
361 public static ContainerNode createTestContainer() {
362 return createBaseTestContainerBuilder().build();
365 public static MapEntryNode createAugmentedListEntry(int id, String name) {
367 Set<QName> childAugmentations = new HashSet<>();
368 childAugmentations.add(AUG_CONT_QNAME);
370 ContainerNode augCont =
371 ImmutableContainerNodeBuilder
374 new YangInstanceIdentifier.NodeIdentifier(AUG_CONT_QNAME))
375 .withChild(ImmutableNodes.leafNode(AUG_NAME_QNAME, name)).build();
378 final YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier =
379 new YangInstanceIdentifier.AugmentationIdentifier(childAugmentations);
381 final AugmentationNode augmentationNode =
382 Builders.augmentationBuilder()
383 .withNodeIdentifier(augmentationIdentifier).withChild(augCont)
386 return ImmutableMapEntryNodeBuilder
389 new YangInstanceIdentifier.NodeIdentifierWithPredicates(
390 AUGMENTED_LIST_ENTRY_QNAME, ID_QNAME, id))
391 .withChild(ImmutableNodes.leafNode(ID_QNAME, id))
392 .withChild(augmentationNode).build();
396 public static ContainerNode createFamily() {
397 final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> familyContainerBuilder =
398 ImmutableContainerNodeBuilder.create().withNodeIdentifier(
399 new YangInstanceIdentifier.NodeIdentifier(FAMILY_QNAME));
401 final CollectionNodeBuilder<MapEntryNode, MapNode> childrenBuilder =
402 mapNodeBuilder(CHILDREN_QNAME);
404 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstChildBuilder =
405 mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID);
406 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondChildBuilder =
407 mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID);
409 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstGrandChildBuilder =
410 mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
411 FIRST_GRAND_CHILD_ID);
412 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondGrandChildBuilder =
413 mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
414 SECOND_GRAND_CHILD_ID);
416 firstGrandChildBuilder
418 ImmutableNodes.leafNode(GRAND_CHILD_NUMBER_QNAME,
419 FIRST_GRAND_CHILD_ID)).withChild(
420 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
421 FIRST_GRAND_CHILD_NAME));
423 secondGrandChildBuilder.withChild(
425 .leafNode(GRAND_CHILD_NUMBER_QNAME, SECOND_GRAND_CHILD_ID))
427 ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
428 SECOND_GRAND_CHILD_NAME));
431 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, FIRST_CHILD_ID))
432 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, FIRST_CHILD_NAME))
434 mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
435 firstGrandChildBuilder.build()).build());
439 .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, SECOND_CHILD_ID))
440 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, SECOND_CHILD_NAME))
442 mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
443 firstGrandChildBuilder.build()).build());
445 childrenBuilder.withChild(firstChildBuilder.build());
446 childrenBuilder.withChild(secondChildBuilder.build());
448 return familyContainerBuilder.withChild(childrenBuilder.build()).build();