From Fedora Project Wiki

Revision as of 22:31, 13 May 2020 by Adamwill (talk | contribs) (create template (based on Modular one))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Template documentation [edit]

This documentation is transcluded from Template:IoT validation results/doc. It will not be transcluded on pages that use this template.
Wikitcms core page
This page is a core component of the Wikitcms system for storing release validation testing results in the Fedora wiki. This system relies on specific expectations regarding page naming, contents, and categorization. Please take special care when editing this page, especially if you change any element of wiki syntax, especially templating elements. If you are at all unsure about the consequences of your planned change, please contact the QA group before applying it.

This template is designed to be substituted to create IoT validation testing result pages. It will cause the page that substitutes it to transclude the Template:Release_validation_instructions template with parameter values that should be passed in at the point of creating a new results page, and substitute the appropriate IoT test matrix template for the test type it was passed. Do not transclude this page! Always substitute it!

Usage: {{subst:IoT_validation_results|testtype=Base|release=21|milestone=Beta|compose=RC3}}, for example, as the entire contents of a new page, would generate the Base validation results page for Fedora 21 Beta RC3.

It does some semi-clever mucking about with parameters to produce a nice clean result. Please don't mess about with it unless you understand how it works; the Mediawiki Transclusion and Substitution pages are a good starting point. Please contact QA before touching this page if you are at all unsure what you're doing (Adam Williamson is the original designer of this system). Using it to generate new results pages is just fine, though - see above.

The weird <only<includeonlyy></includeonlyy>include> blocks are a trick used to get <onlyincludee> and </onlyincludee> tags (all misspellings intentional to avoid the tags activating in this documentation) into the actual result pages when they're generated - the empty includeonly blocks and the tags themselves drop out on substitution, leaving the 'complete' onlyinclude tags in the substituting page, where they'll be respected when that page itself is included in another. This is used for the Results Summary pages, so that when they transclude the individual result pages, only the result tables are shown, not the surrounding explanatory text.
No longer current
The compose for which this page contains results is no longer the current one. [[Test Results:Fedora-IoT 42 RC 20241222.0 {{{testtype}}}|This page]] contains the results for the current compose.

This page records {{{testtype}}} validation testing test results for the Fedora-IoT {{{release}}} compose.

Which tests to run

Test coverage page
This page provides information about test coverage for the tests on this page across all the composes for the current release: it can help you see which test cases most need to be run.

Tests with a Milestone of Basic, Beta or Final are the most important. Optional tests are less so, but still useful to run. The milestone indicates that for that milestone release or a later one to be approved for release, the test must have been run against the release candidate build (so at Beta, all Basic and Beta tests must have been run, for instance). However, it is important to run the tests for all milestones as early and often as possible. Please refer to the test coverage page linked above and try to find and run tests which have not been run at all, or not run recently, for the current release.

How to test

1. Download one or more media for testing: {{Fedora-IoT {{{release}}} Download}}


2. Perform one or more of the test cases and add your results to the table below

  • You can submit results by editing the page directly, or by using relval, with the relval report-results --dist Fedora-IoT command. It provides a simple text interface for reporting test results.

3. If a test fails, file a bug report. You may propose the bug as a release blocker or freeze exception bug for the appropriate release - see blocker bug process and freeze exception bug process.


If you notice a problem during a test which does not constitute a complete failure of the test, you should still file a bug report, but it may not be appropriate to propose it as a release blocker bug. Use your judgment in deciding this, with reference to the Fedora_Release_Criteria, which these tests are intended to verify. If you are unsure, err on the side of proposing the bug as a blocker.

Don't install updates
Don't install updates before performing any of the tests, as when you are testing pre-releases, available updates are not part of the proposed released package set.
Virtual machine testing
In most cases, testing in a virtual machine is OK. You can test UEFI (including SecureBoot) in VMs as well.

Results summary page

The [[Test Results:Fedora-IoT {{{release}}} Summary|Test Results:Fedora-IoT {{{release}}} Summary]] page contains the results from this page and all the other validation pages for the same compose listed together to provide an overview.

Add, Modify or Remove a Test Case

  1. Please request review for your changes by publishing your test case for review to the test mailing list and/or the appropriate working group mailing list (e.g. iot).
  2. Once reviewed, make your changes to any current documents that use the template (e.g. [[Test_Results:Current_IoT_{{{testtype}}}_Test]]).
  3. Lastly, update [[Template:{{{testtype}}}_IoT_test_matrix]] with the same changes.

Key

See the table below for a sample format for test results. All test results are posted using the result template.


Test Result Explanation Code Entered
none
Untested - This test has not been run, and is available for anyone to contribute feedback. {{result|none}}
Pass pass robatino
Passed - The test has been run and the tester determine the test met the expected results {{result|pass|robatino}}
Inprogress inprogress adamwill
Inprogress - An inprogress result is often used for tests that take a long time to execute. Inprogress results should be temporary and change to pass, fail or warn. {{result|inprogress|adamwill}}
Fail fail jlaska [1] [2]
Failed - Indicates a failed test. A link to a bug must be provided. See Template:Result for details on providing bug information.
  1. RHBZ #XYZ
  2. RHBZ #ZXY
{{result|fail|jlaska|XYZ|ZXY}}
Warning warn rhe
[1]
Warning - This test completed and met the expected results of the test, but other issues were encountered during testing that warrant attention.
  1. Brief description about the warning status
{{result|warn|rhe}} <ref>Brief description about the warning status</ref>
Pass pass hongqing
Warning warn kparal
Multiple results - More people can easily provide results to a single test case. {{result|pass|hongqing}} {{result|warn|kparal}}
Fail fail pboy [1] [2]
Failed - Same issue with LVM again
  1. RHBZ #2246871
  2. RHBZ #'2244305
{{result|fail|pboy|2246871|2244305}}
Pass pass previous <build> run
Result from previous test run - This test result is directly moved from the test run of previous <build>. {{result|pass|previous <build> run}}
Unsupported - An unsupported test or configuration. No testing is required.

Test Matrix

<onlyinclude>{{safesubst:{{{testtype}}}_IoT_test_matrix}}</onlyinclude>

[[Category:{{{testtype}}}_validation_testing]] [[Category:Fedora-IoT_{{{release}}}_{{{milestone}}}_Test_Results|{{{testtype}}}]]