summaryrefslogtreecommitdiff
path: root/tests/README
diff options
context:
space:
mode:
Diffstat (limited to 'tests/README')
-rw-r--r--tests/README39
1 files changed, 39 insertions, 0 deletions
diff --git a/tests/README b/tests/README
new file mode 100644
index 0000000..33bddc1
--- /dev/null
+++ b/tests/README
@@ -0,0 +1,39 @@
+This is the README file for the test directory of libradsec.
+
+Build
+-----
+
+In order to build and run the tests, you'll need to have CUnit
+installed.
+
+Source code: http://cunit.sourceforge.net/
+Debian package: libcunit1-dev
+FreeBSD port: devel/cunit
+
+
+Run
+---
+
+NOTE: To run the tests you currently need
+- a RADIUS server running at localhost:1820 with the shared RADIUS
+ secret "sikrit" configured (or whatever "test-udp-auth" in test.conf
+ says)
+- a user "molgan@PROJECT-MOONSHOT.ORG" with password "password"
+ present in the RADIUS database
+These requirements will be removed in a future libradsec release.
+
+
+Run the tests by typing
+
+ make check
+
+The output should read something like
+
+ --Run Summary: Type Total Ran Passed Failed
+ suites 2 2 n/a 0
+ tests 2 2 2 0
+ asserts 23 23 23 0
+ PASS: test-udp
+ =============
+ 1 test passed
+ =============