openassetio.test.manager.apiComplianceSuite Namespace Reference

A manager test harness test case suite that validates that a specific manager plugin complies to the relevant core OpenAssetIO API contract. More...

Classes
class	Test_createChildState
	Tests that the createChildState method is implemented if createState has been implemented to return a custom state object. More...
class	Test_displayName
	Check plugin's implementation of managerApi.ManagerInterface.displayName. More...
class	Test_entityExists
	Check plugin's implementation of managerApi.ManagerInterface.entityExists. More...
class	Test_entityTraits
	Check plugin's implementation of managerApi.ManagerInterface.entityTraits. More...
class	Test_getWithRelationship_All
	Check plugin's implementation of managerApi.ManagerInterface.getWithRelationship[s]. More...
class	Test_identifier
	Check plugin's implementation of managerApi.ManagerInterface.identifier. More...
class	Test_info
	Check plugin's implementation of managerApi.ManagerInterface.info. More...
class	Test_initialize
	Check plugin's implementation of managerApi.ManagerInterface.initialize. More...
class	Test_isEntityReferenceString
	Check plugin's implementation of managerApi.ManagerInterface.isEntityReferenceString. More...
class	Test_managementPolicy
	Check plugin's implementation of managerApi.ManagerInterface.managementPolicy. More...
class	Test_persistenceTokenForState
	Tests that the persistenceTokenForState method is implemented if createState has been implemented to return a custom state object. More...
class	Test_preflight
	Check a plugin's implementation of managerApi.ManagerInterface.preflight. More...
class	Test_register
	Check a plugin's implementation of managerApi.ManagerInterface.register. More...
class	Test_resolve
	Check plugin's implementation of managerApi.ManagerInterface.resolve. More...
class	Test_settings
	Check plugin's implementation of managerApi.ManagerInterface.settings. More...
class	Test_stateFromPersistenceToken
	Tests that the persistenceTokenForState method is implemented if createState has been implemented to return a custom state object. More...
class	Test_updateTerminology
	Check plugin's implementation of managerApi.ManagerInterface.updateTerminology. More...

Detailed Description

A manager test harness test case suite that validates that a specific manager plugin complies to the relevant core OpenAssetIO API contract.

This suite is solely concerned with verifying that a plugin meets the requirements of the API, and can handle all documented calling patterns. For example, that when a managementPolicy query returns a non-ignored state, that there are no errors calling the other required methods for a managed entity with those traits.

The suite does not validate any specific business logic by checking the values API methods may return in certain situations. This should be handled through additional suites local to the manager's implementation.