This MR enables code coverage metric capturing, at least for C++ code, within Nektar++. It gives:
a general code coverage percentage, which is picked up by GitLab and is viewable in merge requests;
code coverage reports in GitLab's diff directly, as shown in the image below, where the green and orange bars indicate regions of the code that are tested and not tested, respectively.
Proposed solution
To enable code coverage, as well as code coverage reports, we use:
appropriate code coverage flags during compilation
fastcov to much more quickly generate coverage statistics than vanilla lcov (which can take 20-30 minutes to run otherwise)
lcov to print out general statistics (line coverage %) that are captured by gitlab
a third-party script called lcov_cobertura.py converts the .info file produced by fastcov into a Cobertura XML, the format used by Gitlab for code coverage reports;
a second script called split_cobertura.py splits this into multiple XML files in order to overcome processing limitations of gitlab on XML output larger than 10MB;
this is all built into a code coverage job run through the CI.
