diff --git a/Documentation/index.rst b/Documentation/index.rst index e40cd0c9..bc5f849e 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -25,6 +25,7 @@ Tracing guide Camera Sensor Model SoftwareISP Benchmarking + Testing Design document: AE Internal API Contribute diff --git a/Documentation/meson.build b/Documentation/meson.build index a156bd0b..69819776 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -175,6 +175,7 @@ if sphinx.found() 'sensor_driver_requirements.rst', 'sensor-support.rst', 'software-isp-benchmarking.rst', + 'testing.rst', '../README.rst', ] diff --git a/Documentation/testing.rst b/Documentation/testing.rst new file mode 100644 index 00000000..49c1f085 --- /dev/null +++ b/Documentation/testing.rst @@ -0,0 +1,35 @@ +.. SPDX-License-Identifier: CC-BY-SA-4.0 + +Testing libcamera +================= + +Test suites +----------- + +Unit tests check individual components with self-contained fixtures. They +include geometry, controls, serialization and the operating-system wrappers +for files, timers, threads, processes and sockets. + +Integration tests combine components with device, pipeline or external +backend fixtures. Existing checks cover camera capture, V4L2 devices, +media graphs, IPA loading and communication, and camera-backed controls +and serialization. Tests keep their component suites, such as ``camera`` +and ``ipa``, alongside the ``unit`` or ``integration`` suite. + +The ``test-unit`` and ``test-integration`` Meson options enable their +respective groups independently. The existing ``test`` option enables +both groups. All three options are disabled by default. + +.. code-block:: shell + + meson setup build-unit -Dtest-unit=true + ninja -C build-unit + meson test -C build-unit --suite unit --print-errorlogs + +Use ``-Dtest-integration=true`` to build integration tests, or ``-Dtest=true`` +to build both groups. To switch an existing build from both groups to one, +set ``-Dtest=false`` as well as enabling the desired group. + +Many integration tests need the kernel's vimc or vivid test devices. +Integration builds automatically include the vimc pipeline handler and its +IPA. Unit-only selection does not add that pipeline.