yang/yang-data-impl/src/test/java/org/opendaylight/yangtools/yang/data/impl/leafref/context/DataTreeCandidateValidatorTest2.java

   1 /*
   2  * Copyright (c) 2016 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.leafref.context;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertTrue;
  12 import java.io.File;
  13 import java.io.FileNotFoundException;
  14 import java.net.URISyntaxException;
  15 import java.util.Arrays;
  16 import java.util.Set;
  17 import org.apache.log4j.BasicConfigurator;
  18 import org.junit.BeforeClass;
  19 import org.junit.Test;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.common.QNameModule;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  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.schema.ContainerNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  30 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  31 import org.opendaylight.yangtools.yang.data.api.schema.tree.TipProducingDataTree;
  32 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
  33 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefContext;
  34 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefDataValidationFailedException;
  35 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefValidatation;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
  41 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  43 import org.opendaylight.yangtools.yang.model.api.Module;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  45 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  46 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 public class DataTreeCandidateValidatorTest2 {
  51
  52     private static SchemaContext context;
  53     private static Module mainModule;
  54     private static QNameModule rootModuleQname;
  55     private static LeafRefContext rootLeafRefContext;
  56     public static TipProducingDataTree inMemoryDataTree;
  57
  58     private static QName chips;
  59     private static QName chip;
  60     private static QName devType;
  61     private static QName chipDesc;
  62
  63     private static QName devices;
  64     private static QName device;
  65     private static QName typeChoice;
  66     private static QName typeText;
  67     private static QName devDesc;
  68     private static QName sn;
  69     private static QName defaultIp;
  70
  71     private static QName deviceTypeStr;
  72     private static QName deviceType;
  73     private static QName type;
  74     private static QName desc;
  75
  76     private static final Logger LOG = LoggerFactory.getLogger(DataTreeCandidateValidatorTest2.class);
  77     private static final String NEW_LINE = System.getProperty("line.separator");
  78
  79     static {
  80         BasicConfigurator.configure();
  81     }
  82
  83     @BeforeClass
  84     public static void init() throws FileNotFoundException, ReactorException, URISyntaxException {
  85
  86         initSchemaContext();
  87         initLeafRefContext();
  88         initQnames();
  89         initDataTree();
  90     }
  91
  92     @Test
  93     public void dataTreeCanditateValidationTest2() {
  94
  95         writeDevices();
  96     }
  97
  98     private static void writeDevices() {
  99
 100         final ContainerSchemaNode devicesContSchemaNode = (ContainerSchemaNode) mainModule.getDataChildByName(devices);
 101
 102         final ContainerNode devicesContainer = createDevicesContainer(devicesContSchemaNode);
 103
 104         final YangInstanceIdentifier devicesPath = YangInstanceIdentifier.of(devices);
 105         final DataTreeModification writeModification = inMemoryDataTree.takeSnapshot().newModification();
 106         writeModification.write(devicesPath, devicesContainer);
 107
 108         writeModification.ready();
 109         final DataTreeCandidate writeDevicesCandidate = inMemoryDataTree.prepare(writeModification);
 110
 111         LOG.debug("*************************");
 112         LOG.debug("Before writeDevices: ");
 113         LOG.debug("*************************");
 114         LOG.debug(inMemoryDataTree.toString());
 115
 116         boolean exception = false;
 117         try {
 118             LeafRefValidatation.validate(writeDevicesCandidate, rootLeafRefContext);
 119         } catch (final LeafRefDataValidationFailedException e) {
 120             LOG.debug("All validation errors:" + NEW_LINE + e.getMessage());
 121
 122             assertEquals(4, e.getValidationsErrorsCount());
 123             exception = true;
 124         }
 125
 126         assertTrue(exception);
 127
 128         inMemoryDataTree.commit(writeDevicesCandidate);
 129
 130         LOG.debug("*************************");
 131         LOG.debug("After write: ");
 132         LOG.debug("*************************");
 133         LOG.debug(inMemoryDataTree.toString());
 134     }
 135
 136     private static void initQnames() {
 137
 138         chips = QName.create(rootModuleQname, "chips");
 139         chip = QName.create(rootModuleQname, "chip");
 140         devType = QName.create(rootModuleQname, "dev_type");
 141         chipDesc = QName.create(rootModuleQname, "chip_desc");
 142
 143         devices = QName.create(rootModuleQname, "devices");
 144         device = QName.create(rootModuleQname, "device");
 145         typeText = QName.create(rootModuleQname, "type_text");
 146         devDesc = QName.create(rootModuleQname, "dev_desc");
 147         sn = QName.create(rootModuleQname, "sn");
 148         defaultIp = QName.create(rootModuleQname, "default_ip");
 149
 150         deviceTypeStr = QName.create(rootModuleQname, "device_types");
 151         deviceType = QName.create(rootModuleQname, "device_type");
 152         type = QName.create(rootModuleQname, "type");
 153         desc = QName.create(rootModuleQname, "desc");
 154     }
 155
 156     private static void initSchemaContext() throws URISyntaxException, FileNotFoundException, ReactorException {
 157
 158         final File resourceFile = new File(DataTreeCandidateValidatorTest.class.getResource(
 159                 "/leafref-validation/leafref-validation2.yang").toURI());
 160         final File resourceDir = resourceFile.getParentFile();
 161
 162         context = YangParserTestUtils.parseYangSources(Arrays.asList(resourceDir.listFiles()));
 163
 164         final Set<Module> modules = context.getModules();
 165         for (final Module module : modules) {
 166             if (module.getName().equals("leafref-validation2")) {
 167                 mainModule = module;
 168             }
 169         }
 170
 171         rootModuleQname = mainModule.getQNameModule();
 172     }
 173
 174     private static void initDataTree() {
 175
 176         inMemoryDataTree = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
 177         inMemoryDataTree.setSchemaContext(context);
 178
 179         final DataTreeModification initialDataTreeModification = inMemoryDataTree.takeSnapshot().newModification();
 180
 181         final ContainerSchemaNode chipsListContSchemaNode = (ContainerSchemaNode) mainModule.getDataChildByName(chips);
 182         final ContainerNode chipsContainer = createChipsContainer(chipsListContSchemaNode);
 183         final YangInstanceIdentifier path1 = YangInstanceIdentifier.of(chips);
 184         initialDataTreeModification.write(path1, chipsContainer);
 185
 186         final ContainerSchemaNode devTypesListContSchemaNode = (ContainerSchemaNode) mainModule
 187                 .getDataChildByName(deviceTypeStr);
 188         final ContainerNode deviceTypesContainer = createDevTypeStrContainer(devTypesListContSchemaNode);
 189         final YangInstanceIdentifier path2 = YangInstanceIdentifier.of(deviceTypeStr);
 190         initialDataTreeModification.write(path2, deviceTypesContainer);
 191
 192         initialDataTreeModification.ready();
 193         final DataTreeCandidate writeChipsCandidate = inMemoryDataTree.prepare(initialDataTreeModification);
 194
 195         inMemoryDataTree.commit(writeChipsCandidate);
 196
 197         System.out.println(inMemoryDataTree.toString());
 198     }
 199
 200     private static void initLeafRefContext() {
 201         rootLeafRefContext = LeafRefContext.create(context);
 202     }
 203
 204     private static ContainerNode createDevTypeStrContainer(final ContainerSchemaNode container) {
 205
 206         final ListSchemaNode devTypeListSchemaNode = (ListSchemaNode) container.getDataChildByName(deviceType);
 207
 208         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> devTypeContainerBldr = Builders
 209                 .containerBuilder(container);
 210
 211         final MapNode devTypeMap = createDevTypeList(devTypeListSchemaNode);
 212         devTypeContainerBldr.addChild(devTypeMap);
 213
 214         return devTypeContainerBldr.build();
 215     }
 216
 217     private static MapNode createDevTypeList(final ListSchemaNode devTypeListSchemaNode) {
 218
 219         final CollectionNodeBuilder<MapEntryNode, MapNode> devTypeMapBldr = Builders.mapBuilder(devTypeListSchemaNode);
 220
 221         devTypeMapBldr.addChild(createDevTypeListEntry("dev_type_1", "typedesc1", devTypeListSchemaNode));
 222         devTypeMapBldr.addChild(createDevTypeListEntry("dev_type_2", "typedesc2", devTypeListSchemaNode));
 223         devTypeMapBldr.addChild(createDevTypeListEntry("dev_type_3", "typedesc3", devTypeListSchemaNode));
 224
 225         return devTypeMapBldr.build();
 226     }
 227
 228     private static MapEntryNode createDevTypeListEntry(final String typeVal, final String descVal,
 229             final ListSchemaNode devTypeListSchemaNode) {
 230
 231         final LeafNode<String> typeLeaf = ImmutableNodes.leafNode(type, typeVal);
 232         final LeafNode<String> descLeaf = ImmutableNodes.leafNode(desc, descVal);
 233
 234         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> devTypeMapEntryBldr = Builders
 235                 .mapEntryBuilder(devTypeListSchemaNode);
 236
 237         devTypeMapEntryBldr.addChild(typeLeaf);
 238         devTypeMapEntryBldr.addChild(descLeaf);
 239
 240         return devTypeMapEntryBldr.build();
 241     }
 242
 243     private static ContainerNode createChipsContainer(final ContainerSchemaNode container) {
 244
 245         final ListSchemaNode chipsListSchemaNode = (ListSchemaNode) container.getDataChildByName(chip);
 246
 247         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> chipsContainerBldr = Builders
 248                 .containerBuilder(container);
 249
 250         final MapNode chipsMap = createChipsList(chipsListSchemaNode);
 251         chipsContainerBldr.addChild(chipsMap);
 252
 253         return chipsContainerBldr.build();
 254     }
 255
 256     private static MapNode createChipsList(final ListSchemaNode chipsListSchemaNode) {
 257
 258         final CollectionNodeBuilder<MapEntryNode, MapNode> chipsMapBldr = Builders.mapBuilder(chipsListSchemaNode);
 259
 260         chipsMapBldr.addChild(createChipsListEntry("dev_type_1", "desc1", chipsListSchemaNode));
 261         chipsMapBldr.addChild(createChipsListEntry("dev_type_2", "desc2", chipsListSchemaNode));
 262
 263         return chipsMapBldr.build();
 264     }
 265
 266     private static MapEntryNode createChipsListEntry(final String devTypeVal, final String chipDescVal,
 267             final ListSchemaNode chipsListSchemaNode) {
 268
 269         final LeafNode<String> devTypeLeaf = ImmutableNodes.leafNode(devType, devTypeVal);
 270         final LeafNode<String> chipDescLeaf = ImmutableNodes.leafNode(chipDesc, chipDescVal);
 271
 272         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> chipsMapEntryBldr = Builders
 273                 .mapEntryBuilder(chipsListSchemaNode);
 274
 275         chipsMapEntryBldr.addChild(devTypeLeaf);
 276         chipsMapEntryBldr.addChild(chipDescLeaf);
 277
 278         return chipsMapEntryBldr.build();
 279     }
 280
 281     private static ContainerNode createDevicesContainer(final ContainerSchemaNode container) {
 282
 283         final ListSchemaNode devicesListSchemaNode = (ListSchemaNode) container.getDataChildByName(device);
 284
 285         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> devicesContainerBldr = Builders
 286                 .containerBuilder(container);
 287
 288         final MapNode devicesMap = createDeviceList(devicesListSchemaNode);
 289         devicesContainerBldr.addChild(devicesMap);
 290
 291         return devicesContainerBldr.build();
 292     }
 293
 294     private static MapNode createDeviceList(final ListSchemaNode deviceListSchemaNode) {
 295
 296         final CollectionNodeBuilder<MapEntryNode, MapNode> devicesMapBldr = Builders.mapBuilder(deviceListSchemaNode);
 297
 298         devicesMapBldr.addChild(createDeviceListEntry("dev_type_1", "typedesc1", 123456, "192.168.0.1",
 299                 deviceListSchemaNode));
 300         devicesMapBldr.addChild(createDeviceListEntry("dev_type_2", "typedesc2", 123457, "192.168.0.1",
 301                 deviceListSchemaNode));
 302         devicesMapBldr.addChild(createDeviceListEntry("dev_type_2", "typedesc3", 123457, "192.168.0.1",
 303                 deviceListSchemaNode));
 304         devicesMapBldr.addChild(createDeviceListEntry("dev_type_1", "typedesc2", 123458, "192.168.0.1",
 305                 deviceListSchemaNode));
 306         devicesMapBldr
 307                 .addChild(createDeviceListEntry("unknown", "unknown", 123457, "192.168.0.1", deviceListSchemaNode));
 308
 309         return devicesMapBldr.build();
 310     }
 311
 312     private static MapEntryNode createDeviceListEntry(final String typeTextVal, final String descVal, final int snVal,
 313             final String defaultIpVal, final ListSchemaNode devicesListSchemaNode) {
 314
 315         final LeafNode<String> typeTextLeaf = ImmutableNodes.leafNode(typeText, typeTextVal);
 316         final LeafNode<String> descLeaf = ImmutableNodes.leafNode(devDesc, descVal);
 317         final LeafNode<Integer> snValLeaf = ImmutableNodes.leafNode(sn, snVal);
 318         final LeafNode<String> defaultIpLeaf = ImmutableNodes.leafNode(defaultIp, defaultIpVal);
 319
 320         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> devicesMapEntryBldr = Builders
 321                 .mapEntryBuilder(devicesListSchemaNode);
 322
 323         devicesMapEntryBldr.addChild(typeTextLeaf);
 324         devicesMapEntryBldr.addChild(descLeaf);
 325         devicesMapEntryBldr.addChild(snValLeaf);
 326         devicesMapEntryBldr.addChild(defaultIpLeaf);
 327
 328         return devicesMapEntryBldr.build();
 329     }
 330 }