Bug 980660 - Clearly document beah task structure
Clearly document beah task structure
Status: NEW
Product: Beaker
Classification: Community
Component: Doc (Show other bugs)
0.13
Unspecified Unspecified
medium Severity unspecified (vote)
: ---
: ---
Assigned To: beaker-dev-list
tools-bugs
: Documentation, Triaged
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2013-07-02 20:52 EDT by Nick Coghlan
Modified: 2016-05-26 09:29 EDT (History)
9 users (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: 980423
Environment:
Last Closed:
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)

  None (edit)
Description Nick Coghlan 2013-07-02 20:52:57 EDT
The new task docs in Beaker 0.13 are in improvement, but are still missing an overview of the required contents of a beah task. The example relies on beaker-wizard to generate the skeleton, while the task metadata section runs through some expected variables in the Makefile and testinfo.desc without actually summarising the expected files anywhere.

We need a "Structure of a beah task" section which:

1. Explains the required files
2. Explains the general concepts involved in result reporting and log uploading
3. Makes it clear that tasks are assumed to fail by default, *unless* a positive result is reported (and rhts-run-simple-command is an easier way to do that)

This section would reference other sections for details where appropriate.


+++ This bug was initially created as a clone of Bug #980423 +++

Note You need to log in before you can comment on or make changes to this bug.