Added parameters parsing exception rather than boolean

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>

gclc/src/main/java/fr/bigeon/gclc/ConsoleApplication.java

@@ -148,7 +148,7 @@ public class ConsoleApplication implements ICommandProvider {
             args = GCLCConstants.splitCommand(cmd);
         } catch (CommandParsingException e1) {
             manager.println("Command line cannot be parsed"); //$NON-NLS-1$
-            LOGGER.log(Level.INFO, "Invalid user command " + cmd, e1); //$NON-NLS-1$
+            LOGGER.log(Level.FINE, "Invalid user command " + cmd, e1); //$NON-NLS-1$
             return;
         }
         if (!args.isEmpty()) {
@@ -156,7 +156,7 @@ public class ConsoleApplication implements ICommandProvider {
                 executeSub(args.get(0), Arrays.copyOfRange(
                         args.toArray(new String[0]), 1, args.size()));
             } catch (final CommandRunException e) {
-                LOGGER.log(Level.WARNING, "Command failed: " + cmd, e); //$NON-NLS-1$
+                LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$
                 manager.println(Messages
                         .getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
                 manager.println(e.getLocalizedMessage());

gclc/src/main/java/fr/bigeon/gclc/command/CommandParameters.java

@@ -45,6 +45,8 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
+import fr.bigeon.gclc.exception.CommandParsingException;
+
 /** <p>
  * An object representing a collection of parameters. It is used for defaulting
  * values.
@@ -98,8 +100,8 @@ public class CommandParameters {
     }
 
     /** @param args the arguments to parse
-     * @return if the arguments were parsed */
+     * @throws CommandParsingException if the arguments parsing failed */
-    public boolean parseArgs(String... args) {
+    public void parseArgs(String... args) throws CommandParsingException {
         int i = 0;
         while (i < args.length) {
             String next = null;
@@ -108,11 +110,11 @@ public class CommandParameters {
             }
             int p = parseArg(args[i], next);
             if (p == 0) {
-                return false;
+                throw new CommandParsingException(
+                        "Invalid parameter " + args[i]);
             }
             i += p;
         }
-        return true;
 
     }
 
@@ -126,7 +128,7 @@ public class CommandParameters {
      * @return the number of element read */
     private int parseArg(String arg, String next) {
         if (!arg.startsWith("-")) { //$NON-NLS-1$
-            return 1;
+            return strict ? 0 : 1;
         }
         String name = arg.substring(1);
         if (booleanArguments.containsKey(name)) {

gclc/src/main/java/fr/bigeon/gclc/command/ParametrizedCommand.java

@@ -48,6 +48,7 @@ import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
 
+import fr.bigeon.gclc.exception.CommandParsingException;
 import fr.bigeon.gclc.exception.CommandRunException;
 import fr.bigeon.gclc.exception.CommandRunExceptionType;
 import fr.bigeon.gclc.exception.InvalidParameterException;
@@ -165,10 +166,11 @@ public abstract class ParametrizedCommand extends Command {
     public final void execute(String... args) throws CommandRunException {
         final CommandParameters parameters = new CommandParameters(
                 boolParams, stringParams.keySet(), strict);
-        if (!parameters.parseArgs(args)) {
+        try {
-            // the parameters could not be correctly parsed
+            parameters.parseArgs(args);
+        } catch (CommandParsingException e) {
             throw new CommandRunException(CommandRunExceptionType.USAGE,
-                    "Unable to read arguments", this); //$NON-NLS-1$
+                    "Unable to read arguments", e, this); //$NON-NLS-1$
         }
         final List<String> toProvide = new ArrayList<>();
         for (final Entry<String, Boolean> string : params.entrySet()) {

gclc/src/test/java/fr/bigeon/gclc/command/CommandParametersTest.java

@@ -40,27 +40,27 @@ package fr.bigeon.gclc.command;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
 
 import java.util.HashSet;
 import java.util.Set;
 
 import org.junit.Test;
 
-/**
+import fr.bigeon.gclc.exception.CommandParsingException;
- * <p>
+
+/** <p>
  * TODO
  *
- * @author Emmanuel Bigeon
+ * @author Emmanuel Bigeon */
- *
- */
 @SuppressWarnings({"static-method", "nls"})
 public class CommandParametersTest {
 
-    /**
+    /** Test method for
-     * Test method for {@link fr.bigeon.gclc.command.CommandParameters#CommandParameters(java.util.Set, java.util.Set, boolean)}.
+     * {@link fr.bigeon.gclc.command.CommandParameters#CommandParameters(java.util.Set, java.util.Set, boolean)}. */
-     */
     @Test
     public final void testCommandParameters() {
         Set<String> strings = new HashSet<>();
@@ -68,15 +68,24 @@ public class CommandParametersTest {
         CommandParameters parameters = new CommandParameters(bools, strings,
                 true);
 
-        assertFalse(parameters.parseArgs("-ungivenFlag"));
+        try {
+            parameters.parseArgs("-ungivenFlag");
+            fail("parse of unknown in strict should fail");
+        } catch (CommandParsingException e) {
+            assertNotNull(e);
+        }
         parameters = new CommandParameters(bools, strings, false);
 
-        assertTrue(parameters.parseArgs("-ungivenFlag"));
+        try {
+            parameters.parseArgs("-ungivenFlag");
+        } catch (CommandParsingException e) {
+            fail("parse of unknown in non strict should suceed");
+            assertNull(e);
+        }
     }
 
-    /**
+    /** Test method for
-     * Test method for {@link fr.bigeon.gclc.command.CommandParameters#get(java.lang.String)}.
+     * {@link fr.bigeon.gclc.command.CommandParameters#get(java.lang.String)}. */
-     */
     @Test
     public final void testGet() {
         Set<String> strings = new HashSet<>();
@@ -91,22 +100,33 @@ public class CommandParametersTest {
         assertNull(parameters.get("ungiven"));
         assertNull(parameters.get("str"));
 
+        try {
             parameters.parseArgs("-ungiven", "val");
+        } catch (CommandParsingException e) {
+            assertNotNull(e);
+        }
         assertNull(parameters.get("ungiven"));
         assertNull(parameters.get("str"));
 
+        try {
             parameters.parseArgs("-str", "val");
+        } catch (CommandParsingException e) {
+            assertNull(e);
+        }
         assertNull(parameters.get("ungiven"));
         assertEquals("val", parameters.get("str"));
 
+        try {
             parameters.parseArgs("-ungiven");
+        } catch (CommandParsingException e) {
+            assertNotNull(e);
+        }
         assertNull(parameters.get("ungiven"));
         assertEquals("val", parameters.get("str"));
     }
 
-    /**
+    /** Test method for
-     * Test method for {@link fr.bigeon.gclc.command.CommandParameters#getAdditionals()}.
+     * {@link fr.bigeon.gclc.command.CommandParameters#getAdditionals()}. */
-     */
     @Test
     public final void testGetAdditionals() {
         Set<String> strings = new HashSet<>();
@@ -118,25 +138,40 @@ public class CommandParametersTest {
         CommandParameters parameters = new CommandParameters(bools, strings,
                 true);
 
+        try {
             parameters.parseArgs("-boolFlag");
+        } catch (CommandParsingException e) {
+            assertNull(e);
+        }
         assertTrue(parameters.getAdditionals().isEmpty());
 
+        try {
             parameters.parseArgs("-ungiven");
+        } catch (CommandParsingException e) {
+            assertNotNull(e);
+        }
         assertTrue(parameters.getAdditionals().isEmpty());
 
         parameters = new CommandParameters(bools, strings, false);
 
+        try {
             parameters.parseArgs("-boolFlag");
+        } catch (CommandParsingException e) {
+            assertNull(e);
+        }
         assertTrue(parameters.getAdditionals().isEmpty());
 
+        try {
             parameters.parseArgs("-ungiven");
+        } catch (CommandParsingException e) {
+            assertNotNull(e);
+        }
         assertTrue(parameters.getAdditionals().contains("ungiven"));
         assertEquals(1, parameters.getAdditionals().size());
     }
 
-    /**
+    /** Test method for
-     * Test method for {@link fr.bigeon.gclc.command.CommandParameters#getBool(java.lang.String)}.
+     * {@link fr.bigeon.gclc.command.CommandParameters#getBool(java.lang.String)}. */
-     */
     @Test
     public final void testGetBool() {
         Set<String> strings = new HashSet<>();
@@ -151,11 +186,20 @@ public class CommandParametersTest {
         assertFalse(parameters.getBool("ungiven"));
         assertFalse(parameters.getBool("boolFlag"));
 
+        try {
             parameters.parseArgs("-boolFlag");
+        } catch (CommandParsingException e) {
+            assertNull(e);
+        }
         assertTrue(parameters.getBool("boolFlag"));
         assertFalse(parameters.getBool("ungiven"));
 
+        try {
             parameters.parseArgs("-ungiven");
+            fail("unknown parameter should fail");
+        } catch (CommandParsingException e) {
+            assertNotNull(e);
+        }
         assertFalse(parameters.getBool("ungiven"));
         assertTrue(parameters.getBool("boolFlag"));
 
@@ -164,18 +208,25 @@ public class CommandParametersTest {
         assertFalse(parameters.getBool("ungiven"));
         assertFalse(parameters.getBool("boolFlag"));
 
+        try {
             parameters.parseArgs("-boolFlag");
+        } catch (CommandParsingException e) {
+            assertNull(e);
+        }
         assertTrue(parameters.getBool("boolFlag"));
         assertFalse(parameters.getBool("ungiven"));
 
+        try {
             parameters.parseArgs("-ungiven");
+        } catch (CommandParsingException e) {
+            assertNull(e);
+        }
         assertFalse(parameters.getBool("ungiven"));
         assertTrue(parameters.getBool("boolFlag"));
     }
 
-    /**
+    /** Test method for
-     * Test method for {@link fr.bigeon.gclc.command.CommandParameters#parseArgs(java.lang.String[])}.
+     * {@link fr.bigeon.gclc.command.CommandParameters#parseArgs(java.lang.String[])}. */
-     */
     @Test
     public final void testParseArgs() {
         Set<String> strings = new HashSet<>();
@@ -187,17 +238,38 @@ public class CommandParametersTest {
         CommandParameters parameters = new CommandParameters(bools, strings,
                 true);
 
-        assertFalse(parameters.parseArgs("-ungivenFlag"));
+        try {
-        assertFalse(parameters.parseArgs("-str"));
+            parameters.parseArgs("-ungivenFlag");
-        assertTrue(parameters.parseArgs("-boolFlag"));
+            fail("unknown argument should fail in strict");
-        assertTrue(parameters.parseArgs("-str", "-boolFlag"));
+        } catch (CommandParsingException e) {
-        assertTrue(parameters.parseArgs("-boolFlag", "-str", "val"));
+            assertNotNull(e);
+        }
+        try {
+            parameters.parseArgs("-str");
+            fail("missing string argument value should fail");
+        } catch (CommandParsingException e) {
+            assertNotNull(e);
+        }
+        try {
+            parameters.parseArgs("-boolFlag");
+        } catch (CommandParsingException e) {
+            assertNull(e);
+        }
+        try {
+            parameters.parseArgs("-str", "-boolFlag");
+        } catch (CommandParsingException e) {
+            assertNull(e);
+        }
+        try {
+            parameters.parseArgs("-boolFlag", "-str", "val");
+        } catch (CommandParsingException e) {
+            assertNull(e);
+        }
 
     }
 
-    /**
+    /** Test method for
-     * Test method for {@link fr.bigeon.gclc.command.CommandParameters#set(java.lang.String, boolean)}.
+     * {@link fr.bigeon.gclc.command.CommandParameters#set(java.lang.String, boolean)}. */
-     */
     @Test
     public final void testSetStringBoolean() {
         Set<String> strings = new HashSet<>();
@@ -234,9 +306,8 @@ public class CommandParametersTest {
         assertTrue(parameters.getBool("boolFlag"));
     }
 
-    /**
+    /** Test method for
-     * Test method for {@link fr.bigeon.gclc.command.CommandParameters#set(java.lang.String, java.lang.String)}.
+     * {@link fr.bigeon.gclc.command.CommandParameters#set(java.lang.String, java.lang.String)}. */
-     */
     @Test
     public final void testSetStringString() {
         Set<String> strings = new HashSet<>();