opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/md/cluster/datastore/model/CompositeModel.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.md.cluster.datastore.model;
   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
  14 import java.io.InputStream;
  15 import java.util.ArrayList;
  16 import java.util.HashSet;
  17 import java.util.List;
  18 import java.util.Set;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  23 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  24 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  28 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  29 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
  36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  38 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  39
  40 public final class CompositeModel {
  41
  42     public static final QName TEST_QNAME = QName
  43             .create("urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:test", "2014-03-13", "test");
  44
  45     public static final QName AUG_QNAME = QName
  46             .create("urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:aug", "2014-03-13", "name");
  47
  48     public static final QName AUG_CONTAINER = QName.create(AUG_QNAME, "aug-container");
  49     public static final QName AUG_INNER_CONTAINER = QName.create(AUG_QNAME, "aug-inner-container");
  50     public static final QName DESC_QNAME = QName.create(TEST_QNAME, "desc");
  51     public static final QName OUTER_LIST_QNAME = QName.create(TEST_QNAME, "outer-list");
  52     public static final QName INNER_LIST_QNAME = QName.create(TEST_QNAME, "inner-list");
  53     public static final QName OUTER_CHOICE_QNAME = QName.create(TEST_QNAME, "outer-choice");
  54     public static final QName ID_QNAME = QName.create(TEST_QNAME, "id");
  55     public static final QName NAME_QNAME = QName.create(TEST_QNAME, "name");
  56     public static final QName VALUE_QNAME = QName.create(TEST_QNAME, "value");
  57     private static final String DATASTORE_TEST_YANG = "/odl-datastore-test.yang";
  58     private static final String DATASTORE_AUG_YANG = "/odl-datastore-augmentation.yang";
  59     private static final String DATASTORE_TEST_NOTIFICATION_YANG = "/odl-datastore-test-notification.yang";
  60
  61     public static final YangInstanceIdentifier TEST_PATH = YangInstanceIdentifier.of(TEST_QNAME);
  62     public static final YangInstanceIdentifier DESC_PATH = YangInstanceIdentifier.builder(TEST_PATH).node(DESC_QNAME)
  63             .build();
  64     public static final YangInstanceIdentifier OUTER_LIST_PATH = YangInstanceIdentifier.builder(TEST_PATH)
  65             .node(OUTER_LIST_QNAME).build();
  66     public static final QName TWO_QNAME = QName.create(TEST_QNAME, "two");
  67     public static final QName THREE_QNAME = QName.create(TEST_QNAME, "three");
  68
  69     private static final Integer ONE_ID = 1;
  70     private static final Integer TWO_ID = 2;
  71     private static final String TWO_ONE_NAME = "one";
  72     private static final String TWO_TWO_NAME = "two";
  73     private static final String DESC = "Hello there";
  74
  75     // Family specific constants
  76     public static final QName FAMILY_QNAME = QName.create(
  77             "urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom:store:notification-test", "2014-04-17",
  78             "family");
  79     public static final QName CHILDREN_QNAME = QName.create(FAMILY_QNAME, "children");
  80     public static final QName GRAND_CHILDREN_QNAME = QName.create(FAMILY_QNAME, "grand-children");
  81     public static final QName CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME, "child-number");
  82     public static final QName CHILD_NAME_QNAME = QName.create(FAMILY_QNAME, "child-name");
  83     public static final QName GRAND_CHILD_NUMBER_QNAME = QName.create(FAMILY_QNAME, "grand-child-number");
  84     public static final QName GRAND_CHILD_NAME_QNAME = QName.create(FAMILY_QNAME, "grand-child-name");
  85
  86     public static final YangInstanceIdentifier FAMILY_PATH = YangInstanceIdentifier.of(FAMILY_QNAME);
  87     public static final YangInstanceIdentifier FAMILY_DESC_PATH = YangInstanceIdentifier.builder(FAMILY_PATH)
  88             .node(DESC_QNAME).build();
  89     public static final YangInstanceIdentifier CHILDREN_PATH = YangInstanceIdentifier.builder(FAMILY_PATH)
  90             .node(CHILDREN_QNAME).build();
  91
  92     private static final Integer FIRST_CHILD_ID = 1;
  93     private static final Integer SECOND_CHILD_ID = 2;
  94
  95     private static final String FIRST_CHILD_NAME = "first child";
  96     private static final String SECOND_CHILD_NAME = "second child";
  97
  98     private static final Integer FIRST_GRAND_CHILD_ID = 1;
  99     private static final Integer SECOND_GRAND_CHILD_ID = 2;
 100
 101     private static final String FIRST_GRAND_CHILD_NAME = "first grand child";
 102     private static final String SECOND_GRAND_CHILD_NAME = "second grand child";
 103
 104     private static final MapEntryNode BAR_NODE = mapEntryBuilder(OUTER_LIST_QNAME, ID_QNAME, TWO_ID)
 105             .withChild(mapNodeBuilder(INNER_LIST_QNAME)
 106                     .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_ONE_NAME))
 107                     .withChild(mapEntry(INNER_LIST_QNAME, NAME_QNAME, TWO_TWO_NAME))
 108                     .build())
 109             .build();
 110
 111     private CompositeModel() {
 112
 113     }
 114
 115     public static InputStream getDatastoreTestInputStream() {
 116         return getInputStream(DATASTORE_TEST_YANG);
 117     }
 118
 119     public static InputStream getDatastoreAugInputStream() {
 120         return getInputStream(DATASTORE_AUG_YANG);
 121     }
 122
 123     public static InputStream getDatastoreTestNotificationInputStream() {
 124         return getInputStream(DATASTORE_TEST_NOTIFICATION_YANG);
 125     }
 126
 127     private static InputStream getInputStream(final String resourceName) {
 128         return CompositeModel.class.getResourceAsStream(resourceName);
 129     }
 130
 131     public static SchemaContext createTestContext() {
 132         List<InputStream> inputStreams = new ArrayList<>();
 133         inputStreams.add(getDatastoreTestInputStream());
 134         inputStreams.add(getDatastoreAugInputStream());
 135         inputStreams.add(getDatastoreTestNotificationInputStream());
 136
 137         try {
 138             return YangParserTestUtils.parseYangStreams(inputStreams);
 139         } catch (ReactorException e) {
 140             throw new RuntimeException("Unable to build schema context from " + inputStreams, e);
 141         }
 142     }
 143
 144     /**
 145      * Returns a test document.
 146      *
 147      * <pre>
 148      * test
 149      *     outer-list
 150      *          id 1
 151      *     outer-list
 152      *          id 2
 153      *          inner-list
 154      *                  name "one"
 155      *          inner-list
 156      *                  name "two"
 157      *
 158      * </pre>
 159      */
 160     public static NormalizedNode<?, ?> createDocumentOne(final SchemaContext schemaContext) {
 161         return ImmutableContainerNodeBuilder.create()
 162                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(schemaContext.getQName()))
 163                 .withChild(createTestContainer()).build();
 164
 165     }
 166
 167     public static ContainerNode createTestContainer() {
 168
 169         final LeafSetEntryNode<Object> nike = ImmutableLeafSetEntryNodeBuilder.create()
 170                 .withNodeIdentifier(
 171                         new YangInstanceIdentifier.NodeWithValue<>(QName.create(TEST_QNAME, "shoe"), "nike"))
 172                 .withValue("nike").build();
 173         final LeafSetEntryNode<Object> puma = ImmutableLeafSetEntryNodeBuilder.create()
 174                 .withNodeIdentifier(
 175                         new YangInstanceIdentifier.NodeWithValue<>(QName.create(TEST_QNAME, "shoe"), "puma"))
 176                 .withValue("puma").build();
 177         final LeafSetNode<Object> shoes = ImmutableLeafSetNodeBuilder.create()
 178                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(QName.create(TEST_QNAME, "shoe")))
 179                 .withChild(nike).withChild(puma).build();
 180
 181         final LeafSetEntryNode<Object> five = ImmutableLeafSetEntryNodeBuilder.create()
 182                 .withNodeIdentifier(new YangInstanceIdentifier.NodeWithValue<>(QName.create(TEST_QNAME, "number"), 5))
 183                 .withValue(5).build();
 184         final LeafSetEntryNode<Object> fifteen = ImmutableLeafSetEntryNodeBuilder.create()
 185                 .withNodeIdentifier(
 186                         new YangInstanceIdentifier.NodeWithValue<>(QName.create(TEST_QNAME, "number"), 15))
 187                 .withValue(15).build();
 188         final LeafSetNode<Object> numbers = ImmutableLeafSetNodeBuilder.create()
 189                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(QName.create(TEST_QNAME, "number")))
 190                 .withChild(five).withChild(fifteen).build();
 191
 192         Set<QName> childAugmentations = new HashSet<>();
 193         childAugmentations.add(AUG_QNAME);
 194         final YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier =
 195                 new YangInstanceIdentifier.AugmentationIdentifier(childAugmentations);
 196         final AugmentationNode augmentationNode = Builders.augmentationBuilder()
 197                 .withNodeIdentifier(augmentationIdentifier).withChild(ImmutableNodes.leafNode(AUG_QNAME, "First Test"))
 198                 .build();
 199         return ImmutableContainerNodeBuilder.create()
 200                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TEST_QNAME))
 201                 .withChild(ImmutableNodes.leafNode(DESC_QNAME, DESC)).withChild(augmentationNode).withChild(shoes)
 202                 .withChild(numbers).withChild(mapNodeBuilder(OUTER_LIST_QNAME)
 203                         .withChild(mapEntry(OUTER_LIST_QNAME, ID_QNAME, ONE_ID)).withChild(BAR_NODE).build())
 204                 .build();
 205
 206     }
 207
 208     public static ContainerNode createFamily() {
 209         final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode>
 210             familyContainerBuilder = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
 211                     new YangInstanceIdentifier.NodeIdentifier(FAMILY_QNAME));
 212
 213         final CollectionNodeBuilder<MapEntryNode, MapNode> childrenBuilder = mapNodeBuilder(CHILDREN_QNAME);
 214
 215         final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode>
 216             firstChildBuilder = mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, FIRST_CHILD_ID);
 217         final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode>
 218             secondChildBuilder = mapEntryBuilder(CHILDREN_QNAME, CHILD_NUMBER_QNAME, SECOND_CHILD_ID);
 219
 220         final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode>
 221             firstGrandChildBuilder = mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
 222                     FIRST_GRAND_CHILD_ID);
 223         final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode>
 224             secondGrandChildBuilder = mapEntryBuilder(GRAND_CHILDREN_QNAME, GRAND_CHILD_NUMBER_QNAME,
 225                     SECOND_GRAND_CHILD_ID);
 226
 227         firstGrandChildBuilder.withChild(ImmutableNodes.leafNode(GRAND_CHILD_NUMBER_QNAME, FIRST_GRAND_CHILD_ID))
 228                 .withChild(ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME, FIRST_GRAND_CHILD_NAME));
 229
 230         secondGrandChildBuilder.withChild(ImmutableNodes.leafNode(GRAND_CHILD_NUMBER_QNAME, SECOND_GRAND_CHILD_ID))
 231                 .withChild(ImmutableNodes.leafNode(GRAND_CHILD_NAME_QNAME, SECOND_GRAND_CHILD_NAME));
 232
 233         firstChildBuilder.withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, FIRST_CHILD_ID))
 234                 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, FIRST_CHILD_NAME))
 235                 .withChild(mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(firstGrandChildBuilder.build()).build());
 236
 237         secondChildBuilder.withChild(ImmutableNodes.leafNode(CHILD_NUMBER_QNAME, SECOND_CHILD_ID))
 238                 .withChild(ImmutableNodes.leafNode(CHILD_NAME_QNAME, SECOND_CHILD_NAME))
 239                 .withChild(mapNodeBuilder(GRAND_CHILDREN_QNAME).withChild(firstGrandChildBuilder.build()).build());
 240
 241         childrenBuilder.withChild(firstChildBuilder.build());
 242         childrenBuilder.withChild(secondChildBuilder.build());
 243
 244         return familyContainerBuilder.withChild(childrenBuilder.build()).build();
 245     }
 246
 247 }