action #92311
closedcoordination #58184: [saga][epic][use case] full version control awareness within openQA
Complete test definition from a single yaml schedule file in local test distribution folder
Description
Motivation¶
See #58184 . As a test maintainer using openQA I want openQA to be able to load the complete test definition from a yaml schedule in a local test distribution folder so that all the necessary configuration can come from a central place and no configuration needs to be added to the openQA database beforehand
Acceptance criteria¶
- AC1:
isos post
accepts a file path parameter pointing to a job templates file - AC2:
isos post
reads products+machines+job_templates from the referenced file and schedules according jobs
Suggestions¶
- Read our results and get ideas from spike #71758 and https://github.com/os-autoinst/openQA/pull/2706 and https://github.com/os-autoinst/openQA/pull/3848
- Think about fitting parameter, e.g. how about
JOB_TEMPLATES
taking a relative or absolute file path? - Probably picking up https://github.com/os-autoinst/openQA/pull/3848 and starting with the already existing test is the best approach
- Crosscheck that the implementation does not break reading job templates
- Add documentation
Out of scope¶
- Reading git repositories from within openQA
- Loading more than one job templates file
- Merging configuration with already existing database configuration, assume a clean database with no machines, no products, no job templates defined.
Updated by okurz over 3 years ago
- Copied from action #71758: [spike][timeboxed:20h] complete test definition from a yaml schedule file in local test distribution folder added
Updated by okurz over 1 year ago
- Status changed from Workable to New
- Target version changed from future to Ready
Updated by mkittler over 1 year ago
Updated by okurz over 1 year ago
- Related to action #124502: [spike][timeboxed:20h] complete test definition from yaml schedule in git checked out test distribution added
Updated by mkittler over 1 year ago
- Status changed from In Progress to Feedback
The PR is ready to be merged and documentation has been prepared as well (https://github.com/os-autoinst/openQA/pull/4999#issuecomment-1446028476).
Updated by mkittler over 1 year ago
- I will work on points added as inline-comments on https://github.com/os-autoinst/openQA/pull/4999. for everything that seems too much for the initial version of this feature I'll create follow-up tickets.
- I will pick the documentation branch here and update it to use single quotes and to state the feature is experimental.
Updated by mkittler over 1 year ago
I will also create a ticket to have openqa-cli
validate the YAML client-side. I could create the ticket right now but it would be blocked by this one anyways.
Updated by mkittler over 1 year ago
- Status changed from Feedback to In Progress
Updated by mkittler over 1 year ago
- Related to action #125990: Allow client-side validation of YAML files posted via `openqa-cli` added
Updated by mkittler over 1 year ago
- Status changed from In Progress to Resolved
- The PR has been merged with previously mentioned amendments. This also includes documentation (stating the feature is experimental).
- I've created #125990 as follow-up ticket with the idea of client-side validation of YAML documents.
So I'm considering this ticket resolved. The work on #124502 has already shown that this feature generally works in production. There are further features to implement, though. So I will continue the epic by implementing #125720 (and then #125723 would be next).