diff options
| author | Christian Krinitsin <christian.krinitsin@iqmine.de> | 2025-04-09 08:40:39 +0000 |
|---|---|---|
| committer | Christian Krinitsin <christian.krinitsin@iqmine.de> | 2025-04-09 08:40:39 +0000 |
| commit | 51305fceca7668f6636538a52f1aa24c9ed96683 (patch) | |
| tree | b89ee7543b4dd9f6d92bc916746e1b94c176b4ec | |
| parent | 79f32b351b1883cf47cb9bab53d5b07ba05d5791 (diff) | |
| download | testreport-51305fceca7668f6636538a52f1aa24c9ed96683.tar.gz testreport-51305fceca7668f6636538a52f1aa24c9ed96683.zip | |
Update README.md
| -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 |