action #75388
Updated by okurz over 2 years ago
## Motivation
In cases like #73231 there is a "die" message pointing to what unexpected situation was encountered but it is not clear to unexperienced test reviewers who needs to act on this, if it is a test maintainer or an instance admin or openQA developer. We should provide clear error feedback on wrong test API usage and distinguish from other error cases
## Acceptance criteria
* **AC1:** The "reason" field in openQA jobs makes it clear to readers if the test API was used in a wrong way, e.g. as in the case of #73231
* **AC2:** **AC1:** os-autoinst contribution documentation explains how wrong test API usage can be distinguished from other error cases
## Suggestions
* Research existing "die" messages in os-autoinst
* Explore how these die messages are displayed in openQA
* Find a way to distinguish, e.g. a clear prefix in os-autoinst or exception vs. generic "die", custom die handler, etc.
* Extend os-autoinst contribution documentation with hints or guidelines what to use in which case
In cases like #73231 there is a "die" message pointing to what unexpected situation was encountered but it is not clear to unexperienced test reviewers who needs to act on this, if it is a test maintainer or an instance admin or openQA developer. We should provide clear error feedback on wrong test API usage and distinguish from other error cases
## Acceptance criteria
* **AC1:** The "reason" field in openQA jobs makes it clear to readers if the test API was used in a wrong way, e.g. as in the case of #73231
* **AC2:** **AC1:** os-autoinst contribution documentation explains how wrong test API usage can be distinguished from other error cases
## Suggestions
* Research existing "die" messages in os-autoinst
* Explore how these die messages are displayed in openQA
* Find a way to distinguish, e.g. a clear prefix in os-autoinst or exception vs. generic "die", custom die handler, etc.
* Extend os-autoinst contribution documentation with hints or guidelines what to use in which case