/**
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You 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.option;
  
  import java.util.Collections;
  import java.util.HashSet;
  import java.util.List;
  import java.util.ListIterator;
  import java.util.Set;
  
  import org.apache.commons.cli2.DisplaySetting;
  import org.apache.commons.cli2.Option;
  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;
  import org.apache.commons.cli2.resource.ResourceConstants;
  import org.apache.commons.cli2.resource.ResourceHelper;
  
  /**
   * @author Rob Oxspring
   *
   * To change the template for this generated type comment go to
   * Window>Preferences>Java>Code Generation>Code and Comments
   */
  public class CommandTest
      extends ParentTestCase {
      public static Command buildStartCommand() {
          return new Command("start", "Begins the process", Collections.singleton("go"), false, null,
                             null, 0);
      }
  
      public static Command buildCommitCommand() {
          return new Command("commit", "Commit the changes to the database", null, true, null, null, 0);
      }
  
      public static Command buildLoginCommand() {
          return new Command("login", "Initiates a session for the user", null, false,
                             ArgumentTest.buildUsernameArgument(), null, 0);
      }
  
      /*
       * (non-Javadoc)
       *
       * @see org.apache.commons.cli2.ParentTestCase#testProcessParent()
       */
      public void testProcessParent()
          throws OptionException {
          final Command option = buildStartCommand();
          final List args = list("go");
          final WriteableCommandLine commandLine = commandLine(option, args);
          final ListIterator iterator = args.listIterator();
          option.processParent(commandLine, iterator);
  
          assertFalse(iterator.hasNext());
          assertTrue(commandLine.hasOption(option));
          assertTrue(commandLine.hasOption("start"));
          assertTrue(commandLine.hasOption("go"));
          assertTrue(commandLine.getValues(option).isEmpty());
      }
  
      public void testProcessParent_Spare()
          throws OptionException {
          final Command option = buildLoginCommand();
          final List args = list("login", "rob");
          final WriteableCommandLine commandLine = commandLine(option, args);
          final ListIterator iterator = args.listIterator();
          option.processParent(commandLine, iterator);
  
          assertEquals("rob", iterator.next());
          assertFalse(iterator.hasNext());
          assertTrue(commandLine.hasOption(option));
          assertTrue(commandLine.hasOption("login"));
          assertTrue(commandLine.getValues(option).isEmpty());
      }
  
      /*
       * (non-Javadoc)
       *
       * @see org.apache.commons.cli2.OptionTestCase#testCanProcess()
       */
      public void testCanProcess() {
          final Command option = buildStartCommand();
          assertTrue(option.canProcess(new WriteableCommandLineImpl(option, null), "start"));
      }
 
     public void testCanProcess_BadMatch() {
         final Command option = buildStartCommand();
         assertFalse(option.canProcess(new WriteableCommandLineImpl(option, null), "stop"));
     }
 
     public void testCanProcess_Alias() {
         final Command option = buildStartCommand();
         assertTrue(option.canProcess(new WriteableCommandLineImpl(option, null), "go"));
     }
 
     /*
      * (non-Javadoc)
      *
      * @see org.apache.commons.cli2.OptionTestCase#testPrefixes()
      */
     public void testPrefixes() {
         final Command option = buildStartCommand();
         assertTrue(option.getPrefixes().isEmpty());
     }
 
     /*
      * (non-Javadoc)
      *
      * @see org.apache.commons.cli2.OptionTestCase#testProcess()
      */
     public void testProcess()
         throws OptionException {
         final Command option = buildLoginCommand();
         final List args = list("login", "rob");
         final WriteableCommandLine commandLine = commandLine(option, args);
         final ListIterator iterator = args.listIterator();
         option.process(commandLine, iterator);
 
         assertFalse(iterator.hasNext());
         assertTrue(commandLine.hasOption(option));
         assertTrue(commandLine.hasOption("login"));
         assertEquals("rob", commandLine.getValue(option));
     }
 
     /*
      * (non-Javadoc)
      *
      * @see org.apache.commons.cli2.OptionTestCase#testTriggers()
      */
     public void testTriggers() {
         final Command option = buildStartCommand();
         final Set triggers = option.getTriggers();
         assertContentsEqual(list("start", "go"), triggers);
     }
 
     /*
      * (non-Javadoc)
      *
      * @see org.apache.commons.cli2.OptionTestCase#testValidate()
      */
     public void testValidate() {
         final Parent option = buildCommitCommand();
         final WriteableCommandLine commandLine = commandLine(option, list());
 
         try {
             option.validate(commandLine);
             fail("Missing an option");
         } catch (OptionException moe) {
             assertSame(option, moe.getOption());
         }
     }
 
     /*
      * (non-Javadoc)
      *
      * @see org.apache.commons.cli2.OptionTestCase#testAppendUsage()
      */
     public void testAppendUsage() {
         final Option option = buildStartCommand();
         final StringBuffer buffer = new StringBuffer();
         option.appendUsage(buffer, DisplaySetting.ALL, null);
 
         assertEquals("[start (go)]", buffer.toString());
     }
 
     public void testNullPreferredName() {
         try {
             new Command(null, "", Collections.singleton("go"), false, null, null, 0);
         } catch (IllegalArgumentException exp) {
             assertEquals("wrong exception name",
                          ResourceHelper.getResourceHelper().getMessage(ResourceConstants.COMMAND_PREFERRED_NAME_TOO_SHORT),
                          exp.getMessage());
         }
     }
 
     public void testEmotyPreferredName() {
         try {
             new Command("", "", Collections.singleton("go"), false, null, null, 0);
         } catch (IllegalArgumentException exp) {
             assertEquals("wrong exception name",
                          ResourceHelper.getResourceHelper().getMessage(ResourceConstants.COMMAND_PREFERRED_NAME_TOO_SHORT),
                          exp.getMessage());
         }
     }
 
     public void testAppendUsage_NoOptional() {
         final Option option = buildStartCommand();
         final StringBuffer buffer = new StringBuffer();
         final Set settings = new HashSet(DisplaySetting.ALL);
         settings.remove(DisplaySetting.DISPLAY_OPTIONAL);
         option.appendUsage(buffer, settings, null);
 
         assertEquals("start (go)", buffer.toString());
     }
 
     public void testAppendUsage_NoAlias() {
         final Option option = buildStartCommand();
         final StringBuffer buffer = new StringBuffer();
         final Set settings = new HashSet(DisplaySetting.ALL);
         settings.remove(DisplaySetting.DISPLAY_ALIASES);
         option.appendUsage(buffer, settings, null);
 
         assertEquals("[start]", buffer.toString());
     }
 
     /*
      * (non-Javadoc)
      *
      * @see org.apache.commons.cli2.OptionTestCase#testGetPreferredName()
      */
     public void testGetPreferredName() {
         final Option option = buildStartCommand();
         assertEquals("start", option.getPreferredName());
     }
 
     /*
      * (non-Javadoc)
      *
      * @see org.apache.commons.cli2.OptionTestCase#testGetDescription()
      */
     public void testGetDescription() {
         final Option option = buildLoginCommand();
         assertEquals("Initiates a session for the user", option.getDescription());
     }
 
     /*
      * (non-Javadoc)
      *
      * @see org.apache.commons.cli2.OptionTestCase#testHelpLines()
      */
     public void testHelpLines() {
         // TODO Auto-generated method stub
     }
 }