-
Notifications
You must be signed in to change notification settings - Fork 25k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow bootstrap plugins to appear in _cat/plugins #66260
Merged
pugnascotia
merged 7 commits into
elastic:master
from
pugnascotia:cat-api-bootstrap-plugins
Dec 17, 2020
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
e4a9ef3
Allow bootstrap plugins to appear in _cat/plugins
pugnascotia b4ecb00
Fix test
pugnascotia 60729f7
Tweak _cat/plugins YAML test to handle output change
pugnascotia e3c72d5
Merge remote-tracking branch 'upstream/master' into cat-api-bootstrap…
pugnascotia dc578a3
Add unit tests
pugnascotia 6cfda81
Simply IT for quota-aware-fs and _cat/plugins
pugnascotia 9641ab6
Merge remote-tracking branch 'upstream/master' into cat-api-bootstrap…
pugnascotia File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
178 changes: 178 additions & 0 deletions
178
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,178 @@ | ||
/* | ||
* 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.Map; | ||
import java.util.Set; | ||
import java.util.stream.Collectors; | ||
|
||
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(List.of(), 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( | ||
List.of( | ||
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( | ||
List.of(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 : List.of("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, List.of()), | ||
null, | ||
null, | ||
null | ||
) | ||
); | ||
} | ||
|
||
NodesInfoResponse nodesInfoResponse = new NodesInfoResponse(clusterName, nodeInfos, List.of()); | ||
|
||
return action.buildTable(request, clusterStateResponse, nodesInfoResponse, includeBootstrap); | ||
} | ||
|
||
private DiscoveryNode node(final int id) { | ||
return new DiscoveryNode("node-" + id, Integer.toString(id), buildNewFakeTransportAddress(), Map.of(), Set.of(), Version.CURRENT); | ||
} | ||
|
||
private PluginInfo plugin(String name, PluginType type) { | ||
return new PluginInfo(name, name + " description", "1.0", null, null, null, List.of(), false, type, null, false); | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't seem to have any unit tests for this class. Would it be possible to add a simple one? The packaging tests added seem to be testing this new flag, but that doesn't seem like the right place, since the flag doesn't directly have anything to do with the quota aware fs plugin, it's just the only example we have so far a bootstrap plugin.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rjernst I've added unit tests, please take a look.