Uploaded image for project: 'Commons CLI'
  1. Commons CLI
  2. CLI-156

Missing required options not throwing MissingOptionException

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 1.1
    • Fix Version/s: 1.2
    • Component/s: Parser
    • Labels:
      None

      Description

      When an Options object is used to parse a second set of command arguments it won't throw a MissingOptionException.

      import org.apache.commons.cli.CommandLine;
      import org.apache.commons.cli.GnuParser;
      import org.apache.commons.cli.OptionBuilder;
      import org.apache.commons.cli.Options;
      import org.apache.commons.cli.ParseException;
      
      public class Example
      {
      	public static void main(String[] args) throws ParseException
      	{
      		brokenExample();
      		workingExample();
      	}
      
      	// throws exception as expected
      	private static void workingExample() throws ParseException
      	{
      		String[] args = {};
      
      		Options opts = new Options();
      		opts.addOption(OptionBuilder.isRequired().create('v'));
      
      		GnuParser parser = new GnuParser();
      		CommandLine secondCL = parser.parse(opts, args);
      
      		System.out.println("Done workingExample");
      	}
      
      	// fails to throw exception on second invocation of parse
      	private static void brokenExample() throws ParseException
      	{
      		String[] firstArgs = { "-v" };
      		String[] secondArgs = {};
      
      		Options opts = new Options();
      		opts.addOption(OptionBuilder.isRequired().create('v'));
      
      		GnuParser parser = new GnuParser();
      		CommandLine firstCL = parser.parse(opts, firstArgs);
      		CommandLine secondCL = parser.parse(opts, secondArgs);
      
      		System.out.println("Done brokenExample");
      	}
      }
      

      This is a result of the Options object returning the reference to its own list and the parsers modifying that list. The first call is removing the required options as they are found and subsequent calls get back an empty list.

        Activity

        Hide
        bayard Henri Yandell added a comment -

        Seems like it should be easy to solve by cloning the list before returning.

        Show
        bayard Henri Yandell added a comment - Seems like it should be easy to solve by cloning the list before returning.
        Hide
        ebourg Emmanuel Bourg added a comment -

        Fixed, I cloned the list in the parser, it seemed better than cloning the list in the getter.

        Show
        ebourg Emmanuel Bourg added a comment - Fixed, I cloned the list in the parser, it seemed better than cloning the list in the getter.

          People

          • Assignee:
            Unassigned
            Reporter:
            jwilde Jeremy Wilde
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development