yang/yang-data-impl/src/test/java/org/opendaylight/yangtools/yang/data/impl/schema/retest/NormalizedDataBuilderTest.java

   1 /*
   2  * Copyright (c) 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.yangtools.yang.data.impl.schema.retest;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.collect.Lists;
  12 import com.google.common.collect.Sets;
  13 import java.io.File;
  14 import java.io.FileNotFoundException;
  15 import java.net.URI;
  16 import java.net.URISyntaxException;
  17 import java.util.Collections;
  18 import java.util.List;
  19 import org.junit.Before;
  20 import org.junit.Test;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  26 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  33 import org.opendaylight.yangtools.yang.data.impl.RetestUtils;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeSchemaAwareBuilder;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeSchemaAwareBuilder;
  38 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  39 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  40 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  41 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  42 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  43 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  46 import org.opendaylight.yangtools.yang.model.api.Module;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  48 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  49
  50 public class NormalizedDataBuilderTest {
  51
  52     private ContainerSchemaNode containerNode;
  53     private SchemaContext schema;
  54
  55     @Before
  56     public void setUp() throws URISyntaxException, FileNotFoundException, ReactorException {
  57         final File resourceFile = new File(getClass().getResource(
  58                 "../test.yang").toURI());
  59         schema = RetestUtils.parseYangSources(resourceFile);
  60         containerNode = (ContainerSchemaNode) getSchemaNode(schema, "test", "container");
  61     }
  62
  63     @Test
  64     public void testSchemaUnaware() {
  65         // Container
  66         DataContainerNodeBuilder<NodeIdentifier, ContainerNode> builder = Builders
  67                 .containerBuilder().withNodeIdentifier(getNodeIdentifier("container"));
  68
  69         // leaf
  70         LeafNode<String> leafChild = Builders.<String> leafBuilder().withNodeIdentifier(getNodeIdentifier("leaf"))
  71                 .withValue("String").build();
  72         builder.withChild(leafChild);
  73
  74         // leafList
  75         LeafSetNode<Integer> leafList = Builders
  76                 .<Integer> leafSetBuilder()
  77                 .withNodeIdentifier(getNodeIdentifier("leaf"))
  78                 .withChildValue(1)
  79                 .withChild(
  80                         Builders.<Integer> leafSetEntryBuilder()
  81                                 .withNodeIdentifier(getNodeWithValueIdentifier("leaf", 3)).withValue(3).build())
  82                 .build();
  83         builder.withChild(leafList);
  84
  85         // list
  86         MapEntryNode listChild1 = Builders
  87                 .mapEntryBuilder()
  88                 .withChild(
  89                         Builders.<Integer> leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"))
  90                                 .withValue(1).build())
  91                 .withChild(Builders.containerBuilder().withNodeIdentifier(getNodeIdentifier("containerInList")).build())
  92                 .withNodeIdentifier(
  93                         new NodeIdentifierWithPredicates(
  94                                 getNodeIdentifier("list").getNodeType(), Collections.singletonMap(
  95                                 getNodeIdentifier("uint32InList").getNodeType(), (Object) 1))).build();
  96
  97         MapNode list = Builders.mapBuilder().withChild(listChild1).withNodeIdentifier(getNodeIdentifier("list"))
  98                 .build();
  99         builder.withChild(list);
 100
 101         AugmentationNode augmentation = Builders
 102                 .augmentationBuilder()
 103                 .withNodeIdentifier(
 104                         new AugmentationIdentifier(Sets.newHashSet(getQName("augmentUint32"))))
 105                 .withChild(
 106                         Builders.<Integer>leafBuilder().withNodeIdentifier(getNodeIdentifier("augmentUint32"))
 107                                 .withValue(11).build()).build();
 108
 109         builder.withChild(augmentation);
 110
 111         // This works without schema (adding child from augment as a direct
 112         // child)
 113         builder.withChild(Builders.<Integer> leafBuilder().withNodeIdentifier(getNodeIdentifier("augmentUint32"))
 114                 .withValue(11).build());
 115     }
 116
 117     @Test
 118     public void testSchemaAware() {
 119         DataContainerNodeBuilder<NodeIdentifier, ContainerNode> builder = Builders
 120                 .containerBuilder(containerNode);
 121
 122         LeafSchemaNode schemaNode = (LeafSchemaNode) getSchemaNode(schema, "test", "uint32");
 123         LeafNode<String> leafChild = Builders.<String> leafBuilder(schemaNode).withValue("String").build();
 124         builder.withChild(leafChild);
 125
 126         LeafListSchemaNode leafListSchemaNode = (LeafListSchemaNode) getSchemaNode(schema, "test", "leafList");
 127         LeafSetNode<Integer> leafList = Builders.<Integer> leafSetBuilder(leafListSchemaNode).withChildValue(1)
 128                 .withChild(Builders.<Integer> leafSetEntryBuilder(leafListSchemaNode).withValue(3).build()).build();
 129         builder.withChild(leafList);
 130
 131         ListSchemaNode listSchema = (ListSchemaNode) getSchemaNode(schema, "test", "list");
 132         LeafSchemaNode uint32InListSchemaNode = (LeafSchemaNode) getSchemaNode(schema, "test", "uint32InList");
 133         ContainerSchemaNode containerInListSchemaNode = (ContainerSchemaNode) getSchemaNode(schema, "test",
 134                 "containerInList");
 135
 136         MapEntryNode listChild1 = Builders.mapEntryBuilder(listSchema)
 137                 .withChild(Builders.<Integer> leafBuilder(uint32InListSchemaNode).withValue(1).build())
 138                 .withChild(Builders.containerBuilder(containerInListSchemaNode).build()).build();
 139
 140         MapNode list = ImmutableMapNodeSchemaAwareBuilder.create(listSchema).withChild(listChild1).build();
 141         builder.withChild(list);
 142
 143         LeafSchemaNode augmentUint32SchemaNode = (LeafSchemaNode) getSchemaNode(schema, "test", "augmentUint32");
 144         AugmentationSchema augmentationSchema = getAugmentationSchemaForChild(containerNode,
 145                 augmentUint32SchemaNode.getQName());
 146
 147         AugmentationNode augmentation = Builders.augmentationBuilder(augmentationSchema)
 148                 .withChild(Builders.<Integer> leafBuilder(augmentUint32SchemaNode).withValue(11).build()).build();
 149
 150         builder.withChild(augmentation);
 151
 152         // This should fail with schema, since the leaf comes from augmentation
 153         // builder.withChild(ImmutableLeafNodeSchemaAwareBuilder.<Integer>get(augmentUint32SchemaNode).withValue(11).build());
 154
 155         LeafSchemaNode augumentString1SchemaNode = (LeafSchemaNode) getSchemaNode(schema, "test", "augmentString1");
 156         LeafSchemaNode augumentString2SchemaNode = (LeafSchemaNode) getSchemaNode(schema, "test", "augmentString2");
 157
 158         ChoiceSchemaNode choice1SchemaNode = (ChoiceSchemaNode) getSchemaNode(schema, "test", "choice");
 159         ChoiceNode choice = ImmutableChoiceNodeSchemaAwareBuilder.create(choice1SchemaNode)
 160                 .withChild(Builders.<String> leafBuilder(augumentString1SchemaNode).withValue("case1").build())
 161                 // This should fail, since child node belongs to different case
 162                 // .withChild(Builders.<String>leafBuilder(augumentString2SchemaNode).withValue("case2")
 163                 // .build())
 164                 .build();
 165
 166         ;
 167         builder.withChild(choice);
 168
 169         // This should fail, child from case
 170         // builder.withChild(Builders.<String>leafBuilder(augumentString1SchemaNode).withValue("case1")
 171         // .build());
 172     }
 173
 174     private static AugmentationSchema getAugmentationSchemaForChild(final ContainerSchemaNode containerNode,
 175             final QName qName) {
 176         for (AugmentationSchema augmentationSchema : containerNode.getAvailableAugmentations()) {
 177             if (augmentationSchema.getDataChildByName(qName) != null) {
 178                 return augmentationSchema;
 179             }
 180         }
 181         throw new IllegalStateException("Unable to find child augmentation in " + containerNode);
 182     }
 183
 184     private static <T> NodeWithValue<T> getNodeWithValueIdentifier(final String localName, final T value) {
 185         return new NodeWithValue<>(getQName(localName), value);
 186     }
 187
 188     private static QName getQName(final String localName) {
 189         String namespace = "namespace";
 190         return new QName(URI.create(namespace), localName);
 191     }
 192
 193     private static NodeIdentifier getNodeIdentifier(final String localName) {
 194         return new NodeIdentifier(getQName(localName));
 195     }
 196
 197     public static DataSchemaNode getSchemaNode(final SchemaContext context, final String moduleName,
 198             final String childNodeName) {
 199         for (Module module : context.getModules()) {
 200             if (module.getName().equals(moduleName)) {
 201                 DataSchemaNode found = findChildNode(module.getChildNodes(), childNodeName);
 202                 Preconditions.checkState(found != null, "Unable to find %s", childNodeName);
 203                 return found;
 204             }
 205         }
 206         throw new IllegalStateException("Unable to find child node " + childNodeName);
 207     }
 208
 209     private static DataSchemaNode findChildNode(final Iterable<DataSchemaNode> children, final String name) {
 210         List<DataNodeContainer> containers = Lists.newArrayList();
 211
 212         for (DataSchemaNode dataSchemaNode : children) {
 213             if (dataSchemaNode.getQName().getLocalName().equals(name)) {
 214                 return dataSchemaNode;
 215             }
 216             if (dataSchemaNode instanceof DataNodeContainer) {
 217                 containers.add((DataNodeContainer) dataSchemaNode);
 218             } else if (dataSchemaNode instanceof ChoiceSchemaNode) {
 219                 containers.addAll(((ChoiceSchemaNode) dataSchemaNode).getCases());
 220             }
 221         }
 222
 223         for (DataNodeContainer container : containers) {
 224             DataSchemaNode retVal = findChildNode(container.getChildNodes(), name);
 225             if (retVal != null) {
 226                 return retVal;
 227             }
 228         }
 229
 230         return null;
 231     }
 232 }