JSON/YAML schema for YAML based Citrus test source files

[picimako]

Summary

Citrus provides various DSLs besides Java to write tests, and one among them is YAML files.

Tasks

• Implement a custom JSON schema provider for Citrus YAML test source files.
• Such YAML files have to be recognized. That will be done based on the values specified in the citrus.yaml.file.name.pattern property of the citrus-application.properties.
  • If Custom citrus-application.properties files #17 is completed beforehand, custom configuration files must also be taken into account.
  • If the citrus.yaml.file.name.pattern property is not specified or is blank, then it will fall back to the Citrus defaults.
  • The file name patterns must be cached/indexed, and updated when the Citrus configuration file changes.
  • File name patterns that would match files with not .yml or .yaml extension should be excluded.
  • Optionally, for cases when the file name patterns are specified externally via the corresponding system property or environment variable, an option on the plugin settings UI could be introduced, so that users could customize/extend the list of YAML files to be recognized.
• Schemas must be Citrus-version specific, so that the proper schemas could be provided for different Citrus versions.

Questions

• Is there JSON schemas in the Citrus codebase, or must one be created from scratch?
  • Json/Yaml schema for the Yaml test cases? citrusframework/citrus#1119

Resources

• CitrusSettings class
• Providing meta information (like schema file)

[picimako]

Completed in v1.0.6 with the following caveats:

• The file name pattern, for now, uses the default value of the citrus.yaml.file.name.pattern property with the addition of the .yml file extension: (test|it)\.(yaml|yml). That value is hardcoded for now, reading the aforementioned configuration property will happen later.
• The 4.x schema contains schemas for test actions that are outside citrus-base, e.g. sql, plsql, selenium, etc., while the 3.x schema doesn't contain those.