Skip to content

[Feature Request] Support for YAML Configuration File Input via CLI #167

@lkurzaj

Description

@lkurzaj

Is your feature request related to a problem? Please describe.
Currently, CATS allows configuration through command-line arguments, but does not support passing a YAML configuration file that includes parameters such as fuzzers, skipFuzzers, and others. This feature request proposes adding support for a --config or similar CLI flag that allows users to specify a YAML file containing all configuration options.

This would improve usability, especially for complex test setups, CI/CD pipelines, and teams managing multiple test profiles.

Describe the solution you'd like
Add support for a --config flag that accepts a path to a YAML file.
The YAML file should support all CLI parameters currently accepted by CATS.
If a parameter is defined both in the CLI and the config file, the CLI value should take precedence.

contract: openapi.yml
output: cats-report
fuzzers:
  - VeryLargeStrings
  - NullValuesInFields
skipFuzzers:
  - ControlCharsInFields
  - WhitespacesInFields

The command line could be then cats --config cats-config.yml

Additional context
Here there are additional benefits to implement that:

  • Simplifies command-line usage
  • Enables version-controlled test configurations
  • Improves maintainability and readability of test setups

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions