OpenAssetIO / OpenAssetIO/OpenAssetIO-Manager-BAL
Enforce correct creation of Context
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
What
Set a flag in the Context.managerState and assert that the same flag exists in the Context passed to each API method
Why
See https://github.com/OpenAssetIO/usdOpenAssetIOResolver/pull/47 where the USD resolver plugin was not creating the Context properly, and it was only when prototyping a feature that required use of the managerState that it became apparent.
By making some use of the managerState, if only to store and check a boolean flag, we could have detected this problem early in the unit tests.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating Context construction, the API methods that receive Context, and the existing unit tests in this Python repository. Add the managerState flag check described in the issue and verify that the tests detect incorrectly created or passed Context objects.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design, testing-qa
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100