mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-22 18:08:16 +00:00
Code Issues Releases Wiki Activity

[#1051] Clarified gtest section in devel guide

Browse Source
This commit is contained in:
Tomek Mrugalski 2020-01-15 17:26:49 +01:00 committed by Tomek Mrugalski
parent 49d4e2842b
commit f2a95fcb51
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/devel/unit-tests.dox
View File

@ -8,14 +8,38 @@
@page unitTests Building Kea with Unit Tests @page unitTests Building Kea with Unit Tests
By default, Kea is built without unit-tests as they're used mostly by
developers and prospective contributors. Kea's unit-tests are using
<a href="https://github.com/google/googletest">gtest framework</a> from
Google. Google's approach has changed over the years. For some time,
they were very keen on not installing gtest as a normal software would
be, but rather provide gtest as sources. This was further complicated
with the fact that some Linux distributions packaged gtest and tried
to mimic its installation. Kea tries its best to accommodate all typical
situations and provides two switches to point to gtest. You can use
`--with-gtest` or `--with-gtest-source`. Both attempt to locate gtest
on their own. However, if neither of them can find it, you can specify
the path explicitly. For example, on ubuntu with googletest package installed,
you can do the following for Kea to find it:
@code
sudo apt install googletest
./configure --with-gtest-source=/usr/src/googletest
@endcode
Depending on how you compiled or installed \c gtest (e.g. from sources Depending on how you compiled or installed \c gtest (e.g. from sources
or using some package management system) one of those two switches will or using some package management system) one of those two switches will
find \c gtest. After that you make and run the unit-tests with: find \c gtest. After that you make and run the unit-tests with:
@code @code
make
make check make check
@endcode @endcode
As usual, using \c -jX option will speed up compilation. This parameter is
even more useful for unit-tests as there are over 6000 unit-tests and their
compilation is significantly slower than just the production Kea sources.
@section unitTestsEnvironmentVariables Environment Variables @section unitTestsEnvironmentVariables Environment Variables
The following environment variable can affect the unit tests: The following environment variable can affect the unit tests: