From 14615ae3b0c787a4831f644b021d87ac3027bb18 Mon Sep 17 00:00:00 2001 From: Jim Ramsay Date: Mon, 2 Jan 2023 07:47:47 -0500 Subject: [PATCH] Enable unit tests by default Also documents how to run the tests. Signed-off-by: Jim Ramsay --- CONTRIBUTING.md | 7 +++++++ README.md | 5 +++++ meson_options.txt | 2 +- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9ddba0..13de46c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,13 @@ as far as coding style is concererned, with the following exceptions: a lot of code that uses aligned argument lists in the project, but I have come to the conclusion that these alignments are not very nice to maintain. +## Unit Tests + +wayvnc has a small but growing set of unit tests, which are run on every GitHub PR. To run them locally, do the following: +```bash +meson test -C build +``` + ## No Brown M&Ms All pull requests must contain the following sentence in the description: diff --git a/README.md b/README.md index 4399574..ec77b0d 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,11 @@ meson build ninja -C build ``` +To run the unit tests: +``` +meson test -C build +``` + ## Running Wayvnc can be run from the build directory like so: ``` diff --git a/meson_options.txt b/meson_options.txt index 9b94654..b34fe78 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -6,5 +6,5 @@ option('man-pages', type: 'feature', value: 'auto', description: 'Generate and install man pages') option('systemtap', type: 'boolean', value: false, description: 'Enable tracing using sdt') -option('tests', type: 'boolean', value: false, +option('tests', type: 'boolean', value: true, description: 'Build unit tests')