Project

General

Profile

Actions

action #173878

closed

coordination #173872: [saga][epic] Full traceability "paper trail" and test reproducability of openQA tests

coordination #173875: [epic] Full traceability and reproducibility of openQA tests

Documentation of how to achieve full traceability "paper trail" of openQA tests size:S

Added by okurz 3 months ago. Updated 3 days ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Feature requests
Target version:
Start date:
2024-12-06
Due date:
% Done:

0%

Estimated time:
Tags:

Description

Motivation

openQA tests already should provide all what is necessary to understand all relevant parameters to define a test and the test object. We should demonstrate such capability and reflect that accordingly in our documentation.

Acceptance criteria

  • AC1: openQA documentation demonstrates how full traceability of tests can be achieved, e.g. test settings, assets, test code, program versions, etc.

Suggestions

  • Review what our documentation covers for that topic so far
  • Look up the according ticket or https://github.com/os-autoinst/openQA/blob/master/etc/openqa/workers.ini#L78 for recording all RPM package versions into tests
  • Look into SUSE Carwos which might have good examples with tests pinned to specific git commits, see https://openqa.suse.de/group_overview/328
  • Try out openQA yourself how tests can be fully traceable (not necessarily fully reproducible because one might miss old assets and such)
  • Document what is missing for a demonstration use-case
  • Consider creating a potential follow-up ticket for any cool ideas you have, e.g. "one-page traceability report" offered by openQA

Related issues 1 (1 open0 closed)

Copied to openQA Project (public) - action #177904: Clarify next steps for full traceability "paper trail" of openQA tests based on what is currently documentedNew

Actions
Actions #1

Updated by okurz 29 days ago

  • Subject changed from Documentation of how to achieve full traceability "paper trail" of openQA tests to Documentation of how to achieve full traceability "paper trail" of openQA tests size:S
  • Description updated (diff)
  • Status changed from New to Workable
Actions #2

Updated by okurz 5 days ago

  • Target version changed from Tools - Next to Ready
Actions #3

Updated by mkittler 3 days ago

  • Status changed from Workable to In Progress
  • Assignee set to mkittler
Actions #4

Updated by mkittler 3 days ago

  • Status changed from In Progress to Feedback
Actions #5

Updated by okurz 3 days ago

  • Description updated (diff)
Actions #6

Updated by mkittler 3 days ago

  • Status changed from Feedback to Resolved

I updated the documentation which fulfills AC1.

Not sure whether I have a good enough understanding what is meant by "one-page traceability report" so I'm not creating a follow-up ticket.

Actions #7

Updated by okurz 3 days ago

  • Copied to action #177904: Clarify next steps for full traceability "paper trail" of openQA tests based on what is currently documented added
Actions

Also available in: Atom PDF