-
Notifications
You must be signed in to change notification settings - Fork 25k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Allow bootstrap plugins to appear in _cat/plugins (#66260)
Closes #66107. Bootstrap plugins are not loaded in the main Elasticsearch process, but instead take effect only when ES is starting. As such, these plugins are skipped when ES loads all installed plugins. As a result, it was impossible for the plugins _cat API to report whether any bootstrap plugins are installed. Fix this by adjusting how the loading process skips bootstrap plugins, and then tweaking the plugins _cat API so that bootstrap plugins can optionally be included in the response.
- Loading branch information
1 parent
5c97dfa
commit d948960
Showing
6 changed files
with
257 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
184 changes: 184 additions & 0 deletions
184
server/src/test/java/org/elasticsearch/rest/action/cat/RestPluginsActionTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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.elasticsearch.rest.action.cat; | ||
|
|
||
| import org.elasticsearch.Version; | ||
| import org.elasticsearch.action.admin.cluster.node.info.NodeInfo; | ||
| import org.elasticsearch.action.admin.cluster.node.info.NodesInfoResponse; | ||
| import org.elasticsearch.action.admin.cluster.node.info.PluginsAndModules; | ||
| import org.elasticsearch.action.admin.cluster.state.ClusterStateResponse; | ||
| import org.elasticsearch.cluster.ClusterName; | ||
| import org.elasticsearch.cluster.ClusterState; | ||
| import org.elasticsearch.cluster.node.DiscoveryNode; | ||
| import org.elasticsearch.cluster.node.DiscoveryNodes; | ||
| import org.elasticsearch.common.Table; | ||
| import org.elasticsearch.plugins.PluginInfo; | ||
| import org.elasticsearch.plugins.PluginType; | ||
| import org.elasticsearch.rest.RestRequest; | ||
| import org.elasticsearch.test.ESTestCase; | ||
| import org.elasticsearch.test.rest.FakeRestRequest; | ||
| import org.hamcrest.Matcher; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import static java.util.Arrays.asList; | ||
| import static java.util.Collections.emptyList; | ||
| import static java.util.Collections.emptyMap; | ||
| import static java.util.Collections.emptySet; | ||
| import static org.hamcrest.Matchers.contains; | ||
| import static org.hamcrest.Matchers.containsInAnyOrder; | ||
| import static org.hamcrest.Matchers.empty; | ||
| import static org.hamcrest.Matchers.hasSize; | ||
| import static org.hamcrest.Matchers.is; | ||
|
|
||
| public class RestPluginsActionTests extends ESTestCase { | ||
| private final RestPluginsAction action = new RestPluginsAction(); | ||
|
|
||
| /** | ||
| * Check that the plugins cat API handles no plugins being installed | ||
| */ | ||
| public void testNoPlugins() { | ||
| final Table table = buildTable(emptyList(), false); | ||
|
|
||
| assertThat(table.getRows(), is(empty())); | ||
| } | ||
|
|
||
| /** | ||
| * Check that the plugins cat API excludes bootstrap plugins when they are not requested. | ||
| */ | ||
| public void testIsolatedPluginOnly() { | ||
| final Table table = buildTable( | ||
| asList(plugin("test-plugin", PluginType.ISOLATED), plugin("ignored-plugin", PluginType.BOOTSTRAP)), | ||
| false | ||
| ); | ||
|
|
||
| // verify the table headers are correct | ||
| final List<Object> headers = table.getHeaders().stream().map(h -> h.value).collect(Collectors.toList()); | ||
| assertThat(headers, contains("id", "name", "component", "version", "description", "type")); | ||
|
|
||
| // verify the table rows are correct | ||
| final List<List<String>> rows = table.getRows() | ||
| .stream() | ||
| .map(row -> row.stream().map(c -> String.valueOf(c.value)).collect(Collectors.toList())) | ||
| .collect(Collectors.toList()); | ||
| assertThat(rows, hasSize(3)); | ||
|
|
||
| final List<Matcher<? super List<String>>> matchers = new ArrayList<>(); | ||
|
|
||
| for (int i = 0; i < 3; i++) { | ||
| matchers.add(contains(Integer.toString(i), "node-" + i, "test-plugin", "1.0", "test-plugin description", "isolated")); | ||
| } | ||
|
|
||
| assertThat(rows, containsInAnyOrder(matchers)); | ||
| } | ||
|
|
||
| /** | ||
| * Check that the plugins cat API includes bootstrap plugins when they are requested. | ||
| */ | ||
| public void testIncludeBootstrap() { | ||
| final Table table = buildTable( | ||
| asList(plugin("test-plugin", PluginType.ISOLATED), plugin("bootstrap-plugin", PluginType.BOOTSTRAP)), | ||
| true | ||
| ); | ||
|
|
||
| // verify the table rows are correct | ||
| final List<List<String>> rows = table.getRows() | ||
| .stream() | ||
| .map(row -> row.stream().map(c -> String.valueOf(c.value)).collect(Collectors.toList())) | ||
| .collect(Collectors.toList()); | ||
| assertThat(rows, hasSize(6)); | ||
|
|
||
| final List<Matcher<? super List<String>>> matchers = new ArrayList<>(); | ||
|
|
||
| for (int i = 0; i < 3; i++) { | ||
| for (String pluginName : asList("test-plugin", "bootstrap-plugin")) { | ||
| matchers.add( | ||
| contains( | ||
| Integer.toString(i), | ||
| "node-" + i, | ||
| pluginName, | ||
| "1.0", | ||
| pluginName + " description", | ||
| pluginName.contains("bootstrap") ? "bootstrap" : "isolated" | ||
| ) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| assertThat(rows, containsInAnyOrder(matchers)); | ||
| } | ||
|
|
||
| private Table buildTable(List<PluginInfo> pluginInfo, boolean includeBootstrap) { | ||
| final RestRequest request = new FakeRestRequest(); | ||
|
|
||
| final DiscoveryNodes.Builder builder = DiscoveryNodes.builder(); | ||
| for (int i = 0; i < 3; i++) { | ||
| builder.add(node(i)); | ||
| } | ||
|
|
||
| final ClusterName clusterName = new ClusterName("test"); | ||
|
|
||
| final ClusterState state = ClusterState.builder(clusterName).nodes(builder.build()).build(); | ||
| ClusterStateResponse clusterStateResponse = new ClusterStateResponse(clusterName, state, false); | ||
|
|
||
| final List<NodeInfo> nodeInfos = new ArrayList<>(); | ||
| for (int i = 0; i < 3; i++) { | ||
| nodeInfos.add( | ||
| new NodeInfo( | ||
| Version.CURRENT, | ||
| null, | ||
| node(i), | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| new PluginsAndModules(pluginInfo, emptyList()), | ||
| null, | ||
| null, | ||
| null | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| NodesInfoResponse nodesInfoResponse = new NodesInfoResponse(clusterName, nodeInfos, emptyList()); | ||
|
|
||
| return action.buildTable(request, clusterStateResponse, nodesInfoResponse, includeBootstrap); | ||
| } | ||
|
|
||
| private DiscoveryNode node(final int id) { | ||
| return new DiscoveryNode( | ||
| "node-" + id, | ||
| Integer.toString(id), | ||
| buildNewFakeTransportAddress(), | ||
| emptyMap(), | ||
| emptySet(), | ||
| Version.CURRENT | ||
| ); | ||
| } | ||
|
|
||
| private PluginInfo plugin(String name, PluginType type) { | ||
| return new PluginInfo(name, name + " description", "1.0", null, null, null, emptyList(), false, type, null, false); | ||
| } | ||
| } |