The RegressionCheck processor performs a test of tbwiki features by getting the html for each page in the current wiki, and comparing it with a saved file of expected output.

A table is produced which shows the status of the rendering for each page. The table shows the page, the rendering status (ok, missing saved output, or bad), and render duration time. The table also has links for:

• accessing the page
• diffing the current rendered output with the saved output (expected rendered html)
• saving the current rendered output as the new expected output
• creating or managing a 'transform' page

The processor supports several features, including

• colorizing the results (green=ok, orange=missing, red=mismatch to expected output)
• timing the results for each page render
• allowing the user to see a diff between the current render and the expected output
• allowing the user to update the expected output (saved html) for a page render
  • from the main table, or
  • from a diff page
• allowing the user to create or edit a transform page, which can be used to mask certain areas of the page before comparison with the expected output
  • this is useful for pages that have dynamic content

The processor reads a page in the current wiki called "Skiplist", and uses that as a list of pages to omit from the regression check operation. The Skiplist page consists of a list of page names that should be skipped, one page per line (with optional comment lines starting with '#').

See Regression Test Notes for more information about the Skiplist and <page>_transform pages.

Processor arguments are:

• (optional) pages=<list of pages to test>
• (optional) skiplist=<list of pages to skip>

Example usage:

{{{#!RegressionCheck
}} }

This example shows the default regression check table, with all pages in the wiki except Talk:<page> and <page>_transform pages.

---

Example usage:

{{{#!RegressionCheck
pages=" ""TestTableChart
TestProcessorChart
TestProcessorFlot
" ""
}} }

This example shows a regression check table for just the indicated pages.

---

Example usage:

{{{#!RegressionCheck
skiplist=" ""TestMacroBR
TestSiteStatus
" ""
}} }

This example shows a regression check table for all pages except the pages in the indicated skiplist (long-running or problematic pages).

Back to page: System_Info