Exceptional GitLab maintenance is scheduled for June 24, 2025. The service will be unavailable between 8:00 am and 9:30 am. Please do not work on the platform until an announcement indicates that maintenance is complete.
Here is [an example of report for pyfaust](https://faustgrp.gitlabpages.inria.fr/-/faust/-/jobs/3163959/artifacts/build_FaustLinuxPython/python_pyfaust_test_output.html)
(if this link doesn't work, the associated pipeline has been deleted on Gitlab,
please look [here](https://gitlab.inria.fr/faustgrp/faust/-/jobs) for a recent ``ctest_python``/``ctest_matlab``
output).
output). You can also simply browse the job directory of artifacts to find the report.
- On the end of ``ctest`` CI job execution a test report in HTML for the C++ tests too.
It is automatically uploaded to the project Gitlab pages (as a hidden page).
- On the end of ``ctest`` CI job execution, a test report in HTML is produced for
the C++ tests too. It is automatically uploaded to the project Gitlab pages.
The link is displayed in the CI job output (the finished jobs are listed
Here is [an example of report for C++ tests](https://faustgrp.gitlabpages.inria.fr/-/faust/-/jobs/3193880/artifacts/build_FaustLinux/cpp_test_report.html)
(if this link doesn't work, the associated pipeline has been deleted on Gitlab,
please look [here](https://gitlab.inria.fr/faustgrp/faust/-/jobs) for a recent ``ctest``
output).
At the time of writing a group of 167 C++ tests are ran by the ctest CI job. It includes
many unit tests and all these tests passed the latest pipeline.
[here](https://gitlab.inria.fr/faustgrp/faust/-/jobs)). Here is
[an example of report for C++ tests](https://faustgrp.gitlabpages.inria.fr/-/faust/-/jobs/3193880/artifacts/build_FaustLinux/cpp_test_report.html)
(if this link doesn't work, the associated pipeline has been deleted on Gitlab, please
look [here](https://gitlab.inria.fr/faustgrp/faust/-/jobs) for a recent ``ctest``
output). At the time of writing a group of 167 C++ tests are ran by the ctest CI
job. It includes many unit tests and all these tests passed the latest pipeline.
You can also simply browse the job directory of artifacts to find the report.
- Alternative test reports are available here: [FAµST CDash](https://cdash-ci.inria.fr/index.php?project=faust),
they are uploaded by ctest/cdash (CDash configuration is available in ``CDashConfScript.cmake``
...
...
@@ -97,24 +101,26 @@ recent FAµST API is needed).
#### Doctest
The pyfaust/matfaust API comes with many examples integrated in the [documentation](https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/index.html).
They are all fully tested in the ``doctest_pyfaust``/``doctest_matfaust``
ci job (cf. ``gitlab-ci.yml``) and comply with the job passing policy exposed in [1.](#gitlab_pol_test)
(any doctest failure means normally that the CI pipeline fails). These CI jobs are [scheduled](https://gitlab.inria.fr/faustgrp/faust/-/pipeline_schedules)
to run by night (cf. Gitlab schedule interface). If any of the tested pyfaust/matfaust submodules or functions
fails (and they are all tested at the time of writing), the erroneous tests will be
displayed in the CI job output.
The pyfaust/matfaust API comes with many examples integrated in the
-- note: this link won't last forever). The report is also available directly as
text in the CI job output.
...
...
@@ -125,26 +131,27 @@ It really matters to keep a metric of how much code is covered by the tests in t
are pretty much the same as the ones in ``ctest_matlab`` and ``doctest_matfaust``.
Look at the badge below to know what is the current coverage of matfaust tests. If it is not so good
it is partially due to the fact that the code for mex float (single in matlab) is not auto-tested
but there is no reason to think it would fail more often than the code for double which is tested.
However it would be advisable to pursue for a larger coverage.
but there is no reason to think it would fail more often than the code for double which is tested
(except for tests based on a strong accuracy of the results obtained for approximation algorithms).
However it would be advisable to pursue adding tests for a larger coverage.
- C++ test coverage: the calculation of the coverage for C++ tests is
integrated directly in the ``ctest``/``ctest_nightly_linux`` CI job
(see the badge in the next to know the coverage rate).
integrated directly in the ``ctest`` CI job
(the badge below indicates the coverage rate).
- About GPU code: GPU code is tested mainly in C++ tests but ``pyfaust.tests``
submodule provides the same tests on GPU and CPU (except for the CPU only API).
matfaust is not so well tested on GPU code, another reason for its poor coverage rate.
Not all VMs are capable to run GPU tests (cf. [README](README.md) for requirements), the gitlab-runners
must be tagged 'cuda' if they are capable of running the GPU code (this condition is
verified dynamically in the concerned CI jobs).
- About GPU code: GPU code is tested mainly in C++ tests but ``pyfaust.tests`` submodule
provides the same tests on GPU and CPU (except for the CPU only API). matfaust is
not so well tested on GPU code, another reason for its poor coverage rate. Not all
VMs are capable to run GPU tests (cf. [README](README.md) for requirements), the gitlab-runners
must be tagged 'cuda' if they are capable of running the GPU code (this condition
is verified dynamically in the concerned CI jobs).
- Gitlab badges: Gitlab provides the badge feature for indicating clearly the test coverage rate. The
- Gitlab badges: Gitlab provides a badge feature for indicating clearly the test coverage rate. The
pyfaust/matfaust/C++ core coverage badges are displayed above and below.
### Package tests and automatic releases
...
...
@@ -166,8 +173,8 @@ avoid to find out too late (at release time) that one package doesn't build.
- Jobs for wheel PIP packages for pyfaust only (one per system type):
*``pkg_linux_purepy_rev``,
*``pkg_win_purepy_rev``,
*``pkg_macos_purepy_rev``.
*``pkg_win_purepy_rev``,
*``pkg_macos_purepy_rev``.
#### Jobs for release packages
...
...
@@ -195,22 +202,23 @@ The jobs are listed below. See description of equivalent jobs for revision packa
- Jobs for extra feature packages.
* Another version of Python is used to build the wrappers in these jobs:
