import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+import javax.annotation.CheckForNull;
+import javax.annotation.Nullable;
+import org.sonar.process.MessageException;
import org.sonar.process.Props;
+import static java.lang.String.format;
import static java.util.Objects.requireNonNull;
+import static java.util.stream.Collectors.joining;
public class JvmOptions<T extends JvmOptions> {
private static final String JVM_OPTION_NOT_NULL_ERROR_MESSAGE = "a JVM option can't be null";
+ private final HashMap<String, String> mandatoryOptions = new HashMap<>();
private final LinkedHashSet<String> options = new LinkedHashSet<>();
- public JvmOptions(String... mandatoryJvmOptions) {
- Arrays.stream(requireNonNull(mandatoryJvmOptions, JVM_OPTION_NOT_NULL_ERROR_MESSAGE))
- .forEach(this::add);
+ public JvmOptions() {
+ this(Collections.emptyMap());
+ }
+
+ public JvmOptions(Map<String, String> mandatoryJvmOptions) {
+ requireNonNull(mandatoryJvmOptions, JVM_OPTION_NOT_NULL_ERROR_MESSAGE)
+ .entrySet()
+ .stream()
+ .filter(e -> {
+ requireNonNull(e.getKey(), "JVM option prefix can't be null");
+ if (e.getKey().trim().isEmpty()) {
+ throw new IllegalArgumentException("JVM option prefix can't be empty");
+ }
+ requireNonNull(e.getValue(), "JVM option value can't be null");
+ return true;
+ }).forEach(e -> {
+ String key = e.getKey().trim();
+ String value = e.getValue().trim();
+ mandatoryOptions.put(key, value);
+ add(key + value);
+ });
}
public T addFromMandatoryProperty(Props props, String propertyName) {
String value = props.nonNullValue(propertyName);
if (!value.isEmpty()) {
- Arrays.stream(value.split(" (?=-)")).forEach(this::add);
+ List<String> jvmOptions = Arrays.stream(value.split(" (?=-)")).map(String::trim).collect(Collectors.toList());
+ checkOptionFormat(propertyName, jvmOptions);
+ checkMandatoryOptionOverwrite(propertyName, jvmOptions);
+ options.addAll(jvmOptions);
}
return castThis();
}
+ private static void checkOptionFormat(String propertyName, List<String> jvmOptionsFromProperty) {
+ List<String> invalidOptions = jvmOptionsFromProperty.stream()
+ .filter(JvmOptions::isInvalidOption)
+ .collect(Collectors.toList());
+ if (!invalidOptions.isEmpty()) {
+ throw new MessageException(format(
+ "a JVM option can't be empty and must start with '-'. The following JVM options defined by property '%s' are invalid: %s",
+ propertyName,
+ invalidOptions.stream()
+ .collect(joining(", "))));
+ }
+ }
+
+ private void checkMandatoryOptionOverwrite(String propertyName, List<String> jvmOptionsFromProperty) {
+ List<Match> matches = jvmOptionsFromProperty.stream()
+ .map(jvmOption -> new Match(jvmOption, mandatoryOptionFor(jvmOption)))
+ .filter(match -> match.getMandatoryOption() != null)
+ .collect(Collectors.toList());
+ if (!matches.isEmpty()) {
+ throw new MessageException(format(
+ "a JVM option can't overwrite mandatory JVM options. The following JVM options defined by property '%s' are invalid: %s",
+ propertyName,
+ matches.stream()
+ .map(m -> m.getOption() + " overwrites " + m.mandatoryOption.getKey() + m.mandatoryOption.getValue())
+ .collect(joining(", "))));
+ }
+ }
+
/**
* Add an option.
* Argument is trimmed before being added.
public T add(String str) {
requireNonNull(str, JVM_OPTION_NOT_NULL_ERROR_MESSAGE);
String value = str.trim();
- if (value.isEmpty() || !value.startsWith("-")) {
+ if (isInvalidOption(value)) {
throw new IllegalArgumentException("a JVM option can't be empty and must start with '-'");
}
+ checkMandatoryOptionOverwrite(value);
options.add(value);
return castThis();
}
+ private void checkMandatoryOptionOverwrite(String value) {
+ Map.Entry<String, String> overriddenMandatoryOption = mandatoryOptionFor(value);
+ if (overriddenMandatoryOption != null) {
+ throw new MessageException(String.format(
+ "a JVM option can't overwrite mandatory JVM options. %s overwrites %s",
+ value,
+ overriddenMandatoryOption.getKey() + overriddenMandatoryOption.getValue()));
+ }
+ }
+
+ @CheckForNull
+ private Map.Entry<String, String> mandatoryOptionFor(String jvmOption) {
+ return mandatoryOptions.entrySet().stream()
+ .filter(s -> jvmOption.startsWith(s.getKey()) && !jvmOption.equals(s.getKey() + s.getValue()))
+ .findFirst()
+ .orElse(null);
+ }
+
+ private static boolean isInvalidOption(String value) {
+ return value.isEmpty() || !value.startsWith("-");
+ }
+
@SuppressWarnings("unchecked")
private T castThis() {
return (T) this;
public String toString() {
return options.toString();
}
+
+ private static final class Match {
+ private final String option;
+
+ private final Map.Entry<String, String> mandatoryOption;
+
+ private Match(String option, @Nullable Map.Entry<String, String> mandatoryOption) {
+ this.option = option;
+ this.mandatoryOption = mandatoryOption;
+ }
+
+ String getOption() {
+ return option;
+ }
+
+ @CheckForNull
+ Map.Entry<String, String> getMandatoryOption() {
+ return mandatoryOption;
+ }
+
+ }
}
*/
package org.sonar.process.jmvoptions;
+import com.google.common.collect.ImmutableMap;
import com.tngtech.java.junit.dataprovider.DataProvider;
import com.tngtech.java.junit.dataprovider.DataProviderRunner;
import com.tngtech.java.junit.dataprovider.UseDataProvider;
-import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
import java.util.Properties;
import java.util.Random;
+import java.util.stream.Collectors;
import java.util.stream.IntStream;
import java.util.stream.Stream;
-import org.apache.commons.lang.RandomStringUtils;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.runner.RunWith;
+import org.sonar.process.MessageException;
import org.sonar.process.Props;
+import static java.lang.String.valueOf;
+import static org.apache.commons.lang.RandomStringUtils.randomAlphabetic;
+import static org.apache.commons.lang.RandomStringUtils.randomAlphanumeric;
import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.fail;
@RunWith(DataProviderRunner.class)
public class JvmOptionsTest {
public ExpectedException expectedException = ExpectedException.none();
private final Random random = new Random();
- private final String randomPropertyName = RandomStringUtils.randomAlphanumeric(3);
+ private final String randomPropertyName = randomAlphanumeric(3);
+ private final String randomPrefix = "-" + randomAlphabetic(5).toLowerCase(Locale.ENGLISH);
+ private final String randomValue = randomAlphanumeric(4).toLowerCase(Locale.ENGLISH);
private final Properties properties = new Properties();
private final Props props = new Props(properties);
private final JvmOptions underTest = new JvmOptions();
}
@Test
- public void constructor_throws_NPE_if_any_argument_is_null() {
- ArrayList<String> nullList = new ArrayList<>();
- nullList.add(null);
- String[] arguments = Stream.of(
- Stream.of("-S1"),
- IntStream.range(0, random.nextInt(2)).mapToObj(i -> "-B" + i),
- nullList.stream(),
- IntStream.range(0, random.nextInt(2)).mapToObj(i -> "-A" + i)).flatMap(s -> s)
- .toArray(String[]::new);
+ public void constructor_throws_NPE_if_any_option_prefix_is_null() {
+ Map<String, String> mandatoryJvmOptions = shuffleThenToMap(
+ Stream.of(
+ IntStream.range(0, random.nextInt(10)).mapToObj(i -> new Option("-B", valueOf(i))),
+ Stream.of(new Option(null, "value")))
+ .flatMap(s -> s));
- expectJvmOptionNotNullNPE();
+ expectedException.expect(NullPointerException.class);
+ expectedException.expectMessage("JVM option prefix can't be null");
- new JvmOptions(arguments);
+ new JvmOptions(mandatoryJvmOptions);
}
@Test
@UseDataProvider("variousEmptyStrings")
- public void constructor_throws_IAE_if_argument_is_empty(String emptyString) {
- expectJvmOptionNotEmptyAndStartByDashIAE();
+ public void constructor_throws_IAE_if_any_option_prefix_is_empty(String emptyString) {
+ Map<String, String> mandatoryJvmOptions = shuffleThenToMap(
+ Stream.of(
+ IntStream.range(0, random.nextInt(10)).mapToObj(i -> new Option("-B", valueOf(i))),
+ Stream.of(new Option(emptyString, "value")))
+ .flatMap(s -> s));
+
+ expectedException.expect(IllegalArgumentException.class);
+ expectedException.expectMessage("JVM option prefix can't be empty");
- new JvmOptions(emptyString);
+ new JvmOptions(mandatoryJvmOptions);
}
@Test
- @UseDataProvider("variousEmptyStrings")
- public void constructor_throws_IAE_if_any_argument_is_empty(String emptyString) {
- String[] arguments = Stream.of(
- Stream.of("-S1"),
- IntStream.range(0, random.nextInt(2)).mapToObj(i -> "-B" + i),
- Stream.of(emptyString),
- IntStream.range(0, random.nextInt(2)).mapToObj(i -> "-A" + i))
- .flatMap(s -> s)
- .toArray(String[]::new);
+ public void constructor_throws_IAE_if_any_option_prefix_does_not_start_with_dash() {
+ String invalidPrefix = randomAlphanumeric(3);
+ Map<String, String> mandatoryJvmOptions = shuffleThenToMap(
+ Stream.of(
+ IntStream.range(0, random.nextInt(10)).mapToObj(i -> new Option("-B", valueOf(i))),
+ Stream.of(new Option(invalidPrefix, "value")))
+ .flatMap(s -> s));
expectJvmOptionNotEmptyAndStartByDashIAE();
- new JvmOptions(arguments);
+ new JvmOptions(mandatoryJvmOptions);
}
@Test
- public void constructor_throws_IAE_if_argument_does_not_start_with_dash() {
- expectJvmOptionNotEmptyAndStartByDashIAE();
+ public void constructor_throws_NPE_if_any_option_value_is_null() {
+ Map<String, String> mandatoryJvmOptions = shuffleThenToMap(
+ Stream.of(
+ IntStream.range(0, random.nextInt(10)).mapToObj(i -> new Option("-B", valueOf(i))),
+ Stream.of(new Option("-prefix", null)))
+ .flatMap(s -> s));
+
+ expectedException.expect(NullPointerException.class);
+ expectedException.expectMessage("JVM option value can't be null");
- new JvmOptions(RandomStringUtils.randomAlphanumeric(3));
+ new JvmOptions(mandatoryJvmOptions);
}
@Test
- public void constructor_throws_IAE_if_any_argument_does_not_start_with_dash() {
- String[] arguments = Stream.of(
- Stream.of("-S1"),
- IntStream.range(0, random.nextInt(2)).mapToObj(i -> "-B" + i),
- Stream.of(RandomStringUtils.randomAlphanumeric(3)),
- IntStream.range(0, random.nextInt(2)).mapToObj(i -> "-A" + i))
- .flatMap(s -> s)
- .toArray(String[]::new);
-
- expectJvmOptionNotEmptyAndStartByDashIAE();
-
- new JvmOptions(arguments);
+ @UseDataProvider("variousEmptyStrings")
+ public void constructor_accepts_any_empty_option_value(String emptyString) {
+ Map<String, String> mandatoryJvmOptions = shuffleThenToMap(
+ Stream.of(
+ IntStream.range(0, random.nextInt(10)).mapToObj(i -> new Option("-B", valueOf(i))),
+ Stream.of(new Option("-prefix", emptyString)))
+ .flatMap(s -> s));
+
+ new JvmOptions(mandatoryJvmOptions);
}
@Test
public void add_throws_IAE_if_argument_does_not_start_with_dash() {
expectJvmOptionNotEmptyAndStartByDashIAE();
- underTest.add(RandomStringUtils.randomAlphanumeric(3));
+ underTest.add(randomAlphanumeric(3));
+ }
+
+ @Test
+ @UseDataProvider("variousEmptyStrings")
+ public void add_adds_with_trimming(String emptyString) {
+ underTest.add(emptyString + "-foo" + emptyString);
+
+ assertThat(underTest.getAll()).containsOnly("-foo");
+ }
+
+ @Test
+ public void add_throws_MessageException_if_option_starts_with_prefix_of_mandatory_option_but_has_different_value() {
+ String[] optionOverrides = {
+ randomPrefix,
+ randomPrefix + randomAlphanumeric(1),
+ randomPrefix + randomAlphanumeric(2),
+ randomPrefix + randomAlphanumeric(3),
+ randomPrefix + randomAlphanumeric(4),
+ randomPrefix + randomValue.substring(1),
+ randomPrefix + randomValue.substring(2),
+ randomPrefix + randomValue.substring(3)
+ };
+
+ JvmOptions underTest = new JvmOptions(ImmutableMap.of(randomPrefix, randomValue));
+
+ for (String optionOverride : optionOverrides) {
+ try {
+ underTest.add(optionOverride);
+ fail("an MessageException should have been thrown");
+ } catch (MessageException e) {
+ assertThat(e.getMessage()).isEqualTo("a JVM option can't overwrite mandatory JVM options. " + optionOverride + " overwrites " + randomPrefix + randomValue);
+ }
+ }
+ }
+
+ @Test
+ public void add_checks_against_mandatory_options_is_case_sensitive() {
+ String[] optionOverrides = {
+ randomPrefix,
+ randomPrefix + randomAlphanumeric(1),
+ randomPrefix + randomAlphanumeric(2),
+ randomPrefix + randomAlphanumeric(3),
+ randomPrefix + randomAlphanumeric(4),
+ randomPrefix + randomValue.substring(1),
+ randomPrefix + randomValue.substring(2),
+ randomPrefix + randomValue.substring(3)
+ };
+
+ JvmOptions underTest = new JvmOptions(ImmutableMap.of(randomPrefix, randomValue));
+
+ for (String optionOverride : optionOverrides) {
+ underTest.add(optionOverride.toUpperCase(Locale.ENGLISH));
+ }
+ }
+
+ @Test
+ public void add_accepts_property_equal_to_mandatory_option_and_does_not_add_it_twice() {
+ JvmOptions underTest = new JvmOptions(ImmutableMap.of(randomPrefix, randomValue));
+
+ underTest.add(randomPrefix + randomValue);
+
+ assertThat(underTest.getAll()).containsOnly(randomPrefix + randomValue);
}
@Test
}
@Test
- @UseDataProvider("variousEmptyStrings")
- public void addFromMandatoryProperty_fails_with_IAE_if_property_contains_an_empty_value(String emptyString) {
+ public void addFromMandatoryProperty_fails_with_IAE_if_property_contains_an_empty_value() {
expectMissingPropertyIAE(this.randomPropertyName);
underTest.addFromMandatoryProperty(props, randomPropertyName);
@Test
@UseDataProvider("variousEmptyStrings")
- public void addFromMandatoryProperty_fails_with_IAE_if_property_does_not_start_with_dash_after_trimmed(String emptyString) {
+ public void addFromMandatoryProperty_fails_with_MessageException_if_property_does_not_start_with_dash_after_trimmed(String emptyString) {
properties.put(randomPropertyName, emptyString + "foo -bar");
- expectJvmOptionNotEmptyAndStartByDashIAE();
+ expectJvmOptionNotEmptyAndStartByDashMessageException(randomPropertyName, "foo");
underTest.addFromMandatoryProperty(props, randomPropertyName);
}
assertThat(underTest.getAll()).containsOnly("-foo bar", "-duck");
}
+ @Test
+ public void addFromMandatoryProperty_throws_IAE_if_option_starts_with_prefix_of_mandatory_option_but_has_different_value() {
+ String[] optionOverrides = {
+ randomPrefix,
+ randomPrefix + randomValue.substring(1),
+ randomPrefix + randomValue.substring(1),
+ randomPrefix + randomValue.substring(2),
+ randomPrefix + randomValue.substring(3),
+ randomPrefix + randomValue.substring(3) + randomAlphanumeric(1),
+ randomPrefix + randomValue.substring(3) + randomAlphanumeric(2),
+ randomPrefix + randomValue.substring(3) + randomAlphanumeric(3),
+ randomPrefix + randomValue + randomAlphanumeric(1)
+ };
+
+ JvmOptions underTest = new JvmOptions(ImmutableMap.of(randomPrefix, randomValue));
+
+ for (String optionOverride : optionOverrides) {
+ try {
+ properties.put(randomPropertyName, optionOverride);
+ underTest.addFromMandatoryProperty(props, randomPropertyName);
+ fail("an MessageException should have been thrown");
+ } catch (MessageException e) {
+ assertThat(e.getMessage())
+ .isEqualTo("a JVM option can't overwrite mandatory JVM options. " +
+ "The following JVM options defined by property '" + randomPropertyName + "' are invalid: " + optionOverride + " overwrites " + randomPrefix + randomValue);
+ }
+ }
+ }
+
+ @Test
+ public void addFromMandatoryProperty_checks_against_mandatory_options_is_case_sensitive() {
+ String[] optionOverrides = {
+ randomPrefix,
+ randomPrefix + randomValue.substring(1),
+ randomPrefix + randomValue.substring(1),
+ randomPrefix + randomValue.substring(2),
+ randomPrefix + randomValue.substring(3),
+ randomPrefix + randomValue.substring(3) + randomAlphanumeric(1),
+ randomPrefix + randomValue.substring(3) + randomAlphanumeric(2),
+ randomPrefix + randomValue.substring(3) + randomAlphanumeric(3),
+ randomPrefix + randomValue + randomAlphanumeric(1)
+ };
+
+ JvmOptions underTest = new JvmOptions(ImmutableMap.of(randomPrefix, randomValue));
+
+ for (String optionOverride : optionOverrides) {
+ properties.setProperty(randomPropertyName, optionOverride.toUpperCase(Locale.ENGLISH));
+ underTest.addFromMandatoryProperty(props, randomPropertyName);
+ }
+ }
+
+ @Test
+ public void addFromMandatoryProperty_reports_all_overriding_options_in_single_exception() {
+ String overriding1 = randomPrefix;
+ String overriding2 = randomPrefix + randomValue + randomAlphanumeric(1);
+ properties.setProperty(randomPropertyName, "-foo " + overriding1 + " -bar " + overriding2);
+
+ JvmOptions underTest = new JvmOptions(ImmutableMap.of(randomPrefix, randomValue));
+
+ expectedException.expect(MessageException.class);
+ expectedException.expectMessage("a JVM option can't overwrite mandatory JVM options. " +
+ "The following JVM options defined by property '" + randomPropertyName + "' are invalid: " +
+ overriding1 + " overwrites " + randomPrefix + randomValue + ", " + overriding2 + " overwrites " + randomPrefix + randomValue);
+
+ underTest.addFromMandatoryProperty(props, randomPropertyName);
+ }
+
+ @Test
+ public void addFromMandatoryProperty_accepts_property_equal_to_mandatory_option_and_does_not_add_it_twice() {
+ JvmOptions underTest = new JvmOptions(ImmutableMap.of(randomPrefix, randomValue));
+
+ properties.put(randomPropertyName, randomPrefix + randomValue);
+ underTest.addFromMandatoryProperty(props, randomPropertyName);
+
+ assertThat(underTest.getAll()).containsOnly(randomPrefix + randomValue);
+ }
+
@Test
public void toString_prints_all_jvm_options() {
underTest.add("-foo").add("-bar");
expectedException.expectMessage("a JVM option can't be empty and must start with '-'");
}
+ private void expectJvmOptionNotEmptyAndStartByDashMessageException(String randomPropertyName, String option) {
+ expectedException.expect(MessageException.class);
+ expectedException.expectMessage("a JVM option can't be empty and must start with '-'. " +
+ "The following JVM options defined by property '" + randomPropertyName + "' are invalid: " + option);
+ }
+
public void expectMissingPropertyIAE(String randomPropertyName) {
expectedException.expect(IllegalArgumentException.class);
expectedException.expectMessage("Missing property: " + randomPropertyName);
{" "}
};
}
+
+ private static Map<String, String> shuffleThenToMap(Stream<Option> stream) {
+ List<Option> options = stream.collect(Collectors.toList());
+ Collections.shuffle(options);
+ Map<String, String> res = new HashMap<>(options.size());
+ for (Option option : options) {
+ res.put(option.getPrefix(), option.getValue());
+ }
+ return res;
+ }
+
+ private static final class Option {
+ private final String prefix;
+ private final String value;
+
+ private Option(String prefix, String value) {
+ this.prefix = prefix;
+ this.value = value;
+ }
+
+ public String getPrefix() {
+ return prefix;
+ }
+
+ public String getValue() {
+ return value;
+ }
+
+ @Override
+ public String toString() {
+ return "[" + prefix + "-" + value + ']';
+ }
+ }
}
projects / sonarqube.git / commitdiff