gharris1727 commented on code in PR #14064: URL: https://github.com/apache/kafka/pull/14064#discussion_r1272626540
########## tools/src/main/java/org/apache/kafka/tools/ConnectPluginPath.java: ########## @@ -0,0 +1,399 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.kafka.tools; + +import net.sourceforge.argparse4j.ArgumentParsers; +import net.sourceforge.argparse4j.impl.Arguments; +import net.sourceforge.argparse4j.inf.ArgumentGroup; +import net.sourceforge.argparse4j.inf.ArgumentParser; +import net.sourceforge.argparse4j.inf.ArgumentParserException; +import net.sourceforge.argparse4j.inf.Namespace; +import org.apache.kafka.common.utils.Exit; +import org.apache.kafka.common.utils.Utils; +import org.apache.kafka.connect.runtime.WorkerConfig; +import org.apache.kafka.connect.runtime.isolation.ClassLoaderFactory; +import org.apache.kafka.connect.runtime.isolation.DelegatingClassLoader; +import org.apache.kafka.connect.runtime.isolation.PluginDesc; +import org.apache.kafka.connect.runtime.isolation.PluginScanResult; +import org.apache.kafka.connect.runtime.isolation.PluginSource; +import org.apache.kafka.connect.runtime.isolation.PluginType; +import org.apache.kafka.connect.runtime.isolation.PluginUtils; +import org.apache.kafka.connect.runtime.isolation.ReflectionScanner; +import org.apache.kafka.connect.runtime.isolation.ServiceLoaderScanner; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.PrintStream; +import java.io.UncheckedIOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.net.URLConnection; +import java.nio.charset.StandardCharsets; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Properties; +import java.util.Set; +import java.util.function.Predicate; +import java.util.stream.Collectors; + +public class ConnectPluginPath { + + private static final String MANIFEST_PREFIX = "META-INF/services/"; + + public static void main(String[] args) { + Exit.exit(mainNoExit(args, System.out, System.err)); + } + + public static int mainNoExit(String[] args, PrintStream out, PrintStream err) { + ArgumentParser parser = parser(); + try { + Namespace namespace = parser.parseArgs(args); + Config config = parseConfig(parser, namespace, out, err); + runCommand(config); + return 0; + } catch (ArgumentParserException e) { + parser.handleError(e); + return 1; + } catch (TerseException e) { + err.println(e.getMessage()); + return 2; + } catch (Throwable e) { + err.println(e.getMessage()); + err.println(Utils.stackTrace(e)); + return 3; + } + } + + private static ArgumentParser parser() { + ArgumentParser parser = ArgumentParsers.newArgumentParser("connect-plugin-path") + .defaultHelp(true) + .description("Manage plugins on the Connect plugin.path"); + + ArgumentParser listCommand = parser.addSubparsers() + .description("List information about plugins contained within the specified plugin locations") + .dest("subcommand") + .addParser("list"); + + ArgumentParser[] subparsers = new ArgumentParser[] { + listCommand, + }; + + for (ArgumentParser subparser : subparsers) { + ArgumentGroup pluginProviders = subparser.addArgumentGroup("plugin providers"); + pluginProviders.addArgument("--plugin-location") + .setDefault(new ArrayList<>()) + .action(Arguments.append()) + .help("A single plugin location (jar file or directory)"); + + pluginProviders.addArgument("--plugin-path") + .setDefault(new ArrayList<>()) + .action(Arguments.append()) + .help("A list of locations containing plugins"); + + pluginProviders.addArgument("--worker-config") + .setDefault(new ArrayList<>()) + .action(Arguments.append()) + .help("A Connect worker configuration file"); + } + + return parser; + } + + private static Config parseConfig(ArgumentParser parser, Namespace namespace, PrintStream out, PrintStream err) throws ArgumentParserException, TerseException { + Set<Path> locations = parseLocations(parser, namespace); + switch (namespace.getString("subcommand")) { + case "list": + return new Config(Command.LIST, locations, out, err); + default: + throw new ArgumentParserException("No subcommand specified", parser); + } + } + + private static Set<Path> parseLocations(ArgumentParser parser, Namespace namespace) throws ArgumentParserException, TerseException { + List<String> rawLocations = new ArrayList<>(namespace.getList("plugin_location")); + List<String> rawPluginPaths = new ArrayList<>(namespace.getList("plugin_path")); + List<String> rawWorkerConfigs = new ArrayList<>(namespace.getList("worker_config")); + if (rawLocations.isEmpty() && rawPluginPaths.isEmpty() && rawWorkerConfigs.isEmpty()) { + throw new ArgumentParserException("Must specify at least one --plugin-location, --plugin-path, or --worker-config", parser); + } + Set<Path> pluginLocations = new HashSet<>(); + for (String rawWorkerConfig : rawWorkerConfigs) { + Properties properties; + try { + properties = Utils.loadProps(rawWorkerConfig); + } catch (IOException e) { + throw new TerseException("Unable to read worker config at " + rawWorkerConfig); + } + String pluginPath = properties.getProperty(WorkerConfig.PLUGIN_PATH_CONFIG); + if (pluginPath != null) { + rawPluginPaths.add(pluginPath); + } + } + for (String rawPluginPath : rawPluginPaths) { + try { + pluginLocations.addAll(PluginUtils.pluginLocations(rawPluginPath, true)); + } catch (UncheckedIOException e) { + throw new TerseException("Unable to parse plugin path " + rawPluginPath + ": " + e.getMessage()); + } + } + for (String rawLocation : rawLocations) { + pluginLocations.add(Paths.get(rawLocation)); + } + return pluginLocations; + } + + enum Command { + LIST + } + + private static class Config { + private final Command command; + private final Set<Path> locations; + private final PrintStream out; + private final PrintStream err; + + private Config(Command command, Set<Path> locations, PrintStream out, PrintStream err) { + this.command = command; + this.locations = locations; + this.out = out; + this.err = err; + } + + @Override + public String toString() { + return "Config{" + + "command=" + command + + ", locations=" + locations + + '}'; + } + } + + public static void runCommand(Config config) throws TerseException { + try { + for (Path pluginLocation : config.locations) { + ClassLoaderFactory factory = new ClassLoaderFactory(); + try (DelegatingClassLoader delegatingClassLoader = factory.newDelegatingClassLoader(ConnectPluginPath.class.getClassLoader())) { + Set<PluginSource> pluginSources = PluginUtils.pluginSources(Collections.singletonList(pluginLocation), delegatingClassLoader, factory); + Predicate<PluginSource> isolated = PluginSource::isolated; + PluginSource isolatedSource = pluginSources.stream() + .filter(isolated) + .findFirst() + .orElseThrow(() -> new IllegalStateException("DelegatingClassLoader should have a PluginSource corresponding to" + pluginLocation)); + PluginSource classpathSource = pluginSources.stream() + .filter(isolated.negate()) + .findFirst() + .orElseThrow(() -> new IllegalStateException("DelegatingClassLoader should have a PluginSource corresponding to the classpath")); + PluginScanResult scanResult = new ReflectionScanner().discoverPlugins(Collections.singleton(isolatedSource)); + PluginScanResult serviceLoadResult = new ServiceLoaderScanner().discoverPlugins(Collections.singleton(isolatedSource)); + PluginScanResult merged = new PluginScanResult(Arrays.asList(scanResult, serviceLoadResult)); + Set<ManifestEntry> isolatedManifests = findManifests(isolatedSource); + Set<ManifestEntry> classpathManifests = findManifests(classpathSource); + classpathManifests.forEach(isolatedManifests::remove); + Map<String, Set<ManifestEntry>> indexedManifests = indexManifests(isolatedManifests); + Map<String, List<String>> aliases = invertAliases(PluginUtils.computeAliases(merged)); + Map<String, Set<ManifestEntry>> unloadablePlugins = new HashMap<>(indexedManifests); + merged.forEach(pluginDesc -> unloadablePlugins.remove(pluginDesc.className())); + merged.forEach(pluginDesc -> operation(config, isolatedSource, aliases, indexedManifests, pluginDesc.className(), pluginDesc.version(), pluginDesc.type(), true)); + for (Set<ManifestEntry> manifestEntries : unloadablePlugins.values()) { + manifestEntries.forEach(manifestEntry -> operation(config, isolatedSource, aliases, indexedManifests, manifestEntry.className, PluginDesc.UNDEFINED_VERSION, manifestEntry.type, false)); + } + } + } + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + private static <T> void operation( + // fixed + Config config, + // each location + PluginSource source, + Map<String, List<String>> aliases, + Map<String, Set<ManifestEntry>> manifests, + // each plugin + String pluginName, + String pluginVersion, + PluginType pluginType, + boolean loadable + ) { + operation(config, source, pluginName, pluginVersion, aliases.getOrDefault(pluginName, Collections.emptyList()), pluginType, loadable, manifests.containsKey(pluginName)); + } + + private static <T> void operation( + // fixed + Config config, + // each location + PluginSource source, + // each plugin + String pluginName, + String pluginVersion, + List<String> aliases, + PluginType pluginType, + boolean loadable, + boolean hasManifest + ) { + Path pluginLocation = source.location(); + if (config.command == Command.LIST) { + String firstAlias = aliases.size() > 0 ? aliases.get(0) : "null"; + String secondAlias = aliases.size() > 1 ? aliases.get(1) : "null"; + // there should only be one location, otherwise the plugin source column will be ambiguous. Review Comment: This doesn't make sense given the surrounding code, this must have been from a previous iteration. I remember I went through a number of strategies for iterating over the plugins before arriving at this one, it must have been some simplifying assumption that is no longer relevant. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
