action #60782: descriptions for parameterized job templates independant of test suite descriptions - openQA Project (public) - openSUSE Project Management Tool

Actions

Copy link

action #60782

closed

openQA Tests (public) - coordination #15132: [saga][epic] Better structure of test plans in main.pm

coordination #44360: [epic] Parameterize test suites within job groups

coordination #55730: [epic] Move parameters from test suites into job groups

descriptions for parameterized job templates independant of test suite descriptions

Added by okurz about 5 years ago. Updated almost 5 years ago.

Status:

Resolved

Priority:

Normal

Assignee:

tinita

Category:

Feature requests

Target version:

Current Sprint

Start date:

2019-12-06

Due date:

% Done:

100%

Estimated time:

Description

Motivation¶

We finished the main part for #59097 so https://openqa.opensuse.org/tests/overview?groupid=24 looks nice, see the second test named openqa_from_git_in_place_defined_testsuite_poo55730" which merely inherits an "empty" test suite. The next requirement I see so that we can get rid of the actual test suite definitions is that we do not want the description to vanish. We should have a description for job templates overwriting test suite descriptions if any.

Acceptance criteria¶

AC1: A description can be specified for parameterized job templates in the job group yaml documents
AC2: The description from parameterized job templates is shown on job details page instead of the one from a test suite
AC3: Same as AC2 but for /tests/overview

Suggestions¶

Add a column "description" to job templates table
Allow to add key "description" to every job template in yaml format
If description exists on job template display that, else fallback to testsuite description
Ensure the same description is still shown for machine variants on /tests/overview, same as for testsuites, e.g. for a job template "foo" the description should be shown for the /tests/overview entry "foo@spvm" just as well

Actions

Copy link

Updated by okurz about 5 years ago

Description updated (diff)

Actions

Copy link

Updated by tinita about 5 years ago

Status changed from New to In Progress
Assignee set to tinita

Actions

Copy link

Updated by tinita about 5 years ago

Target version set to Current Sprint

Actions

Copy link

Updated by tinita about 5 years ago

% Done changed from 0 to 20

I created two PRs

https://github.com/os-autoinst/openQA/pull/2590 - Fix regex and error message for prio (merged)

https://github.com/os-autoinst/openQA/pull/2596 - Refactor JobTemplates and fix regex substitution
In the second I did some refactoring which will make testing easier in the future.

Now working on the actual feature in branch job-template-descr in my fork.
Basically the features work, but needs cleanup and more tests.

Actions

Copy link

Updated by okurz about 5 years ago

PR is merged.

I added a description key in https://openqa.opensuse.org/admin/job_templates/24 but https://openqa.opensuse.org/tests/overview?distri=openqa&version=Tumbleweed&build=%3ATW.3716&groupid=24 does not show it.

Further suggestions to follow on as next step:

rename TEST_SUITE_DESCRIPTION to JOB_(TEMPLATE_)DESCRIPTION, https://github.com/os-autoinst/openQA/pull/2602#discussion_r359303815
read description from job template with proper fallback to test suite, https://github.com/os-autoinst/openQA/pull/2602#discussion_r358861582 and https://github.com/os-autoinst/openQA/pull/2602#discussion_r359332794
use recommendations in https://github.com/os-autoinst/openQA/pull/2610 to improve abstraction of description (and job template name) handling, https://github.com/os-autoinst/openQA/pull/2602#pullrequestreview-333915137
do all job template DB updates in one go, https://github.com/os-autoinst/openQA/pull/2602#discussion_r359327901
initialize settings initialization hashes with map, https://github.com/os-autoinst/openQA/pull/2602#discussion_r359336627

Actions

Copy link

Updated by tinita almost 5 years ago

@okurz I can see the desciption here: https://openqa.opensuse.org/tests/overview?distri=openqa&version=Tumbleweed&build=%3ATW.3750&groupid=24

Actions

Copy link

Updated by tinita almost 5 years ago

Created PR for the following points: https://github.com/os-autoinst/openQA/pull/2633

do all job template DB updates in one go, https://github.com/os-autoinst/openQA/pull/2602#discussion_r359327901
initialize settings initialization hashes with map, https://github.com/os-autoinst/openQA/pull/2602#discussion_r359336627

Actions

Copy link

Updated by tinita almost 5 years ago

I'm working on adding the test suite description to the Job Settings.
So far t/ui/10-tests_overview.t is failing. There are some adaptions necessary in t/fixtures/01-jobs.pl, but I haven't got it working yet.

We should be aware that adding the description to the settings will make it a fixed string, while loading it from the test suites table will always fetch the current description.
If that's what we want then it is probably the way to go.

OTOH, saving a copy of something to another table just to save SQL statements can also be a sign that we want caching (e.g. Redis or memcached). Some job information never changes and could probably cached, and as soon as the build is done, everything could be cached. Loading a page like https://openqa.opensuse.org/tests/overview?distri=opensuse&version=15.2&build=547.2&groupid=50 is quite slow, as it is doing several SQL statements for each of the jobs.

Actions

Copy link