mirror of
https://github.com/OpenVPN/openvpn.git
synced 2025-05-09 05:31:05 +08:00

Change-Id: I15c7cfdddb06d4530d669b222a3c65db5169b29a Signed-off-by: Arne Schwabe <arne@rfc2549.org> Acked-by: MaxF <max@max-fillinger.net> Message-Id: <20250213193942.26423-1-gert@greenie.muc.de> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg30864.html Signed-off-by: Gert Doering <gert@greenie.muc.de>
Unit Tests
This directory contains unit tests for openvpn. New features/bugfixes should be written in a test friendly way and come with corresponding tests.
Run tests
Tests are run by make check
. A failed tests stops test execution. To run all
tests regardless of errors call make -k check
.
Add new tests to existing test suite
Test suites are organized in directories. example_test/ is an example for a test suite with two test executables. Feel free to use it as a template for new tests.
Test suites
Test suites live inside a subdirectory of $ROOT/tests/unit_tests
, e.g. $ROOT/tests/unit_tests/my_feature
.
Test suites are configured by a Makefile.am
. Tests are executed by testdrivers. One testsuite can contain more than one testdriver.
Hints
- Name suites & testdrivers in a way that the name of the driver says something about which component/feature is tested
- Name the testdriver executable
*_testdriver
. This way it gets picked up by the default.gitignore
- If this is not feasible: Add all output to a
.gitignore
* Use descriptive test names:coffee_brewing__with_no_beans__fails
vs.test34
- If this is not feasible: Add all output to a
- Testing a configurable feature? Wrap test execution with a conditional (see auth_pam for an example)
- Add multiple test-drivers when one testdriver looks crowded with tests
New Test Suites
- Organize tests in folders for features.
- Add the new test directory to
SUBDIRS
inMakefile.am
- Edit
configure.ac
and add the newMakefile
toAC_CONFIG_FILES
- Run
./configure
, and enable the feature you'd like to test - Make sure that
make check
runs your tests - Check: Would a stranger be able to easily find your tests by you looking at the test output?
- Run
./configure
, and disable the feature you'd like to test - Make sure that
make check
does not run your tests