opendaylight/md-sal/sal-clustering-commons/src/test/java/org/opendaylight/controller/cluster/datastore/util/TestModel.java

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