Skip to content

Simplify plugin descriptor tests #88659

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jul 20, 2022
Merged

Simplify plugin descriptor tests #88659

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ca11835
Simplify plugin descriptor tests
rjernst Jul 20, 2022
836e461
suppress
rjernst Jul 20, 2022
5338d0a
spotless
rjernst Jul 20, 2022
78d2b46
fix
rjernst Jul 20, 2022
adc7eff
spotless
rjernst Jul 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
280 changes: 61 additions & 219 deletions server/src/test/java/org/elasticsearch/plugins/PluginDescriptorTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,16 @@
import org.elasticsearch.common.io.stream.BytesStreamOutput;
import org.elasticsearch.test.ESTestCase;

import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.containsString;
Expand All @@ -29,26 +34,47 @@

public class PluginDescriptorTests extends ESTestCase {

public void testReadFromProperties() throws Exception {
private static final Map<String, String> DESCRIPTOR_TEMPLATE = Map.of(
"name",
"my_plugin",
"description",
"fake desc",
"version",
"1.0",
"elasticsearch.version",
Version.CURRENT.toString(),
"java.version",
System.getProperty("java.specification.version"),
"classname",
"FakePlugin",
"modulename",
"org.mymodule"
);

PluginDescriptor mockDescriptor(String... additionalProps) throws IOException {
assert additionalProps.length % 2 == 0;
@SuppressWarnings("unchecked")
Map.Entry<String, String>[] additionalPropEntries = (Map.Entry<String, String>[]) new Map.Entry[additionalProps.length / 2];
for (int i = 0; i < additionalProps.length; i += 2) {
additionalPropEntries[i / 2] = Map.entry(additionalProps[i], additionalProps[i + 1]);
}
var stream = Stream.concat(DESCRIPTOR_TEMPLATE.entrySet().stream(), Arrays.stream(additionalPropEntries));
Map<String, String> propsMap = stream.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (e1, e2) -> e2));
String[] props = new String[propsMap.size() * 2];
int i = 0;
for (var e : propsMap.entrySet()) {
props[i] = e.getKey();
props[i + 1] = e.getValue();
++i;
}

Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"name",
"my_plugin",
"version",
"1.0",
"elasticsearch.version",
Version.CURRENT.toString(),
"java.version",
System.getProperty("java.specification.version"),
"classname",
"FakePlugin",
"modulename",
"org.mymodule"
);
PluginDescriptor info = PluginDescriptor.readFromProperties(pluginDir);
PluginTestUtil.writePluginProperties(pluginDir, props);
return PluginDescriptor.readFromProperties(pluginDir);
}

public void testReadFromProperties() throws Exception {
PluginDescriptor info = mockDescriptor();
assertEquals("my_plugin", info.getName());
assertEquals("fake desc", info.getDescription());
assertEquals("1.0", info.getVersion());
Expand All @@ -58,241 +84,77 @@ public void testReadFromProperties() throws Exception {
}

public void testReadFromPropertiesNameMissing() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(pluginDir);
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
var e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("name", null));
assertThat(e.getMessage(), containsString("property [name] is missing in"));

PluginTestUtil.writePluginProperties(pluginDir, "name", "");
e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("name", ""));
assertThat(e.getMessage(), containsString("property [name] is missing in"));
}

public void testReadFromPropertiesDescriptionMissing() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(pluginDir, "name", "fake-plugin");
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
var e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("description", null));
assertThat(e.getMessage(), containsString("[description] is missing"));
}

public void testReadFromPropertiesVersionMissing() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(pluginDir, "description", "fake desc", "name", "fake-plugin");
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
var e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("version", null));
assertThat(e.getMessage(), containsString("[version] is missing"));
}

public void testReadFromPropertiesElasticsearchVersionMissing() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(pluginDir, "description", "fake desc", "name", "my_plugin", "version", "1.0");
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
var e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("elasticsearch.version", null));
assertThat(e.getMessage(), containsString("[elasticsearch.version] is missing"));
}

public void testReadFromPropertiesElasticsearchVersionEmpty() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"name",
"my_plugin",
"version",
"1.0",
"elasticsearch.version",
" "
);
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
var e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("elasticsearch.version", " "));
assertThat(e.getMessage(), containsString("[elasticsearch.version] is missing"));
}

public void testReadFromPropertiesJavaVersionMissing() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"name",
"my_plugin",
"elasticsearch.version",
Version.CURRENT.toString(),
"version",
"1.0"
);
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
var e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("java.version", null));
assertThat(e.getMessage(), containsString("[java.version] is missing"));
}

public void testReadFromPropertiesBadJavaVersionFormat() throws Exception {
String pluginName = "fake-plugin";
Path pluginDir = createTempDir().resolve(pluginName);
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"name",
pluginName,
"elasticsearch.version",
Version.CURRENT.toString(),
"java.version",
"1.7.0_80",
"classname",
"FakePlugin",
"version",
"1.0"
);
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
var e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("java.version", "1.7.0_80"));
assertThat(e.getMessage(), equalTo("Invalid version string: '1.7.0_80'"));
}

public void testReadFromPropertiesBogusElasticsearchVersion() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"version",
"1.0",
"name",
"my_plugin",
"elasticsearch.version",
"bogus"
);
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
var e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("elasticsearch.version", "bogus"));
assertThat(e.getMessage(), containsString("version needs to contain major, minor, and revision"));
}

public void testReadFromPropertiesJvmMissingClassname() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"name",
"my_plugin",
"version",
"1.0",
"elasticsearch.version",
Version.CURRENT.toString(),
"java.version",
System.getProperty("java.specification.version")
);
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("classname", null));
assertThat(e.getMessage(), containsString("property [classname] is missing"));
}

public void testReadFromPropertiesModulenameFallback() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"name",
"my_plugin",
"version",
"1.0",
"elasticsearch.version",
Version.CURRENT.toString(),
"java.version",
System.getProperty("java.specification.version"),
"classname",
"FakePlugin"
);
PluginDescriptor info = PluginDescriptor.readFromProperties(pluginDir);
PluginDescriptor info = mockDescriptor("modulename", null);
assertThat(info.getModuleName().isPresent(), is(false));
assertThat(info.getExtendedPlugins(), empty());
}

public void testReadFromPropertiesModulenameEmpty() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"name",
"my_plugin",
"version",
"1.0",
"elasticsearch.version",
Version.CURRENT.toString(),
"java.version",
System.getProperty("java.specification.version"),
"classname",
"FakePlugin",
"modulename",
" "
);
PluginDescriptor info = PluginDescriptor.readFromProperties(pluginDir);
PluginDescriptor info = mockDescriptor("modulename", " ");
assertThat(info.getModuleName().isPresent(), is(false));
assertThat(info.getExtendedPlugins(), empty());
}

public void testExtendedPluginsSingleExtension() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"name",
"my_plugin",
"version",
"1.0",
"elasticsearch.version",
Version.CURRENT.toString(),
"java.version",
System.getProperty("java.specification.version"),
"classname",
"FakePlugin",
"extended.plugins",
"foo"
);
PluginDescriptor info = PluginDescriptor.readFromProperties(pluginDir);
PluginDescriptor info = mockDescriptor("extended.plugins", "foo");
assertThat(info.getExtendedPlugins(), contains("foo"));
}

public void testExtendedPluginsMultipleExtensions() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"name",
"my_plugin",
"version",
"1.0",
"elasticsearch.version",
Version.CURRENT.toString(),
"java.version",
System.getProperty("java.specification.version"),
"classname",
"FakePlugin",
"extended.plugins",
"foo,bar,baz"
);
PluginDescriptor info = PluginDescriptor.readFromProperties(pluginDir);
PluginDescriptor info = mockDescriptor("extended.plugins", "foo,bar,baz");
assertThat(info.getExtendedPlugins(), contains("foo", "bar", "baz"));
}

public void testExtendedPluginsEmpty() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"description",
"fake desc",
"name",
"my_plugin",
"version",
"1.0",
"elasticsearch.version",
Version.CURRENT.toString(),
"java.version",
System.getProperty("java.specification.version"),
"classname",
"FakePlugin",
"extended.plugins",
""
);
PluginDescriptor info = PluginDescriptor.readFromProperties(pluginDir);
PluginDescriptor info = mockDescriptor("extended.plugins", "");
assertThat(info.getExtendedPlugins(), empty());
}

Expand Down Expand Up @@ -368,27 +230,7 @@ public void testPluginListSorted() {
}

public void testUnknownProperties() throws Exception {
Path pluginDir = createTempDir().resolve("fake-plugin");
PluginTestUtil.writePluginProperties(
pluginDir,
"extra",
"property",
"unknown",
"property",
"description",
"fake desc",
"classname",
"Foo",
"name",
"my_plugin",
"version",
"1.0",
"elasticsearch.version",
Version.CURRENT.toString(),
"java.version",
System.getProperty("java.specification.version")
);
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> PluginDescriptor.readFromProperties(pluginDir));
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> mockDescriptor("extra", "property"));
assertThat(e.getMessage(), containsString("Unknown properties for plugin [my_plugin] in plugin descriptor"));
}

Expand Down
5 changes: 4 additions & 1 deletion test/framework/src/main/java/org/elasticsearch/plugins/PluginTestUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ private static void writeProperties(Path propertiesFile, String... stringProps)
Files.createDirectories(propertiesFile.getParent());
Properties properties = new Properties();
for (int i = 0; i < stringProps.length; i += 2) {
properties.put(stringProps[i], stringProps[i + 1]);
String value = stringProps[i + 1];
if (value != null) {
properties.put(stringProps[i], stringProps[i + 1]);
}
}
try (OutputStream out = Files.newOutputStream(propertiesFile)) {
properties.store(out, "");
Expand Down