package org.djutils.cli;
import static org.junit.Assert.assertEquals;
import org.djunits.unit.DurationUnit;
import org.djunits.value.vdouble.scalar.Duration;
import org.junit.Test;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
/**
* Program to test the CLI.
*
* Copyright (c) 2003-2018 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
* for project information www.simulation.tudelft.nl. The
* source code and binary code of this software is proprietary information of Delft University of Technology.
* @author Alexander Verbraeck
*/
public class TestCLISuperclass
{
/** */
@Command(description = "Test program for CLI", name = "Program", mixinStandardHelpOptions = true, version = "1.0")
public static class Options implements Checkable
{
/** */
@Option(names = {"-p", "--port"}, description = "Internet port to use", defaultValue = "80")
private int port;
/** @return the port number */
public int getPort()
{
return this.port;
}
/** {@inheritDoc} */
@Override
public void check() throws Exception
{
if (this.port <= 0 || this.port > 65535)
{
throw new Exception("Port should be between 1 and 65535");
}
}
}
/** */
public static class OptionsSub extends Options
{
/** */
@Option(names = {"-t", "--timeout"}, description = "timeout", defaultValue = "10min")
private Duration timeout;
/** @return the timeout */
public Duration getTimeout()
{
return this.timeout;
}
}
/**
* Test the CliUtil methods.
* @throws CliException on error
* @throws IllegalAccessException on error
* @throws IllegalArgumentException on error
* @throws NoSuchFieldException on error
*/
@Test
public void testCli() throws NoSuchFieldException, IllegalArgumentException, IllegalAccessException, CliException
{
// do the command line overrrides work?
String[] args = new String[] {"-p", "1200"};
Options options = new Options();
CliUtil.execute(options, args);
assertEquals(1200, options.getPort());
assertEquals("1.0", options.getClass().getAnnotation(Command.class).version()[0]);
assertEquals("Program", options.getClass().getAnnotation(Command.class).name());
assertEquals("Test program for CLI", options.getClass().getAnnotation(Command.class).description()[0]);
// do the command line overrides work for classes and subclasses?
args = new String[] {"-p", "2400", "--timeout", "60s"};
OptionsSub optionsSub = new OptionsSub();
CliUtil.execute(optionsSub, args);
assertEquals(2400, optionsSub.getPort());
assertEquals(new Duration(60.0, DurationUnit.SECOND), optionsSub.getTimeout());
assertEquals("1.0", optionsSub.getClass().getSuperclass().getAnnotation(Command.class).version()[0]);
assertEquals("Program", optionsSub.getClass().getSuperclass().getAnnotation(Command.class).name());
assertEquals("Test program for CLI",
optionsSub.getClass().getSuperclass().getAnnotation(Command.class).description()[0]);
// does the change of command name, description and version work?
CliUtil.changeCommandName(OptionsSub.class, "NewName");
CliUtil.changeCommandDescription(OptionsSub.class, "NewDescription");
CliUtil.changeCommandVersion(OptionsSub.class, "1.1");
CliUtil.execute(optionsSub, args);
assertEquals("1.1", CliUtil.getCommandVersion(options)[0]);
assertEquals("NewName", CliUtil.getCommandName(options));
assertEquals("NewDescription", CliUtil.getCommandDescription(options)[0]);
// does the change work for the main class?
args = new String[] {};
OptionsSub optionsChanged1 = new OptionsSub();
CliUtil.changeOptionDefault(OptionsSub.class, "timeout", "30s");
CliUtil.execute(optionsChanged1, args);
assertEquals(80, optionsChanged1.getPort());
assertEquals(new Duration(30.0, DurationUnit.SECOND), optionsChanged1.getTimeout());
// does the change work for a subclass?
args = new String[] {};
OptionsSub optionsChanged2 = new OptionsSub();
CliUtil.changeOptionDefault(optionsChanged2.getClass().getSuperclass(), "port", "8080");
CliUtil.execute(optionsChanged2, args);
assertEquals(8080, optionsChanged2.getPort());
assertEquals(new Duration(30.0, DurationUnit.SECOND), optionsChanged2.getTimeout());
// does the change stay?
args = new String[] {};
OptionsSub optionsChanged3 = new OptionsSub();
CliUtil.execute(optionsChanged3, args);
assertEquals(8080, optionsChanged3.getPort());
assertEquals(new Duration(30.0, DurationUnit.SECOND), optionsChanged3.getTimeout());
// clean the override map
CliUtil.overrideMap.clear();
}
}