Merge "Bug 2265: Use new NormalizedNode streaming in messages"
[controller.git] / opendaylight / md-sal / sal-clustering-commons / src / test / java / org / opendaylight / controller / cluster / datastore / util / TestModel.java
1 /*
2  *
3  *  Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
4  *
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
8  *
9  */
10
11 package org.opendaylight.controller.cluster.datastore.util;
12
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;
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;
24 import java.util.Map;
25 import java.util.Set;
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;
50
51 public class TestModel {
52
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");
56
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");
60
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");
64
65
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,
71       "some-ref");
72   public static final QName MYIDENTITY_QNAME = QName.create(TEST_QNAME,
73       "myidentity");
74   public static final QName SWITCH_FEATURES_QNAME = QName.create(TEST_QNAME,
75       "switch-features");
76
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");
79
80   public static final QName OUTER_LIST_QNAME = QName.create(TEST_QNAME,
81       "outer-list");
82   public static final QName INNER_LIST_QNAME = QName.create(TEST_QNAME,
83       "inner-list");
84   public static final QName OUTER_CHOICE_QNAME = QName.create(TEST_QNAME,
85       "outer-choice");
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";
104
105
106   public static final YangInstanceIdentifier TEST_PATH = YangInstanceIdentifier
107       .of(TEST_QNAME);
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");
114
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 =
126       QName
127           .create(
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,
131       "children");
132   public static final QName GRAND_CHILDREN_QNAME = QName.create(FAMILY_QNAME,
133       "grand-children");
134   public static final QName CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME,
135       "child-number");
136   public static final QName CHILD_NAME_QNAME = QName.create(FAMILY_QNAME,
137       "child-name");
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,
141       "grand-child-name");
142
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();
149
150   private static final Integer FIRST_CHILD_ID = 1;
151   private static final Integer SECOND_CHILD_ID = 2;
152
153   private static final String FIRST_CHILD_NAME = "first child";
154   private static final String SECOND_CHILD_NAME = "second child";
155
156   private static final Integer FIRST_GRAND_CHILD_ID = 1;
157   private static final Integer SECOND_GRAND_CHILD_ID = 2;
158
159   private static final String FIRST_GRAND_CHILD_NAME = "first grand child";
160   private static final String SECOND_GRAND_CHILD_NAME = "second grand child";
161
162
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)) //
168           .build()) //
169       .build();
170
171   public static final InputStream getDatastoreTestInputStream() {
172     return getInputStream(DATASTORE_TEST_YANG);
173   }
174
175   public static final InputStream getDatastoreAugInputStream() {
176     return getInputStream(DATASTORE_AUG_YANG);
177   }
178
179   public static final InputStream getDatastoreTestNotificationInputStream() {
180     return getInputStream(DATASTORE_TEST_NOTIFICATION_YANG);
181   }
182
183   private static InputStream getInputStream(final String resourceName) {
184     return TestModel.class.getResourceAsStream(resourceName);
185   }
186
187   public static SchemaContext createTestContext() {
188     List<InputStream> inputStreams = new ArrayList<>();
189     inputStreams.add(getDatastoreTestInputStream());
190     inputStreams.add(getDatastoreAugInputStream());
191     inputStreams.add(getDatastoreTestNotificationInputStream());
192
193     YangParserImpl parser = new YangParserImpl();
194     Set<Module> modules = parser.parseYangModelsFromStreams(inputStreams);
195     return parser.resolveSchemaContext(modules);
196   }
197
198   /**
199    * Returns a test document
200    * <p/>
201    *
202    * <pre>
203    * test
204    *     outer-list
205    *          id 1
206    *     outer-list
207    *          id 2
208    *          inner-list
209    *                  name "one"
210    *          inner-list
211    *                  name "two"
212    *
213    * </pre>
214    *
215    * @return
216    */
217   public static NormalizedNode<?, ?> createDocumentOne(
218       SchemaContext schemaContext) {
219     return ImmutableContainerNodeBuilder
220         .create()
221         .withNodeIdentifier(
222             new YangInstanceIdentifier.NodeIdentifier(schemaContext.getQName()))
223         .withChild(createTestContainer()).build();
224
225   }
226
227   public static DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> createBaseTestContainerBuilder() {
228       // Create a list of shoes
229       // This is to test leaf list entry
230       final LeafSetEntryNode<Object> nike =
231               ImmutableLeafSetEntryNodeBuilder
232                       .create()
233                       .withNodeIdentifier(
234                               new YangInstanceIdentifier.NodeWithValue(QName.create(
235                                       TEST_QNAME, "shoe"), "nike")).withValue("nike").build();
236
237       final LeafSetEntryNode<Object> puma =
238               ImmutableLeafSetEntryNodeBuilder
239                       .create()
240                       .withNodeIdentifier(
241                               new YangInstanceIdentifier.NodeWithValue(QName.create(
242                                       TEST_QNAME, "shoe"), "puma")).withValue("puma").build();
243
244       final LeafSetNode<Object> shoes =
245               ImmutableLeafSetNodeBuilder
246                       .create()
247                       .withNodeIdentifier(
248                               new YangInstanceIdentifier.NodeIdentifier(QName.create(
249                                       TEST_QNAME, "shoe"))).withChild(nike).withChild(puma)
250                       .build();
251
252
253       // Test a leaf-list where each entry contains an identity
254       final LeafSetEntryNode<Object> cap1 =
255               ImmutableLeafSetEntryNodeBuilder
256                       .create()
257                       .withNodeIdentifier(
258                               new YangInstanceIdentifier.NodeWithValue(QName.create(
259                                       TEST_QNAME, "capability"), DESC_QNAME))
260                       .withValue(DESC_QNAME).build();
261
262       final LeafSetNode<Object> capabilities =
263               ImmutableLeafSetNodeBuilder
264                       .create()
265                       .withNodeIdentifier(
266                               new YangInstanceIdentifier.NodeIdentifier(QName.create(
267                                       TEST_QNAME, "capability"))).withChild(cap1).build();
268
269       ContainerNode switchFeatures =
270               ImmutableContainerNodeBuilder
271                       .create()
272                       .withNodeIdentifier(
273                               new YangInstanceIdentifier.NodeIdentifier(SWITCH_FEATURES_QNAME))
274                       .withChild(capabilities).build();
275
276       // Create a leaf list with numbers
277       final LeafSetEntryNode<Object> five =
278               ImmutableLeafSetEntryNodeBuilder
279                       .create()
280                       .withNodeIdentifier(
281                               (new YangInstanceIdentifier.NodeWithValue(QName.create(
282                                       TEST_QNAME, "number"), 5))).withValue(5).build();
283       final LeafSetEntryNode<Object> fifteen =
284               ImmutableLeafSetEntryNodeBuilder
285                       .create()
286                       .withNodeIdentifier(
287                               (new YangInstanceIdentifier.NodeWithValue(QName.create(
288                                       TEST_QNAME, "number"), 15))).withValue(15).build();
289       final LeafSetNode<Object> numbers =
290               ImmutableLeafSetNodeBuilder
291                       .create()
292                       .withNodeIdentifier(
293                               new YangInstanceIdentifier.NodeIdentifier(QName.create(
294                                       TEST_QNAME, "number"))).withChild(five).withChild(fifteen)
295                       .build();
296
297
298       // Create augmentations
299       MapEntryNode augMapEntry = createAugmentedListEntry(1, "First Test");
300
301       // Create a bits leaf
302       NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, Object, LeafNode<Object>>
303               myBits = Builders.leafBuilder().withNodeIdentifier(
304               new YangInstanceIdentifier.NodeIdentifier(
305                       QName.create(TEST_QNAME, "my-bits"))).withValue(
306               ImmutableSet.of("foo", "bar"));
307
308       // Create unkeyed list entry
309       UnkeyedListEntryNode unkeyedListEntry =
310           Builders.unkeyedListEntryBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(UNKEYED_LIST_ENTRY_QNAME)).
311               withChild(ImmutableNodes.leafNode(NAME_QNAME, "unkeyed-entry-name")).build();
312
313       // Create YangInstanceIdentifier with all path arg types.
314       YangInstanceIdentifier instanceID = YangInstanceIdentifier.create(
315               new YangInstanceIdentifier.NodeIdentifier(QName.create(TEST_QNAME, "qname")),
316               new YangInstanceIdentifier.NodeIdentifierWithPredicates(QName.create(TEST_QNAME, "list-entry"),
317                       QName.create(TEST_QNAME, "key"), 10),
318               new YangInstanceIdentifier.AugmentationIdentifier(ImmutableSet.of(
319                       QName.create(TEST_QNAME, "aug1"), QName.create(TEST_QNAME, "aug2"))),
320               new YangInstanceIdentifier.NodeWithValue(QName.create(TEST_QNAME, "leaf-list-entry"), "foo"));
321
322       Map<QName, Object> keyValues = new HashMap<>();
323       keyValues.put(CHILDREN_QNAME, FIRST_CHILD_NAME);
324
325
326       // Create the document
327       return ImmutableContainerNodeBuilder
328               .create()
329               .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME))
330               .withChild(myBits.build())
331               .withChild(ImmutableNodes.leafNode(DESC_QNAME, DESC))
332               .withChild(ImmutableNodes.leafNode(BOOLEAN_LEAF_QNAME, ENABLED))
333               .withChild(ImmutableNodes.leafNode(SHORT_LEAF_QNAME, SHORT_ID))
334               .withChild(ImmutableNodes.leafNode(BYTE_LEAF_QNAME, BYTE_ID))
335               .withChild(ImmutableNodes.leafNode(TestModel.BIGINTEGER_LEAF_QNAME, BigInteger.valueOf(100)))
336               .withChild(ImmutableNodes.leafNode(TestModel.BIGDECIMAL_LEAF_QNAME, BigDecimal.valueOf(1.2)))
337               .withChild(ImmutableNodes.leafNode(SOME_REF_QNAME, instanceID))
338               .withChild(ImmutableNodes.leafNode(MYIDENTITY_QNAME, DESC_QNAME))
339               .withChild(Builders.unkeyedListBuilder()
340                    .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(UNKEYED_LIST_QNAME))
341                    .withChild(unkeyedListEntry).build())
342               .withChild(Builders.choiceBuilder()
343                    .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(CHOICE_QNAME))
344                    .withChild(ImmutableNodes.leafNode(DESC_QNAME, LONG_ID)).build())
345                       // .withChild(augmentationNode)
346               .withChild(shoes)
347               .withChild(numbers)
348               .withChild(switchFeatures)
349               .withChild(mapNodeBuilder(AUGMENTED_LIST_QNAME).withChild(augMapEntry).build())
350               .withChild(mapNodeBuilder(OUTER_LIST_QNAME)
351                    .withChild(mapEntry(OUTER_LIST_QNAME, ID_QNAME, ONE_ID))
352                    .withChild(BAR_NODE).build()
353               );
354   }
355
356   public static ContainerNode createTestContainer() {
357       return createBaseTestContainerBuilder().build();
358   }
359
360   public static MapEntryNode createAugmentedListEntry(int id, String name) {
361
362     Set<QName> childAugmentations = new HashSet<>();
363     childAugmentations.add(AUG_CONT_QNAME);
364
365     ContainerNode augCont =
366         ImmutableContainerNodeBuilder
367             .create()
368             .withNodeIdentifier(
369                 new YangInstanceIdentifier.NodeIdentifier(AUG_CONT_QNAME))
370             .withChild(ImmutableNodes.leafNode(AUG_NAME_QNAME, name)).build();
371
372
373     final YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier =
374         new YangInstanceIdentifier.AugmentationIdentifier(childAugmentations);
375
376     final AugmentationNode augmentationNode =
377         Builders.augmentationBuilder()
378             .withNodeIdentifier(augmentationIdentifier).withChild(augCont)
379             .build();
380
381     return ImmutableMapEntryNodeBuilder
382         .create()
383         .withNodeIdentifier(
384             new YangInstanceIdentifier.NodeIdentifierWithPredicates(
385                     AUGMENTED_LIST_ENTRY_QNAME, ID_QNAME, id))
386         .withChild(ImmutableNodes.leafNode(ID_QNAME, id))
387         .withChild(augmentationNode).build();
388   }
389
390
391   public static ContainerNode createFamily() {
392     final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> familyContainerBuilder =
393         ImmutableContainerNodeBuilder.create().withNodeIdentifier(
394             new YangInstanceIdentifier.NodeIdentifier(FAMILY_QNAME));
395
396     final CollectionNodeBuilder<MapEntryNode, MapNode> childrenBuilder =
397         mapNodeBuilder(CHILDREN_QNAME);
398
399     final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstChildBuilder =
400         mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID);
401     final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondChildBuilder =
402         mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID);
403
404     final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> firstGrandChildBuilder =
405         mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
406             FIRST_GRAND_CHILD_ID);
407     final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> secondGrandChildBuilder =
408         mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
409             SECOND_GRAND_CHILD_ID);
410
411     firstGrandChildBuilder
412         .withChild(
413             ImmutableNodes.leafNode(GRAND_CHILD_NUMBER_QNAME,
414                 FIRST_GRAND_CHILD_ID)).withChild(
415             ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
416                 FIRST_GRAND_CHILD_NAME));
417
418     secondGrandChildBuilder.withChild(
419         ImmutableNodes
420             .leafNode(GRAND_CHILD_NUMBER_QNAME, SECOND_GRAND_CHILD_ID))
421         .withChild(
422             ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME,
423                 SECOND_GRAND_CHILD_NAME));
424
425     firstChildBuilder
426         .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, FIRST_CHILD_ID))
427         .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, FIRST_CHILD_NAME))
428         .withChild(
429             mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
430                 firstGrandChildBuilder.build()).build());
431
432
433     secondChildBuilder
434         .withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, SECOND_CHILD_ID))
435         .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, SECOND_CHILD_NAME))
436         .withChild(
437             mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(
438                 firstGrandChildBuilder.build()).build());
439
440     childrenBuilder.withChild(firstChildBuilder.build());
441     childrenBuilder.withChild(secondChildBuilder.build());
442
443     return familyContainerBuilder.withChild(childrenBuilder.build()).build();
444   }
445
446 }