Skip to main content
Version: 2.26

Resolving Plugin Errors

There are many errors that could happen when attempting to add a step plugin to Cycle. Whenever Cycle identifies an error, it will issue notifications through the editor (the Cycle Desktop IDE or the Cycle Testing VS Code extension).

Step spec file​

The following errors could happen regarding the steps.yml file:

  1. The steps.yml file is not found in the step plugin directory.
  2. Cycle fails to parse the file.
  3. A step is missing any of its fields.
  4. A step ID is duplicated.
  5. A step text is duplicated.
  6. Different step plugins provide steps with the same CycleScript step text.

If Cycle discovers any of these issues, it will issue error notifications in the current editor. You will not be able to run any Cycle tests until the step plugin is fixed.

Settings file​

The following errors could happen regarding the settings.yml file:

  1. The settings.yml file is not found in the step plugin plugin directory.
  2. Cycle fails to parse the file.
  3. The file is missing the start command.
  4. The file cannot find the plugin dependencies.

If Cycle discovers any of these issues, it will issue error notifications in the current editor. You will not be able to run any Cycle tests until the step plugin is fixed.

Executable artifact​

The following errors could happen when trying to start the step plugin process for test execution:

  1. The start command in the settings.yml fails (for any reason).
  2. The plugin is not alive after timing out from calling the plugin's health check endpoint.
  3. The Cycle engine attempts to call a step that the plugin does not provide.

When the Cycle engine hits any of these errors, it will abort immediately and report error messages to all the standard places (editors, logs, console out).

API compatibility​

There could be incompatibilities between Cycle and the plugin's API endpoints. This is very unlikely if you are building your plugin using the Java Plugin SDK, but it could happen if there are version misalignments between the SDK and the Cycle app. Please double check your versions and then reach out to the Cycle Labs support team if you have any trouble.