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