Skip to content

Add unit tests for reading JVM options files #52176

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
Feb 12, 2020
Merged

Add unit tests for reading JVM options files #52176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ffda718
Add unit tests for reading JVM options files
jasontedor Feb 11, 2020
d48f6ae
Formatting
jasontedor Feb 11, 2020
dbf08eb
Ensure temp directory exists
jasontedor Feb 11, 2020
214c4a6
Merge branch 'master' into read-jvm-options-files-tests
jasontedor Feb 11, 2020
274a7bb
Add messages
jasontedor Feb 11, 2020
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
44 changes: 25 additions & 19 deletions ...ion/tools/launchers/src/main/java/org/elasticsearch/tools/launchers/JvmOptionsParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
*/
final class JvmOptionsParser {

private static class JvmOptionsFileParserException extends Exception {
static class JvmOptionsFileParserException extends Exception {

private final Path jvmOptionsFile;

Expand Down Expand Up @@ -127,6 +127,29 @@ private List<String> jvmOptions(final Path config, final String esJavaOpts, fina
throws InterruptedException,
IOException,
JvmOptionsFileParserException {

final List<String> jvmOptions = readJvmOptionsFiles(config);

if (esJavaOpts != null) {
jvmOptions.addAll(
Arrays.stream(esJavaOpts.split("\\s+")).filter(Predicate.not(String::isBlank)).collect(Collectors.toUnmodifiableList())
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe?

for (String opt : esJavaOpts.split("\\s+")) {
    if (opt.isBlank() == false) {
        jvmOptions.add(opt);
    }
}

);
}

final List<String> substitutedJvmOptions = substitutePlaceholders(jvmOptions, Collections.unmodifiableMap(substitutions));
final List<String> ergonomicJvmOptions = JvmErgonomics.choose(substitutedJvmOptions);
final List<String> systemJvmOptions = SystemJvmOptions.systemJvmOptions();
final List<String> finalJvmOptions = new ArrayList<>(
systemJvmOptions.size() + substitutedJvmOptions.size() + ergonomicJvmOptions.size()
);
finalJvmOptions.addAll(systemJvmOptions); // add the system JVM options first so that they can be overridden
finalJvmOptions.addAll(substitutedJvmOptions);
finalJvmOptions.addAll(ergonomicJvmOptions);

return finalJvmOptions;
}

List<String> readJvmOptionsFiles(final Path config) throws IOException, JvmOptionsFileParserException {
final ArrayList<Path> jvmOptionsFiles = new ArrayList<>();
jvmOptionsFiles.add(config.resolve("jvm.options"));

Expand Down Expand Up @@ -154,24 +177,7 @@ private List<String> jvmOptions(final Path config, final String esJavaOpts, fina
throw new JvmOptionsFileParserException(jvmOptionsFile, invalidLines);
}
}

if (esJavaOpts != null) {
jvmOptions.addAll(
Arrays.stream(esJavaOpts.split("\\s+")).filter(Predicate.not(String::isBlank)).collect(Collectors.toUnmodifiableList())
);
}

final List<String> substitutedJvmOptions = substitutePlaceholders(jvmOptions, Collections.unmodifiableMap(substitutions));
final List<String> ergonomicJvmOptions = JvmErgonomics.choose(substitutedJvmOptions);
final List<String> systemJvmOptions = SystemJvmOptions.systemJvmOptions();
final List<String> finalJvmOptions = new ArrayList<>(
systemJvmOptions.size() + substitutedJvmOptions.size() + ergonomicJvmOptions.size()
);
finalJvmOptions.addAll(systemJvmOptions); // add the system JVM options first so that they can be overridden
finalJvmOptions.addAll(substitutedJvmOptions);
finalJvmOptions.addAll(ergonomicJvmOptions);

return finalJvmOptions;
return jvmOptions;
}

static List<String> substitutePlaceholders(final List<String> jvmOptions, final Map<String, String> substitutions) {
Expand Down
109 changes: 109 additions & 0 deletions ...ools/launchers/src/test/java/org/elasticsearch/tools/launchers/JvmOptionsParserTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
import java.io.BufferedReader;
import java.io.IOException;
import java.io.StringReader;
import java.nio.file.Files;
import java.nio.file.NoSuchFileException;
import java.nio.file.Path;
import java.nio.file.StandardOpenOption;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
Expand All @@ -31,7 +35,10 @@
import java.util.concurrent.atomic.AtomicBoolean;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasKey;
import static org.hamcrest.Matchers.hasSize;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertThat;
Expand Down Expand Up @@ -149,6 +156,108 @@ public void testComplexOptions() throws IOException {
}
}

public void testMissingRootJvmOptions() throws IOException, JvmOptionsParser.JvmOptionsFileParserException {
final Path config = newTempDir();
try {
final JvmOptionsParser parser = new JvmOptionsParser();
parser.readJvmOptionsFiles(config);
fail("expected no such file exception, the root jvm.options file does not exist");
} catch (final NoSuchFileException expected) {
// this is expected, the root JVM options file must exist
}
}

public void testReadRootJvmOptions() throws IOException, JvmOptionsParser.JvmOptionsFileParserException {
final Path config = newTempDir();
final Path rootJvmOptions = config.resolve("jvm.options");
Files.write(rootJvmOptions, List.of("# comment", "-Xms256m", "-Xmx256m"), StandardOpenOption.CREATE_NEW, StandardOpenOption.APPEND);
if (randomBoolean()) {
// an empty jvm.options.d directory should be irrelevant
Files.createDirectory(config.resolve("jvm.options.d"));
}
final JvmOptionsParser parser = new JvmOptionsParser();
final List<String> jvmOptions = parser.readJvmOptionsFiles(config);
assertThat(jvmOptions, contains("-Xms256m", "-Xmx256m"));
}

public void testReadJvmOptionsDirectory() throws IOException, JvmOptionsParser.JvmOptionsFileParserException {
final Path config = newTempDir();
Files.createDirectory(config.resolve("jvm.options.d"));
Files.write(
config.resolve("jvm.options"),
List.of("# comment", "-Xms256m", "-Xmx256m"),
StandardOpenOption.CREATE_NEW,
StandardOpenOption.APPEND
);
Files.write(
config.resolve("jvm.options.d").resolve("heap.options"),
List.of("# comment", "-Xms384m", "-Xmx384m"),
StandardOpenOption.CREATE_NEW,
StandardOpenOption.APPEND
);
final JvmOptionsParser parser = new JvmOptionsParser();
final List<String> jvmOptions = parser.readJvmOptionsFiles(config);
assertThat(jvmOptions, contains("-Xms256m", "-Xmx256m", "-Xms384m", "-Xmx384m"));
}

public void testReadJvmOptionsDirectoryInOrder() throws IOException, JvmOptionsParser.JvmOptionsFileParserException {
final Path config = newTempDir();
Files.createDirectory(config.resolve("jvm.options.d"));
Files.write(
config.resolve("jvm.options"),
List.of("# comment", "-Xms256m", "-Xmx256m"),
StandardOpenOption.CREATE_NEW,
StandardOpenOption.APPEND
);
Files.write(
config.resolve("jvm.options.d").resolve("first.options"),
List.of("# comment", "-Xms384m", "-Xmx384m"),
StandardOpenOption.CREATE_NEW,
StandardOpenOption.APPEND
);
Files.write(
config.resolve("jvm.options.d").resolve("second.options"),
List.of("# comment", "-Xms512m", "-Xmx512m"),
StandardOpenOption.CREATE_NEW,
StandardOpenOption.APPEND
);
final JvmOptionsParser parser = new JvmOptionsParser();
final List<String> jvmOptions = parser.readJvmOptionsFiles(config);
assertThat(jvmOptions, contains("-Xms256m", "-Xmx256m", "-Xms384m", "-Xmx384m", "-Xms512m", "-Xmx512m"));
}

public void testReadJvmOptionsDirectoryIgnoresFilesNotNamedOptions() throws IOException,
JvmOptionsParser.JvmOptionsFileParserException {
final Path config = newTempDir();
Files.createFile(config.resolve("jvm.options"));
Files.createDirectory(config.resolve("jvm.options.d"));
Files.write(
config.resolve("jvm.options.d").resolve("heap.not-named-options"),
List.of("# comment", "-Xms256m", "-Xmx256m"),
StandardOpenOption.CREATE_NEW,
StandardOpenOption.APPEND
);
final JvmOptionsParser parser = new JvmOptionsParser();
final List<String> jvmOptions = parser.readJvmOptionsFiles(config);
assertThat(jvmOptions, empty());
}

public void testFileContainsInvalidLinesThrowsParserException() throws IOException {
final Path config = newTempDir();
final Path rootJvmOptions = config.resolve("jvm.options");
Files.write(rootJvmOptions, List.of("XX:+UseG1GC"), StandardOpenOption.CREATE_NEW, StandardOpenOption.APPEND);
try {
final JvmOptionsParser parser = new JvmOptionsParser();
parser.readJvmOptionsFiles(config);
fail("expected JVM options file parser exception, XX:+UseG1GC is improperly formatted");
} catch (final JvmOptionsParser.JvmOptionsFileParserException expected) {
assertThat(expected.jvmOptionsFile(), equalTo(rootJvmOptions));
assertThat(expected.invalidLines().entrySet(), hasSize(1));
assertThat(expected.invalidLines(), hasKey(1));
assertThat(expected.invalidLines().get(1), equalTo("XX:+UseG1GC"));
}
}

private void assertExpectedJvmOptions(final int javaMajorVersion, final BufferedReader br, final List<String> expectedJvmOptions)
throws IOException {
final Map<String, AtomicBoolean> seenJvmOptions = new HashMap<>();
Expand Down