[Bug]: test success/failure message appended to CSV result file, causing invalid formatting

[parislarkins]

Describe the bug

#967 introduced a change so that when using the --results-file option and a test run completes, the success/failure message (e.g. ✅ SUCCESS (took 123 seconds)) is appended to the result file at the end of the test.

This is fine with the default --results-format value of markdown, but for csv this means the result file is not a valid CSV due to having a non comma-separated line at the end.

I believe the relevant part of the code is here: https://github.com/gkamat/opensearch-benchmark/blob/main/osbenchmark/benchmark.py#L1370.

To reproduce

Run any test with the --results-file option set to any file you like, and with --results-format=markdown. At the end of the test run, check the result file and observe that the last line is the success/failure message, making the file an invalid CSV.

Expected behavior

Using --results-format=csv should mean the generated results file is a valid CSV, with every line in the file correctly comma-separated.

When using csv, the success/failure summary message should only be logged to the console and not added to the results file.

Screenshots

If applicable, add screenshots to help explain your problem.

Host / Environment

Debian 12

Additional context

No response

Relevant log output

[krisfreedain]

@IanHoang @gkamat @beaioun & maintainers - can you take a look at this one?

Catch All Triage - 1 2

[OVI3D0]

I'll take a look - thanks @krisfreedain