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
8 package org.opendaylight.controller.cluster.datastore.util;
10 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.leafNode;
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.ImmutableSet;
16 import java.io.InputStream;
17 import java.util.List;
18 import org.opendaylight.yangtools.yang.common.Decimal64;
19 import org.opendaylight.yangtools.yang.common.QName;
20 import org.opendaylight.yangtools.yang.common.Uint64;
21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
25 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
28 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
29 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
30 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
32 public final class TestModel {
34 public static final QName TEST_QNAME = QName.create(
35 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:test",
36 "2014-03-13", "test");
38 public static final QName AUG_NAME_QNAME = QName.create(
39 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug",
40 "2014-03-13", "name");
42 public static final QName AUG_CONT_QNAME = QName.create(
43 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug",
44 "2014-03-13", "cont");
47 public static final QName DESC_QNAME = QName.create(TEST_QNAME, "desc");
48 public static final QName POINTER_QNAME = QName.create(TEST_QNAME, "pointer");
49 public static final QName SOME_BINARY_DATA_QNAME = QName.create(TEST_QNAME, "some-binary-data");
50 public static final QName BINARY_LEAF_LIST_QNAME = QName.create(TEST_QNAME, "binary_leaf_list");
51 public static final QName SOME_REF_QNAME = QName.create(TEST_QNAME, "some-ref");
52 public static final QName MYIDENTITY_QNAME = QName.create(TEST_QNAME, "myidentity");
53 public static final QName SWITCH_FEATURES_QNAME = QName.create(TEST_QNAME, "switch-features");
55 public static final QName AUGMENTED_LIST_QNAME = QName.create(TEST_QNAME, "augmented-list");
56 public static final QName AUGMENTED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "augmented-list-entry");
58 public static final QName OUTER_LIST_QNAME = QName.create(TEST_QNAME, "outer-list");
59 public static final QName INNER_LIST_QNAME = QName.create(TEST_QNAME, "inner-list");
60 public static final QName INNER_CONTAINER_QNAME = QName.create(TEST_QNAME, "inner-container");
61 public static final QName OUTER_CHOICE_QNAME = QName.create(TEST_QNAME, "outer-choice");
62 public static final QName ID_QNAME = QName.create(TEST_QNAME, "id");
63 public static final QName NAME_QNAME = QName.create(TEST_QNAME, "name");
64 public static final QName VALUE_QNAME = QName.create(TEST_QNAME, "value");
65 public static final QName BOOLEAN_LEAF_QNAME = QName.create(TEST_QNAME, "boolean-leaf");
66 public static final QName SHORT_LEAF_QNAME = QName.create(TEST_QNAME, "short-leaf");
67 public static final QName BYTE_LEAF_QNAME = QName.create(TEST_QNAME, "byte-leaf");
68 public static final QName BIGINTEGER_LEAF_QNAME = QName.create(TEST_QNAME, "biginteger-leaf");
69 public static final QName BIGDECIMAL_LEAF_QNAME = QName.create(TEST_QNAME, "bigdecimal-leaf");
70 public static final QName ORDERED_LIST_QNAME = QName.create(TEST_QNAME, "ordered-list");
71 public static final QName ORDERED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "ordered-list-leaf");
72 public static final QName UNKEYED_LIST_QNAME = QName.create(TEST_QNAME, "unkeyed-list");
73 public static final QName UNKEYED_LIST_ENTRY_QNAME = QName.create(TEST_QNAME, "unkeyed-list-entry");
74 public static final QName CHOICE_QNAME = QName.create(TEST_QNAME, "choice");
75 public static final QName SHOE_QNAME = QName.create(TEST_QNAME, "shoe");
76 public static final QName ANY_XML_QNAME = QName.create(TEST_QNAME, "any");
77 public static final QName EMPTY_QNAME = QName.create(TEST_QNAME, "empty-leaf");
78 public static final QName INVALID_QNAME = QName.create(TEST_QNAME, "invalid");
79 private static final String DATASTORE_TEST_YANG = "/odl-datastore-test.yang";
80 private static final String DATASTORE_AUG_YANG = "/odl-datastore-augmentation.yang";
81 private static final String DATASTORE_TEST_NOTIFICATION_YANG = "/odl-datastore-test-notification.yang";
83 public static final YangInstanceIdentifier TEST_PATH = YangInstanceIdentifier.of(TEST_QNAME);
84 public static final YangInstanceIdentifier DESC_PATH = YangInstanceIdentifier
85 .builder(TEST_PATH).node(DESC_QNAME).build();
86 public static final YangInstanceIdentifier OUTER_LIST_PATH =
87 YangInstanceIdentifier.builder(TEST_PATH).node(OUTER_LIST_QNAME).build();
88 public static final QName TWO_THREE_QNAME = QName.create(TEST_QNAME, "two");
89 public static final QName TWO_QNAME = QName.create(TEST_QNAME, "two");
90 public static final QName THREE_QNAME = QName.create(TEST_QNAME, "three");
92 private static final Integer ONE_ID = 1;
93 private static final Integer TWO_ID = 2;
94 private static final String TWO_ONE_NAME = "one";
95 private static final String TWO_TWO_NAME = "two";
96 private static final String DESC = "Hello there";
97 private static final Boolean ENABLED = true;
98 private static final Short SHORT_ID = 1;
99 private static final Byte BYTE_ID = 1;
100 // Family specific constants
101 public static final QName FAMILY_QNAME = QName.create(
102 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:notification-test", "2014-04-17", "family");
103 public static final QName CHILDREN_QNAME = QName.create(FAMILY_QNAME, "children");
104 public static final QName GRAND_CHILDREN_QNAME = QName.create(FAMILY_QNAME, "grand-children");
105 public static final QName CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME, "child-number");
106 public static final QName CHILD_NAME_QNAME = QName.create(FAMILY_QNAME, "child-name");
107 public static final QName GRAND_CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME, "grand-child-number");
108 public static final QName GRAND_CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,"grand-child-name");
110 public static final YangInstanceIdentifier FAMILY_PATH = YangInstanceIdentifier.of(FAMILY_QNAME);
111 public static final YangInstanceIdentifier FAMILY_DESC_PATH =
112 YangInstanceIdentifier.builder(FAMILY_PATH).node(DESC_QNAME).build();
113 public static final YangInstanceIdentifier CHILDREN_PATH =
114 YangInstanceIdentifier.builder(FAMILY_PATH).node(CHILDREN_QNAME).build();
116 private static final Integer FIRST_CHILD_ID = 1;
117 private static final Integer SECOND_CHILD_ID = 2;
119 private static final String FIRST_CHILD_NAME = "first child";
120 private static final String SECOND_CHILD_NAME = "second child";
122 private static final Integer FIRST_GRAND_CHILD_ID = 1;
123 private static final Integer SECOND_GRAND_CHILD_ID = 2;
125 private static final String FIRST_GRAND_CHILD_NAME = "first grand child";
126 private static final String SECOND_GRAND_CHILD_NAME = "second grand child";
128 private static final MapEntryNode BAR_NODE = mapEntryBuilder(
129 OUTER_LIST_QNAME, ID_QNAME, TWO_ID) //
130 .withChild(mapNodeBuilder(INNER_LIST_QNAME) //
131 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_ONE_NAME)) //
132 .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME)) //
136 private TestModel() {
137 throw new UnsupportedOperationException();
140 public static InputStream getDatastoreTestInputStream() {
141 return getInputStream(DATASTORE_TEST_YANG);
144 public static InputStream getDatastoreAugInputStream() {
145 return getInputStream(DATASTORE_AUG_YANG);
148 public static InputStream getDatastoreTestNotificationInputStream() {
149 return getInputStream(DATASTORE_TEST_NOTIFICATION_YANG);
152 private static InputStream getInputStream(final String resourceName) {
153 return TestModel.class.getResourceAsStream(resourceName);
156 public static EffectiveModelContext createTestContext() {
157 return YangParserTestUtils.parseYangResources(TestModel.class, DATASTORE_TEST_YANG, DATASTORE_AUG_YANG,
158 DATASTORE_TEST_NOTIFICATION_YANG);
161 public static EffectiveModelContext createTestContextWithoutTestSchema() {
162 return YangParserTestUtils.parseYangResource(DATASTORE_TEST_NOTIFICATION_YANG);
165 public static EffectiveModelContext createTestContextWithoutAugmentationSchema() {
166 return YangParserTestUtils.parseYangResources(TestModel.class, DATASTORE_TEST_YANG,
167 DATASTORE_TEST_NOTIFICATION_YANG);
170 public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> createBaseTestContainerBuilder() {
171 // Create YangInstanceIdentifier with all path arg types.
172 YangInstanceIdentifier instanceID = YangInstanceIdentifier.of(
173 new NodeIdentifier(QName.create(TEST_QNAME, "qname")),
174 NodeIdentifierWithPredicates.of(QName.create(TEST_QNAME, "list-entry"),
175 QName.create(TEST_QNAME, "key"), 10),
176 new NodeWithValue<>(QName.create(TEST_QNAME, "leaf-list-entry"), "foo"));
178 // Create the document
179 return Builders.containerBuilder()
180 .withNodeIdentifier(new NodeIdentifier(TEST_QNAME))
181 // Create a bits leaf
182 .withChild(leafNode(QName.create(TEST_QNAME, "my-bits"), ImmutableSet.of("foo", "bar")))
183 .withChild(leafNode(DESC_QNAME, DESC))
184 .withChild(leafNode(BOOLEAN_LEAF_QNAME, ENABLED))
185 .withChild(leafNode(SHORT_LEAF_QNAME, SHORT_ID))
186 .withChild(leafNode(BYTE_LEAF_QNAME, BYTE_ID))
187 .withChild(leafNode(TestModel.BIGINTEGER_LEAF_QNAME, Uint64.valueOf(100)))
188 .withChild(leafNode(TestModel.BIGDECIMAL_LEAF_QNAME, Decimal64.valueOf("1.2").scaleTo(2)))
189 .withChild(leafNode(SOME_REF_QNAME, instanceID))
190 .withChild(leafNode(MYIDENTITY_QNAME, DESC_QNAME))
191 .withChild(Builders.unkeyedListBuilder()
192 .withNodeIdentifier(new NodeIdentifier(UNKEYED_LIST_QNAME))
193 // Create unkeyed list entry
194 .withChild(Builders.unkeyedListEntryBuilder()
195 .withNodeIdentifier(new NodeIdentifier(UNKEYED_LIST_QNAME))
196 .withChild(leafNode(NAME_QNAME, "unkeyed-entry-name"))
199 .withChild(Builders.choiceBuilder()
200 .withNodeIdentifier(new NodeIdentifier(TWO_THREE_QNAME))
201 .withChild(leafNode(TWO_QNAME, "two")).build())
202 .withChild(Builders.orderedMapBuilder()
203 .withNodeIdentifier(new NodeIdentifier(ORDERED_LIST_QNAME))
205 mapEntryBuilder(ORDERED_LIST_QNAME, ORDERED_LIST_ENTRY_QNAME, "1").build(),
206 mapEntryBuilder(ORDERED_LIST_QNAME, ORDERED_LIST_ENTRY_QNAME, "2").build()))
208 .withChild(Builders.leafSetBuilder()
209 .withNodeIdentifier(new NodeIdentifier(SHOE_QNAME))
210 .withChild(Builders.leafSetEntryBuilder()
211 .withNodeIdentifier(new NodeWithValue<>(SHOE_QNAME, "nike"))
214 .withChild(Builders.leafSetEntryBuilder()
215 .withNodeIdentifier(new NodeWithValue<>(SHOE_QNAME, "puma"))
219 .withChild(Builders.leafSetBuilder()
220 .withNodeIdentifier(new NodeIdentifier(QName.create(TEST_QNAME, "number")))
221 .withChild(Builders.leafSetEntryBuilder()
222 .withNodeIdentifier(new NodeWithValue<>(QName.create(TEST_QNAME, "number"), 5))
225 .withChild(Builders.leafSetEntryBuilder()
226 .withNodeIdentifier(new NodeWithValue<>(QName.create(TEST_QNAME, "number"), 15))
230 .withChild(Builders.containerBuilder()
231 .withNodeIdentifier(new NodeIdentifier(SWITCH_FEATURES_QNAME))
232 // Test a leaf-list where each entry contains an identity
233 .withChild(Builders.leafSetBuilder()
234 .withNodeIdentifier(new NodeIdentifier(QName.create(TEST_QNAME, "capability")))
235 .withChild(Builders.leafSetEntryBuilder()
236 .withNodeIdentifier(new NodeWithValue<>(QName.create(TEST_QNAME, "capability"), DESC_QNAME))
237 .withValue(DESC_QNAME)
241 .withChild(mapNodeBuilder(AUGMENTED_LIST_QNAME)
242 // Create augmentations
243 .withChild(createAugmentedListEntry(1, "First Test"))
245 .withChild(mapNodeBuilder(OUTER_LIST_QNAME)
246 .withChild(mapEntry(OUTER_LIST_QNAME, ID_QNAME, ONE_ID))
251 public static ContainerNode createTestContainer() {
252 return createBaseTestContainerBuilder().build();
255 public static MapEntryNode createAugmentedListEntry(final int id, final String name) {
256 return Builders.mapEntryBuilder()
257 .withNodeIdentifier(NodeIdentifierWithPredicates.of(AUGMENTED_LIST_QNAME, ID_QNAME, id))
258 .withChild(leafNode(ID_QNAME, id))
259 .withChild(Builders.containerBuilder()
260 .withNodeIdentifier(new NodeIdentifier(AUG_CONT_QNAME))
261 .withChild(leafNode(AUG_NAME_QNAME, name))
266 public static ContainerNode createFamily() {
267 final var firstGrandChildBuilder = mapEntryBuilder(
268 GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME, FIRST_GRAND_CHILD_ID)
269 .withChild(leafNode(GRAND_CHILD_NUMBER_QNAME,FIRST_GRAND_CHILD_ID))
270 .withChild(leafNode(GRAND_CHILD_NAME_QNAME, FIRST_GRAND_CHILD_NAME));
272 return Builders.containerBuilder()
273 .withNodeIdentifier(new NodeIdentifier(FAMILY_QNAME))
274 .withChild(mapNodeBuilder()
275 .withNodeIdentifier(new NodeIdentifier(CHILDREN_QNAME))
276 .withChild(mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID)
277 .withChild(leafNode(CHILD_NUMBER_QNAME, FIRST_CHILD_ID))
278 .withChild(leafNode(CHILD_NAME_QNAME, FIRST_CHILD_NAME))
279 .withChild(mapNodeBuilder(GRAND_CHILDREN_QNAME)
280 .withChild(firstGrandChildBuilder.build())
283 .withChild(mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID)
284 .withChild(leafNode(CHILD_NUMBER_QNAME, SECOND_CHILD_ID))
285 .withChild(leafNode(CHILD_NAME_QNAME, SECOND_CHILD_NAME))
286 .withChild(mapNodeBuilder(GRAND_CHILDREN_QNAME)
287 .withChild(firstGrandChildBuilder.build())