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