testdays-web

License

This project is licensed under the GNU General Public License v3.0 or later - see the LICENSE file for details.

TestdayApp Metadata

The new TestdayApp's metadata define the testdays' structure, testcases and possibly the Profile column name override.

Only lines starting (disregarding whitespace) with =, *, # or ! ProfileText: are considered data, rest is discarded.

Lines starting with = denote sections; Lines starting with * represent testcases within the section, and must be formatted as * testcase name; testcase url

A line like ! ProfileText: Foobar can be used to change that section's Profile column name to Foobar

A basic tesday's structure could look like this:

= Basic Tests
* pm-suspend; https://fedoraproject.org/wiki/QA:Testcase_Power_Management_pm_suspend
* Tuned disabled idle; http://fedoraproject.org/wiki/QA:Testcase_Power_Management_tuned_off_idle

= Other Tests
! ProfileText: libvirt-version
* Virtualization libvirt connections; https://fedoraproject.org/wiki/QA:Testcase_Virtualization_libvirt_connections

Editing existing Testdays

Whenever you edit an existing testday, you will notice that the testcase lines also contain an ULID at the end. For example:

= Basic Tests
* pm-suspendr; https://fedoraproject.org/wiki/QA:Testcase_Power_Management_pm_suspend; 01JR2VGYFAWA5F7EHCZ3C6FXK2
* Tuned disabled idle; http://fedoraproject.org/wiki/QA:Testcase_Power_Management_tuned_off_idle; 01JR2VGYFAW3E05JVGT452QQXP

= Other Tests
! ProfileText: libvirt-version
* Virtualization libvirt connections; https://fedoraproject.org/wiki/QA:Testcase_Virtualization_libvirt_connections; 01JR2VGYFAG2Y7K5C6Z9DCG3MY

This is an unique id assigned to the specific "column" within the Testday, and as long as you keep it intact, you can move the testcases around, change the name or the url part, and any results that are already entered will be still correctly linked.

For example:

= Basic Tests
* Tuned disabled idle; http://fedoraproject.org/wiki/QA:Testcase_Power_Management_tuned_off_idle; 01JR2VGYFAW3E05JVGT452QQXP

= Other Tests
! ProfileText: libvirt-version
* Virtualization libvirt connections; https://fedoraproject.org/wiki/QA:Testcase_Virtualization_libvirt_connections; 01JR2VGYFAG2Y7K5C6Z9DCG3MY
* Another name; https://another.url; 01JR2VGYFAWA5F7EHCZ3C6FXK2

Here, we moved the pm-suspendr testcase identified by ULID 01JR2VGYFAWA5F7EHCZ3C6FXK2 from the Basic Tests section to the Other Tests section, changed the name to Another name and the url to https://another.url, but since we kept the ULID reference intact, alle the results previously entered into the pm-suspendr column will be correctly shown in the new location.

Commenting Out Testcases

You can temporarily disable any line by prefixing it with #. In the following example, one test case is disabled in the first section, and the second section is disabled completely:

= Basic Tests
* Tuned disabled idle; http://fedoraproject.org/wiki/QA:Testcase_Power_Management_tuned_off_idle; 01JR2VGYFAW3E05JVGT452QQXP
# * pm-suspend; https://fedoraproject.org/wiki/QA:Testcase_Power_Management_pm_suspend; 01JR2VGYFAWA5F7EHCZ3C6FXK2

# = Other Tests
# ! ProfileText: libvirt-version
# * Virtualization libvirt connections; https://fedoraproject.org/wiki/QA:Testcase_Virtualization_libvirt_connections; 01JR2VGYFAG2Y7K5C6Z9DCG3MY

A commented-out testcase will not be displayed on the testday page and no new results can be submitted for it. However, the ULID is preserved, so any existing results remain linked. Removing the # prefix will re-enable the testcase and restore all its results. Similarly, uncommenting a whole section will restore it fully with all testcases and their results.

Lines starting with # that do not contain a * testcase definition are ignored. You can also add any other arbitrary lines starting with #, e.g. some preparation notes. They will be preserved through save/edit round-trips, and obviously not influence the results table in any way.

App Development Notes

Please see developer notes in docs/DEVELOPER.md.