CLI-265: Optional argument picking up next regular option as its argument. Thank you to Lynn Henderson, Martin Sandiford and Veit Guna for providing reproductions.

britter · britter · commit 1bf9e6c551b6 · 2016-09-07T20:19:32.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/trunk@1759695 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -23,6 +23,9 @@
   <body>
 
     <release version="1.4" date="tba" description="tba">
+      <action type="fix" dev="britter" issue="CLI-265">
+        Optional argument picking up next regular option as its argument
+      </action>
       <action type="add" dev="britter" issue="CLI-267" due-to="Ricardo Ribeiro">
         Add an addRequiredOption method to Options
       </action>
diff --git a/src/main/java/org/apache/commons/cli/DefaultParser.java b/src/main/java/org/apache/commons/cli/DefaultParser.java
@@ -299,7 +299,15 @@ private boolean isOption(String token)
     private boolean isShortOption(String token)
     {
         // short options (-S, -SV, -S=V, -SV1=V2, -S1S2)
-        return token.startsWith("-") && token.length() >= 2 && options.hasShortOption(token.substring(1, 2));
+        if (!token.startsWith("-") || token.length() == 1)
+        {
+            return false;
+        }
+
+        // remove leading "-" and "=value"
+        int pos = token.indexOf("=");
+        String optName = pos == -1 ? token.substring(1) : token.substring(1, pos);
+        return options.hasShortOption(optName);
     }
 
     /**
diff --git a/src/test/java/org/apache/commons/cli/bug/BugCLI265Test.java b/src/test/java/org/apache/commons/cli/bug/BugCLI265Test.java
@@ -0,0 +1,56 @@
+package org.apache.commons.cli.bug;
+
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * Test for CLI-265.
+ * <p>
+ * The issue is that a short option with an optional value will use whatever comes next as value.
+ */
+public class BugCLI265Test {
+
+    private DefaultParser parser;
+    private Options options;
+
+    @Before
+    public void setUp() throws Exception {
+        parser = new DefaultParser();
+
+        Option TYPE1 = Option.builder("t1").hasArg().numberOfArgs(1).optionalArg(true).argName("t1_path").build();
+        Option LAST = Option.builder("last").hasArg(false).build();
+
+        options = new Options().addOption(TYPE1).addOption(LAST);
+    }
+
+    @Test
+    public void shouldParseShortOptionWithValue() throws Exception {
+        String[] shortOptionWithValue = new String[]{"-t1", "path/to/my/db"};
+
+        final CommandLine commandLine = parser.parse(options, shortOptionWithValue);
+
+        assertEquals("path/to/my/db", commandLine.getOptionValue("t1"));
+        assertFalse(commandLine.hasOption("last"));
+    }
+
+    @Test
+    public void shouldParseShortOptionWithoutValue() throws Exception {
+        String[] twoShortOptions = new String[]{"-t1", "-last"};
+
+        final CommandLine commandLine = parser.parse(options, twoShortOptions);
+
+        assertTrue(commandLine.hasOption("t1"));
+        assertNotEquals("Second option has been used as value for first option", "-last", commandLine.getOptionValue("t1"));
+        assertTrue("Second option has not been detected", commandLine.hasOption("last"));
+    }
+
+}
