aboutsummaryrefslogtreecommitdiff
path: root/test/README
diff options
context:
space:
mode:
Diffstat (limited to 'test/README')
-rw-r--r--test/README62
1 files changed, 0 insertions, 62 deletions
diff --git a/test/README b/test/README
deleted file mode 100644
index f1c86df..0000000
--- a/test/README
+++ /dev/null
@@ -1,62 +0,0 @@
-Testing
-
----
-
-File Layout:
-
-The test files mirror the src files, so a function in src/file.c would have a test in test/file.c
-
----
-
-Includes:
-
-#include "kpl_test.h"
-
-This is the only include a .c file in the test folder needs
-
----
-
-Writing Tests:
-
-KPL_TEST(test_name) {
- // TEST CODE
-}
-
-Tests pass by default
-
----
-
-Asserting:
-
-KPL_ASSERT(CONDITION, FAIL_MESSAGE);
-
----
-
-Failing:
-
-KPL_FAIL(FAIL_MESSAGE);
-
----
-
-Building:
-
-make kpl_test # build test exec
-make kpl_test_memory # build test exec with address, leak and undefined sanitizer
-make kpl_test_thread # build test exec with thread sanitizer
-
-All objects need to be built with the same sanitizer and do not run valgrind when sanitizers are added
-
----
-
-Running:
-
-./kpl_test # Run all tests
-./kpl_test NAME # Run test named NAME
-./kpl_test NAME1 NAME2 ... # Run selected tests named NAM1 NAME2 ...
-./kpl_test -h # Show help
-
----
-
-Compiler Flags:
-
----