purpose/steps/verification output different from current description output
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
PlainBox (Toolkit) |
Fix Released
|
Medium
|
Maciej Kisielewski |
Bug Description
Plainbox version: 0.21c4
As of today, most of our tests are written using the `description` job field like this:
_description:
PURPOSE:
This test will check that you can use a USB HID device
STEPS:
1. Enable either a USB mouse or keyboard
2. For mice, perform actions such as moving the pointer, right and left button clicks and double clicks
3. For keyboards, click the Test button to lauch a small tool. Type some text and close the tool.
VERIFICATION:
Did the device work as expected?
Using the new job fields `purpose`, `steps` and `verification` (available since plainbox 0.17), the above test looks like this:
_purpose:
This test will check that you can use a USB HID device
_steps:
1. Enable either a USB mouse or keyboard
2. For mice, perform actions such as moving the pointer, right and left button clicks and double clicks
3. For keyboards, click the Test button to lauch a small tool. Type some text and close the tool.
_verification:
Did the device work as expected?
However, when displayed on the screen (when running checkbox-cli for instance), the output of the new way is not clear (and steps are missing as described in lp:1453067):
-------
This test will check that you can use a USB HID device
Did the device work as expected?
-------
We would like a better output that separates purpose, steps and verification, to have something similare to the previous way:
-------
Purpose:
This test will check that you can use a USB HID device
Steps:
1. Enable either a USB mouse or keyboard
2. For mice, perform actions such as moving the pointer, right and left button clicks and double clicks
3. For keyboards, click the Test button to lauch a small tool. Type some text and close the tool.
Verification:
Did the device work as expected?
-------
Related branches
- Zygmunt Krynicki (community): Approve
-
Diff: 23 lines (+3/-0)1 file modifiedplainbox/plainbox/impl/commands/inv_run.py (+3/-0)
Changed in plainbox: | |
importance: | Undecided → Medium |
status: | New → In Progress |
assignee: | nobody → Maciej Kisielewski (kissiel) |
Changed in plainbox: | |
status: | In Progress → Fix Committed |
Changed in plainbox: | |
milestone: | none → 0.22 |
Changed in plainbox: | |
status: | Fix Committed → Fix Released |
This issue has been fixed in plainbox 0.22.
Now tester can see description, steps and verification parts even for jobs using the new job fields.