Validate literals do not contain whitespace (#662)

Author: jpenilla

cloud-core/src/main/java/org/incendo/cloud/parser/standard/LiteralParser.java

@@ -23,14 +23,17 @@
 //
 package org.incendo.cloud.parser.standard;
 
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 import java.util.TreeSet;
 import org.apiguardian.api.API;
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.incendo.cloud.context.CommandContext;
 import org.incendo.cloud.context.CommandInput;
 import org.incendo.cloud.parser.ArgumentParseResult;
@@ -62,6 +65,7 @@ public final class LiteralParser<C> implements ArgumentParser<C, String>, Blocki
     private final String name;
 
     private LiteralParser(final @NonNull String name, final @NonNull String... aliases) {
+        validateNames(name, aliases);
         this.name = name;
         this.allAcceptedAliases.add(this.name);
         this.allAcceptedAliases.addAll(Arrays.asList(aliases));
@@ -119,7 +123,35 @@ private LiteralParser(final @NonNull String name, final @NonNull String... alias
      * @param alias New alias
      */
     public void insertAlias(final @NonNull String alias) {
+        validateNames("valid", new String[]{alias});
         this.allAcceptedAliases.add(alias);
         this.alternativeAliases.add(alias);
     }
+
+    private static void validateNames(final String name, final @NonNull String[] aliases) {
+        @Nullable List<String> errors = null;
+        errors = validateName(name, false, errors);
+        for (final String alias : aliases) {
+            errors = validateName(alias, true, errors);
+        }
+        if (errors != null && !errors.isEmpty()) {
+            throw new IllegalArgumentException(String.join("\n", errors));
+        }
+    }
+
+    @SuppressWarnings("checkstyle:FinalParameters")
+    private static @Nullable List<String> validateName(
+            final @NonNull String name,
+            final boolean alias,
+            @Nullable List<String> errors
+    ) {
+        final int found = name.codePoints().filter(Character::isWhitespace).findFirst().orElse(Integer.MIN_VALUE);
+        if (found != Integer.MIN_VALUE) {
+            if (errors == null) {
+                errors = new ArrayList<>();
+            }
+            errors.add(String.format("%s '%s' is invalid: contains whitespace", alias ? "Alias" : "Name", name));
+        }
+        return errors;
+    }
 }

cloud-core/src/test/java/org/incendo/cloud/parser/standard/LiteralParserTest.java

@@ -0,0 +1,46 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.parser.standard;
+
+import org.junit.jupiter.api.Test;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+class LiteralParserTest {
+
+    @Test
+    void testInvalidName() {
+        final IllegalArgumentException thr = assertThrows(IllegalArgumentException.class, () -> {
+            LiteralParser.literal("invalid name", "invalid\talias", "another\ninvalid\nalias");
+        });
+        assertThat(thr).hasMessageThat().isEqualTo(
+                "Name 'invalid name' is invalid: contains whitespace\n" +
+                        "Alias 'invalid\talias' is invalid: contains whitespace\n" +
+                        "Alias 'another\n" +
+                        "invalid\n" +
+                        "alias' is invalid: contains whitespace"
+        );
+    }
+}