Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 2.15 KB

README.md

File metadata and controls

60 lines (44 loc) · 2.15 KB
Raw

SimpleCppManager

A simple C++ manager and plugin useful in basic host application test cases, where a C++ plugin is required.

Where Python is available, it is recommended to use the Basic Asset Library fake manager for testing, which is much more configurable and supports a wider cross-section of the OpenAssetIO API.

The SimpleCppManager manager/plugin only implements the minimal required methods plus resolve. It is entirely configured by the settings provided at initialize time (typically coming from the standard OpenAssetIO .toml configuration file). This includes the "database" of entities, encoded as a CSV document in a string setting. Note: this is not representative of a real-world implementation; it is purely a convenient approach for the purposes of configuring test cases - a real-world manager plugin would typically retrieve information from a dynamic external data source.

Building

As part of OpenAssetIO

The plugin can be built and installed as part of OpenAssetIO by setting the CMake option OPENASSETIO_ENABLE_SIMPLECPPMANAGER=ON when building OpenAssetIO.

Independently

Alternatively, the plugin can be built as an independent CMake project.

Available CMake settings

  • OPENASSETIO_ENABLE_TESTS - If truthy, tests will be enabled. These require an OpenAssetIO build with Python enabled, and a Python environment with pytest installed.

Assuming the working directory is at the root of the SimpleCppManager project, and assuming a POSIX host

export CMAKE_PREFIX_PATH=/path/to/OpenAssetIO/dist
cmake -S . -B build
cmake --build build --parallel
cmake --install build --prefix /path/to/OpenAssetIO/plugins

where /path/to/OpenAssetIO/plugins is an arbitrary path to be provided in the OPENASSETIO_PLUGIN_PATH environment variable.

Usage

See example config file for available configuration options, including constructing a database of resolveable entities.

Once the plugin has been installed, the usual configuration via OPENASSETIO_PLUGIN_PATH and OPENASSETIO_DEFAULT_CONFIG can be used (see API documentation).