Configurable hasCapability responses
#115
Merged
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
feltech
force-pushed
the
work/84-configurableCapabilities
branch
from
9f94199
to
768fa0b
Compare
feltech
force-pushed
the
work/84-configurableCapabilities
branch
from
768fa0b
to
37a3595
Compare
SamCrooksFoundry
approved these changes
Jul 22, 2024
feltech
force-pushed
the
work/84-configurableCapabilities
branch
from
37a3595
to
0eb8c47
Compare
Closes OpenAssetIO#84. Host applications must be able to tolerate manager plugins that do not support the full suite of (optional) capabilities that a manager may implement. However, there was no way for hosts to use BAL to test their logic for dealing with different combinations of capabilities. In addition, configurable capabilities are required to enable e2e testing of the capability-based routing used by the upcoming hybrid plugin system (see OpenAssetIO/OpenAssetIO#1202). So add a simple way to override the default set of capabilities reported by BAL, by adding an optional "capabilities" list element to the library, where each element is a stringified capability, as defined in `kCapabilityNames`. Presence of a capability in this list indicates that it is supported. If the list is not found, then the default (i.e. true) set of capabilities is used. Short-circuit methods where the capability is unsupported. Instead, call the base class (which will raise an error). This logic is similar to that used in the SimpleCppManager (see OpenAssetIO/OpenAssetIO#1324). Signed-off-by: David Feltell <[email protected]>
feltech
force-pushed
the
work/84-configurableCapabilities
branch
from
0eb8c47
to
1f65d3d
Compare
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.
Closes #84. Host applications must be able to tolerate manager plugins that do not support the full suite of (optional) capabilities that a manager may implement. However, there was no way for hosts to use BAL to test their logic for dealing with different combinations of capabilities.
In addition, configurable capabilities are required to enable e2e testing of the capability-based routing used by the upcoming hybrid plugin system (see OpenAssetIO/OpenAssetIO#1202).
So add a simple way to override the default set of capabilities reported by BAL, by adding an optional "capabilities" list element to the library, where each element is a stringified capability, as defined in
kCapabilityNames. Presence of a capability in this list indicates that it is supported. If the list is not found, then the default (i.e. true) set of capabilities is used.Short-circuit methods where the capability is unsupported. Instead, call the base class (which will raise an error).
This logic is similar to that used in the SimpleCppManager (see OpenAssetIO/OpenAssetIO#1324).
Also see OpenAssetIO/OpenAssetIO-MediaCreation#99 for context.