MediaWiki Reporting Extension: Difference between revisions

From Yocto Project
Jump to navigationJump to search
No edit summary
Line 90: Line 90:
| <pre>  
| <pre>  
{{#testopia:
{{#testopia:
|report_id=concatstats
|report_id=agenda
|run_id=403, 415, 416, 417, 404, 411}}
|run_id=411}}
</pre>
</pre>
|{{#testopia:
|{{#testopia:
|report_id=concatstats
|report_id=agenda
|run_id=403, 415, 416, 417, 404, 411}}
|run_id=411}}
|}
|}


Line 103: Line 103:
# test runs with identical Test Plans and Environments are merged together and the % is calculated based on the total number of test cases. The test run links are aggregated in the Test Run field.
# test runs with identical Test Plans and Environments are merged together and the % is calculated based on the total number of test cases. The test run links are aggregated in the Test Run field.
# when calculating the % only PASSED/BLOCKED/FAILED test cases are taken into account. This means that all other states are ignored(IDLE, PAUSED, RUNNING, ERROR, etc.). This is done because at the moment we use this report only for finished test suites. This may be changed in the future.
# when calculating the % only PASSED/BLOCKED/FAILED test cases are taken into account. This means that all other states are ignored(IDLE, PAUSED, RUNNING, ERROR, etc.). This is done because at the moment we use this report only for finished test suites. This may be changed in the future.
{| class="wikitable"
|-
|Code
|Output
|-
| <pre>
{{#testopia:
|report_id=concatstats
|run_id=403, 415, 416, 417, 404, 411}}
</pre>
|{{#testopia:
|report_id=concatstats
|run_id=403, 415, 416, 417, 404, 411}}
|}

Revision as of 15:36, 10 May 2013

Summary

This page describes the functionality and usage instructions for the Testopia MediaWiki reporting extension. Derived from http://www.mediawiki.org/wiki/Extension:Testopia_Reports this extension was modified in order to generate reports specific to the Yocto Project's needs. If you wish to use it on another MediaWiki server you can do so by cloning it from the public repository: https://github.com/halstead/testopiareports .

Report types

This is a list of reports that can be generated using the reporting extension. The parameters that you need in order to generate a raport are:

  1. report_id = the ID of the report type (ex: testplan, bugs, status, agenda, concatstats) - does not support multiple inputs
  2. plan_id = the ID of the test plan/test plans - supports multiple inputs separated by comma + space ( ", " )
  3. run_id = the ID of the test run/test runs - supports multiple inputs separated by comma + space ( ", " )

Testplan

Generates a list of test cases from one or more test plans.

NOTE: this is the only current report type that supports (only) test plans. All the rest support (only) test runs.

Here is an example:

Code Output
 
{{#testopia:
|report_id=testplan
|plan_id=34}}
{{#testopia: report_id=testplan plan_id=34}}

Status

Generates a status report for test cases in one or more test runs. It can also create a chart from the result as seen below:

Code Output
 
{{#testopia:
|report_id=status
|run_id=411
|charttype=pie3}}
{{#testopia: report_id=status run_id=411 charttype=pie3}}

Bugs

Generates bug reports for one or more test runs. It has the following special fields:

  1. Age(days) - the number of days the bug is opened, relevant to the test run's date field (this is extracted from the test run's name using this format: YYYY-MM-DD. This date must be placed at the begining of the Test Run's name)
  2. Test Runs - links to all test runs that the bug was attached (filters are applicable)
Code Output
 
{{#testopia:
|report_id=bugs
|run_id=403, 415, 416, 417, 404
|chart=bstatus,prio
|charttype=pie,pie}}
{{#testopia: report_id=bugs run_id=403, 415, 416, 417, 404 chart=bstatus,prio charttype=pie,pie}}

Agenda

Generates a detailed report of test cases in one or more test runs. If more that 1 test runs are introduced 3 new columns will be added: Test Run, Test Plan and Environment (this is done in order to differentiate between test runs)

Code Output
 
{{#testopia:
|report_id=agenda
|run_id=411}}
{{#testopia: report_id=agenda run_id=411}}

ConcatStats

Generates a one-test_run-per-line report. There are a few things to note about how this report works:

  1. test runs with identical Test Plans and Environments are merged together and the % is calculated based on the total number of test cases. The test run links are aggregated in the Test Run field.
  2. when calculating the % only PASSED/BLOCKED/FAILED test cases are taken into account. This means that all other states are ignored(IDLE, PAUSED, RUNNING, ERROR, etc.). This is done because at the moment we use this report only for finished test suites. This may be changed in the future.
Code Output
 
{{#testopia:
|report_id=concatstats
|run_id=403, 415, 416, 417, 404, 411}}
{{#testopia: report_id=concatstats run_id=403, 415, 416, 417, 404, 411}}