Project

General

Profile

Actions
Copy link

action #125990

open

Allow client-side validation of YAML files posted via `openqa-cli`

Added by mkittler over 1 year ago. Updated over 1 year ago.

Status:
New
Priority:
Low
Assignee:
-
Category:
Feature requests
Target version:
QA - future
Start date:
2023-03-14
Due date:
% Done:

0%

Estimated time:

Description

Motivation

Since https://github.com/os-autoinst/openQA/pull/4999 has been merged there are now already two routes that expect YAML data. So far the YAML documents are validated against a schema on the server-side. This should of course stay but it would be nice to validate the YAML documents also on the client-side to catch errors early.

Acceptance criteria

  • AC1: YAML documents specified via openqa-cli for job templates or scenario definitions are validated by the openqa-cli before the actual request is done. Errors are reported to the user and no request is done in the error case.
  • AC2: The validation can be disabled.

Related issues 1 (0 open — 1 closed)

Related to openQA Project - action #92311: Complete test definition from a single yaml schedule file in local test distribution folderResolvedmkittler

Actions
Actions
Copy link
 #1

Updated by mkittler over 1 year ago

  • Related to action #92311: Complete test definition from a single yaml schedule file in local test distribution folder added
Actions
Copy link
 #2

Updated by tinita over 1 year ago

My original point was that users should be encouraged to use the existing openqa-validate-yaml script as an extra test, for example when triggering tests in CI, but also locally. This way an invalid YAML can be detected faster.
So it would just be an addition to the documentation.

Actions
Copy link

Also available in: Atom PDF