code-generator/binding-generator-impl/src/test/java/org/opendaylight/yangtools/sal/binding/generator/impl/RefineTest.java

   1 /*
   2  * Copyright (c) 2013 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.sal.binding.generator.impl;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertFalse;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertTrue;
  14
  15 import java.io.File;
  16 import java.io.FileInputStream;
  17 import java.io.FileNotFoundException;
  18 import java.io.InputStream;
  19 import java.lang.reflect.InvocationTargetException;
  20 import java.lang.reflect.Method;
  21 import java.net.URI;
  22 import java.net.URISyntaxException;
  23 import java.util.*;
  24
  25 import org.junit.Test;
  26 import org.opendaylight.yangtools.yang.common.QName;
  27 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
  28 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  29 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
  30 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
  31 import org.opendaylight.yangtools.yang.parser.builder.impl.*;
  32 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
  33 import org.opendaylight.yangtools.yang.parser.util.GroupingUtils;
  34 import org.opendaylight.yangtools.yang.parser.util.RefineHolder;
  35 import org.opendaylight.yangtools.yang.parser.util.RefineUtils;
  36
  37 import com.google.common.collect.Lists;
  38 import com.google.common.collect.Maps;
  39
  40 //Test for class RefineUtils
  41 public class RefineTest {
  42
  43     private static List<File> testModels = new ArrayList<>();
  44
  45     private void loadTestResources() {
  46         final File listModelFile = new File(RefineTest.class.getResource("/refine.yang").getPath());
  47         testModels.add(listModelFile);
  48     }
  49
  50     private void findUnknownNode(DataSchemaNodeBuilder childNode, String unknownNodeValue, String unknownNodeName) {
  51         List<UnknownSchemaNodeBuilder> unknownSchemaNodesBuilder = childNode.getUnknownNodeBuilders();
  52         boolean refinedUnknownNodeLflstFound = false;
  53
  54         for (UnknownSchemaNodeBuilder unknownSchemaNodeBuilders : unknownSchemaNodesBuilder) {
  55             if (unknownSchemaNodeBuilders.getNodeType().getLocalName().equals(unknownNodeName)
  56                     && unknownSchemaNodeBuilders.getQName().getLocalName().equals(unknownNodeValue)) {
  57                 refinedUnknownNodeLflstFound = true;
  58             }
  59         }
  60         assertTrue("Unknown node " + unknownNodeName + " with value " + unknownNodeValue + " wasn't found.",
  61                 refinedUnknownNodeLflstFound);
  62     }
  63
  64     private void findMustConstraint(ConstraintsBuilder conDef, String mustValue) {
  65         boolean mustLflstFound = false;
  66         for (MustDefinition mustDef : conDef.getMustDefinitions()) {
  67             if (mustDef.toString().equals(mustValue)) {
  68                 mustLflstFound = true;
  69                 break;
  70             }
  71         }
  72         assertTrue("Must element in 'lflst' is missing.", mustLflstFound);
  73     }
  74
  75     @Test
  76     public void usesInGroupingDependenciesTest() {
  77         loadTestResources();
  78         assertEquals("Incorrect number of test files.", 1, testModels.size());
  79
  80         Set<UsesNodeBuilder> usesNodeBuilders = getModuleBuilder().getUsesNodes();
  81         List<RefineHolder> refineHolders = null;
  82         Set<DataSchemaNodeBuilder> dataSchemaNodeBuilders = null;
  83         for (UsesNodeBuilder usesNodeBuilder : usesNodeBuilders) {
  84             if (usesNodeBuilder.getGroupingPathAsString().equals("grp")) {
  85                 refineHolders = usesNodeBuilder.getRefines();
  86                 GroupingUtils.updateUsesParent(usesNodeBuilder);
  87                 dataSchemaNodeBuilders = usesNodeBuilder.getParent().getChildNodeBuilders();
  88                 break;
  89             }
  90         }
  91
  92         assertNotNull("List of refine holders wasn't initialized.", refineHolders);
  93         assertEquals("Incorrect number of refine holders", 4, refineHolders.size());
  94
  95         checkLflstRefineHolderAndSchemaNodeBuilder("lflst", refineHolders, dataSchemaNodeBuilders);
  96         checkChcRefineHolderAndSchemaNodeBuilder("chc", refineHolders, dataSchemaNodeBuilders);
  97         checkChc2RefineHolderAndSchemaNodeBuilder("chc2", refineHolders, dataSchemaNodeBuilders);
  98         checkAnyXmlRefineHolderAndSchemaNodeBuilder("data", refineHolders, dataSchemaNodeBuilders);
  99     }
 100
 101     private ModuleBuilder getModuleBuilder() {
 102         Class<YangParserImpl> cl = YangParserImpl.class;
 103
 104         YangParserImpl yangParserImpl = null;
 105         yangParserImpl = new YangParserImpl();
 106         assertNotNull("Instance of YangParserImpl isn't created", yangParserImpl);
 107
 108         Method methodResolveModuleBuilders = null;
 109         try {
 110             methodResolveModuleBuilders = cl.getDeclaredMethod("resolveModuleBuilders", List.class, Map.class);
 111         } catch (NoSuchMethodException | SecurityException e1) {
 112         }
 113         assertNotNull("The method resolveModuleBuilders cannot be found", methodResolveModuleBuilders);
 114
 115         final Map<InputStream, File> inputStreams = Maps.newHashMap();
 116
 117         for (final File yangFile : testModels) {
 118             try {
 119                 inputStreams.put(new FileInputStream(yangFile), yangFile);
 120             } catch (FileNotFoundException e) {
 121             }
 122         }
 123         assertEquals("Map with input streams contains incorrect number of files.", 1, inputStreams.size());
 124
 125         Map<ModuleBuilder, InputStream> builderToStreamMap = Maps.newHashMap();
 126         Map<String, Map<Date, ModuleBuilder>> modules = null;
 127         try {
 128             methodResolveModuleBuilders.setAccessible(true);
 129             modules = (Map<String, Map<Date, ModuleBuilder>>) methodResolveModuleBuilders.invoke(yangParserImpl,
 130                     Lists.newArrayList(inputStreams.keySet()), builderToStreamMap);
 131         } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
 132             e.printStackTrace();
 133         }
 134         assertEquals("Map with modules contains incorrect number of modules", 1, modules.size());
 135         Map<Date, ModuleBuilder> mapWithModuleBuilder = modules.get("module-refine");
 136         assertEquals("Map with module builders contains incorrect number of modules", 1, mapWithModuleBuilder.size());
 137         Date date = new GregorianCalendar(2013, GregorianCalendar.SEPTEMBER, 11).getTime();
 138         ModuleBuilder moduleBuilder = mapWithModuleBuilder.get(date);
 139         assertNotNull("Module builder wasn't find", moduleBuilder);
 140         return moduleBuilder;
 141     }
 142
 143     private void checkAnyXmlRefineHolderAndSchemaNodeBuilder(String string, List<RefineHolder> refineHolders,
 144             Set<DataSchemaNodeBuilder> dataSchemaNodeBuilders) {
 145         RefineHolder refHolderData = getRefineHolder("data", refineHolders);
 146
 147         QName qname = createQname();
 148         DataSchemaNodeBuilder builderData = new AnyXmlBuilder("module", 4, qname, createSchemaPath(qname));
 149
 150         assertNotNull("Refine holder data wasn't initialized.", refHolderData);
 151         RefineUtils.refineAnyxml((AnyXmlBuilder) builderData, refHolderData, 3);
 152
 153         // data node
 154         ConstraintsBuilder conDefData = builderData.getConstraints();
 155         assertFalse("'data' has incorrect value for 'mandatory'", conDefData.isMandatory());
 156
 157         String unknownNodeDataValue = "some value from data";
 158         String unknownNodeDataName = "new-subnode-data";
 159         findUnknownNode(builderData, unknownNodeDataValue, unknownNodeDataName);
 160         findMustConstraint(conDefData, "something-else = 9");
 161
 162     }
 163
 164     private void checkChc2RefineHolderAndSchemaNodeBuilder(String nodeName, List<RefineHolder> refineHolders,
 165             Set<DataSchemaNodeBuilder> dataSchemaNodeBuilders) {
 166         RefineHolder refHolderChc2 = getRefineHolder("chc2", refineHolders);
 167
 168         QName qname = createQname();
 169         DataSchemaNodeBuilder builderChc2 = new ChoiceBuilder("module", 4, qname);
 170         assertNotNull("Refine holder chc2 wasn't initialized.", refHolderChc2);
 171
 172         RefineUtils.refineChoice((ChoiceBuilder) builderChc2, refHolderChc2, 3);
 173
 174         // chc2 node
 175         ConstraintsBuilder conDefChc2 = builderChc2.getConstraints();
 176         assertFalse("'chc2' has incorrect value for 'mandatory'", conDefChc2.isMandatory());
 177     }
 178
 179     private void checkChcRefineHolderAndSchemaNodeBuilder(String nodeName, List<RefineHolder> refineHolders,
 180             Set<DataSchemaNodeBuilder> dataSchemaNodeBuilders) {
 181         RefineHolder refHolderChc = getRefineHolder("chc", refineHolders);
 182
 183         QName qname = createQname();
 184         DataSchemaNodeBuilder builderChc = new ChoiceBuilder("module", 4, qname);
 185
 186         assertNotNull("Refine holder chc wasn't initialized.", refHolderChc);
 187         assertNotNull("Data schema node builder chc wasn't initialized.", builderChc);
 188         RefineUtils.refineChoice((ChoiceBuilder) builderChc, refHolderChc, 2);
 189
 190         ChoiceBuilder choiceBuilder = null;
 191         if (builderChc instanceof ChoiceBuilder) {
 192             choiceBuilder = (ChoiceBuilder) builderChc;
 193         }
 194         assertNotNull("Choice node chc isn't of type ChoiceBuilder", choiceBuilder);
 195         assertEquals("chc node has incorrect default node.", "first", choiceBuilder.getDefaultCase());
 196         String unknownNodeChcValue = "some value from chc";
 197         String unknownNodeChcName = "new-subnode-chc";
 198         findUnknownNode(choiceBuilder, unknownNodeChcValue, unknownNodeChcName);
 199     }
 200
 201     private void checkLflstRefineHolderAndSchemaNodeBuilder(String nodeName, List<RefineHolder> refineHolders,
 202             Set<DataSchemaNodeBuilder> dataSchemaNodeBuilders) {
 203         RefineHolder refHolderLflst = getRefineHolder(nodeName, refineHolders);
 204
 205         QName qname = createQname();
 206         DataSchemaNodeBuilder builderLflst = new LeafListSchemaNodeBuilder("module", 4, qname, createSchemaPath(qname));
 207
 208         assertNotNull("Refine holder " + nodeName + " wasn't initialized.", refHolderLflst);
 209         assertNotNull("Data schema node builder " + nodeName + " wasn't initialized.", builderLflst);
 210         RefineUtils.refineLeafList((LeafListSchemaNodeBuilder) builderLflst, refHolderLflst, 1);
 211         // lflst node
 212
 213         ConstraintsBuilder conDefLflst = builderLflst.getConstraints();
 214         assertEquals("Max elements number in " + nodeName + " is incorrect.", new Integer(64),
 215                 conDefLflst.getMaxElements());
 216         assertEquals("Max elements number in " + nodeName + " is incorrect.", new Integer(32),
 217                 conDefLflst.getMinElements());
 218
 219         findMustConstraint(conDefLflst, "new = 57");
 220
 221         boolean mustLflstFound = false;
 222         for (MustDefinition mustDef : conDefLflst.getMustDefinitions()) {
 223             if (mustDef.toString().equals("new = 57")) {
 224                 mustLflstFound = true;
 225                 break;
 226             }
 227         }
 228         assertTrue("Must element in " + nodeName + " is missing.", mustLflstFound);
 229
 230         findUnknownNode(builderLflst, "some value from " + nodeName, "new-subnode");
 231
 232     }
 233
 234     private RefineHolder getRefineHolder(String refHolderName, List<RefineHolder> refineHolders) {
 235         for (RefineHolder refineHolder : refineHolders) {
 236             if (refineHolder.getName().equals(refHolderName)) {
 237                 return refineHolder;
 238             }
 239         }
 240         return null;
 241     }
 242
 243     private QName createQname() {
 244         QName qname = null;
 245         boolean uriCreated = false;
 246         try {
 247             qname = new QName(new URI("uri"), "q name");
 248             uriCreated = true;
 249         } catch (URISyntaxException e) {
 250         }
 251         assertTrue("Qname wasn't created sucessfully.", uriCreated);
 252         return qname;
 253     }
 254
 255     private SchemaPath createSchemaPath(QName qname) {
 256         List<QName> qnames = new ArrayList<>();
 257         qnames.add(createQname());
 258         return new SchemaPath(qnames, true);
 259     }
 260
 261 }