Project

General

Profile

action #13034

Add Maintainer and summary to all openqa tests

Added by coolo over 6 years ago. Updated over 6 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
-
Category:
-
Target version:
-
Start date:
2016-08-05
Due date:
% Done:

0%

Estimated time:
Difficulty:

Description

We need to have some meta data in our tests - so that reviewers for other products have a contact person without having to check git blame.

For this we should have well defined comments in the .pm files. Two fields should be mandatory.

# Summary: This is a multi line text describing what was the intention behind this test, e.g.
#  describing the difference between SLE and TW that made it necessary to have an opensuse 
#  specific variant of another test. But it can also contain links for more details.
# Maintainer: coolo@suse.com

Additionally we might want more optional fields e.g. for integration into http://testsuites.qa.suse.cz. But also openqa
specifics might be interesting

# Tags: under-development,sle-specific

We should start with adding a likely maintainer from git history and possibly the git log of the first commit with a script and have a travis check that verifies new tests have maintainer and summary. Accompanied with a review policy that people touching tests need to review the summary too (the summaries from the script will be stupid :)


Related issues

Related to openQA Tests - action #47012: [functional][u] Summary or Maintainer info missing from test modulesResolved2019-02-012019-03-26

History

#1 Updated by coolo over 6 years ago

  • Description updated (diff)

#2 Updated by okurz over 6 years ago

I am not sure if enforcing these entries will scare off potential voluntary contributors. Still, I think this is the way to go. We should start with a script checking for the existance of these entries very soon to prevent incompatible entries showing up when we ask people to do it.

#3 Updated by okurz over 6 years ago

  • Status changed from New to In Progress
  • Assignee set to okurz

See https://github.com/os-autoinst/os-autoinst-distri-opensuse/pull/1652 for a proposal of a check script.

With the check script we can also accept the current output as "accepted state" and compare if new changes introduce new missing and then fail.

#4 Updated by okurz over 6 years ago

  • Assignee deleted (okurz)

PR merged, we can check the state every time and ask reviewees to add the information. If you all agree we should add this to our DoD and ask reviewees to add the information to new files and when they change existing modules. Agreed?

#5 Updated by okurz over 6 years ago

coolo, you want to take this for now?

#6 Updated by coolo over 6 years ago

  • Status changed from In Progress to Resolved

this already works somewhat

#7 Updated by agraul almost 4 years ago

  • Related to action #47012: [functional][u] Summary or Maintainer info missing from test modules added

Also available in: Atom PDF