src/test/java/org/apache/commons/cli/ValuesTest.java

/*
  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.cli;

import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

@SuppressWarnings("deprecation") // tests some deprecated classes
public class ValuesTest {
    private CommandLine cmd;

    @BeforeEach
    public void setUp() throws Exception {
        final Options options = new Options();

        options.addOption("a", false, "toggle -a");
        options.addOption("b", true, "set -b");
        options.addOption("c", "c", false, "toggle -c");
        options.addOption("d", "d", true, "set -d");

        options.addOption(OptionBuilder.withLongOpt("e").hasArgs().withDescription("set -e ").create('e'));
        options.addOption("f", "f", false, "jk");
        options.addOption(OptionBuilder.withLongOpt("g").hasArgs(2).withDescription("set -g").create('g'));
        options.addOption(OptionBuilder.withLongOpt("h").hasArg().withDescription("set -h").create('h'));
        options.addOption(OptionBuilder.withLongOpt("i").withDescription("set -i").create('i'));
        options.addOption(OptionBuilder.withLongOpt("j").hasArgs().withDescription("set -j").withValueSeparator('=').create('j'));
        options.addOption(OptionBuilder.withLongOpt("k").hasArgs().withDescription("set -k").withValueSeparator('=').create('k'));
        options.addOption(OptionBuilder.withLongOpt("m").hasArgs().withDescription("set -m").withValueSeparator().create('m'));

        //@formatter:off
        final String[] args = {
            "-a",
            "-b", "foo",
            "--c",
            "--d", "bar",
            "-e", "one", "two",
            "-f",
            "arg1", "arg2",
            "-g", "val1", "val2", "arg3",
            "-h", "val1", "-i",
            "-h", "val2",
            "-jkey=value",
            "-j", "key=value",
            "-kkey1=value1",
            "-kkey2=value2",
            "-mkey=value"
        };
        //@formatter:on

        final CommandLineParser parser = new PosixParser();

        cmd = parser.parse(options, args);
    }

    @Test
    public void testCharSeparator() {
        // tests the char methods of CommandLine that delegate to the String methods
        assertTrue(cmd.hasOption("j"), "Option j is not set");
        assertTrue(cmd.hasOption('j'), "Option j is not set");
        assertArrayEquals(new String[] {"key", "value", "key", "value"}, cmd.getOptionValues("j"));
        assertArrayEquals(new String[] {"key", "value", "key", "value"}, cmd.getOptionValues('j'));

        assertTrue(cmd.hasOption("k"), "Option k is not set");
        assertTrue(cmd.hasOption('k'), "Option k is not set");
        assertArrayEquals(new String[] {"key1", "value1", "key2", "value2"}, cmd.getOptionValues("k"));
        assertArrayEquals(new String[] {"key1", "value1", "key2", "value2"}, cmd.getOptionValues('k'));

        assertTrue(cmd.hasOption("m"), "Option m is not set");
        assertTrue(cmd.hasOption('m'), "Option m is not set");
        assertArrayEquals(new String[] {"key", "value"}, cmd.getOptionValues("m"));
        assertArrayEquals(new String[] {"key", "value"}, cmd.getOptionValues('m'));
    }

    @Test
    public void testComplexValues() {
        assertTrue(cmd.hasOption("i"), "Option i is not set");
        assertTrue(cmd.hasOption("h"), "Option h is not set");
        assertArrayEquals(new String[] {"val1", "val2"}, cmd.getOptionValues("h"));
    }

    @Test
    public void testExtraArgs() {
        assertArrayEquals(new String[] {"arg1", "arg2", "arg3"}, cmd.getArgs(), "Extra args");
    }

    @Test
    public void testMultipleArgValues() {
        assertTrue(cmd.hasOption("e"), "Option e is not set");
        assertArrayEquals(new String[] {"one", "two"}, cmd.getOptionValues("e"));
    }

    @Test
    public void testShortArgs() {
        assertTrue(cmd.hasOption("a"), "Option a is not set");
        assertTrue(cmd.hasOption("c"), "Option c is not set");

        assertNull(cmd.getOptionValues("a"));
        assertNull(cmd.getOptionValues("c"));
    }

    @Test
    public void testShortArgsWithValue() {
        assertTrue(cmd.hasOption("b"), "Option b is not set");
        assertEquals("foo", cmd.getOptionValue("b"));
        assertEquals(1, cmd.getOptionValues("b").length);

        assertTrue(cmd.hasOption("b"), "Option b is not set");
        assertEquals("bar", cmd.getOptionValue("d"));
        assertEquals(1, cmd.getOptionValues("d").length);
    }

    @Test
    public void testTwoArgValues() {
        assertTrue(cmd.hasOption("g"), "Option g is not set");
        assertArrayEquals(new String[] {"val1", "val2"}, cmd.getOptionValues("g"));
    }

    /**
     * jkeyes - commented out this test as the new architecture breaks this type of functionality. I have left the test here
     * in case I get a brainwave on how to resolve this.
     */
    /*
     * public void testGetValue() { // the 'm' option assertTrue(_option.getValues().length == 2); assertEquals(
     * _option.getValue(), "key"); assertEquals(_option.getValue(0), "key"); assertEquals(_option.getValue(1),
     * "value");
     *
     * try { assertEquals(_option.getValue(2), "key"); fail("IndexOutOfBounds not caught"); } catch (
     * IndexOutOfBoundsException exp) {
     *
     * }
     *
     * try { assertEquals(_option.getValue(-1), "key"); fail("IndexOutOfBounds not caught"); } catch (
     * IndexOutOfBoundsException exp) {
     *
     * } }
     */
}