Reports

Warning

HTML reporting is now outdated, JSON output is preferred for easier integration with text editors. You can still use ./Alltest --report --html for producing HTML reports though.

Generate HTML reports

Catch2 is capable of generating reports in many formats. I may end up creating a custom reporter just for OpenFOAM cases in the future. But for now, the preferred format is XML JSON.

There is a basic XSLTproc style sheet to format the generated XML reports into HTML documents.

These reports are generated in the following way:

• Reports per OpenFOAM case and library
  • One report for the serial run
  • One report for each process in a parallel run

To generate the reports (Which mention both Catch version and the OpenFOAM version):

./Alltest --report --html
# You can find the HTML reports in reports/ directory if everything went fine

In CI environments, it's recommended to run Alltest but you can also add a job to generate the reports and store them as artifacts.

Here is an example of such reports: