From 8e5374512e46933504cfe344527354cc3d7ea710 Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Tue, 11 May 2021 09:50:09 +0200 Subject: [PATCH] CONTRIBUTING: add section about unit tests --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f95c77f4b..a1bc1a9105 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,6 +78,22 @@ some details of the style we use: - BAD: `static const unsigned myConstant = 42;` +Unit Tests +---------- + +We have plenty of unit tests. Run them with `make check` or +`meson -C "$BUILD_DIR" test`. + +Note that some files in the source tree are both generated and commited +to git. That means, certain changes to the code also affect these generated +files. The unit test fail in that case, to indicate that the generated +files no longer match what is commited to git. +You can also automatically regenerate the files by running `NM_TEST_REGENERATE=1 make check`. +Note that test-client requires working translation. +See the [comment](https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/blob/eee4332e8facfa5ff5940fa1655575d76ca143ea/src/tests/client/test-client.py#L19) +for how to configure it. + + Assertions in NetworkManager code ---------------------------------