luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-06 17:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity
31bd6956f0
glib/.gitlab-ci/coverage-docker.sh

50 lines
1.5 KiB
Bash
Raw Normal View History

ci: collect test coverage and deploy a html report through gitlab pages Use lcov for both Fedora and MSYS2 to create coverage reports and add a second ci stage which merges the coverage and creates a html report using genhtml. In the final stage, which is only run on master, the result is published on gitlab pages. https://bugzilla.gnome.org/show_bug.cgi?id=795636
2018-04-27 17:04:52 +02:00
#!/bin/bash
ci: Show commands run from the test scripts It allows better debugging in case of failures.
2022-10-20 03:07:52 +02:00
set -ex
ci: collect test coverage and deploy a html report through gitlab pages Use lcov for both Fedora and MSYS2 to create coverage reports and add a second ci stage which merges the coverage and creates a html report using genhtml. In the final stage, which is only run on master, the result is published on gitlab pages. https://bugzilla.gnome.org/show_bug.cgi?id=795636
2018-04-27 17:04:52 +02:00
# Fixup Windows paths
python3 ./.gitlab-ci/fixup-cov-paths.py _coverage/*.lcov
for path in _coverage/*.lcov; do
CI: Include coverage data of code which isn't executed by the test suite. See comment in !151. Using the "--initial" option of lcov we collect the coverage of all compiled files and merge them later into the final report. This way we can see which files are built but never executed by the test suite. Because the --initial switch also collects files in the ccache directory we have to point it to the build directory instead, which in turn breaks --no-external. Instead of using --no-external in the collection step, filter out any files not in the source tree in the final coverage job through a path filter.
2018-07-06 09:33:22 +02:00
# Remove coverage from generated code in the build directory
build: Move lcovrc file to root so it’s picked up by Meson Move the lcovrc file to the root of the project, so that it’s picked up by Meson when running `ninja coverage` locally. See https://github.com/mesonbuild/meson/issues/4628 This won’t affect the code coverage run on the CI, since that explicitly used the lcovrc file already. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2022-04-28 12:57:45 +02:00
lcov --config-file .lcovrc -r "${path}" '*/_build/*' -o "$(pwd)/${path}"
CI: Include coverage data of code which isn't executed by the test suite. See comment in !151. Using the "--initial" option of lcov we collect the coverage of all compiled files and merge them later into the final report. This way we can see which files are built but never executed by the test suite. Because the --initial switch also collects files in the ccache directory we have to point it to the build directory instead, which in turn breaks --no-external. Instead of using --no-external in the collection step, filter out any files not in the source tree in the final coverage job through a path filter.
2018-07-06 09:33:22 +02:00
# Remove any coverage from system files
build: Move lcovrc file to root so it’s picked up by Meson Move the lcovrc file to the root of the project, so that it’s picked up by Meson when running `ninja coverage` locally. See https://github.com/mesonbuild/meson/issues/4628 This won’t affect the code coverage run on the CI, since that explicitly used the lcovrc file already. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2022-04-28 12:57:45 +02:00
lcov --config-file .lcovrc -e "${path}" "$(pwd)/*" -o "$(pwd)/${path}"
ci: Exclude copylibs and fuzz tests from code coverage The fuzz tests are run on a separate CI system, and we don’t care what their code coverage is. The only reason they’re run on our CI systems at all is as a smokecheck. They are not unit tests that we want to check are running every line. Similarly, exclude copylibs/subprojects as GLib is not responsible for testing them. They have (or should have) their own unit tests and code coverage metrics in their upstreams. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2022-11-10 15:56:34 +01:00
# Remove coverage from the fuzz tests, since they are run on a separate CI system
lcov --config-file .lcovrc -r "${path}" "*/fuzzing/*" -o "$(pwd)/${path}"
# Remove coverage from copylibs and subprojects
ci/coverage: Remove coverage from all subprojects
2024-08-02 08:58:19 +02:00
for lib in xdgmime libcharset gnulib subprojects; do
ci: Exclude copylibs and fuzz tests from code coverage The fuzz tests are run on a separate CI system, and we don’t care what their code coverage is. The only reason they’re run on our CI systems at all is as a smokecheck. They are not unit tests that we want to check are running every line. Similarly, exclude copylibs/subprojects as GLib is not responsible for testing them. They have (or should have) their own unit tests and code coverage metrics in their upstreams. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2022-11-10 15:56:34 +01:00
lcov --config-file .lcovrc -r "${path}" "*/${lib}/*" -o "$(pwd)/${path}"
done
ci: Generate Cobertura XML and use it to feed gitlab for MR integration gitlab has coverage integration in MRs, but we need a cobertura formatted XML files (each must be less than 10 MB [1]) to show it, so generate it using a python script and inform gitlab about it. See https://docs.gitlab.com/ee/ci/testing/test_coverage_visualization.html [1] https://gitlab.com/gitlab-org/gitlab/-/issues/328772#note_840831654
2022-07-21 01:05:42 +02:00
# Convert to cobertura format for gitlab integration
cobertura_base="${path/.lcov}-cobertura"
cobertura_xml="${cobertura_base}.xml"
lcov_cobertura "${path}" --output "${cobertura_xml}"
mkdir -p "${cobertura_base}"
cobertura-split-by-package.py "${cobertura_xml}" "${cobertura_base}"
rm -f "${cobertura_xml}"
ci: collect test coverage and deploy a html report through gitlab pages Use lcov for both Fedora and MSYS2 to create coverage reports and add a second ci stage which merges the coverage and creates a html report using genhtml. In the final stage, which is only run on master, the result is published on gitlab pages. https://bugzilla.gnome.org/show_bug.cgi?id=795636
2018-04-27 17:04:52 +02:00
done
genhtml \
ci/coverage: Help genhtml to define the common prefix
2024-08-02 10:24:01 +02:00
--prefix "$PWD" \
build: Move lcovrc file to root so it’s picked up by Meson Move the lcovrc file to the root of the project, so that it’s picked up by Meson when running `ninja coverage` locally. See https://github.com/mesonbuild/meson/issues/4628 This won’t affect the code coverage run on the CI, since that explicitly used the lcovrc file already. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2022-04-28 12:57:45 +02:00
--config-file .lcovrc \
ci: collect test coverage and deploy a html report through gitlab pages Use lcov for both Fedora and MSYS2 to create coverage reports and add a second ci stage which merges the coverage and creates a html report using genhtml. In the final stage, which is only run on master, the result is published on gitlab pages. https://bugzilla.gnome.org/show_bug.cgi?id=795636
2018-04-27 17:04:52 +02:00
_coverage/*.lcov \
-o _coverage/coverage
cd _coverage
ci: Fix various shellcheck warnings in the shell scripts I haven’t tested any of them. This is entirely mechanical. I used shellcheck 0.7.0 with default options. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2020-02-25 12:46:11 +01:00
rm -f ./*.lcov
ci: collect test coverage and deploy a html report through gitlab pages Use lcov for both Fedora and MSYS2 to create coverage reports and add a second ci stage which merges the coverage and creates a html report using genhtml. In the final stage, which is only run on master, the result is published on gitlab pages. https://bugzilla.gnome.org/show_bug.cgi?id=795636
2018-04-27 17:04:52 +02:00
cat >index.html <<EOL
<html>
<body>
<ul>
<li><a href="coverage/index.html">Coverage</a></li>
</ul>
</body>
</html>
EOL
ci: Add link to Coverage output at end of coverage job This should make it a bit easier to find the coverage report, rather than digging through the job artifacts. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2022-02-01 12:08:22 +01:00
# Print a handy link to the coverage report
ci/coverage: Fix link of coverage index page Use $CI_JOB_ID as $CI_BUILD_ID is undefined
2024-08-02 13:55:49 +02:00
echo "Coverage report at: https://${CI_PROJECT_NAMESPACE}.pages.gitlab.gnome.org/-/${CI_PROJECT_NAME}/-/jobs/${CI_JOB_ID}/artifacts/_coverage/coverage/index.html"
Reference in New Issue Copy Permalink