Project

General

Profile

action #48641

coordination #58184: [saga][epic][use case] full version control awareness within openQA, e.g. user forks and branches, fully versioned test schedules and configuration settings

[epic] Trigger openQA tests in pull requests of any product github pull request

Added by okurz about 4 years ago. Updated 3 days ago.

Status:
Blocked
Priority:
Normal
Assignee:
Category:
Feature requests
Target version:
Start date:
2020-11-15
Due date:
2023-05-30
% Done:

65%

Estimated time:
(Total: 0.00 h)
Difficulty:

Description

User Story

As a developer of any software on github I want to execute an openQA test on a production server based on a pull request of my software to not need a local openQA instance

Further details

okurz:
Had a nice discussion with trenn: https://github.com/cobbler/cobbler/pull/2024 is a nice example of what one would desire to do in openQA instead, e.g.

  1. pull request in github triggers openQA test
  2. openQA test executes a custom test defined in the github source repo of the product under test (cobbler in this case)
  3. openQA test only boots a VM image, e.g. Tumbleweed, and executes the custom module
  4. test result is fed back to the github PR

implementation suggestions:

  1. could be done with polling bot for now
  2. using latest os-autoinst-distri-opensuse plus – as custom assets currently do not work – a custom test module that same what we tried already for HPC gets the defined test script, could be anything downloadable and executable, and runs it
  3. use SCHEDULE parameter with e.g. SCHEDULE=tests/boot/boot_to_desktop,tests/run_custom
  4. github API access relying on test variables previously provided on trigger

Further ideas

With #128360 a webhook-based approach has been implemented. The following aspects of it could still be improved:

  1. Better scheduled product pages: The PR check "Details" link leads to the page of the related scheduled product. It would make sense to list all jobs belonging to that scheduled product there in a nice table so one can easily access the jobs. It would also be great if it would show the latest jobs in the restart/clone chain (and not just the initial jobs). Maybe we could also show the overall status of the scheduled product reusing the code we use to report it to the CI check. Note that this would also be an improvement in general as it helps not just for the CI use case but when dealing with scheduled products in general.
  2. Better error handling when reporting back: possibly add a retry, add an audit event in case something goes wrong
  3. Finer/better permissions: So far we require an API key/secret pair where the associated user is at least operator. That already includes many permissions. We could allow the creation of API key/secret pairs that fewer permissions.
  4. Have an extra token as secret for signing of the webhook payload: This extra token could be generated for the used API key/secret pair so the secret for signing would not just basically be the API user/credentials again.

Subtasks

coordination #77698: [epic] synchronous qemu based system level test in pull request CI runs, e.g. standalone isotovideo or openQA testsNew

action #77905: CI pipeline proof-of-concept running isotovideoResolvedokurz

action #86063: [epic] Add possibility to trigger openQA API calls, e.g. single "jobs", without the need of the client / over the webUI / with curlBlockedokurz

action #87698: openQA jobs can be triggered with single curl callsResolvedkraih

action #90788: openQA jobs with arbitrary parameters can be triggered over the webUI for authenticated users with right permissions (operator+)Workable

action #87695: Full openQA test development, maintenance and administration from browser without the need of a local terminal size:MWorkable

coordination #124466: [epic] Put open points from okurz's hackweek 22 project into proper ticketsResolvedmkittler

action #124502: [spike][timeboxed:20h] complete test definition from yaml schedule in git checked out test distributionResolvedmkittler

action #125720: [spike][timeboxed:20h] Add monitoring-support into openqa-cliResolvedmkittler

action #125723: Provide a ready-to-use container image or GitHub action repository to trigger/monitor openQA jobs as CI checks size:MResolvedmkittler

action #126950: [openQA-in-openQA] openQA tests in pull requests to github.com/os-autoinst/os-autoinst-distri-openQA/ size:MWorkablejbaier_cz

action #127949: [spike][timeboxed:20h] Research native GitHub for running openQA tests as CI checks size:MResolvedmkittler

action #128360: Supporting fork based development model size:MResolvedmkittler

action #129730: Adapt http://open.qa/docs/#_running_openqa_jobs_as_ci_checks for the use of github pull_request_targetNew


Related issues

Related to openQA Tests - action #124173: [qe-core] Create status badges for verification runsResolved2023-02-09

Copied from openQA Project - action #44327: Trigger tests based on git refspec/branchResolved2018-11-25

History

#1 Updated by okurz about 4 years ago

  • Copied from action #44327: Trigger tests based on git refspec/branch added

#2 Updated by okurz over 3 years ago

  • Parent task set to #58184

#3 Updated by mkittler over 3 years ago

  • This use-case is also impaired by the inability to use custom needles (https://progress.opensuse.org/issues/56789 #56789).
  • Besides, the implementation suggestion use SCHEDULE parameter with e.g. SCHEDULE=tests/boot/boot_to_desktop,tests/run_custom implies that a composability of test distributions would be required. This is of course possible by somehow embedding the base test distribution (e.g. os-autoinst-distri-opensuse) into the product repository (e.g. cobbler) adding own tests on top of it. But this sounds rather hacky and inconvenient to use. So having a light test distribution which can simply be referred to as "base test distribution" seems a desirable for this use-case.

These points are likely the tricky part. Triggering the test execution itself is likely not that hard. Instead of writing a "polling bot" I would add an API route in openQA which can be added as GitHub hook.

#4 Updated by okurz about 3 years ago

mkittler wrote:

Maybe we can still consider any need for needles an independant requirement of the part about triggering test code which I find more important.

Regarding the "hacky approach" or "base test distribution" I think we have a ticket for having something like a "linux" middleware between os-autoinst and os-autoinst-distri-opensuse that can be extracted but for now and to have a proof-of-concept on which to improve upon I recommend the "hacky" approach

[…] I would add an API route in openQA which can be added as GitHub hook.

What would you add as an API route here?

#5 Updated by okurz almost 3 years ago

  • Target version set to Ready

#7 Updated by okurz over 2 years ago

  • Related to coordination #77698: [epic] synchronous qemu based system level test in pull request CI runs, e.g. standalone isotovideo or openQA tests added

#8 Updated by okurz over 2 years ago

  • Subject changed from Trigger openQA tests in pull requests of any product github pull request to [epic] Trigger openQA tests in pull requests of any product github pull request
  • Status changed from New to Blocked
  • Assignee set to okurz

waiting for #77698 first

#9 Updated by okurz about 2 years ago

  • Target version changed from Ready to future

#10 Updated by szarate 2 months ago

  • Related to action #124173: [qe-core] Create status badges for verification runs added

#11 Updated by okurz about 1 month ago

  • Target version changed from future to Ready

#12 Updated by mkittler 6 days ago

  • Description updated (diff)

Also available in: Atom PDF