Skip to content

Refactor default parser test #294

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
garydgregory merged 2 commits into from
Oct 18, 2024
Merged

Refactor default parser test #294

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf171b2
Rewrite DefaultParserTest using parameterized tests
sigee Jul 29, 2024
71d3cd3
Disable test cases from parent
sigee Jul 29, 2024
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
193 changes: 125 additions & 68 deletions src/test/java/org/apache/commons/cli/DefaultParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,18 @@ Licensed to the Apache Software Foundation (ASF) under one or more

import java.util.HashSet;
import java.util.Set;
import java.util.stream.Stream;

import org.apache.commons.cli.DefaultParser.Builder;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.ArgumentsProvider;
import org.junit.jupiter.params.provider.ArgumentsSource;

/**
* TODO Needs a rework using JUnit parameterized tests.
*/
public class DefaultParserTest extends AbstractParserTestCase {

@Override
Expand Down Expand Up @@ -83,84 +87,137 @@ public void testDeprecated() throws ParseException {
assertFalse(handler.contains(opt3));
}

@Test
public void testLongOptionQuoteHandlingWithoutStrip() throws Exception {
parser = DefaultParser.builder().setStripLeadingAndTrailingQuotes(false).get();
final String[] args = {"--bfile", "\"quoted string\""};

@ParameterizedTest(name = "{index}. {0}")
@ArgumentsSource(ExternalArgumentsProvider.class)
public void testParameterized(final String testName, final CommandLineParser parser, final String[] args, final String expected,
final String option, final String message) throws Exception {
final CommandLine cl = parser.parse(options, args);

assertEquals("\"quoted string\"", cl.getOptionValue("b"), "Confirm --bfile \"arg\" keeps quotes");
assertEquals(expected, cl.getOptionValue(option), message);
}

@Test
public void testLongOptionQuoteHandlingWithStrip() throws Exception {
parser = DefaultParser.builder().setStripLeadingAndTrailingQuotes(true).get();
final String[] args = {"--bfile", "\"quoted string\""};

final CommandLine cl = parser.parse(options, args);

assertEquals("quoted string", cl.getOptionValue("b"), "Confirm --bfile \"arg\" strips quotes");
static class ExternalArgumentsProvider implements ArgumentsProvider {

@Override
public Stream<? extends Arguments> provideArguments(final ExtensionContext context) {
return Stream.of(
/* Arguments:
* 1. test case name
* 2. parser
* 3. input string
* 4. expected option value
* 5. checked option
* 6. assertion message
*/
Arguments.of(
"Long option quote handling DEFAULT behavior",
DefaultParser.builder().get(),
new String[]{"--bfile", "\"quoted string\""},
"quoted string",
"b",
"Confirm --bfile=\"arg\" strips quotes"
),
Arguments.of(
"Long option with equals quote handling DEFAULT behavior",
DefaultParser.builder().get(),
new String[]{"--bfile=\"quoted string\""},
"\"quoted string\"",
"b",
"Confirm --bfile=\"arg\" keeps quotes"
),
Arguments.of(
"Short option quote handling DEFAULT behavior",
DefaultParser.builder().get(),
new String[]{"-b", "\"quoted string\""},
"quoted string",
"b",
"Confirm -b\"arg\" strips quotes"
),
Arguments.of(
"Short option concatenated quote handling DEFAULT behavior",
DefaultParser.builder().get(),
new String[]{"-b\"quoted string\""},
"\"quoted string\"",
"b",
"Confirm -b\"arg\" keeps quotes"
),
Arguments.of(
"Long option quote handling WITHOUT strip",
DefaultParser.builder().setStripLeadingAndTrailingQuotes(false).get(),
new String[]{"--bfile", "\"quoted string\""},
"\"quoted string\"",
"b",
"Confirm --bfile \"arg\" keeps quotes"
),
Arguments.of(
"Long option with equals quote handling WITHOUT strip",
DefaultParser.builder().setStripLeadingAndTrailingQuotes(false).get(),
new String[]{"--bfile=\"quoted string\""},
"\"quoted string\"",
"b",
"Confirm --bfile=\"arg\" keeps quotes"
),
Arguments.of(
"Short option quote handling WITHOUT strip",
DefaultParser.builder().setStripLeadingAndTrailingQuotes(false).get(),
new String[]{"-b", "\"quoted string\""},
"\"quoted string\"",
"b",
"Confirm -b\"arg\" keeps quotes"
),
Arguments.of(
"Short option concatenated quote handling WITHOUT strip",
DefaultParser.builder().setStripLeadingAndTrailingQuotes(false).get(),
new String[]{"-b\"quoted string\""},
"\"quoted string\"",
"b",
"Confirm -b\"arg\" keeps quotes"
),
Arguments.of(
"Long option quote handling WITH strip",
DefaultParser.builder().setStripLeadingAndTrailingQuotes(true).get(),
new String[]{"--bfile", "\"quoted string\""},
"quoted string",
"b",
"Confirm --bfile \"arg\" strips quotes"
),
Arguments.of(
"Long option With Equals Quote Handling WITH Strip",
DefaultParser.builder().setStripLeadingAndTrailingQuotes(true).get(),
new String[]{"--bfile=\"quoted string\""},
"quoted string",
"b",
"Confirm --bfile=\"arg\" strips quotes"
),
Arguments.of(
"Short option quote handling WITH strip",
DefaultParser.builder().setStripLeadingAndTrailingQuotes(true).get(),
new String[]{"-b", "\"quoted string\""},
"quoted string",
"b",
"Confirm -b \"arg\" strips quotes"
),
Arguments.of(
"Short option concatenated quote handling WITH strip",
DefaultParser.builder().setStripLeadingAndTrailingQuotes(true).get(),
new String[]{"-b\"quoted string\""},
"quoted string",
"b",
"Confirm -b\"arg\" strips quotes"
)
);
}
}

@Override
@Test
@Disabled("Test case handled in the parameterized tests as \"DEFAULT behavior\"")
public void testLongOptionWithEqualsQuoteHandling() throws Exception {
final String[] args = {"--bfile=\"quoted string\""};

final CommandLine cl = parser.parse(options, args);

assertEquals("\"quoted string\"", cl.getOptionValue("b"), "Confirm --bfile=\"arg\" strips quotes");
}

@Test
public void testLongOptionWithEqualsQuoteHandlingWithoutStrip() throws Exception {
parser = DefaultParser.builder().setStripLeadingAndTrailingQuotes(false).get();
final String[] args = {"--bfile=\"quoted string\""};

final CommandLine cl = parser.parse(options, args);

assertEquals("\"quoted string\"", cl.getOptionValue("b"), "Confirm --bfile=\"arg\" keeps quotes");
}

@Test
public void testLongOptionWithEqualsQuoteHandlingWithStrip() throws Exception {
parser = DefaultParser.builder().setStripLeadingAndTrailingQuotes(true).get();
final String[] args = {"--bfile=\"quoted string\""};

final CommandLine cl = parser.parse(options, args);

assertEquals("quoted string", cl.getOptionValue("b"), "Confirm --bfile=\"arg\" strips quotes");
}

@Override
@Test
@Disabled("Test case handled in the parameterized tests as \"DEFAULT behavior\"")
public void testShortOptionConcatenatedQuoteHandling() throws Exception {
final String[] args = {"-b\"quoted string\""};

final CommandLine cl = parser.parse(options, args);

//This is behavior is not consistent with the other parsers, but is required for backwards compatibility
assertEquals("\"quoted string\"", cl.getOptionValue("b"), "Confirm -b\"arg\" keeps quotes");
}

@Test
public void testShortOptionQuoteHandlingWithoutStrip() throws Exception {
parser = DefaultParser.builder().setStripLeadingAndTrailingQuotes(false).get();
final String[] args = {"-b", "\"quoted string\""};

final CommandLine cl = parser.parse(options, args);

assertEquals("\"quoted string\"", cl.getOptionValue("b"), "Confirm -b \"arg\" keeps quotes");
}

@Test
public void testShortOptionQuoteHandlingWithStrip() throws Exception {
parser = DefaultParser.builder().setStripLeadingAndTrailingQuotes(true).get();
final String[] args = {"-b", "\"quoted string\""};

final CommandLine cl = parser.parse(options, args);

assertEquals("quoted string", cl.getOptionValue("b"), "Confirm -b \"arg\" strips quotes");
}
}