Allow to load extra commands from plugins (with test) #1142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When ROBOT's CLI is initialised, we search for implementations of the `Command` interface offered as services, both in the system class path and in any Jar file found in the following directories: * the directory specified by the `robot.pluginsdir` system property; * the directory specified by the `ROBOT_PLUGINS_DIRECTORY` environment variable; * the calling user's `~/.robot/plugins` directory. When an implementation is found, it is registered to the CommandManager, allowing to use the command the same way as any built-in command. When a command has been loaded from a Jar file from one of the directories listed above (instead of from the system class path), its name must be prefixed by the basename of the Jar file (without the .jar extension) followed by a colon, for the command to be invoked from the command line. For example, if the file `my-plugins.jar` contains a command named `hello`, that command must be invoked as `my-plugins:hello`.
It could happen that a Jar plugin file could contain a bogus service configuration file, that is, a file that does not point to an existing org.obolibrary.robot.Command implementation. ROBOT should not abruptly fail in that situation, but should instead ignore the Jar file.
Add a new 'plugins' page in the documentation to briefly explain how to use and develop plugins. Mention the added support for plugins in the changelog.
Add a new module for a mock plugin (a command that inserts a silly message into the current ontology). The plugin will be used to test the support for pluggable commands and may also act as an example of how to create ROBOT plugins.
Add a new test fixture to check that the plugin manager can successfully find and load the mock plugin.
gouttegd
changed the title
5 tasks
It is counterintuitive that a test for the PluginManager, which is a component of the robot-command module, shall be in a separate module. But obviously we cannot test loading a plugin before the plugin itself has been built, and we cannot build the plugin before robot-command because the plugin itself is dependent on robot-command. So we test the plugin manager during the integration testing phase of the plugin; at this point all artifacts have been built (both the robot.jar and the plugin jar).
matentzn
reviewed
Aug 9, 2023
Fix incorrect environment variable name
|
I finally made time to review and test this for myself. The design and code are lovely, and aside from one typo that tripped me up for a minute, everything worked as expected. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs/have been added/updatedmvn verifysays all tests passmvn sitesays all JavaDocs correctCHANGELOG.mdhas been updatedThis is a the same PR as #1119, except that it includes an integration test to check that the plugin manager does find a plugin and can load a new command from it.