This is a description of the basic features of
Folder Runner.
| name | file system | with | new | file system |
The test files used in the following examples are from
Sample Input Files and
Sample Output Files.
| with | file system |
| make empty folder | test |
| make empty folder | test\output |
| make empty folder | test\output\overidden |
| alias folder | document\fitSharp\Fit\SampleOutputFiles | as | out |
| alias folder | document\fitSharp\Fit\SampleInputFiles | as | in |
Folder Runner runs the FIT tests from the files in an input directory and writes the results to an output directory.
| with | new | folder runner story |
| run | -c,document\fitSharp\Fit\SampleInputFiles\SampleConfig.$OS$.xml |
Test result counts are accumulated for all files processed.
| check | results | 7 right, 1 wrong, 0 ignored, 0 exceptions |
| with | file system |
| ensure | file | test\output\SampleSimpleTest.html | same as | out\SampleSimpleTest.html |
| ensure | file | test\output\SampleExcelTest.html | same as | out\SampleExcelTest.html |
Sub-directories are traversed and copied to a matching structure in the output directory.
| ensure | file | test\output\SampleSubFolder\SampleFailingTest.html | same as | out\SampleFailingTest.html |
If a file SuiteSetUp.* exists in a folder, it is run before all other files in that folder. SuiteTearDown.* is run after all other files in the folder.
| ensure | file | test\output\SampleSubFolder\SuiteSetUp.html | same as | out\SampleSuiteSetUp.html |
| ensure | file | test\output\SampleSubFolder\SuiteTearDown.html | same as | out\SampleSuiteTearDown.html |
If a file does not contain any tables, the contents are copied without changes.
| ensure | file | test\output\SampleSubNoTest\SampleNoTest.html | same as | in\SampleSubNoTest\SampleNoTest.html |
A file reportIndex.html is created in the output directory with the FIT results of each file processed and links to the output files.
| ensure | file | test\output\reportIndex.html | same as | out\SampleReportIndex.html |
A file fit.css is created in the output directories with the styles used by FIT to highlight test results. (This is a bit inconsistent because the test files must already have a link to this stylesheet file.)
| ensure | file | test\output\fit.css | same as | document\fitSharp\fit.css |
| ensure | file | test\output\SampleSubFolder\fit.css | same as | document\fitSharp\fit.css |
If a file fit.css already exists in the input directory, it is copied to the output directory and not overwritten with the standard version.
| ensure | file | test\output\SampleSubWithStyle\fit.css | same as | in\SampleSubWithStyle\fit.css |
The fit.css file is only creates in sub-directories where test results are written.
| not | file | test\output\SampleSubNoTest\fit.css | exists |
The input can be a single file. In this case, the suite setup and teardown are not run.
| make empty folder | test\output |
| with | new | folder runner story |
| run | -c,document\fitSharp\Fit\SampleInputFiles\SampleConfig.$OS$.xml ,-i,document\fitSharp\Fit\SampleInputFiles\SampleSubFolder\SampleFailingTest.html |
| check | results | 0 right, 1 wrong, 0 ignored, 0 exceptions |
| with | file system |
| not | file | test\output\SampleSubFolder\SuiteSetUp.html | exists |
To process a selected file with the associated suite set up and tear down, use the -s option. This specifies the name of the file, relative to the input folder
| make empty folder | test\output |
| with | new | folder runner story |
| run | -c,document\fitSharp\Fit\SampleInputFiles\SampleConfig.$OS$.xml ,-s,SampleSubFolder\SampleFailingTest.html |
| check | results | 2 right, 1 wrong, 0 ignored, 0 exceptions |
XML output can be created.
| with | new | folder runner story |
| run | -c,document\fitSharp\Fit\SampleInputFiles\SampleConfigXmlOutput.$OS$.xml |
| with | file system |
| ensure | file with paths | test\output\XmlOutput.xml | same as | out\SampleXmlOutput.xml |
Files and directories can be excluded.
| with | new | folder runner story |
| run | -c,document\fitSharp\Fit\SampleInputFiles\SampleConfig.$OS$.xml,-x,Sample |
| check | results | 0 right, 0 wrong, 0 ignored, 0 exceptions |
The output folder can be overridden on the command line.
| with | new | folder runner story |
| run | -c,document\fitSharp\Fit\SampleInputFiles\SampleConfig.$OS$.xml,-o,test\output\overridden |
| with | file system |
| ensure | file | test\output\overridden\SampleSimpleTest.html | same as | out\SampleSimpleTest.html |