diff options
| -rw-r--r-- | README.md | 31 |
1 files changed, 30 insertions, 1 deletions
diff --git a/README.md b/README.md index fce6c61..faad3f7 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ -# TestReport \ No newline at end of file +# TestReport + +This is a python script, which creates an html test report out of a csv file. + +# Usage + +Execute the program like this: +``` +.\create_report.py [-h] [-o output] exe_path +``` +The exe_path points to an executable, which outputs the data in the following csv file format in stdout. + +# CSV-Format + +The program does not test for invalid inputs, the behaviour for these is undefined. + +The format of the csv-input (header-row, types and example values): + +| log_type | timestamp | category | number | test_description | log_description | +| ---- | --- | --- | --- | --- | --- | +| `str` | `str` | `str` | `int` | `str` | `str` | +| SUCCESS | 10 ms | category_1 | 1 | description_1 | description_1_1 | + +## log_type (string) + +We differentiate between: "SUCCESS", "FAIL" and everything else (which well be dealt with as an info log). + +## log_description (string) + +The description for the specific log, which belongs to the testcase. The log description will not be printed, if the log type is a success. \ No newline at end of file |