René's URL Explorer Experiment

Title: NMS independent test toolkit to allow developers to test their commands with MockBukkit by willkroboth · Pull Request #575 · CommandAPI/CommandAPI · GitHub

Open Graph Title: NMS independent test toolkit to allow developers to test their commands with MockBukkit by willkroboth · Pull Request #575 · CommandAPI/CommandAPI

X Title: NMS independent test toolkit to allow developers to test their commands with MockBukkit by willkroboth · Pull Request #575 · CommandAPI/CommandAPI

Description: Aims to resolve #356. Currently, when developers try to load the CommandAPI in a MockBukkit environment, it is very hard to get the NMS code accessed by the CommandAPI to cooperate with MockBukkit. There is work on the dev/public-test-suite branch that is trying to make it easier to resolve these issues. As an alternative solution, this PR aims to create a framework for mocking an NMS-independent version of the CommandAPI. Various utilities are also included to make testing commands easier. These features are accessible using the commandapi-bukkit-test-toolkit module. Developers should declare a test scope dependency on this module before their dependency on the plugin or shaded CommandAPI. This overrides CommandAPIVersionHandler when running tests to load MockCommandAPIBukkit instead, which doesn't rely on any NMS classes. The class CommandAPITestUtilities provides many static methods for asserting particular behavior when running commands. The class CommandAPIHandlerSpy intercepts command registration in the background to enable verifying the arguments input when running a command without having to make any changes to the plugin code that registers commands. In order to mock Arguments that usually rely upon NMS ArgumentTypes, we would have to implement the parsing logic ourselves. I've included IntegerRangeArgumentType as a proof of concept. Currently, any unimplemented NMS methods throw an UnimplementedMethodException. I don't think we need to worry about specific implementations for all these methods right now. As developers try to use this framework, the methods they actually use can be implemented first. I've implemented two example projects that showcase how to set up and use the test toolkit, one that shades the CommandAPI and one that depends on the CommandAPI plugin. This also helps verify that each setup works. To more rigorously test the toolkit's features, additional tests have been added inside the src/test directory of the commandapi-bukkit-test-toolkit module. The result of these tests will appear in the Jacoco coverage report. I still need to add javadocs and documentation, but I think this is a good start feature-wise. There are obviously many methods that throw an UnimplementedMethodException, but again I think developers can try using this first and show what methods are actually used. Feel free to suggest anything that should be included in an initial snapshot release of the framework though. Also, of course, code review is greatly appreciated!

Open Graph Description: Aims to resolve #356. Currently, when developers try to load the CommandAPI in a MockBukkit environment, it is very hard to get the NMS code accessed by the CommandAPI to cooperate with MockBukkit....

X Description: Aims to resolve #356. Currently, when developers try to load the CommandAPI in a MockBukkit environment, it is very hard to get the NMS code accessed by the CommandAPI to cooperate with MockBukkit....

Opengraph URL: https://github.com/CommandAPI/CommandAPI/pull/575

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width