Debugging
The Runner supports debugging plugins using several approaches. Choose the method that best fits your workflow.
Method 1: Copy Plugin Assemblies to the Runner Installation
This method involves placing your plugin assemblies directly into the Runner installation directory and enabling development mode.
Steps:
- Copy Assemblies: Place your plugin assemblies (and any required dependencies, ensuring you do not overwrite existing ones like OpenTAP) into the Runner installation directory.
- Enable Development Mode: Set
OPENTAP_RUNNER_DEVELOPMENT_MODE
to 1. - Start the Runner: Run:
./tap runner start
Advantages:- Registration (e.g., via KS8500) is required only once. Caveat:
- You must manually copy both the plugin assemblies and their dependencies, which may lead to version conflicts.
Method 2: Install the Runner in the Plugin Assembly Output Folder
By installing the Runner in your plugin’s output folder, Sessions start directly from that directory, loading your plugin assemblies automatically.
Steps:
- Add the Runner as a Dependency: In your plugin project, include the Runner package. For example, in your project file:
<ItemGroup> <OpenTapPackageReference Include="Runner" Version="1.12.2" /> </ItemGroup>
(Ensure you update the version as needed.)
- Register the Runner: Register the Runner in the output folder using the command provided on the KS8500 “New Runner” page: Run:
./tap runner register ...
- Enable Development Mode: Set
OPENTAP_RUNNER_DEVELOPMENT_MODE
to 1. - Start the Runner: Run:
./tap runner start
Advantages:
- Seamless integration with your plugin project; new builds are immediately available without manual copying.