diff options
| author | Lars Wirzenius <liw@liw.fi> | 2013-06-19 20:42:58 +0100 |
|---|---|---|
| committer | Lars Wirzenius <liw@liw.fi> | 2013-06-19 20:42:58 +0100 |
| commit | 2c288169fd38032575feb4414c039e9c1e9e8764 (patch) | |
| tree | 365b3467e08cac322943ce00830dfb140fcfb77a /yarn.1.in | |
| parent | 54e347e461327c09746b45d19b1d24631652da8e (diff) | |
| download | cmdtest-2c288169fd38032575feb4414c039e9c1e9e8764.tar.gz | |
Switch to "scenario testing"
Diffstat (limited to 'yarn.1.in')
| -rw-r--r-- | yarn.1.in | 20 |
1 files changed, 10 insertions, 10 deletions
@@ -15,17 +15,17 @@ .\" .TH YARN 1 .SH NAME -yarn \- story testing of Unix command line tools +yarn \- scenario testing of Unix command line tools .SH SYNOPSIS .SH DESCRIPTION .B yarn -is a story testing tool: -you write a story describing how a user uses your software +is a scenario testing tool: +you write a scenario describing how a user uses your software and what should happen, and express, using very lightweight syntax, -the story in such a way that it can be tested automatically. -The story has a simple, but strict structure: +the scenario in such a way that it can be tested automatically. +The scenario has a simple, but strict structure: .IP .nf GIVEN some setup for the test @@ -33,7 +33,7 @@ WHEN thing that is to be tested happens THEN the post-conditions must be true .fi .PP -As an example, consider a very short test story for verifying that +As an example, consider a very short test scenario for verifying that a backup program works, at least for one simple case. .IP .nf @@ -46,12 +46,12 @@ THEN the data case be restored (Note the addition of AND: you can have multiple GIVEN, WHEN, and THEN statements. The AND keyword makes the text be more readable.) .PP -Stories are meant to be written in somewhat human readable language. +Scenarios are meant to be written in somewhat human readable language. However, they are not free form text. In addition to the GIVEN/WHEN/THEN structure, the text for each of the steps needs a computer-executable implementation. This is done by using IMPLEMENTS. -The backup story from above might be implemented as follows: +The backup scenario from above might be implemented as follows: .IP .nf IMPLEMENTS GIVEN some live data in a directory @@ -103,10 +103,10 @@ that quite a good test suite can be written. .SH EXAMPLE To run .B yarn -on all the stories in your current directory: +on all the scenarios in your current directory: .IP .nf -yarn *.story +yarn *.scenario .fi .PP All the files will be treated together as if they had been one file. |