Disable broken test: OptionalArgumentTests.kt#executionTestWithCommandTreeAndOptionalArgumentMethod

willkroboth · willkroboth · commit 193f237f9ca3 · 2023-09-02T17:46:44.000-04:00
TODO: Figure out what to do about this
diff --git a/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-test/commandapi-bukkit-kotlin-test/src/test/kotlin/dev/jorel/commandapi/test/dsltests/OptionalArgumentTests.kt b/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-test/commandapi-bukkit-kotlin-test/src/test/kotlin/dev/jorel/commandapi/test/dsltests/OptionalArgumentTests.kt
@@ -9,6 +9,7 @@ import dev.jorel.commandapi.test.TestBase
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Disabled
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertThrows
 
@@ -71,6 +72,27 @@ class OptionalArgumentTests: TestBase() {
 		}
 	}
 
+	// TODO: This test currently fails - The optionality of an argument in a CommandTree is currently ignored
+	//  Note: I'm not sure if optional arguments in command trees make sense
+	//  For example, consider this CommandTree (excuse my Java)
+	//   new CommandTree("command")
+	//   	.then(new StringArgument("string").setOptional(true)
+	//   		.then(new LiteralArgument("a").executes((sender, args) -> {
+	//   			sender.sendMessage("You ran the A path");
+	//   		}))
+	//   		.then(new LiteralArgument("b").executes((sender, args) -> {
+	//   			sender.sendMessage("You ran the B path");
+	//   		}))
+	//   	)
+	//   	.register();
+	//  The `string` argument is optional, which theoretically defines the following commands:
+	//    /command <string> a
+	//    /command <string> b
+	//    /command
+	//  The problem is: What is `/command` supposed to execute? `A path`, `B path`, something else? This works fine for
+	//  a CommandAPICommand since there can only be one executor defined, but I don't think anything makes sense for a
+	//  CommandTree.
+	@Disabled
 	@Test
 	fun executionTestWithCommandTreeAndOptionalArgumentMethod() {
 		val results: Mut<String> = Mut.of()
