8th August 2024 at 2:08am
Test case tiddlers encapsulate one or more tiddlers that can be displayed as a $testcase: an independent embedded wiki that can be used for testing or learning purposes.
Test case tiddlers are formatted as CompoundTiddlers, allowing them to contain multiple tiddlers packed into one.
Test case tiddlers have the following fields:
| Field | Description |
|---|---|
type | Needs to be set to text/vnd.tiddlywiki-multiple |
tags | Test cases are tagged $:/tags/wiki-test-spec. Test cases that intentionally fail are tagged $:/tags/wiki-test-spec-failing |
description | Descriptive heading for the test, intended to make it easy to identify the test |
display-format | Optional, defaults to wikitext. Set to plaintext to cause the output to be rendered as plain text |
import | New in v5.3.6 A filter string that defines a list of tiddlers to import |
import-compound | New in v5.3.6 A filter string that defines a list of compound tiddlers to import. See: $data widget |
Test case tiddlers with the appropriate tag are shown in the $:/ControlPanel -> Advanced -> Test Cases
Some payload tiddlers are set aside for special purposes:
| Tiddler | Description |
|---|---|
| Narrative | Narrative description of the test, intended to explain the purpose and operation of the test |
| Output | The tiddler that produces the test output |
| ExpectedResult | HTML of expected result of rendering the Output tiddler |
| Description | Set to the text of the description field, if the field exists |
Also see: TestCaseWidget, DataWidget