Mercurial > hg > release > thermostat-2.0
view launcher/src/main/java/com/redhat/thermostat/launcher/internal/PluginConfigurationParser.java @ 2593:767b2627c92d
Implement cli/shell command-group support
Reviewed-by: jerboaa
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2016-November/021748.html
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2016-December/021824.html
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-January/021934.html
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-February/022139.html
author | Andrew Azores <aazores@redhat.com> |
---|---|
date | Tue, 14 Feb 2017 11:26:33 -0500 |
parents | e7fd8adb5f9c |
children |
line wrap: on
line source
/* * Copyright 2012-2017 Red Hat, Inc. * * This file is part of Thermostat. * * Thermostat is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published * by the Free Software Foundation; either version 2, or (at your * option) any later version. * * Thermostat is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Thermostat; see the file COPYING. If not see * <http://www.gnu.org/licenses/>. * * Linking this code with other modules is making a combined work * based on this code. Thus, the terms and conditions of the GNU * General Public License cover the whole combination. * * As a special exception, the copyright holders of this code give * you permission to link this code with independent modules to * produce an executable, regardless of the license terms of these * independent modules, and to copy and distribute the resulting * executable under terms of your choice, provided that you also * meet, for each linked independent module, the terms and conditions * of the license of that module. An independent module is a module * which is not derived from or based on this code. If you modify * this code, you may extend this exception to your version of the * library, but you are not obligated to do so. If you do not wish * to do so, delete this exception statement from your version. */ package com.redhat.thermostat.launcher.internal; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.IOException; import java.io.InputStream; import java.util.ArrayList; import java.util.Collections; import java.util.EnumSet; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Set; import java.util.logging.Logger; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import com.redhat.thermostat.launcher.internal.PluginConfiguration.CommandGroupMetadata; import org.apache.commons.cli.Option; import org.apache.commons.cli.OptionGroup; import org.apache.commons.cli.Options; import org.w3c.dom.Document; import org.w3c.dom.Node; import org.w3c.dom.NodeList; import org.xml.sax.ErrorHandler; import org.xml.sax.SAXException; import org.xml.sax.SAXParseException; import com.redhat.thermostat.common.utils.LoggingUtils; import com.redhat.thermostat.launcher.BundleInformation; import com.redhat.thermostat.launcher.internal.PluginConfiguration.CommandExtensions; import com.redhat.thermostat.launcher.internal.PluginConfiguration.Configurations; import com.redhat.thermostat.launcher.internal.PluginConfiguration.NewCommand; import com.redhat.thermostat.launcher.internal.PluginConfiguration.PluginID; import com.redhat.thermostat.plugin.validator.PluginConfigurationValidatorException; import com.redhat.thermostat.plugin.validator.PluginValidator; /** * Parses the configuration of a plugin as specified in an {@code File} or an * {@code InputStream}. This configuration describes which new commands this * plugin provides as well as additional jars to load for existing commands. * <p> * A example configuration looks like the following: * * <pre> * <?xml version="1.0" encoding="UTF-8"?> <plugin xmlns="http://icedtea.classpath.org/thermostat/plugins/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://icedtea.classpath.org/thermostat/plugins/v1.0"> <commands> <command> <name>platform</name> <summary>launches a bare bone Platform Client</summary> <description>launches a bare bone Platform Client. Can also do bar if optA is used.</description> <arguments> <argument>argument1</argument> </arguments> <options> <group> <required>true</required> <option> <long>optA</long> <short>a</short> <required>true</required> </option> <option> <long>optB</long> <short>b</short> <required>true</required> </option> <option> <long>optC</long> <short>b</short> <required>false</required> </option> <option common="true"> <long>dbUrl</long> </option> <option common="true"> <long>username</long> </option> <option common="true"> <long>password</long> </option> <option common="true"> <long>logLevel</long> </option> </group> <option> <long>heapId</long> <short>h</short> <argument>heapArgument</argument> <required>true</required> <description>the ID of the heapdump to analyze</description> </option> <option> <long>limit</long> <short>L</short> <argument>limitArgument</argument> <required>false</required> <description>limit search to top N results, defaults to 10</description> </option> </options> <environments> <environment>cli</environment> <environment>shell</environment> </environments> <bundles> <bundle><symbolic-name>platform.core</symbolic-name><version>0.6.0</version></bundle> <bundle><symbolic-name>platform.swing</symbolic-name><version>0.6.0</version></bundle> </bundles> <dependencies> <bundle><symbolic-name>client.core</symbolic-name><version>0.6.0</version></bundle> </dependencies> </command> <command> <name>platform2</name> <summary>launches a bare bone Platform Client</summary> <description>launches a bare bone Platform Client. Can also do bar if foo is used.</description> <arguments> <argument>argument2</argument> </arguments> <options> <option> <long>heapId2</long> <short>h</short> <argument>heapId2Argument</argument> <required>true</required> <description>the ID of the heapdump to analyze</description> </option> <option> <long>limit2</long> <short>L</short> <argument>limit2Argument</argument> <required>false</required> <description>limit search to top N results, defaults to 10</description> </option> </options> <environments> <environment>shell</environment> </environments> <bundles> <bundle><symbolic-name>platform.common</symbolic-name><version>0.6.0</version></bundle> <bundle><symbolic-name>platform.controllers</symbolic-name><version>0.6.0</version></bundle> </bundles> </command> </commands> <extensions> <extension> <name>platform3</name> <bundles> <bundle><symbolic-name>platform.common</symbolic-name><version>0.6.0</version></bundle> <bundle><symbolic-name>platform.controllers</symbolic-name><version>0.6.0</version></bundle> <bundle><symbolic-name>platform.command</symbolic-name><version>0.6.0</version></bundle> <bundle><symbolic-name>platform.common-export</symbolic-name><version>0.6.0</version></bundle> <bundle><symbolic-name>platform.swing</symbolic-name><version>0.6.0</version></bundle> </bundles> </extension> </extensions> </plugin> * </pre> * <p> * This class is thread-safe */ public class PluginConfigurationParser { private static final Logger logger = LoggingUtils.getLogger(PluginConfigurationParser.class); // thread safe because there is no state :) public PluginConfiguration parse(File configurationFile) throws FileNotFoundException, PluginConfigurationValidatorException { PluginValidator validator = new PluginValidator(); validator.validate(configurationFile); PluginConfiguration config = null; try (FileInputStream fis = new FileInputStream(configurationFile)) { config = parse(configurationFile.getParentFile().getName(), fis); } catch (IOException ioFisClosed) { // ignore if fis closing fails } return config; } PluginConfiguration parse(String pluginName, InputStream configurationStream) { try { DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); factory.setIgnoringComments(true); DocumentBuilder builder = factory.newDocumentBuilder(); builder.setErrorHandler(new ConfigurationParserErrorHandler()); Document xmlDoc = builder.parse(configurationStream); Node rootNode = xmlDoc.getFirstChild(); if (rootNode == null) { throw new PluginConfigurationParseException("no configuration found"); } return parseRootElement(pluginName, rootNode); } catch (ParserConfigurationException | SAXException | IOException exception) { throw new PluginConfigurationParseException("failed to parse plugin configuration", exception); } } private PluginConfiguration parseRootElement(String pluginName, Node root) { List<NewCommand> commands = Collections.emptyList(); List<CommandGroupMetadata> commandGroupMetadataList = Collections.emptyList(); List<CommandExtensions> extensions = Collections.emptyList(); Configurations configurations = null; String pluginID = null; if (root.getNodeName().equals("plugin")) { NodeList nodes = root.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("commands")) { commands = parseCommands(pluginName, node); } else if (node.getNodeName().equals("command-group-metadatas")) { commandGroupMetadataList = parseCommandGroupMetadatas(node); } else if (node.getNodeName().equals("extensions")) { extensions = parseExtensions(pluginName, node); } else if (node.getNodeName().equals("id")) { pluginID = node.getTextContent().trim(); } else if (node.getNodeName().equals("configurations") && (pluginID != null)) { configurations = parseConfigurations(node); } } } if (commands.isEmpty() && extensions.isEmpty()) { logger.warning("plugin " + pluginName + " does not extend any command or provide any new commands"); } if (configurations == null) { configurations = Configurations.emptyConfigurations(); } if (pluginID == null) { pluginID = ""; } return new PluginConfiguration(commands, commandGroupMetadataList, extensions, new PluginID(pluginID), configurations); } private List<NewCommand> parseCommands(String pluginName, Node commandsNode) { List<NewCommand> newCommands = new ArrayList<NewCommand>(); NodeList childNodes = commandsNode.getChildNodes(); for (int i = 0; i < childNodes.getLength(); i++) { Node node = childNodes.item(i); if (node.getNodeName().equals("command")) { NewCommand newCmd = parseNewCommand(pluginName, node); if (newCmd != null) { newCommands.add(newCmd); } } } return newCommands; } private List<CommandGroupMetadata> parseCommandGroupMetadatas(Node commandGroupMetadatasNode) { NodeList childNodes = commandGroupMetadatasNode.getChildNodes(); List<CommandGroupMetadata> commandGroupMetadatas = new ArrayList<>(childNodes.getLength()); for (int i = 0; i < childNodes.getLength(); i++) { Node node = childNodes.item(i); if (node.getNodeName().equals("command-group-metadata")) { commandGroupMetadatas.add(parseCommandGroupMetadata(node)); } } return commandGroupMetadatas; } private CommandGroupMetadata parseCommandGroupMetadata(Node commandGroupMetadataNode) { String name = null; String description = null; int sortOrder = -1; NodeList childNodes = commandGroupMetadataNode.getChildNodes(); for (int i = 0; i < childNodes.getLength(); i++) { Node node = childNodes.item(i); if (node.getNodeName().equals("name")) { name = node.getTextContent().trim(); } else if (node.getNodeName().equals("description")) { description = node.getTextContent().trim(); } else if (node.getNodeName().equals("sort-order")) { sortOrder = Integer.parseInt(node.getTextContent().trim()); } } return new CommandGroupMetadata(name, description, sortOrder); } private List<CommandExtensions> parseExtensions(String pluginName, Node extensionsNode) { List<CommandExtensions> commandExtensions = new ArrayList<CommandExtensions>(); NodeList childNodes = extensionsNode.getChildNodes(); for (int i = 0; i < childNodes.getLength(); i++) { Node node = childNodes.item(i); if (node.getNodeName().equals("extension")) { CommandExtensions additions = parseAdditionsToExistingCommand(pluginName, node); if (additions != null) { commandExtensions.add(additions); } } } return commandExtensions; } private Configurations parseConfigurations(Node configurationsNode) { NodeList childNodes = configurationsNode.getChildNodes(); Map<String, String> configs = new HashMap<String, String>(); String file = null; for (int i = 0; i < childNodes.getLength(); i++) { Node node = childNodes.item(i); if (node.getNodeName().equals("configuration")) { file = node.getTextContent().trim(); File f = new File(file); configs.put(f.getName(), file); if (!f.exists() || !f.isFile()) { logger.warning("Plugin file: " + file + " does not exist or is not a valid file."); } } } return new Configurations(configs); } private CommandExtensions parseAdditionsToExistingCommand(String pluginName, Node commandNode) { String name = null; List<BundleInformation> bundles = new ArrayList<>(); NodeList nodes = commandNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("name")) { name = node.getTextContent().trim(); } else if (node.getNodeName().equals("bundles")) { bundles.addAll(parseBundles(pluginName, name, node)); } } if (bundles.isEmpty()) { logger.warning("plugin " + pluginName + " extends the command " + name + " but supplies no bundles"); } if (name == null) { logger.warning("plugin " + pluginName + " provides extensions without specifying the command"); return null; } return new CommandExtensions(name, bundles); } private NewCommand parseNewCommand(String pluginName, Node commandNode) { String name = null; String usage = null; String summary = null; String description = null; List<String> commandGroups = new ArrayList<>(); List<PluginConfiguration.Subcommand> subcommands = new ArrayList<>(); List<String> arguments = new ArrayList<>(); Options options = new Options(); Set<Environment> availableInEnvironments = EnumSet.noneOf(Environment.class); List<BundleInformation> bundles = new ArrayList<>(); NodeList nodes = commandNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("name")) { name = node.getTextContent().trim(); } else if (node.getNodeName().equals("usage")) { usage = node.getTextContent().trim(); } else if (node.getNodeName().equals("summary")) { summary = node.getTextContent().trim(); } else if (node.getNodeName().equals("description")) { description = parseDescription(node); } else if (node.getNodeName().equals("command-groups")) { commandGroups = parseCommandGroups(node); } else if (node.getNodeName().equals("subcommands")) { subcommands = parseSubcommands(node); } else if (node.getNodeName().equals("arguments")) { arguments = parseArguments(pluginName, name, node); } else if (node.getNodeName().equals("options")) { options = parseOptions(node); } else if (node.getNodeName().equals("environments")) { availableInEnvironments = parseEnvironment(pluginName, name, node); } else if (node.getNodeName().equals("bundles")) { bundles.addAll(parseBundles(pluginName, name, node)); } } if (bundles.isEmpty()) { logger.warning("plugin " + pluginName + " provides a new command " + name + " but supplies no bundles"); } if (name == null || summary == null || description == null || availableInEnvironments.isEmpty()) { logger.warning("plugin " + pluginName + " provides an incomplete new command: " + "name='" + name + "', summary='" + summary + ", description='" + description + "', options='" + options + "'"); return null; } else { return new NewCommand(name, summary, description, commandGroups, usage, arguments, options, subcommands, availableInEnvironments, bundles); } } private List<BundleInformation> parseBundles(String pluginName, String commandName, Node bundlesNode) { List<BundleInformation> result = new ArrayList<>(); NodeList nodes = bundlesNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("bundle")) { BundleInformation bundleInfo = parseBundle(pluginName, commandName, node); if (bundleInfo != null) { result.add(bundleInfo); } } } return result; } private BundleInformation parseBundle(String pluginName, String commandName, Node bundleNode) { String name = null; String version = null; NodeList nodes = bundleNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("symbolic-name")) { name = node.getTextContent().trim(); } else if (node.getNodeName().equals("version")) { version = node.getTextContent().trim(); // FIXME hack: convert maven-style qualifiers to osgi-style qualifiers. // thermostat uses ${project.version}, which is the maven version, in the // plugin.xml files. This converts that maven -SNAPSHOT into OSGi .SNAPSHOT if (version.endsWith("-SNAPSHOT")) { version = version.replace("-SNAPSHOT", ".SNAPSHOT"); } } } if (name == null || version == null) { logger.warning("plugin " + pluginName + " has an empty bundles element for command " + name); return null; } return new BundleInformation(name, version); } private String parseDescription(Node descriptionNode) { String text = descriptionNode.getTextContent().trim(); String[] lines = text.split("(\r\n|\r|\n)+"); StringBuilder result = new StringBuilder(); for (String line : lines) { result.append(line.trim()); result.append(" "); } return result.toString().trim(); } private List<String> parseCommandGroups(Node commandGroupsNode) { NodeList nodes = commandGroupsNode.getChildNodes(); List<String> groups = new ArrayList<>(nodes.getLength()); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("command-group")) { String group = node.getTextContent().trim(); groups.add(group); } } return groups; } private String parseCommandGroup(Node commandGroupNode) { return commandGroupNode.getTextContent().trim().toLowerCase(); } private List<String> parseArguments(String pluginName, String commandName, Node argumentsNode) { return parseNodeAsList(pluginName, commandName, argumentsNode, "argument"); } private List<PluginConfiguration.Subcommand> parseSubcommands(Node subcommandsNode) { List<PluginConfiguration.Subcommand> list = new ArrayList<>(); NodeList nodes = subcommandsNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("subcommand")) { PluginConfiguration.Subcommand subcommand = parseSubcommand(node); if (subcommand != null) { list.add(subcommand); } } } return list; } private PluginConfiguration.Subcommand parseSubcommand(Node subcommandNode) { String name = null; String description = null; Options options = new Options(); NodeList nodes = subcommandNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("name")) { name = node.getTextContent().trim(); } else if (node.getNodeName().equals("description")) { description = node.getTextContent().trim(); } else if (node.getNodeName().equals("options")) { options = parseOptions(node); } } return new PluginConfiguration.Subcommand(name, description, options); } private Options parseOptions(Node optionsNode) { Options opts = new Options(); NodeList nodes = optionsNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("group")) { OptionGroup group = parseOptionGroup(node); opts.addOptionGroup(group); } else if (node.getNodeName().equals("option")) { Option option = parseOption(node); if (option != null) { opts.addOption(option); } } } return opts; } private OptionGroup parseOptionGroup(Node optionGroupNode) { OptionGroup group = new OptionGroup(); NodeList nodes = optionGroupNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("option")) { Option option = parseOption(node); if (option != null) { group.addOption(option); } } else if (node.getNodeName().equals("required")) { group.setRequired(Boolean.valueOf(node.getTextContent().trim())); } } return group; } private Option parseOption(Node optionNode) { Option option; Node type = optionNode.getAttributes().getNamedItem("common"); if (type != null && Boolean.valueOf(type.getNodeValue())) { option = parseCommonOption(optionNode); } else { option = parseNormalOption(optionNode); } return option; } private Option parseCommonOption(Node optionNode) { String longName = null; String shortName = null; boolean required = false; Option option = null; NodeList nodes = optionNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("long")) { longName = node.getTextContent().trim(); } else if (node.getNodeName().equals("short")) { shortName = node.getTextContent().trim(); } else if (node.getNodeName().equals("required")) { required = Boolean.valueOf(node.getTextContent().trim()); } } List<Option> allKnownOptions = new ArrayList<Option>(); allKnownOptions.addAll(CommonOptions.getDbOptions()); allKnownOptions.add(CommonOptions.getLogOption()); for (Option knownOption : allKnownOptions) { if (knownOption.getOpt().equals(shortName) || knownOption.getLongOpt().equals(longName)) { option = new Option(knownOption.getOpt(), knownOption.getLongOpt(), knownOption.hasArg(), knownOption.getDescription()); option.setRequired(required); option.setArgName(knownOption.getArgName()); return option; } } logger.warning("The option " + longName != null ? longName : shortName + " claims to be a common option but it isn't"); return null; } private Option parseNormalOption(Node optionNode) { String longName = null; String shortName = null; String argument = null; String description = null; boolean required = false; NodeList nodes = optionNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("long")) { longName = node.getTextContent().trim(); } else if (node.getNodeName().equals("short")) { shortName = node.getTextContent().trim(); } else if (node.getNodeName().equals("argument")) { argument = node.getTextContent().trim(); } else if (node.getNodeName().equals("description")) { description = node.getTextContent().trim(); } else if (node.getNodeName().equals("required")) { required = Boolean.valueOf(node.getTextContent().trim()); } } Option opt = new Option(shortName, longName, (argument != null), description); if (argument != null) { opt.setArgName(argument); } opt.setRequired(required); return opt; } private Set<Environment> parseEnvironment(String pluginName, String commandName, Node environmentNode) { EnumSet<Environment> result = EnumSet.noneOf(Environment.class); List<String> environments = parseNodeAsList(pluginName, commandName, environmentNode, "environment"); for (String environment : environments) { if (environment.equals("shell")) { result.add(Environment.SHELL); } else if (environment.equals("cli")) { result.add(Environment.CLI); } } return result; } private List<String> parseNodeAsList(String pluginName, String commandName, Node parentNode, String childElementName) { List<String> result = new ArrayList<>(); NodeList nodes = parentNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals(childElementName)) { String data = node.getTextContent().trim(); result.add(data); } } if (result.isEmpty()) { logger.warning("plugin " + pluginName + " has an empty " + parentNode.getNodeName() + " element for command " + commandName); } return result; } private static class ConfigurationParserErrorHandler implements ErrorHandler { @Override public void warning(SAXParseException exception) throws SAXException { // no-op } @Override public void fatalError(SAXParseException exception) throws SAXException { throw exception; } @Override public void error(SAXParseException exception) throws SAXException { throw exception; } } }