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.mapEntry;
  11 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntryBuilder;
  12 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapNodeBuilder;
  13 import static org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes.leafNode;
  14
  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.spi.node.ImmutableNodes;
  29 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  30 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  31
  32 public final class TestModel {
  33
  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");
  37
  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");
  41
  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");
  45
  46
  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");
  54
  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");
  57
  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";
  82
  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");
  91
  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");
 109
 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();
 115
 116     private static final Integer FIRST_CHILD_ID = 1;
 117     private static final Integer SECOND_CHILD_ID = 2;
 118
 119     private static final String FIRST_CHILD_NAME = "first child";
 120     private static final String SECOND_CHILD_NAME = "second child";
 121
 122     private static final Integer FIRST_GRAND_CHILD_ID = 1;
 123     private static final Integer SECOND_GRAND_CHILD_ID = 2;
 124
 125     private static final String FIRST_GRAND_CHILD_NAME = "first grand child";
 126     private static final String SECOND_GRAND_CHILD_NAME = "second grand child";
 127
 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)) //
 133                     .build()) //
 134             .build();
 135
 136     private TestModel() {
 137         throw new UnsupportedOperationException();
 138     }
 139
 140     public static InputStream getDatastoreTestInputStream() {
 141         return getInputStream(DATASTORE_TEST_YANG);
 142     }
 143
 144     public static InputStream getDatastoreAugInputStream() {
 145         return getInputStream(DATASTORE_AUG_YANG);
 146     }
 147
 148     public static InputStream getDatastoreTestNotificationInputStream() {
 149         return getInputStream(DATASTORE_TEST_NOTIFICATION_YANG);
 150     }
 151
 152     private static InputStream getInputStream(final String resourceName) {
 153         return TestModel.class.getResourceAsStream(resourceName);
 154     }
 155
 156     public static EffectiveModelContext createTestContext() {
 157         return YangParserTestUtils.parseYangResources(TestModel.class, DATASTORE_TEST_YANG, DATASTORE_AUG_YANG,
 158             DATASTORE_TEST_NOTIFICATION_YANG);
 159     }
 160
 161     public static EffectiveModelContext createTestContextWithoutTestSchema() {
 162         return YangParserTestUtils.parseYangResource(DATASTORE_TEST_NOTIFICATION_YANG);
 163     }
 164
 165     public static EffectiveModelContext createTestContextWithoutAugmentationSchema() {
 166         return YangParserTestUtils.parseYangResources(TestModel.class, DATASTORE_TEST_YANG,
 167             DATASTORE_TEST_NOTIFICATION_YANG);
 168     }
 169
 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"));
 177
 178         // Create the document
 179         return ImmutableNodes.newContainerBuilder()
 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(ImmutableNodes.newUnkeyedListBuilder()
 192                 .withNodeIdentifier(new NodeIdentifier(UNKEYED_LIST_QNAME))
 193                 // Create unkeyed list entry
 194                 .withChild(ImmutableNodes.newUnkeyedListEntryBuilder()
 195                     .withNodeIdentifier(new NodeIdentifier(UNKEYED_LIST_QNAME))
 196                     .withChild(leafNode(NAME_QNAME, "unkeyed-entry-name"))
 197                     .build())
 198                 .build())
 199             .withChild(ImmutableNodes.newChoiceBuilder()
 200                 .withNodeIdentifier(new NodeIdentifier(TWO_THREE_QNAME))
 201                 .withChild(leafNode(TWO_QNAME, "two")).build())
 202             .withChild(ImmutableNodes.newUserMapBuilder()
 203                 .withNodeIdentifier(new NodeIdentifier(ORDERED_LIST_QNAME))
 204                 .withValue(List.of(
 205                     mapEntryBuilder(ORDERED_LIST_QNAME, ORDERED_LIST_ENTRY_QNAME, "1").build(),
 206                     mapEntryBuilder(ORDERED_LIST_QNAME, ORDERED_LIST_ENTRY_QNAME, "2").build()))
 207                 .build())
 208             .withChild(ImmutableNodes.newSystemLeafSetBuilder()
 209                 .withNodeIdentifier(new NodeIdentifier(SHOE_QNAME))
 210                 .withChildValue("nike")
 211                 .withChildValue("puma")
 212                 .build())
 213             .withChild(ImmutableNodes.newSystemLeafSetBuilder()
 214                 .withNodeIdentifier(new NodeIdentifier(QName.create(TEST_QNAME, "number")))
 215                 .withChildValue(5)
 216                 .withChildValue(15)
 217                 .build())
 218             .withChild(ImmutableNodes.newContainerBuilder()
 219                 .withNodeIdentifier(new NodeIdentifier(SWITCH_FEATURES_QNAME))
 220                 // Test a leaf-list where each entry contains an identity
 221                 .withChild(ImmutableNodes.newSystemLeafSetBuilder()
 222                     .withNodeIdentifier(new NodeIdentifier(QName.create(TEST_QNAME, "capability")))
 223                     .withChildValue(DESC_QNAME)
 224                     .build())
 225                 .build())
 226             .withChild(mapNodeBuilder(AUGMENTED_LIST_QNAME)
 227                 // Create augmentations
 228                 .withChild(createAugmentedListEntry(1, "First Test"))
 229                 .build())
 230             .withChild(mapNodeBuilder(OUTER_LIST_QNAME)
 231                 .withChild(mapEntry(OUTER_LIST_QNAME, ID_QNAME, ONE_ID))
 232                 .withChild(BAR_NODE)
 233                 .build());
 234     }
 235
 236     public static ContainerNode createTestContainer() {
 237         return createBaseTestContainerBuilder().build();
 238     }
 239
 240     public static MapEntryNode createAugmentedListEntry(final int id, final String name) {
 241         return ImmutableNodes.newMapEntryBuilder()
 242             .withNodeIdentifier(NodeIdentifierWithPredicates.of(AUGMENTED_LIST_QNAME, ID_QNAME, id))
 243             .withChild(leafNode(ID_QNAME, id))
 244             .withChild(ImmutableNodes.newContainerBuilder()
 245                 .withNodeIdentifier(new NodeIdentifier(AUG_CONT_QNAME))
 246                 .withChild(leafNode(AUG_NAME_QNAME, name))
 247                 .build())
 248             .build();
 249     }
 250
 251     public static ContainerNode createFamily() {
 252         final var firstGrandChildBuilder = mapEntryBuilder(
 253                 GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME, FIRST_GRAND_CHILD_ID)
 254             .withChild(leafNode(GRAND_CHILD_NUMBER_QNAME,FIRST_GRAND_CHILD_ID))
 255             .withChild(leafNode(GRAND_CHILD_NAME_QNAME, FIRST_GRAND_CHILD_NAME));
 256
 257         return ImmutableNodes.newContainerBuilder()
 258             .withNodeIdentifier(new NodeIdentifier(FAMILY_QNAME))
 259             .withChild(ImmutableNodes.newSystemMapBuilder()
 260                 .withNodeIdentifier(new NodeIdentifier(CHILDREN_QNAME))
 261                 .withChild(mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID)
 262                     .withChild(leafNode(CHILD_NUMBER_QNAME, FIRST_CHILD_ID))
 263                     .withChild(leafNode(CHILD_NAME_QNAME, FIRST_CHILD_NAME))
 264                     .withChild(mapNodeBuilder(GRAND_CHILDREN_QNAME)
 265                         .withChild(firstGrandChildBuilder.build())
 266                         .build())
 267                     .build())
 268                 .withChild(mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID)
 269                     .withChild(leafNode(CHILD_NUMBER_QNAME, SECOND_CHILD_ID))
 270                     .withChild(leafNode(CHILD_NAME_QNAME, SECOND_CHILD_NAME))
 271                     .withChild(mapNodeBuilder(GRAND_CHILDREN_QNAME)
 272                         .withChild(firstGrandChildBuilder.build())
 273                         .build())
 274                     .build())
 275                 .build())
 276             .build();
 277     }
 278 }