Project

General

Profile

Actions

action #158739

open

[openQA][automation][api] Can record_info hightlight recorded info ?

Added by waynechen55 about 1 month ago. Updated 4 days ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Feature requests
Target version:
Start date:
2024-04-10
Due date:
% Done:

0%

Estimated time:

Description

User story

record_info is very useful api to record important information or step during test for purpose of highlighting, reference or even debugging. But when there are many of similar record_info uses in a test run, sometimes I need to look around to find the most desired one (although I can expose important keyword at the beginning to make it more eye-catching, for example, this and this). I was wondering whether record_info can provide functionality of highlight itself as a different color or higher contrast like record_soft_failure does. In this way, I can highlight certain record_info which plays a role of bookmarking or segmenting in order to divide test run into logic parts or steps. This will present more convenient or efficient test result on job page on openQA.

Acceptance criteria

  • record_info provides additional optional setting to highlight itself.
  • Highlighting can be a different color or higher contrast as long as it is more eye-catching.
  • What a finished test run looks like should not change if user chooses to do not use this new setting.

Suggestions

  • Introduce this optional setting for record_info with the least effort and impact.
  • Implementation can be done inside record_info or other more generic functions being used by record_info.

Further details

n/a

Actions #1

Updated by szarate 4 days ago

  • Project changed from openQA Tests to openQA Project

@waynechen55, record info allows you to use iirc failed and the normal default so you get some level of information. Can you provide a mockup (i.e., an edited image) of how you would like to see it? Another question is, what is the motivation or situation that triggered the need?

Actions #2

Updated by okurz 4 days ago

  • Category set to Feature requests
  • Target version set to future

From http://open.qa/api/testapi/#_record_info

The optional value $result can be 'ok' (default), 'fail', 'softfail'

This allows to distinguish different states

Actions

Also available in: Atom PDF