Skip to main content

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).

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 has incorrect step renaming settings.

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.

OpenAPI spec file​

The following problems could happen regarding the OpenAPI specification for steps:

  1. The schema.openapi.yml file is not found in the step plugin plugin directory.
  2. Cycle fails to parse the whole file.
  3. The GET /status path is missing.
  4. The GET /status path is incorrect.
  5. The POST /scenario-start path is missing.
  6. The POST /scenario-start path is incorrect.
  7. The POST /scenario-end path is missing.
  8. The POST /scenario-end path is incorrect.
  9. The POST /shutdown path is missing.
  10. The POST /shutdown path is incorrect.
  11. A step path is incorrect:
    1. It is missing a list of CycleScript steps for x-cycle-steps.
    2. It is missing input definitions for CycleScript step parameters.
    3. It defines an incorrect step response.
    4. It is missing a description. (WARNING)
    5. It is missing examples for inputs for CycleScript step parameters. (WARNING)
    6. It has other issues.
  12. Two step paths define the same CycleScript step text.
  13. Different step plugins provide steps with the same CycleScript step text. (WARNING)

All of these are errors except for the few marked explicitly as warnings. If Cycle discovers any of these issues, it will issue notifications in the current editor. Cycle will allow tests to run for warnings but not for errors.

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 step plugin is not alive after timing out from calling the start command and calling the GET /status command.
  3. The Cycle engine attempts to call a step that the step 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).