Package dev.jorel.commandapi

Class CommandAPITestUtilities

java.lang.Object

dev.jorel.commandapi.CommandAPITestUtilities

public class CommandAPITestUtilities
extends Object

Provides static methods to interact with CommandAPI commands registered in the test environment. This includes verifying that a command runs successfully, fails with a certain error message, runs with certain arguments, or suggests strings or tooltips.

Tip: The standard way to access static methods is by using the class name (e.g. CommandAPITestUtilities.assertCommandSucceeds(...)). However, you can also call these methods with just the method name (assertCommandSucceeds(...)), if you add a static import (import static dev.jorel.commandapi.CommandAPITestUtilities.assertCommandSucceeds;) or make your test class extend this class (class Tests extends CommandAPITestUtilities {...}).

Constructor Summary

Constructors

Constructor	Description
CommandAPITestUtilities()

Method Summary

Modifier and Type	Method	Description
static com.mojang.brigadier.exceptions.CommandSyntaxException	assertCommandFails(org.bukkit.command.CommandSender sender, String command, String expectedMessage)	Runs a CommandAPI command as asserts that it fails.
static void	assertCommandFailsWithArguments(org.bukkit.command.CommandSender sender, String command, String expectedFailureMessage, Object... argumentsArray)	Asserts that the given array of argument objects was available when a command executed and threw an exception.
static void	assertCommandFailsWithArguments(org.bukkit.command.CommandSender sender, String command, String expectedFailureMessage, Map<String,Object> argumentsMap)	Asserts that the given map of argument objects was available when a command executed successfully.
static void	assertCommandSucceeds(org.bukkit.command.CommandSender sender, String command)	Runs a CommandAPI command and asserts that it succeeds.
static void	assertCommandSucceedsWithArguments(org.bukkit.command.CommandSender sender, String command, Object... argumentsArray)	Asserts that the given array of argument objects was available when a command executed successfully.
static void	assertCommandSucceedsWithArguments(org.bukkit.command.CommandSender sender, String command, Map<String,Object> argumentsMap)	Asserts that the given map of argument objects was available when a command executed successfully.
static void	assertCommandSuggests(org.bukkit.command.CommandSender sender, String command, int startingAt, String... expectedSuggestions)	Asserts that the suggestions provided for the given command start at the given index and have the given texts.
static void	assertCommandSuggests(org.bukkit.command.CommandSender sender, String command, int startingAt, List<String> expectedSuggestions)	Asserts that the suggestions provided for the given command start at the given index and have the given texts.
static void	assertCommandSuggests(org.bukkit.command.CommandSender sender, String command, String... expectedSuggestions)	Asserts that the suggestions provided for the given command have the given texts.
static void	assertCommandSuggests(org.bukkit.command.CommandSender sender, String command, List<String> expectedSuggestions)	Asserts that the suggestions provided for the given command have the given texts.
static void	assertCommandSuggestsTooltips(org.bukkit.command.CommandSender sender, String command, int startingAt, com.mojang.brigadier.suggestion.Suggestion... expectedSuggestions)	Asserts that the suggestions provided for the given command start at the given index and have the given texts and tooltips.
static void	assertCommandSuggestsTooltips(org.bukkit.command.CommandSender sender, String command, int startingAt, List<com.mojang.brigadier.suggestion.Suggestion> expectedSuggestions)	Asserts that the suggestions provided for the given command start at the given index and have the given texts and tooltips.
static void	assertCommandSuggestsTooltips(org.bukkit.command.CommandSender sender, String command, com.mojang.brigadier.suggestion.Suggestion... expectedSuggestions)	Asserts that the suggestions provided for the given command have the given texts and tooltips.
static void	assertCommandSuggestsTooltips(org.bukkit.command.CommandSender sender, String command, List<com.mojang.brigadier.suggestion.Suggestion> expectedSuggestions)	Asserts that the suggestions provided for the given command have the given texts and tooltips.
static void	assertSuggestionEquality(List<String> expectedSuggestions, List<com.mojang.brigadier.suggestion.Suggestion> actualSuggestions)	Asserts that the Suggestion.getText() of each given Suggestion matches an expected String.
static void	assertSuggestionEqualityTooltips(List<com.mojang.brigadier.suggestion.Suggestion> expectedSuggestions, List<com.mojang.brigadier.suggestion.Suggestion> actualSuggestions)	Asserts that the Suggestion.getText() and Suggestion.getTooltip() of each given Suggestion matches an expected Suggestion.
static void	assertSuggestionsStartAt(int startingAt, List<com.mojang.brigadier.suggestion.Suggestion> suggestions)	Asserts that all Suggestions in the given list start at the given index.
static void	dispatchCommand(org.bukkit.command.CommandSender sender, String command)	Attempts to run a CommandAPI command.
static ExecutionInfo<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutionInfoOfFailingCommand(org.bukkit.command.CommandSender sender, String command, String expectedFailureMessage)	Returns the ExecutionInfo used when a CommandAPI command was executed and threw an exception.
static ExecutionInfo<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutionInfoOfSuccessfulCommand(org.bukkit.command.CommandSender sender, String command)	Returns the ExecutionInfo used when a CommandAPI command was executed successfully.
static MockCommandAPI	getMockCommandAPI()
static com.mojang.brigadier.suggestion.Suggestions	getSuggestions(org.bukkit.command.CommandSender sender, String command)	Returns the Brigadier Suggestions provided for the given command.
static com.mojang.brigadier.suggestion.Suggestion	makeTooltip(String text, String tooltip)	Creates a Suggestion with the given Strings as its text and tooltip.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CommandAPITestUtilities

public CommandAPITestUtilities()

Method Details

getMockCommandAPI

public static MockCommandAPI getMockCommandAPI()

Returns:

The MockCommandAPI class currently loaded.

dispatchCommand

public static void dispatchCommand(org.bukkit.command.CommandSender sender,
 String command)
                            throws com.mojang.brigadier.exceptions.CommandSyntaxException

Attempts to run a CommandAPI command.

Parameters:

sender - The CommandSender running the command.

command - The command to execute.

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException - If the command fails for any reason.

See Also:

• assertCommandSucceeds(CommandSender, String)
• assertCommandFails(CommandSender, String, String)

assertCommandSucceeds

public static void assertCommandSucceeds(org.bukkit.command.CommandSender sender,
 String command)

Runs a CommandAPI command and asserts that it succeeds.

Parameters:

sender - The CommandSender running the command.

command - The command to execute.

Throws:

org.opentest4j.AssertionFailedError - If dispatching the command fails for any reason.

See Also:

• dispatchCommand(CommandSender, String)

assertCommandFails

@CanIgnoreReturnValue
public static com.mojang.brigadier.exceptions.CommandSyntaxException assertCommandFails(org.bukkit.command.CommandSender sender,
 String command,
 String expectedMessage)

Runs a CommandAPI command as asserts that it fails.

Parameters:

sender - The CommandSender running the command.

command - The command to execute.

expectedMessage - The expected message thrown when the command fails.

Returns:

The CommandSyntaxException that resulted when the command failed. This can be ignored if no further checks are necessary.

Throws:

org.opentest4j.AssertionFailedError - If dispatching the command does not fail, or it fails with a different message than expected.

See Also:

• dispatchCommand(CommandSender, String)

getExecutionInfoOfSuccessfulCommand

public static ExecutionInfo<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> getExecutionInfoOfSuccessfulCommand(org.bukkit.command.CommandSender sender,
 String command)

Returns the ExecutionInfo used when a CommandAPI command was executed successfully.

Parameters:

sender - The CommandSender running the command.

command - The command to execute.

Returns:

The ExecutionInfo used when the command was executed.

Throws:

org.opentest4j.AssertionFailedError - If the command does not succeed or a CommandAPI executor is not invoked.

See Also:

• assertCommandSucceedsWithArguments(CommandSender, String, Object...)
• assertCommandSucceedsWithArguments(CommandSender, String, Map)
• assertCommandSucceeds(CommandSender, String)
• getExecutionInfoOfFailingCommand(CommandSender, String, String)

assertCommandSucceedsWithArguments

public static void assertCommandSucceedsWithArguments(org.bukkit.command.CommandSender sender,
 String command,
 Object... argumentsArray)

Asserts that the given array of argument objects was available when a command executed successfully.

Parameters:

sender - The CommandSender running the command.

command - The command to execute.

argumentsArray - The CommandArguments.args() that is expected when the command executes.

Throws:

org.opentest4j.AssertionFailedError - If the command does not succeed or the available arguments array is different from expected.

See Also:

• assertCommandSucceedsWithArguments(CommandSender, String, Map)
• assertCommandSucceeds(CommandSender, String)
• getExecutionInfoOfSuccessfulCommand(CommandSender, String)

assertCommandSucceedsWithArguments

public static void assertCommandSucceedsWithArguments(org.bukkit.command.CommandSender sender,
 String command,
 Map<String,Object> argumentsMap)

Asserts that the given map of argument objects was available when a command executed successfully.

Parameters:

sender - The CommandSender running the command.

command - The command to execute.

argumentsMap - The CommandArguments.argsMap() that is expected when the command executes.

Throws:

org.opentest4j.AssertionFailedError - If the command does not succeed or the available arguments map is different from expected.

See Also:

• assertCommandSucceedsWithArguments(CommandSender, String, Object...)
• assertCommandSucceeds(CommandSender, String)
• getExecutionInfoOfSuccessfulCommand(CommandSender, String)

getExecutionInfoOfFailingCommand

public static ExecutionInfo<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> getExecutionInfoOfFailingCommand(org.bukkit.command.CommandSender sender,
 String command,
 String expectedFailureMessage)

Returns the ExecutionInfo used when a CommandAPI command was executed and threw an exception. Note that if the command dispatch fails because the input was not parsed properly, then a CommandAPI executor will not be invoked, and this assertion will fail.

Parameters:

sender - The CommandSender running the command.

command - The command to execute.

expectedFailureMessage - The expected message thrown when the command fails.

Returns:

The ExecutionInfo used when the command was executed.

Throws:

org.opentest4j.AssertionFailedError - If dispatching the command does not fail, it fails with a different message than expected, or a CommandAPI executor is not invoked.

See Also:

• assertCommandFailsWithArguments(CommandSender, String, String, Object...)
• assertCommandFailsWithArguments(CommandSender, String, String, Map)
• assertCommandFails(CommandSender, String, String)
• getExecutionInfoOfSuccessfulCommand(CommandSender, String)

assertCommandFailsWithArguments

public static void assertCommandFailsWithArguments(org.bukkit.command.CommandSender sender,
 String command,
 String expectedFailureMessage,
 Object... argumentsArray)

Asserts that the given array of argument objects was available when a command executed and threw an exception. Note that if the command dispatch fails because the input was not parsed properly, then a CommandAPI executor will not be invoked, and this assertion will fail.

Parameters:

sender - The CommandSender running the command.

command - The command to execute.

expectedFailureMessage - The expected message thrown when the command fails.

argumentsArray - The CommandArguments.args() that is expected when the command executes.

Throws:

org.opentest4j.AssertionFailedError - If the command does not fail or the available arguments array is different from expected.

See Also:

• assertCommandFailsWithArguments(CommandSender, String, String, Map)
• assertCommandFails(CommandSender, String, String)
• getExecutionInfoOfFailingCommand(CommandSender, String, String)

assertCommandFailsWithArguments

public static void assertCommandFailsWithArguments(org.bukkit.command.CommandSender sender,
 String command,
 String expectedFailureMessage,
 Map<String,Object> argumentsMap)

Asserts that the given map of argument objects was available when a command executed successfully.

Parameters:

sender - The CommandSender running the command.

command - The command to execute.

expectedFailureMessage - The expected message thrown when the command fails.

argumentsMap - The CommandArguments.argsMap() that is expected when the command executes.

Throws:

org.opentest4j.AssertionFailedError - If the command does not fail or the available arguments map is different from expected.

See Also:

• assertCommandFailsWithArguments(CommandSender, String, String, Object...)
• assertCommandFails(CommandSender, String, String)
• getExecutionInfoOfFailingCommand(CommandSender, String, String)

getSuggestions

public static com.mojang.brigadier.suggestion.Suggestions getSuggestions(org.bukkit.command.CommandSender sender,
 String command)

Returns the Brigadier Suggestions provided for the given command.

Parameters:

sender - The CommandSender requesting suggestions.

command - The command to complete.

Returns:

The Suggestions provided for this command.

See Also:

• assertCommandSuggests(CommandSender, String, String...)
• assertCommandSuggests(CommandSender, String, int, String...)
• assertCommandSuggestsTooltips(CommandSender, String, Suggestion...)
• assertCommandSuggestsTooltips(CommandSender, String, int, Suggestion...)

assertSuggestionsStartAt

public static void assertSuggestionsStartAt(int startingAt,
 List<com.mojang.brigadier.suggestion.Suggestion> suggestions)

Asserts that all Suggestions in the given list start at the given index.

Parameters:

startingAt - The index that the suggestions should start at.

suggestions - A List of Suggestions to check.

Throws:

org.opentest4j.AssertionFailedError - If any of the given Suggestions do not start at the given index.

See Also:

• assertCommandSuggests(CommandSender, String, int, String...)
• assertCommandSuggestsTooltips(CommandSender, String, int, Suggestion...)

assertSuggestionEquality

public static void assertSuggestionEquality(List<String> expectedSuggestions,
 List<com.mojang.brigadier.suggestion.Suggestion> actualSuggestions)

Asserts that the Suggestion.getText() of each given Suggestion matches an expected String.

Parameters:

expectedSuggestions - A List of Strings that are expected to be suggested.

actualSuggestions - The List of Suggestions that was actually produced.

Throws:

org.opentest4j.AssertionFailedError - If any of the actual Suggestions do not have the expected text.

See Also:

• assertCommandSuggests(CommandSender, String, String...)
• assertCommandSuggests(CommandSender, String, int, String...)

assertSuggestionEqualityTooltips

public static void assertSuggestionEqualityTooltips(List<com.mojang.brigadier.suggestion.Suggestion> expectedSuggestions,
 List<com.mojang.brigadier.suggestion.Suggestion> actualSuggestions)

Asserts that the Suggestion.getText() and Suggestion.getTooltip() of each given Suggestion matches an expected Suggestion.

Parameters:

expectedSuggestions - A List of Suggestions that are expected to be suggested.

actualSuggestions - The List of Suggestions that was actually produced.

Throws:

org.opentest4j.AssertionFailedError - If any of the actual Suggestions do not have the expected text or tooltip.

See Also:

• makeTooltip(String, String)
• assertCommandSuggestsTooltips(CommandSender, String, Suggestion...)
• assertCommandSuggestsTooltips(CommandSender, String, int, Suggestion...)

assertCommandSuggests

public static void assertCommandSuggests(org.bukkit.command.CommandSender sender,
 String command,
 String... expectedSuggestions)

Asserts that the suggestions provided for the given command have the given texts.

Parameters:

sender - The CommandSender requesting suggestions.

command - The command to complete.

expectedSuggestions - The suggestion texts that are expected.

Throws:

org.opentest4j.AssertionFailedError - If any of the actual suggestions do not have the expected text.

See Also:

• getSuggestions(CommandSender, String)
• assertCommandSuggests(CommandSender, String, int, String...)
• assertCommandSuggests(CommandSender, String, List)

assertCommandSuggests

public static void assertCommandSuggests(org.bukkit.command.CommandSender sender,
 String command,
 int startingAt,
 String... expectedSuggestions)

Asserts that the suggestions provided for the given command start at the given index and have the given texts.

Parameters:

sender - The CommandSender requesting suggestions.

command - The command to complete.

startingAt - The location in the command where the suggestions are expected.

expectedSuggestions - The suggestion texts that are expected.

Throws:

org.opentest4j.AssertionFailedError - If any of the actual suggestions do not start or the given index or have the expected text.

See Also:

• getSuggestions(CommandSender, String)
• assertCommandSuggests(CommandSender, String, String...)
• assertCommandSuggests(CommandSender, String, int, List)

assertCommandSuggests

public static void assertCommandSuggests(org.bukkit.command.CommandSender sender,
 String command,
 List<String> expectedSuggestions)

Asserts that the suggestions provided for the given command have the given texts.

Parameters:

sender - The CommandSender requesting suggestions.

command - The command to complete.

expectedSuggestions - The suggestion texts that are expected.

Throws:

org.opentest4j.AssertionFailedError - If any of the actual suggestions do not have the expected text.

See Also:

• getSuggestions(CommandSender, String)
• assertCommandSuggests(CommandSender, String, int, List)
• assertCommandSuggests(CommandSender, String, String...)

assertCommandSuggests

public static void assertCommandSuggests(org.bukkit.command.CommandSender sender,
 String command,
 int startingAt,
 List<String> expectedSuggestions)

Asserts that the suggestions provided for the given command start at the given index and have the given texts.

Parameters:

sender - The CommandSender requesting suggestions.

command - The command to complete.

startingAt - The location in the command where the suggestions are expected.

expectedSuggestions - The suggestion texts that are expected.

Throws:

org.opentest4j.AssertionFailedError - If any of the actual suggestions do not start or the given index or have the expected text.

See Also:

• getSuggestions(CommandSender, String)
• assertCommandSuggests(CommandSender, String, String...)
• assertCommandSuggests(CommandSender, String, int, List)

makeTooltip

public static com.mojang.brigadier.suggestion.Suggestion makeTooltip(String text,
 String tooltip)

Creates a Suggestion with the given Strings as its text and tooltip.

Parameters:

text - The String for Suggestion.getText().

tooltip - The String for Suggestion.getTooltip(). This may be null to indicate no tooltip.

Returns:

A new Suggestion.

See Also:

• assertCommandSuggestsTooltips(CommandSender, String, Suggestion...)
• assertCommandSuggestsTooltips(CommandSender, String, int, Suggestion...)

assertCommandSuggestsTooltips

public static void assertCommandSuggestsTooltips(org.bukkit.command.CommandSender sender,
 String command,
 com.mojang.brigadier.suggestion.Suggestion... expectedSuggestions)

Asserts that the suggestions provided for the given command have the given texts and tooltips.

Parameters:

sender - The CommandSender requesting suggestions.

command - The command to complete.

expectedSuggestions - The suggestions that are expected.

Throws:

org.opentest4j.AssertionFailedError - If any of the actual suggestions do not have the expected text or tooltip.

See Also:

• makeTooltip(String, String)
• getSuggestions(CommandSender, String)
• assertCommandSuggestsTooltips(CommandSender, String, int, Suggestion...)
• assertCommandSuggestsTooltips(CommandSender, String, List)

assertCommandSuggestsTooltips

public static void assertCommandSuggestsTooltips(org.bukkit.command.CommandSender sender,
 String command,
 int startingAt,
 com.mojang.brigadier.suggestion.Suggestion... expectedSuggestions)

Asserts that the suggestions provided for the given command start at the given index and have the given texts and tooltips.

Parameters:

sender - The CommandSender requesting suggestions.

command - The command to complete.

startingAt - The location in the command where the suggestions are expected.

expectedSuggestions - The suggestions that are expected.

Throws:

org.opentest4j.AssertionFailedError - If any of the actual suggestions do not start or the given index or have the expected text or tooltip.

See Also:

• makeTooltip(String, String)
• getSuggestions(CommandSender, String)
• assertCommandSuggestsTooltips(CommandSender, String, Suggestion...)
• assertCommandSuggestsTooltips(CommandSender, String, int, List)

assertCommandSuggestsTooltips

public static void assertCommandSuggestsTooltips(org.bukkit.command.CommandSender sender,
 String command,
 List<com.mojang.brigadier.suggestion.Suggestion> expectedSuggestions)

Asserts that the suggestions provided for the given command have the given texts and tooltips.

Parameters:

sender - The CommandSender requesting suggestions.

command - The command to complete.

expectedSuggestions - The suggestions that are expected.

Throws:

org.opentest4j.AssertionFailedError - If any of the actual suggestions do not have the expected text or tooltip.

See Also:

• makeTooltip(String, String)
• getSuggestions(CommandSender, String)
• assertCommandSuggestsTooltips(CommandSender, String, int, List)
• assertCommandSuggestsTooltips(CommandSender, String, Suggestion...)

assertCommandSuggestsTooltips

public static void assertCommandSuggestsTooltips(org.bukkit.command.CommandSender sender,
 String command,
 int startingAt,
 List<com.mojang.brigadier.suggestion.Suggestion> expectedSuggestions)

Asserts that the suggestions provided for the given command start at the given index and have the given texts and tooltips.

Parameters:

sender - The CommandSender requesting suggestions.

command - The command to complete.

startingAt - The location in the command where the suggestions are expected.

expectedSuggestions - The suggestions that are expected.

Throws:

org.opentest4j.AssertionFailedError - If any of the actual suggestions do not start or the given index or have the expected text or tooltip.

See Also:

• makeTooltip(String, String)
• getSuggestions(CommandSender, String)
• assertCommandSuggestsTooltips(CommandSender, String, List)
• assertCommandSuggestsTooltips(CommandSender, String, int, Suggestion...)