X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fconfig%2Fyang-jmx-generator%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fconfig%2Fyangjmxgenerator%2FModuleMXBeanEntryBuilder.java;h=5f8f4e0cbbbcb89fcf47727f72f517fad485ba42;hp=d8c5a56fb7a7561de457894180ad1a1b418b7f57;hb=f43b01b81319959b1907e3e04537f5169e7f33d8;hpb=0d78fea60c4818145e7bd8479427dfc04f0f8145 diff --git a/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ModuleMXBeanEntryBuilder.java b/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ModuleMXBeanEntryBuilder.java index d8c5a56fb7..5f8f4e0cbb 100644 --- a/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ModuleMXBeanEntryBuilder.java +++ b/opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ModuleMXBeanEntryBuilder.java @@ -18,7 +18,6 @@ import com.google.common.base.Optional; import com.google.common.collect.Collections2; import com.google.common.collect.Maps; import com.google.common.collect.Sets; - import java.util.Collection; import java.util.Collections; import java.util.HashMap; @@ -27,9 +26,7 @@ import java.util.Objects; import java.util.Set; import java.util.regex.Matcher; import java.util.regex.Pattern; - import javax.annotation.Nullable; - import org.opendaylight.controller.config.yangjmxgenerator.attribute.AbstractDependencyAttribute; import org.opendaylight.controller.config.yangjmxgenerator.attribute.AttributeIfc; import org.opendaylight.controller.config.yangjmxgenerator.attribute.DependencyAttribute; @@ -38,9 +35,10 @@ import org.opendaylight.controller.config.yangjmxgenerator.attribute.ListAttribu import org.opendaylight.controller.config.yangjmxgenerator.attribute.ListDependenciesAttribute; import org.opendaylight.controller.config.yangjmxgenerator.attribute.TOAttribute; import org.opendaylight.controller.config.yangjmxgenerator.plugin.util.NameConflictException; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.rev130405.ServiceRef; import org.opendaylight.yangtools.yang.common.QName; -import org.opendaylight.yangtools.yang.model.api.AugmentationSchema; -import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode; +import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode; +import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode; import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; @@ -61,6 +59,8 @@ import org.slf4j.LoggerFactory; final class ModuleMXBeanEntryBuilder { + private static final String TYPE = "type"; + private Module currentModule; private Map qNamesToSIEs; private SchemaContext schemaContext; @@ -92,22 +92,24 @@ final class ModuleMXBeanEntryBuilder { return this; } - private static final Logger logger = LoggerFactory + private static final Logger LOG = LoggerFactory .getLogger(ModuleMXBeanEntryBuilder.class); // TODO: the XPath should be parsed by code generator IMO private static final String MAGIC_STRING = "MAGIC_STRING"; private static final String MODULE_CONDITION_XPATH_TEMPLATE = "^/MAGIC_STRING:modules/MAGIC_STRING:module/MAGIC_STRING:type\\s*=\\s*['\"](.+)['\"]$"; - private static final SchemaPath expectedConfigurationAugmentationSchemaPath = SchemaPath.create(true, - createConfigQName("modules"), createConfigQName("module"), createConfigQName("configuration")); - private static final SchemaPath expectedStateAugmentationSchemaPath = SchemaPath.create(true, - createConfigQName("modules"), createConfigQName("module"), createConfigQName("state")); - private static final Pattern PREFIX_COLON_LOCAL_NAME = Pattern - .compile("^(.+):(.+)$"); + private static final SchemaPath AUGMENT_SCHEMAPATH = SchemaPath.create(true, + createConfigQName("modules"), createConfigQName("module")); + + private static final SchemaPath EXPECTED_CONFIGURATION_AUGMENTATION_SCHEMA_PATH = + AUGMENT_SCHEMAPATH.createChild(createConfigQName("configuration")); + private static final SchemaPath EXPECTED_STATE_AUGMENTATION_SCHEMA_PATH = + AUGMENT_SCHEMAPATH.createChild(createConfigQName("state")); + private static final Pattern PREFIX_COLON_LOCAL_NAME = Pattern.compile("^(.+):(.+)$"); public Map build() { - logger.debug("Generating ModuleMXBeans of {} to package {}", + LOG.debug("Generating ModuleMXBeans of {} to package {}", currentModule.getNamespace(), packageName); String configModulePrefix; @@ -129,12 +131,12 @@ final class ModuleMXBeanEntryBuilder { Map result = new HashMap<>(); - for (AugmentationSchema augmentation : currentModule.getAugmentations()) { - Set childNodes = augmentation.getChildNodes(); - if (areAllChildrenChoiceCaseNodes(childNodes)) { - for (ChoiceCaseNode childCase : castChildNodesToChoiceCases(childNodes)) { + for (AugmentationSchemaNode augmentation : currentModule.getAugmentations()) { + Collection childNodes = augmentation.getChildNodes(); + if (areAllChildrenCaseSchemaNodes(childNodes)) { + for (CaseSchemaNode childCase : castChildNodesToChoiceCases(childNodes)) { // TODO refactor, extract to standalone builder class - processChoiceCaseNode(result, uniqueGeneratedClassesNames, configModulePrefix, moduleIdentities, + processCaseSchemaNode(result, uniqueGeneratedClassesNames, configModulePrefix, moduleIdentities, unaugmentedModuleIdentities, augmentation, childCase); } } // skip if child nodes are not all cases @@ -145,7 +147,7 @@ final class ModuleMXBeanEntryBuilder { checkAttributeNamesUniqueness(uniqueGeneratedClassesNames, result); checkUnaugumentedIdentities(unaugmentedModuleIdentities); - logger.debug("Number of ModuleMXBeans to be generated: {}", result.size()); + LOG.debug("Number of ModuleMXBeans to be generated: {}", result.size()); return result; } @@ -165,12 +167,13 @@ final class ModuleMXBeanEntryBuilder { private static void checkUnaugumentedIdentities(final Map unaugmentedModuleIdentities) { if (unaugmentedModuleIdentities.size() > 0) { - logger.warn("Augmentation not found for all currentModule identities: {}", + LOG.warn("Augmentation not found for all currentModule identities: {}", unaugmentedModuleIdentities.keySet()); } } - private static void checkAttributeNamesUniqueness(final Map uniqueGeneratedClassesNames, final Map result) { + private static void checkAttributeNamesUniqueness(final Map uniqueGeneratedClassesNames, + final Map result) { for (Map.Entry entry : result.entrySet()) { checkUniqueRuntimeBeanAttributesName(entry.getValue(), uniqueGeneratedClassesNames); @@ -181,15 +184,15 @@ final class ModuleMXBeanEntryBuilder { Map moduleIdentities = Maps.newHashMap(); for (IdentitySchemaNode id : currentModule.getIdentities()) { - if (id.getBaseIdentity() != null - && ConfigConstants.MODULE_TYPE_Q_NAME.equals(id.getBaseIdentity().getQName())) { + if (!id.getBaseIdentities().isEmpty() + && ConfigConstants.MODULE_TYPE_Q_NAME.equals(id.getBaseIdentities().iterator().next().getQName())) { String identityLocalName = id.getQName().getLocalName(); if (moduleIdentities.containsKey(identityLocalName)) { throw new IllegalStateException("Module name already defined in this currentModule: " + identityLocalName); } else { moduleIdentities.put(identityLocalName, id); - logger.debug("Found identity {}", identityLocalName); + LOG.debug("Found identity {}", identityLocalName); } // validation check on unknown schema nodes boolean providedServiceWasSet = false; @@ -215,52 +218,49 @@ final class ModuleMXBeanEntryBuilder { return moduleIdentities; } - private Collection castChildNodesToChoiceCases(final Set childNodes) { - return Collections2.transform(childNodes, new Function() { + private static Collection castChildNodesToChoiceCases(final Collection childNodes) { + return Collections2.transform(childNodes, new Function() { @Nullable @Override - public ChoiceCaseNode apply(@Nullable final DataSchemaNode input) { - return (ChoiceCaseNode) input; + public CaseSchemaNode apply(@Nullable final DataSchemaNode input) { + return (CaseSchemaNode) input; } }); } - private boolean areAllChildrenChoiceCaseNodes(final Set childNodes) { + private static boolean areAllChildrenCaseSchemaNodes(final Iterable childNodes) { for (DataSchemaNode childNode : childNodes) { - if (childNode instanceof ChoiceCaseNode == false) { + if (childNode instanceof CaseSchemaNode == false) { return false; } } return true; } - private void processChoiceCaseNode(final Map result, + private void processCaseSchemaNode( + final Map result, final Map uniqueGeneratedClassesNames, final String configModulePrefix, final Map moduleIdentities, - final Map unaugmentedModuleIdentities, final AugmentationSchema augmentation, - final DataSchemaNode when) { + final Map unaugmentedModuleIdentities, + final AugmentationSchemaNode augmentation, final DataSchemaNode when) { - ChoiceCaseNode choiceCaseNode = (ChoiceCaseNode) when; - if (choiceCaseNode.getConstraints() == null || choiceCaseNode.getConstraints().getWhenCondition() == null) { + CaseSchemaNode choiceCaseNode = (CaseSchemaNode) when; + if (!choiceCaseNode.getWhenCondition().isPresent()) { return; } - RevisionAwareXPath xPath = choiceCaseNode.getConstraints().getWhenCondition(); - Matcher matcher = getWhenConditionMatcher(configModulePrefix, xPath); + java.util.Optional xPath = choiceCaseNode.getWhenCondition(); + checkState(xPath.isPresent(), "Choice node %s does not have a when condition", choiceCaseNode); + Matcher matcher = getWhenConditionMatcher(configModulePrefix, xPath.get()); if (matcher.matches() == false) { return; } String moduleLocalNameFromXPath = matcher.group(1); IdentitySchemaNode moduleIdentity = moduleIdentities.get(moduleLocalNameFromXPath); unaugmentedModuleIdentities.remove(moduleLocalNameFromXPath); - checkState(moduleIdentity != null, "Cannot find identity " + moduleLocalNameFromXPath - + " matching augmentation " + augmentation); + checkState(moduleIdentity != null, "Cannot find identity %s matching augmentation %s", moduleLocalNameFromXPath, augmentation); Map providedServices = findProvidedServices(moduleIdentity, currentModule, qNamesToSIEs, schemaContext); - if (moduleIdentity == null) { - throw new IllegalStateException("Cannot find identity specified by augmentation xpath constraint: " - + moduleLocalNameFromXPath + " of " + augmentation); - } String javaNamePrefix = TypeProviderWrapper.findJavaNamePrefix(moduleIdentity); Map yangToAttributes = null; @@ -269,13 +269,13 @@ final class ModuleMXBeanEntryBuilder { HAS_CHILDREN_AND_QNAME dataNodeContainer = getDataNodeContainer(choiceCaseNode); - if (expectedConfigurationAugmentationSchemaPath.equals(augmentation.getTargetPath())) { - logger.debug("Parsing configuration of {}", moduleLocalNameFromXPath); + if (EXPECTED_CONFIGURATION_AUGMENTATION_SCHEMA_PATH.equals(augmentation.getTargetPath())) { + LOG.debug("Parsing configuration of {}", moduleLocalNameFromXPath); yangToAttributes = fillConfiguration(dataNodeContainer, currentModule, typeProviderWrapper, qNamesToSIEs, schemaContext, packageName); checkUniqueAttributesWithGeneratedClass(uniqueGeneratedClassesNames, when.getQName(), yangToAttributes); - } else if (expectedStateAugmentationSchemaPath.equals(augmentation.getTargetPath())) { - logger.debug("Parsing state of {}", moduleLocalNameFromXPath); + } else if (EXPECTED_STATE_AUGMENTATION_SCHEMA_PATH.equals(augmentation.getTargetPath())) { + LOG.debug("Parsing state of {}", moduleLocalNameFromXPath); try { runtimeBeans = fillRuntimeBeans(dataNodeContainer, currentModule, typeProviderWrapper, packageName, moduleLocalNameFromXPath, javaNamePrefix); @@ -308,9 +308,9 @@ final class ModuleMXBeanEntryBuilder { " both state and configuration"); } else { ModuleMXBeanEntry.ModuleMXBeanEntryInitial initial = new ModuleMXBeanEntry.ModuleMXBeanEntryInitialBuilder() - .setIdSchemaNode(moduleIdentity).setPackageName(packageName).setJavaNamePrefix(javaNamePrefix) - .setNamespace(currentModule.getNamespace().toString()).setqName(ModuleUtil.getQName(currentModule)) - .build(); + .setIdSchemaNode(moduleIdentity).setPackageName(packageName).setJavaNamePrefix(javaNamePrefix) + .setNamespace(currentModule.getNamespace().toString()).setqName(ModuleUtil.getQName(currentModule)) + .build(); // construct ModuleMXBeanEntry ModuleMXBeanEntry moduleMXBeanEntry = new ModuleMXBeanEntry(initial, yangToAttributes, providedServices, @@ -323,7 +323,7 @@ final class ModuleMXBeanEntryBuilder { } } - private void checkUniqueRuntimeBeansGeneratedClasses(final Map uniqueGeneratedClassesNames, + private static void checkUniqueRuntimeBeansGeneratedClasses(final Map uniqueGeneratedClassesNames, final DataSchemaNode when, final Collection runtimeBeans) { for (RuntimeBeanEntry runtimeBean : runtimeBeans) { final String javaNameOfRuntimeMXBean = runtimeBean.getJavaNameOfRuntimeMXBean(); @@ -348,7 +348,7 @@ final class ModuleMXBeanEntryBuilder { } } - private void checkUniqueAttributesWithGeneratedClass(final Map uniqueGeneratedClassNames, + private static void checkUniqueAttributesWithGeneratedClass(final Map uniqueGeneratedClassNames, final QName parentQName, final Map yangToAttributes) { for (Map.Entry attr : yangToAttributes.entrySet()) { if (attr.getValue() instanceof TOAttribute) { @@ -361,7 +361,7 @@ final class ModuleMXBeanEntryBuilder { } } - private void checkUniqueTOAttr(final Map uniqueGeneratedClassNames, final QName parentQName, final TOAttribute attr) { + private static void checkUniqueTOAttr(final Map uniqueGeneratedClassNames, final QName parentQName, final TOAttribute attr) { final String upperCaseCamelCase = attr.getUpperCaseCammelCase(); if (uniqueGeneratedClassNames.containsKey(upperCaseCamelCase)) { QName firstDefinedQName = uniqueGeneratedClassNames.get(upperCaseCamelCase); @@ -376,7 +376,7 @@ final class ModuleMXBeanEntryBuilder { final String javaNamePrefix) { return RuntimeBeanEntry.extractClassNameToRuntimeBeanMap(packageName, dataNodeContainer, moduleLocalNameFromXPath, - typeProviderWrapper, javaNamePrefix, currentModule).values(); + typeProviderWrapper, javaNamePrefix, currentModule, schemaContext).values(); } @@ -387,8 +387,8 @@ final class ModuleMXBeanEntryBuilder { * @param choiceCaseNode state or configuration case statement * @return either choiceCaseNode or its only child container */ - private HAS_CHILDREN_AND_QNAME getDataNodeContainer(final ChoiceCaseNode choiceCaseNode) { - Set childNodes = choiceCaseNode.getChildNodes(); + private static HAS_CHILDREN_AND_QNAME getDataNodeContainer(final CaseSchemaNode choiceCaseNode) { + Collection childNodes = choiceCaseNode.getChildNodes(); if (childNodes.size() == 1) { DataSchemaNode onlyChild = childNodes.iterator().next(); if (onlyChild instanceof ContainerSchemaNode) { @@ -402,12 +402,11 @@ final class ModuleMXBeanEntryBuilder { return (HAS_CHILDREN_AND_QNAME) choiceCaseNode; } - private Map fillConfiguration(final DataNodeContainer dataNodeContainer, final Module currentModule, + private static Map fillConfiguration(final DataNodeContainer dataNodeContainer, final Module currentModule, final TypeProviderWrapper typeProviderWrapper, final Map qNamesToSIEs, final SchemaContext schemaContext, final String packageName) { Map yangToAttributes = new HashMap<>(); - Set childNodes = dataNodeContainer.getChildNodes(); - for (DataSchemaNode attrNode : childNodes) { + for (DataSchemaNode attrNode : dataNodeContainer.getChildNodes()) { AttributeIfc attributeValue = getAttributeValue(attrNode, currentModule, qNamesToSIEs, typeProviderWrapper, schemaContext, packageName); yangToAttributes.put(attributeValue.getAttributeYangName(), attributeValue); @@ -415,7 +414,7 @@ final class ModuleMXBeanEntryBuilder { return yangToAttributes; } - private Map findProvidedServices(final IdentitySchemaNode moduleIdentity, final Module currentModule, + private static Map findProvidedServices(final IdentitySchemaNode moduleIdentity, final Module currentModule, final Map qNamesToSIEs, final SchemaContext schemaContext) { Map result = new HashMap<>(); for (UnknownSchemaNode unknownNode : moduleIdentity.getUnknownSchemaNodes()) { @@ -429,7 +428,7 @@ final class ModuleMXBeanEntryBuilder { return result; } - private AttributeIfc getAttributeValue(final DataSchemaNode attrNode, final Module currentModule, + private static AttributeIfc getAttributeValue(final DataSchemaNode attrNode, final Module currentModule, final Map qNamesToSIEs, final TypeProviderWrapper typeProviderWrapper, final SchemaContext schemaContext, final String packageName) { @@ -464,37 +463,54 @@ final class ModuleMXBeanEntryBuilder { } } - private Optional extractDependency(final DataNodeContainer dataNodeContainer, + private static Optional extractDependency(final DataNodeContainer dataNodeContainer, final DataSchemaNode attrNode, final Module currentModule, final Map qNamesToSIEs, final SchemaContext schemaContext) { - if (dataNodeContainer.getUses().size() == 1 && getChildNodeSizeWithoutUses(dataNodeContainer) == 0) { + if (isDependencyContainer(dataNodeContainer)) { // reference UsesNode usesNode = dataNodeContainer.getUses().iterator().next(); - checkState(usesNode.getRefines().size() == 1, "Unexpected 'refine' child node size of " + dataNodeContainer); - LeafSchemaNode refine = (LeafSchemaNode) usesNode.getRefines().values().iterator().next(); - checkState(refine.getUnknownSchemaNodes().size() == 1, "Unexpected unknown schema node size of " + refine); - UnknownSchemaNode requiredIdentity = refine.getUnknownSchemaNodes().iterator().next(); - checkState(ConfigConstants.REQUIRED_IDENTITY_EXTENSION_QNAME.equals(requiredIdentity.getNodeType()), - "Unexpected language extension " + requiredIdentity); - String prefixAndIdentityLocalName = requiredIdentity.getNodeParameter(); - // import should point to a module - ServiceInterfaceEntry serviceInterfaceEntry = findSIE(prefixAndIdentityLocalName, currentModule, - qNamesToSIEs, schemaContext); - boolean mandatory = refine.getConstraints().isMandatory(); - AbstractDependencyAttribute reference; - if (dataNodeContainer instanceof ContainerSchemaNode) { - reference = new DependencyAttribute(attrNode, serviceInterfaceEntry, mandatory, - attrNode.getDescription()); - } else { - reference = new ListDependenciesAttribute(attrNode, serviceInterfaceEntry, mandatory, - attrNode.getDescription()); + for (SchemaNode refineNode : usesNode.getRefines().values()) { + // this will ignore name nodes, since they are not needed here + if (TYPE.equals(refineNode.getQName().getLocalName())){ + checkState(refineNode.getUnknownSchemaNodes().size() == 1, "Unexpected unknown schema node size of " + refineNode); + UnknownSchemaNode requiredIdentity = refineNode.getUnknownSchemaNodes().iterator().next(); + checkState(ConfigConstants.REQUIRED_IDENTITY_EXTENSION_QNAME.equals(requiredIdentity.getNodeType()), + "Unexpected language extension " + requiredIdentity); + String prefixAndIdentityLocalName = requiredIdentity.getNodeParameter(); + // import should point to a module + ServiceInterfaceEntry serviceInterfaceEntry = findSIE(prefixAndIdentityLocalName, currentModule, + qNamesToSIEs, schemaContext); + LeafSchemaNode refine = (LeafSchemaNode) usesNode.getRefines().values().iterator().next(); + + boolean mandatory = refine.isMandatory(); + AbstractDependencyAttribute reference; + if (dataNodeContainer instanceof ContainerSchemaNode) { + reference = new DependencyAttribute(attrNode, serviceInterfaceEntry, mandatory, + attrNode.getDescription().orElse(null)); + } else { + reference = new ListDependenciesAttribute(attrNode, serviceInterfaceEntry, mandatory, + attrNode.getDescription().orElse(null)); + } + return Optional.of(reference); + } } - return Optional.of(reference); } return Optional.absent(); } - private int getChildNodeSizeWithoutUses(final DataNodeContainer csn) { + private static boolean isDependencyContainer(final DataNodeContainer dataNodeContainer) { + if(dataNodeContainer.getUses().size() != 1) { + return false; + } + UsesNode onlyUses = dataNodeContainer.getUses().iterator().next(); + if(onlyUses.getGroupingPath().getLastComponent().equals(ServiceRef.QNAME) == false) { + return false; + } + + return getChildNodeSizeWithoutUses(dataNodeContainer) == 0; + } + + private static int getChildNodeSizeWithoutUses(final DataNodeContainer csn) { int result = 0; for (DataSchemaNode dsn : csn.getChildNodes()) { if (dsn.isAddedByUses() == false) { @@ -504,7 +520,7 @@ final class ModuleMXBeanEntryBuilder { return result; } - private ServiceInterfaceEntry findSIE(final String prefixAndIdentityLocalName, final Module currentModule, + private static ServiceInterfaceEntry findSIE(final String prefixAndIdentityLocalName, final Module currentModule, final Map qNamesToSIEs, final SchemaContext schemaContext) { Matcher m = PREFIX_COLON_LOCAL_NAME.matcher(prefixAndIdentityLocalName); @@ -515,7 +531,7 @@ final class ModuleMXBeanEntryBuilder { // Module from SchemaContext String prefix = m.group(1); ModuleImport moduleImport = findModuleImport(currentModule, prefix); - foundModule = schemaContext.findModuleByName(moduleImport.getModuleName(), moduleImport.getRevision()); + foundModule = schemaContext.findModule(moduleImport.getModuleName(), moduleImport.getRevision()).orElse(null); checkNotNull(foundModule, format("Module not found in SchemaContext by %s", moduleImport)); localSIName = m.group(2); } else { @@ -528,7 +544,7 @@ final class ModuleMXBeanEntryBuilder { return sie; } - private ModuleImport findModuleImport(final Module module, final String prefix) { + private static ModuleImport findModuleImport(final Module module, final String prefix) { for (ModuleImport moduleImport : module.getImports()) { if (moduleImport.getPrefix().equals(prefix)) { return moduleImport; @@ -544,7 +560,7 @@ final class ModuleMXBeanEntryBuilder { return pattern.matcher(whenConstraint.toString()); } - String getConfigModulePrefixFromImport(final Module currentModule) { + private static String getConfigModulePrefixFromImport(final Module currentModule) { for (ModuleImport currentImport : currentModule.getImports()) { if (currentImport.getModuleName().equals(ConfigConstants.CONFIG_MODULE)) { return currentImport.getPrefix();