Template:Testcase/doc
From TerraFirmaCraft Wiki
A template for presenting test cases for issues reported on an issue page. A test case is a specific sequence of steps that illustrates the issue at hand when it is carried out. A test case description has three parts:
- Instructions/info (
i
) - The procedure a person needs to follow to perform the test. Try to be as precise as possible when writing this part.
- Expected behavior (
e
) - The "correct"/"ideal" outcome; this is the behavior that should happen as a result of performing the test (but does not happen, because of the issue).
- Actual behavior (
a
) - The observed outcome; this is the behavior that actually results when the test is executed. The difference between expected and actual behavior must be entirely as a result of the issue under test, and no other one.
In addition, a test case is signed (by passing ~~~
in the sig
parameter) by the person who submitted it.
Usage
Code
{{testcase | i= test case info/instructions/summary | e= description of what should happen (what you expect to happen) if you follow the instructions | a= description of what actually happens | sig= ~~~ }}
Result
- Test case:
- test case info/instructions/summary
- Expected behavior:
- description of what should happen (what you expect to happen) if you follow the instructions
- Actual behavior:
- description of what actually happens
~~~
Contrived Example
Code
{{testcase | i= Create a new flat-type world, creative mode. | e= You build something totally epic over the course of the next hour. | a= Your creation sucks. | sig= —JebWorshiper }} : '''Cannot reproduce.''' —MrOstentatious :: Yeah. The "expected behavior" is way off. —HelpfulIsssueProwler ::: That's not what I meant. The actual behavior that ''I'' observed was identical to the "expected behavior" described above. In other words, the test case outcome was not reproduced. —MrOstentatious : Ok guys, I've tried to address your criticisms. How about this one: : {{testcase | i= Create a new flat-type world, creative mode. Build a neat castle or some other structure with large open spaces. | e= You are able to enjoy your chateau in relative peace. | a= Your creation is invaded by an army of slimes. | sig= —JebWorshiper }} :: '''Reproduced.''' Thanks for clarifying what you meant and widening your expectation. —HelpfulIsssueProwler :: '''Cannot reproduce as specified.''' You clearly know nothing about ''slime chunks''. —MrOstentatious
Result
- Test case:
- Create a new flat-type world, creative mode.
- Expected behavior:
- You build something totally epic over the course of the next hour.
- Actual behavior:
- Your creation sucks.
—JebWorshiper
- Cannot reproduce. —MrOstentatious
- Yeah. The "expected behavior" is way off. —HelpfulIsssueProwler
- That's not what I meant. The actual behavior that I observed was identical to the "expected behavior" described above. In other words, the test case outcome was not reproduced. —MrOstentatious
- Yeah. The "expected behavior" is way off. —HelpfulIsssueProwler
- Ok guys, I've tried to address your criticisms. How about this one:
-
- Test case:
- Create a new flat-type world, creative mode. Build a neat castle or some other structure with large open spaces.
- Expected behavior:
- You are able to enjoy your chateau in relative peace.
- Actual behavior:
- Your creation is invaded by an army of slimes.
—JebWorshiper- Reproduced. Thanks for clarifying what you meant and widening your expectation. —HelpfulIsssueProwler
- Cannot reproduce as specified. You clearly know nothing about slime chunks. —MrOstentatious