opendaylight/config/yang-jmx-generator/src/test/java/org/opendaylight/controller/config/yangjmxgenerator/ModuleMXBeanEntryNameConflictTest.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.controller.config.yangjmxgenerator;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.fail;
  12
  13 import java.io.File;
  14 import java.io.FileInputStream;
  15 import java.io.InputStream;
  16 import java.util.ArrayList;
  17 import java.util.HashMap;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Set;
  21
  22 import org.junit.Ignore;
  23 import org.junit.Test;
  24 import org.opendaylight.controller.config.yangjmxgenerator.plugin.util.NameConflictException;
  25 import org.opendaylight.controller.config.yangjmxgenerator.plugin.util.YangModelSearchUtils;
  26 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
  27 import org.opendaylight.yangtools.yang.common.QName;
  28 import org.opendaylight.yangtools.yang.model.api.Module;
  29 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 import com.google.common.base.Preconditions;
  34
  35 public class ModuleMXBeanEntryNameConflictTest extends AbstractYangTest {
  36
  37     private static final Logger logger = LoggerFactory
  38             .getLogger(ModuleMXBeanEntryNameConflictTest.class);
  39
  40     public static final String PACKAGE_NAME = "pack2";
  41     Map<File, String> testedFilesToYangModules = new HashMap<>();
  42     Map<String, String> testedYangModulesToExpectedConflictingName = new HashMap<>();
  43
  44     @Ignore
  45     @Test
  46     public void testNameConflicts() throws Exception {
  47         prepareSamples();
  48         prepareExceptionAssertions();
  49
  50         for (Map.Entry<File, String> currentTestEntry : testedFilesToYangModules
  51                 .entrySet()) {
  52             final String moduleName = currentTestEntry.getValue();
  53             final File yangFile = currentTestEntry.getKey();
  54             Module testedModule = loadYangs(yangFile, moduleName);
  55
  56             try {
  57                 logger.debug("Testing {}", yangFile);
  58                 ModuleMXBeanEntry.create(testedModule,
  59                         new HashMap<QName, ServiceInterfaceEntry>(), context,
  60                         new TypeProviderWrapper(new TypeProviderImpl(context)),
  61                         PACKAGE_NAME);
  62                 fail(yangFile.toString()
  63                         + " did not cause a name conflict and should");
  64             } catch (NameConflictException e) {
  65                 assertEquals(
  66                         testedYangModulesToExpectedConflictingName
  67                                 .get(moduleName),
  68                         e.getConflictingName());
  69             }
  70         }
  71     }
  72
  73     private void prepareSamples() {
  74         File first = new File(getClass().getResource(
  75                 "/duplicates/config-test-duplicate-attribute-in-list.yang")
  76                 .getFile());
  77         File dir = first.getParentFile();
  78
  79         for (File testYang : dir.listFiles()) {
  80             String moduleName = getYangModuleName(testYang.getName());
  81             testedFilesToYangModules.put(testYang, moduleName);
  82         }
  83     }
  84
  85     private void prepareExceptionAssertions() {
  86         testedYangModulesToExpectedConflictingName.put(
  87                 "config-test-duplicate-attribute", "DtoA");
  88         testedYangModulesToExpectedConflictingName.put(
  89                 "config-test-duplicate-attribute-in-list", "DtoA");
  90         testedYangModulesToExpectedConflictingName.put(
  91                 "config-test-duplicate-attribute-runtime-bean", "DtoA");
  92         testedYangModulesToExpectedConflictingName.put(
  93                 "config-test-generated-attributes-name-conflict", "StateB");
  94         testedYangModulesToExpectedConflictingName.put(
  95                 "config-test-runtime-bean-list-name-conflict",
  96                 "StateARuntimeMXBean");
  97         testedYangModulesToExpectedConflictingName.put(
  98                 "config-test-runtime-bean-list-name-conflict2",
  99                 "StateARuntimeMXBean");
 100         testedYangModulesToExpectedConflictingName
 101                 .put("config-test-runtime-bean-name-conflict", "StateARuntimeMXBean");
 102         testedYangModulesToExpectedConflictingName.put(
 103                 "config-test-runtime-bean-name-conflict2",
 104                 "StateARuntimeMXBean");
 105         testedYangModulesToExpectedConflictingName.put(
 106                 "config-test-duplicate-attribute-in-runtime-and-mxbean",
 107                 "port");
 108     }
 109
 110     private String getYangModuleName(String name) {
 111         int startIndex = 0;
 112         int endIndex = name.indexOf(".yang");
 113         return name.substring(startIndex, endIndex);
 114     }
 115
 116     private Module loadYangs(File testedModule, String moduleName)
 117             throws Exception {
 118         List<InputStream> yangISs = new ArrayList<>();
 119         yangISs.addAll(getStreams("/ietf-inet-types.yang"));
 120
 121         yangISs.add(new FileInputStream(testedModule));
 122
 123         yangISs.addAll(getConfigApiYangInputStreams());
 124
 125         YangParserImpl parser = new YangParserImpl();
 126         Set<Module> modulesToBuild = parser.parseYangModelsFromStreams(yangISs);
 127         // close ISs
 128         for (InputStream is : yangISs) {
 129             is.close();
 130         }
 131         context = parser.resolveSchemaContext(modulesToBuild);
 132         namesToModules = YangModelSearchUtils.mapModulesByNames(context
 133                 .getModules());
 134         configModule = namesToModules.get(ConfigConstants.CONFIG_MODULE);
 135         final Module module = namesToModules.get(moduleName);
 136         Preconditions.checkNotNull(module, "Cannot get module %s from %s",
 137                 moduleName, namesToModules.keySet());
 138         return module;
 139     }
 140
 141 }