Loading The CommandAPI in Tests

Plugin Dependency

If your plugin depends on the CommandAPI plugin to load, when running tests you should load the JavaPlugin MockCommandAPIPlugin before you use MockBukkit to load your plugin. You can either load this class directly with MockBukkit.load(MockCommandAPIPlugin.class), or use one of the static MockCommandAPIPlugin#load methods:

MockCommandAPIPlugin load()

Loads the CommandAPI Plugin in the test environment. Works exactly the same as MockBukkit.load(MockCommandAPIPlugin.class).

MockCommandAPIPlugin load(Consumer<CommandAPIBukkitConfig> configureSettings)

Loads the CommandAPI Plugin after applying the given consumer. This allows configuring any setting from the config.yml using the methods provided by CommandAPIBukkitConfig.

@BeforeEach
public void setUp() {
    // Set up MockBukkit server
    ServerMock server = MockBukkit.mock();

    // Load the CommandAPI plugin
    MockCommandAPIPlugin.load(config -> config
        .missingExecutorImplementationMessage("This command cannot be run by %S")
    );

    // Load our plugin
    MockBukkit.load(Main.class);
}

@AfterEach
public void tearDown() {
    // Reset for a clean slate next test
    MockBukkit.unmock();
}

Shaded Dependency

If your plugin shades the CommandAPI, the CommandAPI will automatically load as usual when you use MockBukkit to load your plugin. Just note that you must call CommandAPI.onDisable() in your plugin's onDisable method in order for the test environment to reset properly after each test.

Loading a custom CommandAPI platform implementation

By default, the testing environment will load MockCommandAPIBukkit as the CommandAPI platform object. This works for basic tests, but many methods in MockCommandAPIBukkit are not yet implemented and just throw an UnimplementedMethodException. This may cause your tests to fail if your code relies on any of these methods. If you see an UnimplementedMethodException, please tell us about it with a GitHub Issue or a message in the CommandAPI Discord so we can get it solved for everyone.

In the short term, you can also try to avoid an UnimplementedMethodException by implementing the required method yourself. Simply create a class that extends MockCommandAPIBukkit and override the required method with an appropriate implementation. Before each test where you want to use your custom implementation, make sure to call CommandAPIVersionHandler#usePlatformImplementation to let the CommandAPI know what it should load.

public class CustomMockCommandAPIBukkit extends MockCommandAPIBukkit {
    // Implement a method that usually throws `UnimplementedMethodException`
    @Override
    public void reloadDataPacks() {
        CommandAPI.logInfo("Simulating data pack reload");
        // Further logic
    }
}

@BeforeEach
public void setUp() {
    // Set up MockBukkit server
    MockBukkit.mock();

    // Tell the CommandAPI to use your custom platform implementation
    CommandAPIVersionHandler.usePlatformImplementation(new CustomMockCommandAPIBukkit());

    // Load CommandAPI and your plugin as mentioned above...
}