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