OpenAssetIO / OpenAssetIO/OpenAssetIO

Make python plugin system test agnostic to other managers being installed.

Open
#978 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

test
Dominant language
C++
Stars
348
Forks
47
PR merge metrics
No merged PRs in 30d

Description

What

Make it so no matter if you have other managers installed into your test environment (ie, BAL,) the plugin test won't fail.

Why

Right now, the plugin test checks against a specific list of strings, assuming you don't have other managers installed. You get this output :

/home/elliotmorris/data/openAssetIO/elliotcmorris/OpenAssetIO/src/openassetio-python/tests/bridge/python/test_hostApi.cpp:39: FAILED:
  CHECK( identifiers == openassetio::Identifiers{ "org.openassetio.test.pluginSystem.resources.modulePlugin"} )
with expansion:
  { "org.openassetio.test.pluginSystem.resources.modulePlugin", "org.
  openassetio.examples.manager.bal" }
  ==
  { "org.openassetio.test.pluginSystem.resources.modulePlugin" }

It's reasonably to have other managers installed in your test environment, especially if you are an external contributor. If you're following our instructions and running the full ctest suite, this may make you think our tests dont work out of the box, and degrade the quality opinion of OpenAssetIO.

Acceptance Criteria

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/openassetio-python/tests/bridge/python/test_hostApi.cpp at the failing identifier CHECK on line 39. Run the affected plugin test with another manager such as BAL installed, then run the full ctest suite. Done means the test passes regardless of additional installed managers while still checking the test plugin identifier.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
testing-qa
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.