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