Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Instructions for testing commands with MockBukkit #356

Open
JorelAli opened this issue Oct 25, 2022 · 3 comments · May be fixed by #575
Open

Instructions for testing commands with MockBukkit #356

JorelAli opened this issue Oct 25, 2022 · 3 comments · May be fixed by #575
Labels
documentation Documentation improvement enhancement New feature or request

Comments

@JorelAli
Copy link
Owner

Description

Instructions for testing the CommandAPI with MockBukkit. Some worked examples, how to set up a project for testing, inclusion of the plugin-test dependency and support for plugins that are shading the CommandAPI are all stuff that would need to be done.

Expected code

No response

Extra details

No response

@JorelAli JorelAli added enhancement New feature or request documentation Documentation improvement labels Oct 25, 2022
@tatanpoker09
Copy link

Is there already a plan to incorporate these instructions onto the documentation? I was looking into it myself but I'm having trouble with nms. I am currently trying to copy a little from the plugin-test folder, but a detailed tutorial to avoid having unnecessary bloat would be appreciated

@JorelAli
Copy link
Owner Author

JorelAli commented Apr 7, 2023

Is there already a plan to incorporate these instructions onto the documentation? I was looking into it myself but I'm having trouble with nms. I am currently trying to copy a little from the plugin-test folder, but a detailed tutorial to avoid having unnecessary bloat would be appreciated

Yes! When a suitable framework structure has been made and we're ready to release the public testing setup for CommandAPI commands, we'll add it to the main documentation :)

@fhnaumann
Copy link

Is there an estimate when this will be available?

willkroboth added a commit that referenced this issue Jul 4, 2024
Create `automated-tests-shaded` example project to test using the test toolkit

Resolves #356

Alternative idea to current work on `dev/public-test-suite`

Attempts to allow developers to test their commands independently of any version or nms stuff. Currently, most of the methods throw an UnimplementedMethodException, but I have implemented enough to get the simple `PingPongCommandTests` file to work as a proof of concept.

TODO:
- Implement the methods required to test:
  - `commandapi-bukkit-plugin` based projects
  - Common arguments
  - Suggestions
- Write documentation
- Maybe add a module to more rigorously test the toolkit without cluttering the example project

I think if we can get a simple version working and published as a snapshot, users can try it out and identify methods that need to be implemented.
willkroboth added a commit that referenced this issue Aug 24, 2024
Create `automated-tests-shaded` example project to test using the test toolkit

Resolves #356

Alternative idea to current work on `dev/public-test-suite`

Attempts to allow developers to test their commands independently of any version or nms stuff. Currently, most of the methods throw an UnimplementedMethodException, but I have implemented enough to get the simple `PingPongCommandTests` file to work as a proof of concept.

TODO:
- Implement the methods required to test:
  - `commandapi-bukkit-plugin` based projects
  - Common arguments
  - Suggestions
- Write documentation
- Maybe add a module to more rigorously test the toolkit without cluttering the example project

I think if we can get a simple version working and published as a snapshot, users can try it out and identify methods that need to be implemented.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation improvement enhancement New feature or request
Projects
None yet
3 participants