GroupImpl.canProcess() was returning true when the argument looked like an option but wasn't accepted by the children.

Robert James Oxspring · Robert James Oxspring · commit 1f984e2b4fd3 · 2005-06-03T21:15:13.000Z
Option.canProcess() now takes a WriteableCommandLine to provide the looksLikeOption() method. Bug discovered by Steve Alberty git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@179892 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/java/org/apache/commons/cli2/Option.java b/src/java/org/apache/commons/cli2/Option.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -65,7 +65,7 @@ void process(
      *            The argument to be tested
      * @return true if the argument can be processed by this Option
      */
-    boolean canProcess(final String argument);
+    boolean canProcess(final WriteableCommandLine commandLine, final String argument);
 
     /**
      * Indicates whether this Option will be able to process the particular
@@ -77,7 +77,7 @@ void process(
      *            the ListIterator over String arguments
      * @return true if the argument can be processed by this Option
      */
-    boolean canProcess(final ListIterator arguments);
+    boolean canProcess(final WriteableCommandLine commandLine, final ListIterator arguments);
 
     /**
      * Identifies the argument prefixes that should trigger this option. This
diff --git a/src/java/org/apache/commons/cli2/commandline/Parser.java b/src/java/org/apache/commons/cli2/commandline/Parser.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -63,7 +63,7 @@ public CommandLine parse(final String[] arguments) throws OptionException {
         group.defaults(commandLine);
 
         final ListIterator iterator = argumentList.listIterator();
-        while (group.canProcess(iterator)) {
+        while (group.canProcess(commandLine, iterator)) {
             group.process(commandLine, iterator);
         }
 
diff --git a/src/java/org/apache/commons/cli2/option/ArgumentImpl.java b/src/java/org/apache/commons/cli2/option/ArgumentImpl.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -195,7 +195,7 @@ else if (subsequentSplit) {
         }
     }
 
-    public boolean canProcess(String arg) {
+    public boolean canProcess(final WriteableCommandLine commandLine, final String arg) {
         return true;
     }
 
diff --git a/src/java/org/apache/commons/cli2/option/Command.java b/src/java/org/apache/commons/cli2/option/Command.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -109,7 +109,7 @@ public void processParent(
         final String arg = (String)arguments.next();
 
         // if we can process it
-        if (canProcess(arg)) {
+        if (canProcess(commandLine, arg)) {
 
             // then note the option
             commandLine.addOption(this);
diff --git a/src/java/org/apache/commons/cli2/option/DefaultOption.java b/src/java/org/apache/commons/cli2/option/DefaultOption.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -127,9 +127,9 @@ public DefaultOption(
         checkPrefixes(newPrefixes);
     }
 
-    public boolean canProcess(final String argument) {
+    public boolean canProcess(final WriteableCommandLine commandLine, final String argument) {
         return argument != null
-            && (super.canProcess(argument)
+            && (super.canProcess(commandLine, argument)
                 || (argument.length() >= burstLength
                     && burstAliases.contains(argument.substring(0, burstLength))));
     }
diff --git a/src/java/org/apache/commons/cli2/option/GroupImpl.java b/src/java/org/apache/commons/cli2/option/GroupImpl.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -113,7 +113,7 @@ public GroupImpl(
         this.prefixes = Collections.unmodifiableSet(newPrefixes);
     }
 
-    public boolean canProcess(String arg) {
+    public boolean canProcess(final WriteableCommandLine commandLine, String arg) {
         if (arg == null) {
             return false;
         }
@@ -131,11 +131,15 @@ public boolean canProcess(String arg) {
             iter.hasNext();) {
             
             final Option option = (Option) iter.next();
-            if (option.canProcess(arg)) {
+            if (option.canProcess(commandLine, arg)) {
                 return true;
             }
         }
         
+        if(commandLine.looksLikeOption(arg)) {
+            return false;
+        }
+        
         // anonymous argument(s) means we can process it
         if (anonymous.size() > 0) {
             return true;
@@ -182,7 +186,7 @@ public void process(
                     for (Iterator i = values.iterator(); i.hasNext() && !foundMemberOption;) {
                         final Option option = (Option) i.next();
                         
-                        if (option.canProcess(arg)) {
+                        if (option.canProcess(commandLine, arg)) {
                         	foundMemberOption = true;
                             arguments.previous();
                             option.process(commandLine, arguments);
@@ -210,7 +214,7 @@ public void process(
                     // canProcess will always return true?
                     for (final Iterator i = anonymous.iterator(); i.hasNext();) {
                         final Argument argument = (Argument)i.next();
-                        if (argument.canProcess(arguments)) {
+                        if (argument.canProcess(commandLine, arguments)) {
                             argument.process(commandLine, arguments);
                         }
                     }
diff --git a/src/java/org/apache/commons/cli2/option/OptionImpl.java b/src/java/org/apache/commons/cli2/option/OptionImpl.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,11 +43,11 @@ public OptionImpl(final int id, final boolean required) {
         this.required = required;
     }
 
-    public boolean canProcess(final ListIterator arguments) {
+    public boolean canProcess(final WriteableCommandLine commandLine, final ListIterator arguments) {
         if (arguments.hasNext()) {
             final String argument = (String)arguments.next();
             arguments.previous();
-            return canProcess(argument);
+            return canProcess(commandLine, argument);
         }
         else {
             return false;
diff --git a/src/java/org/apache/commons/cli2/option/ParentImpl.java b/src/java/org/apache/commons/cli2/option/ParentImpl.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -77,7 +77,7 @@ public void process(
             argument.processValues(commandLine, arguments, this);
         }
 
-        if (children != null && children.canProcess(arguments)) {
+        if (children != null && children.canProcess(commandLine, arguments)) {
             children.process(commandLine, arguments);
         }
     }
@@ -87,7 +87,7 @@ public void process(
      * 
      * @see org.apache.commons.cli2.Option#canProcess(java.lang.String)
      */
-    public boolean canProcess(final String arg) {
+    public boolean canProcess(final WriteableCommandLine commandLine, final String arg) {
 
         final Set triggers = getTriggers();
         
diff --git a/src/java/org/apache/commons/cli2/option/PropertyOption.java b/src/java/org/apache/commons/cli2/option/PropertyOption.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -68,7 +68,7 @@ public PropertyOption(
      */
     public static final PropertyOption INSTANCE = new PropertyOption();
 
-    public boolean canProcess(final String argument) {
+    public boolean canProcess(final WriteableCommandLine commandLine, final String argument) {
         return argument != null
             && argument.startsWith(optionString)
             && argument.length() > optionString.length();
@@ -85,7 +85,7 @@ public void process(
 
         final String arg = (String)arguments.next();
 
-        if (!canProcess(arg)) {
+        if (!canProcess(commandLine, arg)) {
             throw new OptionException(this, "cli.error.unexpected", arg);
         }
 
diff --git a/src/java/org/apache/commons/cli2/option/SourceDestArgument.java b/src/java/org/apache/commons/cli2/option/SourceDestArgument.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -138,7 +138,7 @@ public void validate(WriteableCommandLine commandLine, Option option)
         dest.validate(commandLine, dest);
     }
 
-    public boolean canProcess(final String arg) {
-        return source.canProcess(arg) || dest.canProcess(arg);
+    public boolean canProcess(final WriteableCommandLine commandLine, final String arg) {
+        return source.canProcess(commandLine, arg) || dest.canProcess(commandLine, arg);
     }
 }
diff --git a/src/java/org/apache/commons/cli2/option/Switch.java b/src/java/org/apache/commons/cli2/option/Switch.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -139,7 +139,7 @@ public void processParent(
 
         final String arg = (String)arguments.next();
 
-        if (canProcess(arg)) {
+        if (canProcess(commandLine, arg)) {
             if (arg.startsWith(enabledPrefix)) {
                 commandLine.addSwitch(this, true);
                 arguments.set(enabledPrefix + preferredName);
diff --git a/src/test/org/apache/commons/cli2/bug/BugLoopingOptionLookAlikeTest.java b/src/test/org/apache/commons/cli2/bug/BugLoopingOptionLookAlikeTest.java
@@ -0,0 +1,57 @@
+/**
+ * Copyright 2005 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.cli2.bug;
+
+import junit.framework.TestCase;
+
+import org.apache.commons.cli2.Group;
+import org.apache.commons.cli2.OptionException;
+import org.apache.commons.cli2.builder.ArgumentBuilder;
+import org.apache.commons.cli2.builder.DefaultOptionBuilder;
+import org.apache.commons.cli2.builder.GroupBuilder;
+import org.apache.commons.cli2.commandline.Parser;
+
+/**
+ * The first is a loop in Parser.parse() if I set a non-declared option. This 
+ * code goes into a loop in Parser.java method parse this �while� loop runs 
+ * endless
+ * 
+ * @author Steve Alberty
+ */
+public class BugLoopingOptionLookAlikeTest extends TestCase {
+
+    public void testLoopingOptionLookAlike() {
+        final DefaultOptionBuilder obuilder = new DefaultOptionBuilder();
+        final ArgumentBuilder abuilder = new ArgumentBuilder();
+        final GroupBuilder gbuilder = new GroupBuilder();
+        final Group options = gbuilder
+            .withName("ant")
+            .withOption(obuilder.withShortName("help").withDescription("print this message").create())
+            .withOption(obuilder.withShortName("projecthelp").withDescription("print project help information").create())
+            .withOption(abuilder.withName("target").create())
+            .create();
+        
+        final Parser parser = new Parser();
+        parser.setGroup(options);
+        try {
+            parser.parse(new String[] { "-abcdef",
+                    "testfile.txt ", });
+            fail("OptionException");
+        } catch (OptionException e) {
+            assertEquals("Unexpected -abcdef while processing ant",e.getMessage());
+        }
+    }
+}
diff --git a/src/test/org/apache/commons/cli2/option/ArgumentTest.java b/src/test/org/apache/commons/cli2/option/ArgumentTest.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,6 +30,7 @@
 import org.apache.commons.cli2.Option;
 import org.apache.commons.cli2.OptionException;
 import org.apache.commons.cli2.WriteableCommandLine;
+import org.apache.commons.cli2.commandline.WriteableCommandLineImpl;
 import org.apache.commons.cli2.resource.ResourceHelper;
 import org.apache.commons.cli2.validation.DateValidator;
 import org.apache.commons.cli2.validation.DateValidatorTest;
@@ -334,7 +335,7 @@ public void testProcessValues_ContractedTooFew() {
      */
     public void testCanProcess() {
         final Argument option = buildTargetsArgument();
-        assertTrue(option.canProcess("any value"));
+        assertTrue(option.canProcess(new WriteableCommandLineImpl(option,null), "any value"));
     }
 
     /*
@@ -524,7 +525,7 @@ public void testHelpLines() {
     public void testCanProcess_ConsumeRemaining() {
         final Option option = buildUsernameArgument();
 
-        assertTrue(option.canProcess("--"));
+        assertTrue(option.canProcess(new WriteableCommandLineImpl(option,null), "--"));
     }
 
     public void testProcess_ConsumeRemaining() throws OptionException {
diff --git a/src/test/org/apache/commons/cli2/option/CommandTest.java b/src/test/org/apache/commons/cli2/option/CommandTest.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,6 +26,7 @@
 import org.apache.commons.cli2.OptionException;
 import org.apache.commons.cli2.Parent;
 import org.apache.commons.cli2.WriteableCommandLine;
+import org.apache.commons.cli2.commandline.WriteableCommandLineImpl;
 
 /**
  * @author Rob Oxspring
@@ -107,15 +108,18 @@ public void testProcessParent_Spare() throws OptionException {
      * @see org.apache.commons.cli2.OptionTestCase#testCanProcess()
      */
     public void testCanProcess() {
-        assertTrue(buildStartCommand().canProcess("start"));
+        final Command option = buildStartCommand();
+        assertTrue(option.canProcess(new WriteableCommandLineImpl(option,null), "start"));
     }
 
     public void testCanProcess_BadMatch() {
-        assertFalse(buildStartCommand().canProcess("stop"));
+        final Command option = buildStartCommand();
+        assertFalse(option.canProcess(new WriteableCommandLineImpl(option,null), "stop"));
     }
 
     public void testCanProcess_Alias() {
-        assertTrue(buildStartCommand().canProcess("go"));
+        final Command option = buildStartCommand();
+        assertTrue(option.canProcess(new WriteableCommandLineImpl(option,null), "go"));
     }
 
     /*
diff --git a/src/test/org/apache/commons/cli2/option/DefaultOptionTest.java b/src/test/org/apache/commons/cli2/option/DefaultOptionTest.java
diff --git a/src/test/org/apache/commons/cli2/option/GroupTest.java b/src/test/org/apache/commons/cli2/option/GroupTest.java
diff --git a/src/test/org/apache/commons/cli2/option/ParentTest.java b/src/test/org/apache/commons/cli2/option/ParentTest.java
diff --git a/src/test/org/apache/commons/cli2/option/PropertyOptionTest.java b/src/test/org/apache/commons/cli2/option/PropertyOptionTest.java
diff --git a/src/test/org/apache/commons/cli2/option/SwitchTest.java b/src/test/org/apache/commons/cli2/option/SwitchTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/**`
`2`		`- * Copyright 2003-2004 The Apache Software Foundation`
	`2`	`+ * Copyright 2003-2005 The Apache Software Foundation`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -63,7 +63,7 @@ public CommandLine parse(final String[] arguments) throws OptionException {`
`63`	`63`	`group.defaults(commandLine);`
`64`	`64`
`65`	`65`	`final ListIterator iterator = argumentList.listIterator();`
`66`		`- while (group.canProcess(iterator)) {`
	`66`	`+ while (group.canProcess(commandLine, iterator)) {`
`67`	`67`	`group.process(commandLine, iterator);`
`68`	`68`	`}`
`69`	`69`