summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTomek Mrugalski <tomasz@isc.org>2012-08-14 17:30:16 +0200
committerTomek Mrugalski <tomasz@isc.org>2012-08-14 17:30:16 +0200
commit1fc88aa14cd78371d6d8efdb02ac6b0460a390ef (patch)
tree21520d6dd4c5cb01f69ca329c4e3ddf499292223
parentc1ce2d23352df0f25f0bdf1fbe8904367fd1c837 (diff)
downloadisc-dhcp-1fc88aa14cd78371d6d8efdb02ac6b0460a390ef.tar.gz
[v4_1_esv] ATF unit-test support added (branch rt25901_atf merged)
-rw-r--r--.gitignore4
-rw-r--r--common/Makefile.am6
-rw-r--r--common/tests/Atffile5
-rw-r--r--common/tests/Makefile.am23
-rw-r--r--common/tests/test_alloc.c824
-rw-r--r--configure.ac81
-rw-r--r--doc/Makefile15
-rw-r--r--doc/devel/arch.dox11
-rw-r--r--doc/devel/atf.dox200
-rw-r--r--doc/devel/contrib.dox12
-rw-r--r--doc/devel/debug.dox21
-rw-r--r--doc/devel/doxyfile.in1792
-rw-r--r--doc/devel/isc-logo.jpgbin0 -> 4452 bytes
-rw-r--r--doc/devel/mainpage.dox39
-rw-r--r--doc/devel/omapi.dox15
-rw-r--r--doc/devel/qa.dox93
-rw-r--r--server/Makefile.am6
-rw-r--r--server/dhcpd.c5
-rw-r--r--server/mdb6.c664
-rw-r--r--server/tests/Atffile5
-rw-r--r--server/tests/Makefile.am49
-rw-r--r--server/tests/hash_unittest.c603
-rw-r--r--server/tests/mdb6_unittest.c715
-rw-r--r--server/tests/simple_unittest.c77
-rw-r--r--tests/HOWTO-unit-test148
25 files changed, 4166 insertions, 1247 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 00000000..59fea191
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+*.o
+bind
+doc/html
+.deps
diff --git a/common/Makefile.am b/common/Makefile.am
index 8b2f2a97..7720d741 100644
--- a/common/Makefile.am
+++ b/common/Makefile.am
@@ -9,4 +9,8 @@ libdhcp_a_SOURCES = alloc.c bpf.c comapi.c conflex.c ctrace.c discover.c \
man_MANS = dhcp-eval.5 dhcp-options.5
EXTRA_DIST = $(man_MANS)
-SUBDIRS = tests
+# We want to build this directory first, before descending into tests subdir.
+# The reason is that ideally the tests should link existing objects from this
+# directory. That eliminates any discrepancies between tested code and
+# production code. Sadly, we are not there yet.
+SUBDIRS = . tests
diff --git a/common/tests/Atffile b/common/tests/Atffile
new file mode 100644
index 00000000..10402ce7
--- /dev/null
+++ b/common/tests/Atffile
@@ -0,0 +1,5 @@
+Content-Type: application/X-atf-atffile; version="1"
+
+prop: test-suite = dhcp4
+
+tp-glob: *_unittest
diff --git a/common/tests/Makefile.am b/common/tests/Makefile.am
index 1a2e5582..66c9681d 100644
--- a/common/tests/Makefile.am
+++ b/common/tests/Makefile.am
@@ -1,10 +1,23 @@
-AM_CPPFLAGS = -I../..
+SUBDIRS = .
-check_PROGRAMS = test_alloc
+AM_CPPFLAGS = $(ATF_CFLAGS) -std=c99 -I$(top_srcdir)/includes
-TESTS = test_alloc
+ATF_TESTS =
-test_alloc_SOURCES = test_alloc.c
-test_alloc_LDADD = ../libdhcp.a ../../tests/libt_api.a \
+if HAVE_ATF
+
+ATF_TESTS += alloc_unittest
+
+alloc_unittest_SOURCES = test_alloc.c $(top_srcdir)/tests/t_api_dhcp.c
+alloc_unittest_LDADD = $(ATF_LDFLAGS)
+alloc_unittest_LDADD += ../libdhcp.a \
../../omapip/libomapi.a ../../dst/libdst.a ../../minires/libres.a
+check: $(ATF_TESTS)
+ atf-run | atf-report
+
+endif
+
+check_PROGRAMS = $(ATF_TESTS)
+
+
diff --git a/common/tests/test_alloc.c b/common/tests/test_alloc.c
index c0e1b9af..d941c8fb 100644
--- a/common/tests/test_alloc.c
+++ b/common/tests/test_alloc.c
@@ -1,5 +1,7 @@
/*
- * We test the functions provided in alloc.c here. These are very
+ * Copyright (c) 2007,2009,2012 by Internet Systems Consortium, Inc. ("ISC")
+ *
+ * We test the functions provided in alloc.c here. These are very
* basic functions, and it is very important that they work correctly.
*
* You can see two different styles of testing:
@@ -16,482 +18,384 @@
* tests, and less duplicated and extra code. The advantage of having
* a separate test is that each test is simpler. Plus if you need to
* allow certain tests to fail for some reason (known bugs that are
- * hard to fix for example), then
+ * hard to fix for example), then
*/
-/* TODO: dmalloc() test */
+/** @TODO: dmalloc() test */
#include "config.h"
-#include "t_api.h"
-
+#include <atf-c.h>
#include "dhcpd.h"
-static void test_buffer_allocate(void);
-static void test_buffer_reference(void);
-static void test_buffer_dereference(void);
-static void test_data_string_forget(void);
-static void test_data_string_forget_nobuf(void);
-static void test_data_string_copy(void);
-static void test_data_string_copy_nobuf(void);
+ATF_TC(buffer_allocate);
-/*
- * T_testlist is a list of tests that are invoked.
- */
-testspec_t T_testlist[] = {
- { test_buffer_allocate,
- "buffer_allocate()" },
- { test_buffer_reference,
- "buffer_reference()" },
- { test_buffer_dereference,
- "buffer_dereference()" },
- { test_data_string_forget,
- "data_string_forget()" },
- { test_data_string_forget_nobuf,
- "data_string_forget(), no buffer" },
- { test_data_string_copy,
- "data_string_copy()" },
- { test_data_string_copy_nobuf,
- "data_string_copy(), no buffer" },
- { NULL, NULL }
-};
-
-static void
-test_buffer_allocate(void) {
- static const char *test_desc =
- "buffer_allocate basic test";
-
- struct buffer *buf;
-
- t_assert("buffer_allocate", 1, T_REQUIRED, "%s", test_desc);
-
- /*
- * Check a 0-length buffer.
- */
- buf = NULL;
- if (!buffer_allocate(&buf, 0, MDL)) {
- t_info("failed on 0-len buffer\n");
- t_result(T_FAIL);
- return;
- }
- if (!buffer_dereference(&buf, MDL)) {
- t_info("buffer_dereference() failed\n");
- t_result(T_FAIL);
- return;
- }
- if (buf != NULL) {
- t_info("buffer_dereference() did not NULL-out buffer\n");
- t_result(T_FAIL);
- return;
- }
-
- /*
- * Check an actual buffer.
- */
- buf = NULL;
- if (!buffer_allocate(&buf, 100, MDL)) {
- t_info("failed on allocate\n");
- t_result(T_FAIL);
- return;
- }
- if (!buffer_dereference(&buf, MDL)) {
- t_info("buffer_dereference() failed\n");
- t_result(T_FAIL);
- return;
- }
- if (buf != NULL) {
- t_info("buffer_dereference() did not NULL-out buffer\n");
- t_result(T_FAIL);
- return;
- }
-
- /*
- * Okay, we're happy.
- */
- t_result(T_PASS);
+ATF_TC_HEAD(buffer_allocate, tc) {
+ atf_tc_set_md_var(tc, "descr", "buffer_allocate basic test");
}
-static void
-test_buffer_reference(void) {
- static const char *test_desc =
- "buffer_reference basic test";
- int result = T_PASS;
-
- struct buffer *a, *b;
-
- t_assert("buffer_reference", 1, T_REQUIRED, "%s", test_desc);
-
- /*
- * Create a buffer.
- */
- a = NULL;
- if (!buffer_allocate(&a, 100, MDL)) {
- t_info("failed on allocate\n");
- t_result(T_FAIL);
- return;
- }
-
- /*
- * Confirm buffer_reference() doesn't work if we pass in NULL.
- *
- * TODO: we should confirm we get an error message here.
- */
- if (buffer_reference(NULL, a, MDL)) {
- t_info("succeeded on an error input\n");
- t_result(T_FAIL);
- return;
- }
-
- /*
- * TODO: we should confirm we get an error message if we pass
- * a non-NULL target.
- */
-
- /*
- * Confirm we work under normal circumstances.
- */
- b = NULL;
- if (!buffer_reference(&b, a, MDL)) {
- t_info("buffer_reference() failed\n");
- t_result(T_FAIL);
- return;
- }
-
- if (b != a) {
- t_info("incorrect pointer\n");
- result = T_FAIL;
- }
- if (b->refcnt != 2) {
- t_info("incorrect refcnt\n");
- result = T_FAIL;
- }
-
- /*
- * Clean up.
- */
- if (!buffer_dereference(&b, MDL)) {
- t_info("buffer_dereference() failed\n");
- t_result(T_FAIL);
- return;
- }
- if (!buffer_dereference(&a, MDL)) {
- t_info("buffer_dereference() failed\n");
- t_result(T_FAIL);
- return;
- }
-
- t_result(result);
+ATF_TC_BODY(buffer_allocate, tc) {
+ struct buffer *buf = 0;
+
+ /*
+ * Check a 0-length buffer.
+ */
+ buf = NULL;
+ if (!buffer_allocate(&buf, 0, MDL)) {
+ atf_tc_fail("failed on 0-len buffer");
+ }
+ if (!buffer_dereference(&buf, MDL)) {
+ atf_tc_fail("buffer_dereference() failed");
+ }
+ if (buf != NULL) {
+ atf_tc_fail("buffer_dereference() did not NULL-out buffer");
+ }
+
+ /*
+ * Check an actual buffer.
+ */
+ buf = NULL;
+ if (!buffer_allocate(&buf, 100, MDL)) {
+ atf_tc_fail("failed on allocate 100 bytes\n");
+ }
+ if (!buffer_dereference(&buf, MDL)) {
+ atf_tc_fail("buffer_dereference() failed");
+ }
+ if (buf != NULL) {
+ atf_tc_fail("buffer_dereference() did not NULL-out buffer");
+ }
+
+ /*
+ * Okay, we're happy.
+ */
+ atf_tc_pass();
}
-static void
-test_buffer_dereference(void) {
- static const char *test_desc =
- "buffer_dereference basic test";
-
- struct buffer *a, *b;
-
- t_assert("buffer_dereference", 1, T_REQUIRED, "%s", test_desc);
-
- /*
- * Confirm buffer_dereference() doesn't work if we pass in NULL.
- *
- * TODO: we should confirm we get an error message here.
- */
- if (buffer_dereference(NULL, MDL)) {
- t_info("succeeded on an error input\n");
- t_result(T_FAIL);
- return;
- }
-
- /*
- * Confirm buffer_dereference() doesn't work if we pass in
- * a pointer to NULL.
- *
- * TODO: we should confirm we get an error message here.
- */
- a = NULL;
- if (buffer_dereference(&a, MDL)) {
- t_info("succeeded on an error input\n");
- t_result(T_FAIL);
- return;
- }
-
- /*
- * Confirm we work under normal circumstances.
- */
- a = NULL;
- if (!buffer_allocate(&a, 100, MDL)) {
- t_info("failed on allocate\n");
- t_result(T_FAIL);
- return;
- }
- if (!buffer_dereference(&a, MDL)) {
- t_info("buffer_dereference() failed\n");
- t_result(T_FAIL);
- return;
- }
- if (a != NULL) {
- t_info("non-null buffer after buffer_dereference()\n");
- t_result(T_FAIL);
- return;
- }
-
- /*
- * Confirm we get an error from negative refcnt.
- *
- * TODO: we should confirm we get an error message here.
- */
- a = NULL;
- if (!buffer_allocate(&a, 100, MDL)) {
- t_info("failed on allocate\n");
- t_result(T_FAIL);
- return;
- }
- b = NULL;
- if (!buffer_reference(&b, a, MDL)) {
- t_info("buffer_reference() failed\n");
- t_result(T_FAIL);
- return;
- }
- a->refcnt = 0; /* purposely set to invalid value */
- if (buffer_dereference(&a, MDL)) {
- t_info("buffer_dereference() succeeded on error input\n");
- t_result(T_FAIL);
- return;
- }
- a->refcnt = 2;
- if (!buffer_dereference(&b, MDL)) {
- t_info("buffer_dereference() failed\n");
- t_result(T_FAIL);
- return;
- }
- if (!buffer_dereference(&a, MDL)) {
- t_info("buffer_dereference() failed\n");
- t_result(T_FAIL);
- return;
- }
-
- t_result(T_PASS);
+ATF_TC(buffer_reference);
+
+ATF_TC_HEAD(buffer_reference, tc) {
+ atf_tc_set_md_var(tc, "descr", "buffer_reference basic test");
+}
+
+ATF_TC_BODY(buffer_reference, tc) {
+
+ struct buffer *a, *b;
+
+ /*
+ * Create a buffer.
+ */
+ a = NULL;
+ if (!buffer_allocate(&a, 100, MDL)) {
+ atf_tc_fail("failed on allocate 100 bytes");
+ }
+
+ /**
+ * Confirm buffer_reference() doesn't work if we pass in NULL.
+ *
+ * @TODO: we should confirm we get an error message here.
+ */
+ if (buffer_reference(NULL, a, MDL)) {
+ atf_tc_fail("succeeded on an error input");
+ }
+
+ /**
+ * @TODO: we should confirm we get an error message if we pass
+ * a non-NULL target.
+ */
+
+ /*
+ * Confirm we work under normal circumstances.
+ */
+ b = NULL;
+ if (!buffer_reference(&b, a, MDL)) {
+ atf_tc_fail("buffer_reference() failed");
+ }
+
+ if (b != a) {
+ atf_tc_fail("incorrect pointer returned");
+ }
+
+ if (b->refcnt != 2) {
+ atf_tc_fail("incorrect refcnt");
+ }
+
+ /*
+ * Clean up.
+ */
+ if (!buffer_dereference(&b, MDL)) {
+ atf_tc_fail("buffer_dereference() failed");
+ }
+ if (!buffer_dereference(&a, MDL)) {
+ atf_tc_fail("buffer_dereference() failed");
+ }
+
}
-static void
-test_data_string_forget(void) {
- static const char *test_desc =
- "data_string_forget basic test";
- int result = T_PASS;
-
- struct buffer *buf;
- struct data_string a;
- const char *str = "Lorem ipsum dolor sit amet turpis duis.";
-
- t_assert("data_string_forget", 1, T_REQUIRED, "%s", test_desc);
-
- /*
- * Create the string we want to forget.
- */
- memset(&a, 0, sizeof(a));
- a.len = strlen(str);
- buf = NULL;
- if (!buffer_allocate(&buf, a.len, MDL)) {
- t_info("out of memory\n");
- t_result(T_FAIL);
- return;
- }
- if (!buffer_reference(&a.buffer, buf, MDL)) {
- t_info("buffer_reference() failed\n");
- t_result(T_FAIL);
- return;
- }
- a.data = a.buffer->data;
- memcpy(a.buffer->data, str, a.len);
-
- /*
- * Forget and confirm we've forgotten.
- */
- data_string_forget(&a, MDL);
-
- if (a.len != 0) {
- t_info("incorrect length\n");
- result = T_FAIL;
- }
- if (a.data != NULL) {
- t_info("incorrect data\n");
- result = T_FAIL;
- }
- if (a.terminated) {
- t_info("incorrect terminated\n");
- result = T_FAIL;
- }
- if (a.buffer != NULL) {
- t_info("incorrect buffer\n");
- result = T_FAIL;
- }
- if (buf->refcnt != 1) {
- t_info("too many references to buf\n");
- result = T_FAIL;
- }
-
- /*
- * Clean up buffer.
- */
- if (!buffer_dereference(&buf, MDL)) {
- t_info("buffer_reference() failed\n");
- t_result(T_FAIL);
- return;
- }
-
- t_result(result);
+
+ATF_TC(buffer_dereference);
+
+ATF_TC_HEAD(buffer_dereference, tc) {
+ atf_tc_set_md_var(tc, "descr", "buffer_dereference basic test");
+}
+
+ATF_TC_BODY(buffer_dereference, tc) {
+ struct buffer *a, *b;
+
+ /**
+ * Confirm buffer_dereference() doesn't work if we pass in NULL.
+ *
+ * TODO: we should confirm we get an error message here.
+ */
+ if (buffer_dereference(NULL, MDL)) {
+ atf_tc_fail("succeeded on an error input");
+ }
+
+ /**
+ * Confirm buffer_dereference() doesn't work if we pass in
+ * a pointer to NULL.
+ *
+ * @TODO: we should confirm we get an error message here.
+ */
+ a = NULL;
+ if (buffer_dereference(&a, MDL)) {
+ atf_tc_fail("succeeded on an error input");
+ }
+
+ /*
+ * Confirm we work under normal circumstances.
+ */
+ a = NULL;
+ if (!buffer_allocate(&a, 100, MDL)) {
+ atf_tc_fail("failed on allocate");
+ }
+ if (!buffer_dereference(&a, MDL)) {
+ atf_tc_fail("buffer_dereference() failed");
+ }
+ if (a != NULL) {
+ atf_tc_fail("non-null buffer after buffer_dereference()");
+ }
+
+ /**
+ * Confirm we get an error from negative refcnt.
+ *
+ * @TODO: we should confirm we get an error message here.
+ */
+ a = NULL;
+ if (!buffer_allocate(&a, 100, MDL)) {
+ atf_tc_fail("failed on allocate");
+ }
+ b = NULL;
+ if (!buffer_reference(&b, a, MDL)) {
+ atf_tc_fail("buffer_reference() failed");
+ }
+ a->refcnt = 0; /* purposely set to invalid value */
+ if (buffer_dereference(&a, MDL)) {
+ atf_tc_fail("buffer_dereference() succeeded on error input");
+ }
+ a->refcnt = 2;
+ if (!buffer_dereference(&b, MDL)) {
+ atf_tc_fail("buffer_dereference() failed");
+ }
+ if (!buffer_dereference(&a, MDL)) {
+ atf_tc_fail("buffer_dereference() failed");
+ }
+}
+
+ATF_TC(data_string_forget);
+
+ATF_TC_HEAD(data_string_forget, tc) {
+ atf_tc_set_md_var(tc, "descr", "data_string_forget basic test");
}
-static void
-test_data_string_forget_nobuf(void) {
- static const char *test_desc =
- "data_string_forget test, data_string without buffer";
- int result = T_PASS;
-
- struct data_string a;
- const char *str = "Lorem ipsum dolor sit amet massa nunc.";
-
- t_assert("data_string_forget, no buffer", 1, T_REQUIRED, "%s", test_desc);
-
- /*
- * Create the string we want to forget.
- */
- memset(&a, 0, sizeof(a));
- a.len = strlen(str);
- a.data = (const unsigned char *)str;
- a.terminated = 1;
-
- /*
- * Forget and confirm we've forgotten.
- */
- data_string_forget(&a, MDL);
-
- if (a.len != 0) {
- t_info("incorrect length\n");
- result = T_FAIL;
- }
- if (a.data != NULL) {
- t_info("incorrect data\n");
- result = T_FAIL;
- }
- if (a.terminated) {
- t_info("incorrect terminated\n");
- result = T_FAIL;
- }
- if (a.buffer != NULL) {
- t_info("incorrect buffer\n");
- result = T_FAIL;
- }
-
- t_result(result);
+ATF_TC_BODY(data_string_forget, tc) {
+ struct buffer *buf;
+ struct data_string a;
+ const char *str = "Lorem ipsum dolor sit amet turpis duis.";
+
+ /*
+ * Create the string we want to forget.
+ */
+ memset(&a, 0, sizeof(a));
+ a.len = strlen(str);
+ buf = NULL;
+ if (!buffer_allocate(&buf, a.len, MDL)) {
+ atf_tc_fail("out of memory");
+ }
+ if (!buffer_reference(&a.buffer, buf, MDL)) {
+ atf_tc_fail("buffer_reference() failed");
+ }
+ a.data = a.buffer->data;
+ memcpy(a.buffer->data, str, a.len);
+
+ /*
+ * Forget and confirm we've forgotten.
+ */
+ data_string_forget(&a, MDL);
+
+ if (a.len != 0) {
+ atf_tc_fail("incorrect length");
+ }
+
+ if (a.data != NULL) {
+ atf_tc_fail("incorrect data");
+ }
+ if (a.terminated) {
+ atf_tc_fail("incorrect terminated");
+ }
+ if (a.buffer != NULL) {
+ atf_tc_fail("incorrect buffer");
+ }
+ if (buf->refcnt != 1) {
+ atf_tc_fail("too many references to buf");
+ }
+
+ /*
+ * Clean up buffer.
+ */
+ if (!buffer_dereference(&buf, MDL)) {
+ atf_tc_fail("buffer_reference() failed");
+ }
}
-static void
-test_data_string_copy(void) {
- static const char *test_desc =
- "data_string_copy basic test";
- int result = T_PASS;
-
- struct data_string a, b;
- const char *str = "Lorem ipsum dolor sit amet orci aliquam.";
-
- t_assert("data_string_copy", 1, T_REQUIRED, "%s", test_desc);
-
-
- /*
- * Create the string we want to copy.
- */
- memset(&a, 0, sizeof(a));
- a.len = strlen(str);
- if (!buffer_allocate(&a.buffer, a.len, MDL)) {
- t_info("out of memory\n");
- t_result(T_FAIL);
- return;
- }
- a.data = a.buffer->data;
- memcpy(a.buffer->data, str, a.len);
-
- /*
- * Copy the string, and confirm it works.
- */
- memset(&b, 0, sizeof(b));
- data_string_copy(&b, &a, MDL);
-
- if (b.len != a.len) {
- t_info("incorrect length\n");
- result = T_FAIL;
- }
- if (b.data != a.data) {
- t_info("incorrect data\n");
- result = T_FAIL;
- }
- if (b.terminated != a.terminated) {
- t_info("incorrect terminated\n");
- result = T_FAIL;
- }
- if (b.buffer != a.buffer) {
- t_info("incorrect buffer\n");
- result = T_FAIL;
- }
-
- /*
- * Clean up.
- */
- data_string_forget(&b, MDL);
- data_string_forget(&a, MDL);
-
- t_result(result);
+ATF_TC(data_string_forget_nobuf);
+
+ATF_TC_HEAD(data_string_forget_nobuf, tc) {
+ atf_tc_set_md_var(tc, "descr", "data_string_forget test, "
+ "data_string without buffer");
+}
+
+ATF_TC_BODY(data_string_forget_nobuf, tc) {
+ struct data_string a;
+ const char *str = "Lorem ipsum dolor sit amet massa nunc.";
+
+ /*
+ * Create the string we want to forget.
+ */
+ memset(&a, 0, sizeof(a));
+ a.len = strlen(str);
+ a.data = (const unsigned char *)str;
+ a.terminated = 1;
+
+ /*
+ * Forget and confirm we've forgotten.
+ */
+ data_string_forget(&a, MDL);
+
+ if (a.len != 0) {
+ atf_tc_fail("incorrect length");
+ }
+ if (a.data != NULL) {
+ atf_tc_fail("incorrect data");
+ }
+ if (a.terminated) {
+ atf_tc_fail("incorrect terminated");
+ }
+ if (a.buffer != NULL) {
+ atf_tc_fail("incorrect buffer");
+ }
+}
+
+ATF_TC(data_string_copy);
+
+ATF_TC_HEAD(data_string_copy, tc) {
+ atf_tc_set_md_var(tc, "descr", "data_string_copy basic test");
+}
+
+ATF_TC_BODY(data_string_copy, tc) {
+ struct data_string a, b;
+ const char *str = "Lorem ipsum dolor sit amet orci aliquam.";
+
+ /*
+ * Create the string we want to copy.
+ */
+ memset(&a, 0, sizeof(a));
+ a.len = strlen(str);
+ if (!buffer_allocate(&a.buffer, a.len, MDL)) {
+ atf_tc_fail("out of memory");
+ }
+ a.data = a.buffer->data;
+ memcpy(a.buffer->data, str, a.len);
+
+ /*
+ * Copy the string, and confirm it works.
+ */
+ memset(&b, 0, sizeof(b));
+ data_string_copy(&b, &a, MDL);
+
+ if (b.len != a.len) {
+ atf_tc_fail("incorrect length");
+ }
+ if (b.data != a.data) {
+ atf_tc_fail("incorrect data");
+ }
+ if (b.terminated != a.terminated) {
+ atf_tc_fail("incorrect terminated");
+ }
+ if (b.buffer != a.buffer) {
+ atf_tc_fail("incorrect buffer");
+ }
+
+ /*
+ * Clean up.
+ */
+ data_string_forget(&b, MDL);
+ data_string_forget(&a, MDL);
+}
+
+ATF_TC(data_string_copy_nobuf);
+
+ATF_TC_HEAD(data_string_copy_nobuf, tc) {
+ atf_tc_set_md_var(tc, "descr", "data_string_copy test, "
+ "data_string without buffer");
+}
+
+ATF_TC_BODY(data_string_copy_nobuf, tc) {
+ struct data_string a, b;
+ const char *str = "Lorem ipsum dolor sit amet cras amet.";
+
+ /*
+ * Create the string we want to copy.
+ */
+ memset(&a, 0, sizeof(a));
+ a.len = strlen(str);
+ a.data = (const unsigned char *)str;
+ a.terminated = 1;
+
+ /*
+ * Copy the string, and confirm it works.
+ */
+ memset(&b, 0, sizeof(b));
+ data_string_copy(&b, &a, MDL);
+
+ if (b.len != a.len) {
+ atf_tc_fail("incorrect length");
+ }
+ if (b.data != a.data) {
+ atf_tc_fail("incorrect data");
+ }
+ if (b.terminated != a.terminated) {
+ atf_tc_fail("incorrect terminated");
+ }
+ if (b.buffer != a.buffer) {
+ atf_tc_fail("incorrect buffer");
+ }
+
+ /*
+ * Clean up.
+ */
+ data_string_forget(&b, MDL);
+ data_string_forget(&a, MDL);
+
}
-static void
-test_data_string_copy_nobuf(void) {
- static const char *test_desc =
- "data_string_copy test, data_string without buffer";
- int result = T_PASS;
-
- struct data_string a, b;
- const char *str = "Lorem ipsum dolor sit amet cras amet.";
-
- t_assert("data_string_copy, no buffer", 1, T_REQUIRED, "%s",
- test_desc);
-
-
- /*
- * Create the string we want to copy.
- */
- memset(&a, 0, sizeof(a));
- a.len = strlen(str);
- a.data = (const unsigned char *)str;
- a.terminated = 1;
-
- /*
- * Copy the string, and confirm it works.
- */
- memset(&b, 0, sizeof(b));
- data_string_copy(&b, &a, MDL);
-
- if (b.len != a.len) {
- t_info("incorrect length\n");
- result = T_FAIL;
- }
- if (b.data != a.data) {
- t_info("incorrect data\n");
- result = T_FAIL;
- }
- if (b.terminated != a.terminated) {
- t_info("incorrect terminated\n");
- result = T_FAIL;
- }
- if (b.buffer != a.buffer) {
- t_info("incorrect buffer\n");
- result = T_FAIL;
- }
-
- /*
- * Clean up.
- */
- data_string_forget(&b, MDL);
- data_string_forget(&a, MDL);
-
- t_result(result);
+ATF_TP_ADD_TCS(tp)
+{
+ ATF_TP_ADD_TC(tp, buffer_allocate);
+ ATF_TP_ADD_TC(tp, buffer_reference);
+ ATF_TP_ADD_TC(tp, buffer_dereference);
+ ATF_TP_ADD_TC(tp, data_string_forget);
+ ATF_TP_ADD_TC(tp, data_string_forget_nobuf);
+ ATF_TP_ADD_TC(tp, data_string_copy);
+ ATF_TP_ADD_TC(tp, data_string_copy_nobuf);
+
+ return (atf_no_error());
}
diff --git a/configure.ac b/configure.ac
index 15876c5d..e04beefd 100644
--- a/configure.ac
+++ b/configure.ac
@@ -50,7 +50,8 @@ AC_DEFINE_UNQUOTED([DHCP_BYTE_ORDER], [$byte_order],
# Optional compile-time DEBUGging.
AC_ARG_ENABLE(debug,
AC_HELP_STRING([--enable-debug],
- [create a debug-only version of the software (default is no).]))
+ [create a debug-only version of the software (default is no).]),
+ [enable_debug=yes],[enable_debug=no])
# This is very much off by default.
if test "$enable_debug" = "yes" ; then
AC_DEFINE([DEBUG], [1],
@@ -168,6 +169,44 @@ if test "$enable_use_sockets" = "yes"; then
[Define to 1 to use the standard BSD socket API.])
fi
+# Testing section
+
+atf_path="no"
+AC_ARG_WITH([atf],
+ AC_HELP_STRING([--with-atf=PATH],
+ [specify location where atf was installed]),
+ [atf_path="$withval"])
+if test "$atf_path" != "no" ; then
+ # Config path for pkg-config
+ atf_pcp=""
+ if test "$atf_path" != "yes" ; then
+ if test -f $atf_path/lib/pkgconfig/atf-c.pc ; then
+ atf_pcp=$atf_path/lib/pkgconfig
+ fi
+ else
+ # Not specified, try some common paths
+ atf_dirs="/usr /usr/local /usr/pkg /opt /opt/local"
+ for d in $atf_dirs
+ do
+ if test -f $d/lib/pkgconfig/atf-c.pc ; then
+ atf_pcp=$d/lib/pkgconfig
+ fi
+ done
+ fi
+ if test "$atf_pcp" = "" ; then
+ AC_MSG_ERROR([Unable to find atf files in location specified])
+ else
+ ATF_CFLAGS="`PKG_CONFIG_PATH=$atf_pcp pkg-config --cflags atf-c` -DUNIT_TEST"
+ ATF_LDFLAGS="`PKG_CONFIG_PATH=$atf_pcp pkg-config --libs atf-c`"
+ AC_SUBST(ATF_CFLAGS)
+ AC_SUBST(ATF_LDFLAGS)
+ fi
+fi
+
+AM_CONDITIONAL(HAVE_ATF, test "$atf_pcp" != "")
+### Uncomment this once docs.lab.isc.org upgrades to automake 1.11
+### AM_COND_IF([HAVE_ATF], [AC_DEFINE([HAVE_ATF], [1], [ATF framework specified?])])
+
###
### Path fun. Older versions of DHCP were installed in /usr/sbin, so we
### need to look there and potentially overwrite by default (but not if
@@ -547,5 +586,45 @@ AC_OUTPUT([
relay/Makefile
server/Makefile
tests/Makefile
+ server/tests/Makefile
+ doc/devel/doxyfile
])
+cat > config.report << END
+
+ ISC DHCP source configure results:
+ -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+
+Package:
+ Name: $PACKAGE_NAME
+ Version: $PACKAGE_VERSION
+
+C Compiler: $CC
+
+Flags:
+ DEFS: $DEFS
+ CFLAGS: $CFLAGS
+
+Features:
+ debug: $enable_debug
+ failover: $enable_failover
+ execute: $enable_execute
+
+Developer:
+ ATF unittests : $atf_path
+
+END
+# TODO: Add Perl system tests
+
+if test "$atf_path" != "no"
+then
+echo "ATF_CFLAGS : $ATF_CFLAGS" >> config.report
+echo "ATF_LDFLAGS : $ATF_LDFLAGS" >> config.report
+echo
+fi
+
+cat config.report
+
+echo
+echo Now you can type "make" to build ISC DHCP
+echo
diff --git a/doc/Makefile b/doc/Makefile
index 229a0c57..60a48fdf 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -27,3 +27,18 @@ References.txt: References.xml
References.html: References.xml
xml2html References.xml
+devel:
+ mkdir -p html
+ doxygen devel/doxyfile > html/doxygen.log 2>html/doxygen-warnings.log
+
+cppcheck:
+ mkdir -p html
+ cd .. && cppcheck --enable=all --inline-suppr \
+ -f -v -j 2 -i tests/ -i dhcp-*/ \
+ . 1> doc/html/cppcheck.log 2> doc/html/cppcheck-error.log
+
+# cppcheck can be extended with list of suppressions.
+# --suppressions-list=doc/cppcheck-skip.txt \
+
+
+.PHONY: devel cppcheck \ No newline at end of file
diff --git a/doc/devel/arch.dox b/doc/devel/arch.dox
new file mode 100644
index 00000000..6720f4ae
--- /dev/null
+++ b/doc/devel/arch.dox
@@ -0,0 +1,11 @@
+/**
+
+@page archSrv Server Architecture
+
+@todo: Describe high level server architecture here.
+
+@page archCli Client Architecture
+
+@todo: Describe high level client architecture here.
+
+*/ \ No newline at end of file
diff --git a/doc/devel/atf.dox b/doc/devel/atf.dox
new file mode 100644
index 00000000..1f3d7912
--- /dev/null
+++ b/doc/devel/atf.dox
@@ -0,0 +1,200 @@
+/**
+@page tests Testing
+
+@section testsOverview Testing Overview
+
+In DHCP, a unit test exercises a particular piece of code in
+isolation. There is a separate unit test per module or API. Each unit
+test lives in a directory beneath the code it is designed to exercise.
+So, we (will eventually) have:
+
+@verbatim
+server/tests/
+client/tests/
+common/tests/
+dhcpctl/tests/
+...
+@endverbatim
+
+And so on.
+
+Ideally each function would be invoked with every possible type of input, and
+each branch of every function would be checked. In practice we try to be a bit
+more pragmatic, and target the most basic operations, as well tricky code, and
+areas we have seen bugs in the past.
+
+We are using <a href="http://code.google.com/p/kyua/wiki/ATF">ATF (Automated
+Test Framework)</a> as a framework to run our unittests.
+
+@section testsAtf ATF unit-tests
+
+ATF stands for Automated Test Framework, and is the framework used for unit
+tests in ISC DHCP and BIND9. ATF sources can be downloaded from
+http://code.google.com/p/kyua/wiki/ATF . ATF itself must be configured, compiled
+and then installed to be available during the DHCP configure procedure. Please
+follow INSTALL file supplied with ATF sources (it's essentially the typical
+./configure && make && make install procedure).
+
+The ATF successor, called Kyua, is being developed. As of August 2012, the
+latest available release of Kyua is 0.5. It claims to offer feature parity with
+ATF. Migration to Kyua may be planned some time in the future, but DHCP uses ATF
+for now. Such an upgrade should be done in coordination with BIND. The latest
+tested version of ATF that DHCP's unittests were run against is 0.15.
+
+To build the unit-tests, use the following:
+
+@verbatim
+$ ./configure --with-atf
+$ make
+$ make check
+@endverbatim
+
+The following syntax is supported as well:
+@verbatim
+$ ./configure --with-atf=/path/to/your/atf/install
+@endverbatim
+
+but it seems to have troubles sometimes detecting ATF installation, at least
+with ATF 0.14 and Mac OS X 10.6.8.
+
+Each code directory (e.g. server/) that has unit-tests has a sub-directory
+named tests (e.g. server/tests). You can execute "make check" in that
+directory to run specific subset of tests.
+
+Unit-tests are grouped into suites, each suite being a separate
+executable. The typical way to run tests is:
+
+@verbatim
+$ atf-run | atf-report
+@endverbatim
+
+atf-run will read the Atffile in the current directory and execute all the tests
+specified in it. Using atf-run - rather than calling the test binary directly -
+has several major benefits. The main one is that atf-run is able to recover from
+test segfault and continue execution from the next case onwards. Another is that
+it is possible to specify a timeout for a test. atf-run will kill the test in
+case of any infinite loops and will continue running next tests.
+
+It is possible to run atf-run without passing its output to atf-report, but its
+output is somewhat convoluted. That is useful in some situations, e.g. when one
+wants to see test output.
+
+It is possible to run test binary directly. The only required parameter is the
+test case name. The binary will print out a warning that direct binary execution
+is not recommended as it won't be able to recover from crash. However, such an
+approach is convenient for running the test under the debugger.
+
+@section testsAtfAdding Adding new unit-tests
+
+There are a small number of unit-tests that are not ATF based. They will be
+converted to ATF soon. Please do not use any other frameworks.
+
+Sadly, the DHCP code was not written with unit-testing in mind: often a
+non-standard approach is required for writing unit-tests. The existing code
+often has many dependencies that make testing a single piece of code awkward to
+unit test. For example, to test hash tables, one needs to also include the
+OMAPI code. Rather than significantly refactoring the code (a huge task that
+could take months), we decided to link whatever is needed in the tests. If
+developing new test suite, it is recommended that you take a look at existing
+tests and just copy them as a starting point.
+
+
+In particular, the following
+things should be done for adding new tests:
+
+<b>1. Tests directory.</b> For each code component (server, client, common,
+etc.) there should be a tests subdirectory. If it isn't there yet, then it must
+be created. This can be done by:
+
+a). Creating the directory:
+
+@verbatim
+ $ mkdir $subdir/tests
+ $ cvs add tests
+@endverbatim
+
+b). Adding the subdirectory to the build system:
+
+ Add to $subdir/Makefile.am:
+
+@verbatim
+ SUBDIRS = tests
+@endverbatim
+
+ Add to the AC_OUTPUT macro in configure.ac:
+
+@verbatim
+ subdir/tests/Makefile
+@endverbatim
+
+c. Create a Makefile.am in the new directory, something similar to this:
+
+@verbatim
+ AM_CPPFLAGS = -I../..
+
+ check_PROGRAMS = test_foo
+
+ TESTS = test_foo
+
+ test_foo_SOURCES = test_foo.c
+ test_foo_LDADD = ../../tests/libt_api.a # plus others...
+@endverbatim
+
+See existing Makefile.am for examples, and the Automake documentation:
+
+ http://www.gnu.org/software/automake/manual/html_node/Tests.html
+
+<b>2. Implement the test.</b> That typically means that you create a new file that will
+hold test code. It is recommended you name it (tested_feature_name)_unittest.c
+and put the file in specified tests directory. For example tests related to
+hash tables used on the server side should be named
+server/tests/hash_unittest.c. If in doubt, it is convenient to name the test
+code after the file that holds tested code, e.g. server/mdb6.c is tested in
+server/tests/mdb6_unittest.c.
+
+The file server/tests/simple_unittest.c holds a template explaining the basic
+layout of the ATF tests. There may be many test cases in a single *_unittest.c
+file. Make sure that you register all your test cases using ATF_TP_ADD_TC()
+macro, and try to minimize modifications to the tested code if possible. Keep in
+mind that we are using modernized \ref codingGuidelines for test
+development. You are advised to also look at atf-c-api(3) man page.
+
+To add a new test, such as when a new module is added or when you want to start
+testing existing code, you can copy the server/tests/simple_unittest.c as a new
+new file, add the new file as a target in Makefile.am, and begin adding
+tests. Reviewing that file is a good idea, even if you decide to write your test
+from scratch, as it give you quick overview of the essential capabilities of the
+ATF framework (how to write test, how to make checks, pass or fail test
+etc.). Do not forget to add your new file to git via "git add
+yourtest_unittest.c".
+
+<b>3. Extend Makefile.am</b> to build your test. In particular, add your binary
+name to ATF_TESTS. The tests directory will be built only in case where
+ATF is enabled, using --with-atf during configure phase.
+
+<b>4. Modify Atffile to include your new test</b>, if needed. Tests in the
+specified directory must be registered in Atffile. See server/tests/Atffile for
+an example. Currently every executable with name of the form *_unittest will be
+executed automatically. If you followed naming convention proposed in a previous
+step, your test will be included and will be included automatically.
+
+<b>5. Enjoy your improved confidence in the code</b>, as you can run the tests after
+any change you may want to do:
+
+@verbatim
+$ make check
+@endverbatim
+
+to run all tests for all components. See \ref atfTests section for more details
+on running tests.
+
+@section testsAtfCoding ATF Coding Guidelines
+
+As the unit-test code creates an evironment that works under a different
+regime than the production code, there are slight differences to standard
+coding guidelines. In particular:
+
+- The code is written using C99. Double slash comments are allowed.
+- Please do not use tabs. Use 4 spaces for each indent level.
+
+*/
diff --git a/doc/devel/contrib.dox b/doc/devel/contrib.dox
new file mode 100644
index 00000000..c978b880
--- /dev/null
+++ b/doc/devel/contrib.dox
@@ -0,0 +1,12 @@
+/**
+@page contrib Contributing to DHCP
+
+@section contribDir 3rd party contributions in contrib/ directory
+
+ @todo: Describe contrib/ dir
+
+@section codingGuidelines Coding Guidelines
+
+ @todo: (... if people want to contribute significant code)
+
+*/
diff --git a/doc/devel/debug.dox b/doc/devel/debug.dox
new file mode 100644
index 00000000..5feac16d
--- /dev/null
+++ b/doc/devel/debug.dox
@@ -0,0 +1,21 @@
+/**
+ @page debug Debugging
+ This page enumerates various techniques useful for debugging ISC DHCP software.
+
+ @section debugTips Debugging Tips & Tricks
+
+ISC DHCP code is somewhat convoluted. Due to extensive macros use, it is often
+difficult to even find whole function, much less to understand what they
+actually do. One way to find such a macro-defined function is to compile the
+code with debugging symbols (-g), load the binary into gdb and set a breakpoint
+for such a function. gdb will print out exact place in the code where the
+function is defined. Presumably one will find a macro at that specific location.
+For example to find where \ref lease_reference function is defined do:
+
+@verbatim
+gdb
+file dhcpd
+b lease_reference
+@endverbatim
+
+*/
diff --git a/doc/devel/doxyfile.in b/doc/devel/doxyfile.in
new file mode 100644
index 00000000..3ff0762d
--- /dev/null
+++ b/doc/devel/doxyfile.in
@@ -0,0 +1,1792 @@
+# Doxyfile 1.8.1.1
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ").
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or sequence of words) that should
+# identify the project. Note that if you do not use Doxywizard you need
+# to put quotes around the project name if it contains spaces.
+
+PROJECT_NAME = "ISC DHCP"
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER = @PACKAGE_VERSION@
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer
+# a quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF = "A reference DHCPv4 and DHCPv6 implementation"
+
+# With the PROJECT_LOGO tag one can specify an logo or icon that is
+# included in the documentation. The maximum height of the logo should not
+# exceed 55 pixels and the maximum width should not exceed 200 pixels.
+# Doxygen will copy the logo to the output directory.
+
+PROJECT_LOGO = devel/isc-logo.jpg
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY =
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = YES
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH = @abs_top_srcdir@
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful if your file system
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding
+# "class=itcl::class" will allow you to use the command class in the
+# itcl::class meaning.
+
+TCL_SUBST =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given extension.
+# Doxygen has a built-in mapping, but you can override or extend it using this
+# tag. The format is ext=language, where ext is a file extension, and language
+# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
+# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
+# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
+# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
+# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
+# comments according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you
+# can mix doxygen, HTML, and XML commands with Markdown formatting.
+# Disable only in case of backward compatibilities issues.
+
+MARKDOWN_SUPPORT = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also makes the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
+# unions are shown inside the group in which they are included (e.g. using
+# @ingroup) instead of on a separate page (for HTML and Man pages) or
+# section (for LaTeX and RTF).
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
+# unions with only public data fields will be shown inline in the documentation
+# of the scope in which they are defined (i.e. file, namespace, or group
+# documentation), provided this scope is documented. If set to NO (the default),
+# structs, classes, and unions are shown on a separate page (for HTML and Man
+# pages) or section (for LaTeX and RTF).
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penalty.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will roughly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols.
+
+SYMBOL_CACHE_SIZE = 0
+
+# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
+# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
+# their name and scope. Since this can be an expensive process and often the
+# same symbol appear multiple times in the code, doxygen keeps a cache of
+# pre-resolved symbols. If the cache is too small doxygen will become slower.
+# If the cache is too large, memory is wasted. The cache size is given by this
+# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols.
+
+LOOKUP_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespaces are hidden.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
+# will list include files with double quotes in the documentation
+# rather than with sharp brackets.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
+# will sort the (brief and detailed) documentation of class members so that
+# constructors and destructors are listed first. If set to NO (the default)
+# the constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
+# do proper type resolution of all parameters of a function it will reject a
+# match between the prototype and the implementation of a member function even
+# if there is only one candidate or it is obvious which candidate to choose
+# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
+# will still accept a match between prototype and implementation in such cases.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or macro consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and macros in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page.
+# This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option.
+# You can optionally specify a file name after the option, if omitted
+# DoxygenLayout.xml will be used as the name of the layout file.
+
+LAYOUT_FILE =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files
+# containing the references data. This must be a list of .bib files. The
+# .bib extension is automatically appended if omitted. Using this command
+# requires the bibtex tool to be installed. See also
+# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
+# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
+# feature you need bibtex and perl available in the search path.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# The WARN_NO_PARAMDOC option can be enabled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = YES
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE = doxygen-warnings.log
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = ..
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
+# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
+# *.f90 *.f *.for *.vhd *.vhdl
+
+FILE_PATTERNS = *.c *.h *.dox
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS = */tests/* */bind/*
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output.
+# If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis.
+# Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match.
+# The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty or if
+# non of the patterns match the file name, INPUT_FILTER is applied.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
+# and it is also possible to disable source filtering for a specific pattern
+# using *.ext= (so without naming a filter). This option only has effect when
+# FILTER_SOURCE_FILES is enabled.
+
+FILTER_SOURCE_PATTERNS =
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C, C++ and Fortran comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code.
+# Otherwise they will link to the documentation.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = YES
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header. Note that when using a custom header you are responsible
+# for the proper inclusion of any scripts and style sheets that doxygen
+# needs, which is dependent on the configuration options used.
+# It is advised to generate a default header using "doxygen -w html
+# header.html footer.html stylesheet.css YourConfigFile" and then modify
+# that header. Note that the header is subject to change so you typically
+# have to redo this when upgrading to a newer version of doxygen or when
+# changing the value of configuration settings such as GENERATE_TREEVIEW!
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# style sheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that
+# the files will be copied as-is; there are no commands or markers available.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
+# Doxygen will adjust the colors in the style sheet and background images
+# according to this color. Hue is specified as an angle on a colorwheel,
+# see http://en.wikipedia.org/wiki/Hue for more information.
+# For instance the value 0 represents red, 60 is yellow, 120 is green,
+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
+# The allowed range is 0 to 359.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
+# the colors in the HTML output. For a value of 0 the output will use
+# grayscales only. A value of 255 will produce the most vivid colors.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
+# the luminance component of the colors in the HTML output. Values below
+# 100 gradually make the output lighter, whereas values above 100 make
+# the output darker. The value divided by 100 is the actual gamma applied,
+# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
+# and 100 does not change the gamma.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting
+# this to NO can help when comparing the output of multiple runs.
+
+HTML_TIMESTAMP = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
+# entries shown in the various tree structured indices initially; the user
+# can expand and collapse entries dynamically later on. Doxygen will expand
+# the tree to such a level that at most the specified number of entries are
+# visible (unless a fully collapsed tree already exceeds this amount).
+# So setting the number of entries 1 will produce a full collapsed tree by
+# default. 0 is a special value representing an infinite number of entries
+# and will result in a full expanded tree by default.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
+# that can be used as input for Qt's qhelpgenerator to generate a
+# Qt Compressed Help (.qch) of the generated HTML documentation.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
+# add. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
+# Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS =
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+# will be generated, which together with the HTML files, form an Eclipse help
+# plugin. To install this plugin and make it available under the help contents
+# menu in Eclipse, the contents of the directory containing the HTML and XML
+# files needs to be copied into the plugins directory of eclipse. The name of
+# the directory within the plugins directory should be the same as
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
+# the help appears.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have
+# this name.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
+# at top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it. Since the tabs have the same information as the
+# navigation tree you can set this option to NO if you already set
+# GENERATE_TREEVIEW to YES.
+
+DISABLE_INDEX = YES
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to YES, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
+# Windows users are probably better off using the HTML help feature.
+# Since the tree basically has the same information as the tab index you
+# could consider to set DISABLE_INDEX to NO when enabling this option.
+
+GENERATE_TREEVIEW = YES
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
+# (range [0,1..20]) that doxygen will group on one line in the generated HTML
+# documentation. Note that a value of 0 will completely suppress the enum
+# values from appearing in the overview section.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
+# links to external symbols imported via tag files in a separate window.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are
+# not supported properly for IE 6.0, but are supported on all modern browsers.
+# Note that when changing this option you need to delete any form_*.png files
+# in the HTML output before the changes have effect.
+
+FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
+# (see http://www.mathjax.org) which uses client side Javascript for the
+# rendering instead of using prerendered bitmaps. Use this if you do not
+# have LaTeX installed or if you want to formulas look prettier in the HTML
+# output. When enabled you may also need to install MathJax separately and
+# configure the path to it using the MATHJAX_RELPATH option.
+
+USE_MATHJAX = NO
+
+# When MathJax is enabled you need to specify the location relative to the
+# HTML output directory using the MATHJAX_RELPATH option. The destination
+# directory should contain the MathJax.js script. For instance, if the mathjax
+# directory is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to
+# the MathJax Content Delivery Network so you can quickly see the result without
+# installing MathJax.
+# However, it is strongly recommended to install a local
+# copy of MathJax from http://www.mathjax.org before deployment.
+
+MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
+# names that should be enabled during MathJax rendering.
+
+MATHJAX_EXTENSIONS =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
+# for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using
+# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
+# (GENERATE_DOCSET) there is already a search function so this one should
+# typically be disabled. For large projects the javascript based search engine
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+
+SEARCHENGINE = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a PHP enabled web server instead of at the web client
+# using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server
+# based approach is that it scales better to large projects and allows
+# full text search. The disadvantages are that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
+# the generated latex document. The footer should contain everything after
+# the last chapter. If it is left blank doxygen will generate a
+# standard footer. Notice: only use this tag if you know what you are doing!
+
+LATEX_FOOTER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
+# source code with syntax highlighting in the LaTeX output.
+# Note that which sources are shown also depends on other settings
+# such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
+# http://en.wikipedia.org/wiki/BibTeX for more info.
+
+LATEX_BIB_STYLE = plain
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load style sheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader.
+# This is useful
+# if you want to understand what is going on.
+# On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# pointed to by INCLUDE_PATH will be searched when a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition that
+# overrules the definition found in the source code.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all references to function-like macros
+# that are alone on a line, have an all uppercase name, and do not end with a
+# semicolon, because these will confuse the parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles. For each
+# tag file the location of the external documentation should be added. The
+# format of a tag file without this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths
+# or URLs. Note that each tag file must have a unique name (where the name does
+# NOT include the path). If a tag file is not located in the directory in which
+# doxygen is run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option also works with HAVE_DOT disabled, but it is recommended to
+# install and use dot, since it yields more powerful graphs.
+
+CLASS_DIAGRAMS = NO
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = NO
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
+# allowed to run in parallel. When set to 0 (the default) doxygen will
+# base this on the number of processors available in the system. You can set it
+# explicitly to a value larger than 0 to get control over the balance
+# between CPU load and processing speed.
+
+DOT_NUM_THREADS = 0
+
+# By default doxygen will use the Helvetica font for all dot files that
+# doxygen generates. When you want a differently looking font you can specify
+# the font name using DOT_FONTNAME. You need to make sure dot is able to find
+# the font, which can be done by putting it in a standard location or by setting
+# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
+# directory containing the font.
+
+DOT_FONTNAME = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the Helvetica font.
+# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
+# set the path where dot can find it.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside
+# the class node. If there are many fields or methods and many nodes the
+# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
+# threshold limits the number of items for each type to make the size more
+# managable. Set this to 0 for no limit. Note that the threshold may be
+# exceeded by 50% before the limit is enforced.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will generate a graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are svg, png, jpg, or gif.
+# If left blank png will be used. If you choose svg you need to set
+# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
+# visible in IE 9+ (other browsers do not have this requirement).
+
+DOT_IMAGE_FORMAT = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+# Note that this requires a modern browser other than Internet Explorer.
+# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
+# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
+# visible. Older versions of IE do not have SVG support.
+
+INTERACTIVE_SVG = NO
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the
+# \mscfile command).
+
+MSCFILE_DIRS =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. Warning: Depending on the platform used,
+# enabling this option may lead to badly anti-aliased labels on the edges of
+# a graph (i.e. they become hard to read).
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
diff --git a/doc/devel/isc-logo.jpg b/doc/devel/isc-logo.jpg
new file mode 100644
index 00000000..1ce1cfd5
--- /dev/null
+++ b/doc/devel/isc-logo.jpg
Binary files differ
diff --git a/doc/devel/mainpage.dox b/doc/devel/mainpage.dox
new file mode 100644
index 00000000..ab5f66df
--- /dev/null
+++ b/doc/devel/mainpage.dox
@@ -0,0 +1,39 @@
+/**
+ @mainpage
+ This is an ISC DHCP Developer's Guide. This documentation is intended for
+ developers, contributors and other programmers that are interested in
+ internal operation of the code.
+
+ To download the latest version of the software, please go to the
+ http://www.isc.org/software/dhcp website.
+
+ @section toc Table Of Contents
+ - @subpage tests
+ - @subpage testsOverview
+ - @subpage testsAtf
+ - @subpage testsAtfAdding
+ - @subpage testsAtfCoding
+ - @subpage qa
+ - @subpage qaTests
+ - @subpage cppcheck
+ - @subpage doxygen
+ - @subpage valgrind
+ - @subpage debug
+
+ Pages planned to be written:
+ - @subpage archSrv
+ - @subpage archCli
+ - @subpage omapi
+ - @subpage omapiIntro
+ - @subpage omapiC
+ - @subpage dhcpctl
+ - @subpage contrib
+ - @subpage contribDir
+ - @subpage codingGuidelines
+
+ Note: some of the links below may not work if corresponding logs are not available.<br/>
+
+ Doxygen: <a href="doxygen.log">[generation log]</a> <a href="doxygen-warnings.log">[errors and warnings]</a> <br/>
+ cppcheck: <a href="cppcheck.log">[generation log]</a> <a href="cppcheck-error.log">[errors and warnings]</a> <br/>
+
+ */ \ No newline at end of file
diff --git a/doc/devel/omapi.dox b/doc/devel/omapi.dox
new file mode 100644
index 00000000..c6423cec
--- /dev/null
+++ b/doc/devel/omapi.dox
@@ -0,0 +1,15 @@
+/**
+@page omapi OMAPI Interface
+
+@section omapiIntro Introduction
+
+ @todo: Description of OMAPI and dhcpctl
+
+@section omapiC Object Management API
+
+ @todo: Essentially omapi.3
+
+@section dhcpctl dhcpctl Reference Guide
+ @todo: Essentially dhcpctl.3
+
+*/
diff --git a/doc/devel/qa.dox b/doc/devel/qa.dox
new file mode 100644
index 00000000..81a9e83b
--- /dev/null
+++ b/doc/devel/qa.dox
@@ -0,0 +1,93 @@
+/**
+ @page qa Quality Assurance
+
+There is a wide scale effort in progress to improve the quality of the ISC
+DHCP implementation. The following section describes the major aspects of
+quality assurance that are being implemented. As this is a work in progress,
+expect radical changes in this area.
+
+ @section qaTests ATF Unit-tests
+
+ See @ref tests Section for details description of ATF-based unit-tests.
+
+ @section cppcheck cppcheck tool
+
+<a href="http://cppcheck.sourceforge.net/">cppcheck</a> is a static analysis tool
+for C/C++ code. Unlike C/C++ compilers and many other analysis tools it does not
+detect syntax errors in the code. Cppcheck primarily detects the types of bugs
+that the compilers normally do not detect. To generate cppcheck report, you
+must have cppcheck installed in your system. Generation is simple:
+
+@verbatim
+cd doc/
+make cppcheck
+@endverbatim
+
+The log files will be stored in doc/html/cppcheck.log and
+doc/html/cppcheck-error.log. While the former is useful for verifying that all
+sources were checked, the latter is much more useful. It contains a list of
+problems that were detected by cppcheck. The goal is to correct all problems
+and make this an empty file.
+
+In the unlikely event of cppcheck finding false positives it is possible to add
+special comments formatted to instruct cppcheck to not report what it thinks is
+an issue. make cppcheck target is configured to make cppcheck print out a
+specific issue type reported. For example to disable the following error report:
+
+@verbatim
+bind/bind-9.8.1/bin/dnssec/dnssec-keygen.c:522: check_fail: Memory leak: algname (error,memleak)
+@endverbatim
+
+the following line could be added before line 522 in dnssec-keygen.c:
+@verbatim
+// cppcheck-suppress memleak
+@endverbatim
+
+Please consult cppcheck manual for details. It is section 6.2 "Inline
+suppressions" in cppcheck 1.54 manual. Section number may change in later
+versions.
+
+ @section doxygen Doxygen checks
+
+ISC DHCP Developer's Guide (the documentation you are reading now) is
+generated with doxygen. Doxygen is an open source tool for generating
+source code documentation. It is available from
+<a href="http://www.doxygen.org">www.doxygen.org</a> website. Once Doxygen
+is installed, ISC DHCP documentation can be generated with:
+
+@verbatim
+cd doc
+make devel
+@endverbatim
+
+Note that cppcheck (see @ref cppcheck Section) reports are linked from
+Developer's Guide. It is useful to generate both.
+
+ @section systemTests System level tests
+
+ISC is developing a comprehensive set of system level tests.
+They are described by a separate document called DHCP Test Plan.
+
+ @section perfdhcp Performance tests using perfdhcp
+
+ISC is also developing a performance measurement tool, called
+perfdhcp. Its main purpose is to measure performance of DHCPv4 and
+DHCPv6 servers. It is being developed as part of the BIND10 project.
+See tests/tools/perfdhcp directory in BIND10 source code.
+
+ @section tahiTests Conformance tests using TAHI
+
+<a href="http://tahi.org">TAHI project</a> developed an extensive suite of <a
+href="http://tahi.org/logo/dhcpv6/">DHCPv6 conformance tests</a>. ISC plans to
+deploy and run them periodically in the near future.
+
+ @section valgrind Memory correctness using valgrind
+
+<a href="http://valgrind.org/">Valgrind</a> is a powerful tool for dynamic code
+analysis. It allows running existing code (often even without recompiling) in a
+special environment that tracks memory operations. In particular, it is able to
+detect: memory leaks, buffer overflows, usage of uninitialized memory, double
+frees and similar errors. We currently do not use valgrind in ISC DHCP testing,
+but there are plans for starting to use it.
+
+*/
diff --git a/server/Makefile.am b/server/Makefile.am
index efd3b048..4661d9e1 100644
--- a/server/Makefile.am
+++ b/server/Makefile.am
@@ -1,3 +1,9 @@
+# We want to build this directory first, before descending into tests subdir.
+# The reason is that ideally the tests should link existing objects from this
+# directory. That eliminates any discrepancies between tested code and
+# production code. Sadly, we are not there yet.
+SUBDIRS = . tests
+
AM_CPPFLAGS = -I.. -DLOCALSTATEDIR='"@localstatedir@"'
dist_sysconf_DATA = dhcpd.conf
diff --git a/server/dhcpd.c b/server/dhcpd.c
index 1be0e17d..95a571d9 100644
--- a/server/dhcpd.c
+++ b/server/dhcpd.c
@@ -58,7 +58,9 @@ static const char url [] =
# undef group
#endif /* PARANOIA */
+#ifndef UNIT_TEST
static void usage(void);
+#endif
struct iaddr server_identifier;
int server_identifier_matched;
@@ -1182,7 +1184,7 @@ void postdb_startup (void)
}
/* Print usage message. */
-
+#ifndef UNIT_TEST
static void
usage(void) {
log_info("%s %s", message, PACKAGE_VERSION);
@@ -1206,6 +1208,7 @@ usage(void) {
" [-pf pid-file] [--no-pid] [-s server]\n"
" [if0 [...ifN]]");
}
+#endif
void lease_pinged (from, packet, length)
struct iaddr from;
diff --git a/server/mdb6.c b/server/mdb6.c
index b730aef7..da02cb2b 100644
--- a/server/mdb6.c
+++ b/server/mdb6.c
@@ -375,6 +375,8 @@ void
ia_remove_iasubopt(struct ia_xx *ia, struct iasubopt *iasubopt,
const char *file, int line) {
int i, j;
+ if (ia == NULL || iasubopt == NULL)
+ return;
for (i=0; i<ia->num_iasubopt; i++) {
if (ia->iasubopt[i] == iasubopt) {
@@ -1382,7 +1384,7 @@ release_lease6(struct ipv6_pool *pool, struct iasubopt *lease) {
* Create a prefix by hashing the input, and using that for
* the part subject to allocation.
*/
-static void
+void
build_prefix6(struct in6_addr *pref,
const struct in6_addr *net_start_pref,
int pool_bits, int pref_bits,
@@ -2122,662 +2124,4 @@ mark_interfaces_unavailable(void) {
}
}
-
-#ifdef UNIT_TEST
-#include <stdlib.h>
-
-int
-main(int argc, char *argv[]) {
- struct iasubopt *iaaddr;
- struct iasubopt *iaaddr_copy;
- u_int32_t iaid;
- struct ia_xx *ia_na;
- struct ia_xx *ia_na_copy;
- int i;
- struct in6_addr addr;
- struct ipv6_pool *pool;
- struct ipv6_pool *pool_copy;
- char addr_buf[INET6_ADDRSTRLEN];
- char *uid;
- struct data_string ds;
- struct iasubopt *expired_iaaddr;
- unsigned int attempts;
-
- /*
- * Test 0: Basic iaaddr manipulation.
- */
- iaaddr = NULL;
- if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (iaaddr->state != FTS_FREE) {
- printf("ERROR: bad state %s:%d\n", MDL);
- return 1;
- }
- if (iaaddr->heap_index != -1) {
- printf("ERROR: bad heap_index %s:%d\n", MDL);
- return 1;
- }
- iaaddr_copy = NULL;
- if (iasubopt_reference(&iaaddr_copy, iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_reference() %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_reference() %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr_copy, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_reference() %s:%d\n", MDL);
- return 1;
- }
-
- /*
- * Test 1: Error iaaddr manipulation.
- */
- /* bogus allocate arguments */
- if (iasubopt_allocate(NULL, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: iasubopt_allocate() %s:%d\n", MDL);
- return 1;
- }
- iaaddr = (struct iasubopt *)1;
- if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: iasubopt_allocate() %s:%d\n", MDL);
- return 1;
- }
-
- /* bogus reference arguments */
- iaaddr = NULL;
- if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_reference(NULL, iaaddr, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: iasubopt_reference() %s:%d\n", MDL);
- return 1;
- }
- iaaddr_copy = (struct iasubopt *)1;
- if (iasubopt_reference(&iaaddr_copy, iaaddr, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: iasubopt_reference() %s:%d\n", MDL);
- return 1;
- }
- iaaddr_copy = NULL;
- if (iasubopt_reference(&iaaddr_copy, NULL, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: iasubopt_reference() %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_reference() %s:%d\n", MDL);
- return 1;
- }
-
- /* bogus dereference arguments */
- if (iasubopt_dereference(NULL, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: iasubopt_dereference() %s:%d\n", MDL);
- return 1;
- }
- iaaddr = NULL;
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: iasubopt_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /*
- * Test 2: Basic ia_na manipulation.
- */
- iaid = 666;
- ia_na = NULL;
- if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (memcmp(ia_na->iaid_duid.data, &iaid, sizeof(iaid)) != 0) {
- printf("ERROR: bad IAID_DUID %s:%d\n", MDL);
- return 1;
- }
- if (memcmp(ia_na->iaid_duid.data+sizeof(iaid), "TestDUID", 8) != 0) {
- printf("ERROR: bad IAID_DUID %s:%d\n", MDL);
- return 1;
- }
- if (ia_na->num_iasubopt != 0) {
- printf("ERROR: bad num_iasubopt %s:%d\n", MDL);
- return 1;
- }
- ia_na_copy = NULL;
- if (ia_reference(&ia_na_copy, ia_na, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_reference() %s:%d\n", MDL);
- return 1;
- }
- iaaddr = NULL;
- if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (ia_add_iasubopt(ia_na, iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_add_iasubopt() %s:%d\n", MDL);
- return 1;
- }
- ia_remove_iasubopt(ia_na, iaaddr, MDL);
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_reference() %s:%d\n", MDL);
- return 1;
- }
- if (ia_dereference(&ia_na, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_dereference() %s:%d\n", MDL);
- return 1;
- }
- if (ia_dereference(&ia_na_copy, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /*
- * Test 3: lots of iaaddr in our ia_na
- */
-
- /* lots of iaaddr that we delete */
- iaid = 666;
- ia_na = NULL;
- if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_allocate() %s:%d\n", MDL);
- return 1;
- }
- for (i=0; i<100; i++) {
- iaaddr = NULL;
- if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (ia_add_iasubopt(ia_na, iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_add_iasubopt() %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_reference() %s:%d\n", MDL);
- return 1;
- }
- }
- for (i=0; i<100; i++) {
- iaaddr = ia_na->iasubopt[random() % ia_na->num_iasubopt];
- ia_remove_iasubopt(ia_na, iaaddr, MDL);
- }
- if (ia_dereference(&ia_na, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /* lots of iaaddr, let dereference cleanup */
- iaid = 666;
- ia_na = NULL;
- if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_allocate() %s:%d\n", MDL);
- return 1;
- }
- for (i=0; i<100; i++) {
- iaaddr = NULL;
- if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (ia_add_iasubopt(ia_na, iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_add_iasubopt() %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_reference() %s:%d\n", MDL);
- return 1;
- }
- }
- if (ia_dereference(&ia_na, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /*
- * Test 4: Errors in ia_na.
- */
- /* bogus allocate arguments */
- if (ia_allocate(NULL, 123, "", 0, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ia_allocate() %s:%d\n", MDL);
- return 1;
- }
- ia_na = (struct ia_na *)1;
- if (ia_allocate(&ia_na, 456, "", 0, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ia_allocate() %s:%d\n", MDL);
- return 1;
- }
-
- /* bogus reference arguments */
- iaid = 666;
- ia_na = NULL;
- if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (ia_reference(NULL, ia_na, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ia_reference() %s:%d\n", MDL);
- return 1;
- }
- ia_na_copy = (struct ia_na *)1;
- if (ia_reference(&ia_na_copy, ia_na, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ia_reference() %s:%d\n", MDL);
- return 1;
- }
- ia_na_copy = NULL;
- if (ia_reference(&ia_na_copy, NULL, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ia_reference() %s:%d\n", MDL);
- return 1;
- }
- if (ia_dereference(&ia_na, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /* bogus dereference arguments */
- if (ia_dereference(NULL, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ia_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /* bogus remove */
- iaid = 666;
- ia_na = NULL;
- if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_allocate() %s:%d\n", MDL);
- return 1;
- }
- ia_remove_iasubopt(ia_na, NULL, MDL);
- if (ia_dereference(&ia_na, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /*
- * Test 5: Basic ipv6_pool manipulation.
- */
-
- /* allocate, reference */
- inet_pton(AF_INET6, "1:2:3:4::", &addr);
- pool = NULL;
- if (ipv6_pool_allocate(&pool, 0, &addr, 64, 128, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (pool->num_active != 0) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- if (pool->bits != 64) {
- printf("ERROR: bad bits %s:%d\n", MDL);
- return 1;
- }
- inet_ntop(AF_INET6, &pool->start_addr, addr_buf, sizeof(addr_buf));
- if (strcmp(inet_ntop(AF_INET6, &pool->start_addr, addr_buf,
- sizeof(addr_buf)), "1:2:3:4::") != 0) {
- printf("ERROR: bad start_addr %s:%d\n", MDL);
- return 1;
- }
- pool_copy = NULL;
- if (ipv6_pool_reference(&pool_copy, pool, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
- return 1;
- }
-
- /* create_lease6, renew_lease6, expire_lease6 */
- uid = "client0";
- memset(&ds, 0, sizeof(ds));
- ds.len = strlen(uid);
- if (!buffer_allocate(&ds.buffer, ds.len, MDL)) {
- printf("Out of memory\n");
- return 1;
- }
- ds.data = ds.buffer->data;
- memcpy((char *)ds.data, uid, ds.len);
- if (create_lease6(pool, &iaaddr,
- &attempts, &ds, 1) != ISC_R_SUCCESS) {
- printf("ERROR: create_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (pool->num_inactive != 1) {
- printf("ERROR: bad num_inactive %s:%d\n", MDL);
- return 1;
- }
- if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
- printf("ERROR: renew_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (pool->num_active != 1) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- expired_iaaddr = NULL;
- if (expire_lease6(&expired_iaaddr, pool, 0) != ISC_R_SUCCESS) {
- printf("ERROR: expire_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (expired_iaaddr != NULL) {
- printf("ERROR: should not have expired a lease %s:%d\n", MDL);
- return 1;
- }
- if (pool->num_active != 1) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- if (expire_lease6(&expired_iaaddr, pool, 1000) != ISC_R_SUCCESS) {
- printf("ERROR: expire_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (expired_iaaddr == NULL) {
- printf("ERROR: should have expired a lease %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&expired_iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_dereference() %s:%d\n", MDL);
- return 1;
- }
- if (pool->num_active != 0) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /* release_lease6, decline_lease6 */
- if (create_lease6(pool, &iaaddr, &attempts,
- &ds, 1) != ISC_R_SUCCESS) {
- printf("ERROR: create_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
- printf("ERROR: renew_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (pool->num_active != 1) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- if (release_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
- printf("ERROR: decline_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (pool->num_active != 0) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_dereference() %s:%d\n", MDL);
- return 1;
- }
- if (create_lease6(pool, &iaaddr, &attempts,
- &ds, 1) != ISC_R_SUCCESS) {
- printf("ERROR: create_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
- printf("ERROR: renew_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (pool->num_active != 1) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- if (decline_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
- printf("ERROR: decline_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (pool->num_active != 1) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /* dereference */
- if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
- return 1;
- }
- if (ipv6_pool_dereference(&pool_copy, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
- return 1;
- }
-
- /*
- * Test 6: Error ipv6_pool manipulation
- */
- if (ipv6_pool_allocate(NULL, 0, &addr, 64, 128, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
- return 1;
- }
- pool = (struct ipv6_pool *)1;
- if (ipv6_pool_allocate(&pool, 0, &addr, 64, 128, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (ipv6_pool_reference(NULL, pool, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
- return 1;
- }
- pool_copy = (struct ipv6_pool *)1;
- if (ipv6_pool_reference(&pool_copy, pool, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
- return 1;
- }
- pool_copy = NULL;
- if (ipv6_pool_reference(&pool_copy, NULL, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
- return 1;
- }
- if (ipv6_pool_dereference(NULL, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
- return 1;
- }
- if (ipv6_pool_dereference(&pool_copy, MDL) != ISC_R_INVALIDARG) {
- printf("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /*
- * Test 7: order of expiration
- */
- pool = NULL;
- if (ipv6_pool_allocate(&pool, 0, &addr, 64, 128, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
- return 1;
- }
- for (i=10; i<100; i+=10) {
- if (create_lease6(pool, &iaaddr, &attempts,
- &ds, i) != ISC_R_SUCCESS) {
- printf("ERROR: create_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
- printf("ERROR: renew_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_dereference() %s:%d\n", MDL);
- return 1;
- }
- if (pool->num_active != (i / 10)) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- }
- if (pool->num_active != 9) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- for (i=10; i<100; i+=10) {
- if (expire_lease6(&expired_iaaddr,
- pool, 1000) != ISC_R_SUCCESS) {
- printf("ERROR: expire_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (expired_iaaddr == NULL) {
- printf("ERROR: should have expired a lease %s:%d\n",
- MDL);
- return 1;
- }
- if (pool->num_active != (9 - (i / 10))) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- if (expired_iaaddr->hard_lifetime_end_time != i) {
- printf("ERROR: bad hard_lifetime_end_time %s:%d\n",
- MDL);
- return 1;
- }
- if (iasubopt_dereference(&expired_iaaddr, MDL) !=
- ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_dereference() %s:%d\n", MDL);
- return 1;
- }
- }
- if (pool->num_active != 0) {
- printf("ERROR: bad num_active %s:%d\n", MDL);
- return 1;
- }
- expired_iaaddr = NULL;
- if (expire_lease6(&expired_iaaddr, pool, 1000) != ISC_R_SUCCESS) {
- printf("ERROR: expire_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
- return 1;
- }
-
- /*
- * Test 8: small pool
- */
- pool = NULL;
- addr.s6_addr[14] = 0x81;
- if (ipv6_pool_allocate(&pool, 0, &addr, 127, 128, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (create_lease6(pool, &iaaddr, &attempts,
- &ds, 42) != ISC_R_SUCCESS) {
- printf("ERROR: create_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
- printf("ERROR: renew_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_dereference() %s:%d\n", MDL);
- return 1;
- }
- if (create_lease6(pool, &iaaddr, &attempts,
- &ds, 11) != ISC_R_SUCCESS) {
- printf("ERROR: create_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
- printf("ERROR: renew_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: iasubopt_dereference() %s:%d\n", MDL);
- return 1;
- }
- if (create_lease6(pool, &iaaddr, &attempts,
- &ds, 11) != ISC_R_NORESOURCES) {
- printf("ERROR: create_lease6() %s:%d\n", MDL);
- return 1;
- }
- if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
- return 1;
- }
- addr.s6_addr[14] = 0;
-
- /*
- * Test 9: functions across all pools
- */
- pool = NULL;
- if (ipv6_pool_allocate(&pool, 0, &addr, 64, 128, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
- return 1;
- }
- if (add_ipv6_pool(pool) != ISC_R_SUCCESS) {
- printf("ERROR: add_ipv6_pool() %s:%d\n", MDL);
- return 1;
- }
- if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
- return 1;
- }
- pool = NULL;
- if (find_ipv6_pool(&pool, 0, &addr) != ISC_R_SUCCESS) {
- printf("ERROR: find_ipv6_pool() %s:%d\n", MDL);
- return 1;
- }
- if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
- return 1;
- }
- inet_pton(AF_INET6, "1:2:3:4:ffff:ffff:ffff:ffff", &addr);
- pool = NULL;
- if (find_ipv6_pool(&pool, 0, &addr) != ISC_R_SUCCESS) {
- printf("ERROR: find_ipv6_pool() %s:%d\n", MDL);
- return 1;
- }
- if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
- return 1;
- }
- inet_pton(AF_INET6, "1:2:3:5::", &addr);
- pool = NULL;
- if (find_ipv6_pool(&pool, 0, &addr) != ISC_R_NOTFOUND) {
- printf("ERROR: find_ipv6_pool() %s:%d\n", MDL);
- return 1;
- }
- inet_pton(AF_INET6, "1:2:3:3:ffff:ffff:ffff:ffff", &addr);
- pool = NULL;
- if (find_ipv6_pool(&pool, 0, &addr) != ISC_R_NOTFOUND) {
- printf("ERROR: find_ipv6_pool() %s:%d\n", MDL);
- return 1;
- }
-
-/* iaid = 666;
- ia_na = NULL;
- if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
- printf("ERROR: ia_allocate() %s:%d\n", MDL);
- return 1;
- }*/
-
- {
- struct in6_addr r;
- struct data_string ds;
- u_char data[16];
- char buf[64];
- int i, j;
-
- memset(&ds, 0, sizeof(ds));
- memset(data, 0xaa, sizeof(data));
- ds.len = 16;
- ds.data = data;
-
- inet_pton(AF_INET6, "3ffe:501:ffff:100::", &addr);
- for (i = 32; i < 42; i++)
- for (j = i + 1; j < 49; j++) {
- memset(&r, 0, sizeof(r));
- memset(buf, 0, 64);
- build_prefix6(&r, &addr, i, j, &ds);
- inet_ntop(AF_INET6, &r, buf, 64);
- printf("%d,%d-> %s/%d\n", i, j, buf, j);
- }
- }
-
- printf("SUCCESS: all tests passed (ignore any warning messages)\n");
- return 0;
-}
-#endif
+/* unittest moved to server/tests/mdb6_unittest.c */
diff --git a/server/tests/Atffile b/server/tests/Atffile
new file mode 100644
index 00000000..b2fdc0f1
--- /dev/null
+++ b/server/tests/Atffile
@@ -0,0 +1,5 @@
+Content-Type: application/X-atf-atffile; version="1"
+
+prop: test-suite = dhcp4
+
+tp-glob: *_unittests
diff --git a/server/tests/Makefile.am b/server/tests/Makefile.am
new file mode 100644
index 00000000..dbf6c55f
--- /dev/null
+++ b/server/tests/Makefile.am
@@ -0,0 +1,49 @@
+SUBDIRS = .
+
+AM_CPPFLAGS = $(ATF_CFLAGS) -DUNIT_TEST -I$(top_srcdir)/includes
+AM_CPPFLAGS += -std=c99 -I$(top_srcdir)/bind/include -I$(top_srcdir)
+AM_CPPFLAGS += -DLOCALSTATEDIR='"."' -Wno-unused-function -Wno-error=unused-variable
+
+# for autotools debugging only
+info:
+ @echo "ATF_CFLAGS=$(ATF_CFLAGS)"
+ @echo "ATF_LDFLAGS=$(ATF_LDFLAGS)"
+ @echo "ATF_LIBS=$(ATF_LIBS)"
+
+DHCPSRC = ../dhcp.c ../bootp.c ../confpars.c ../db.c ../class.c \
+ ../failover.c ../omapi.c ../mdb.c ../stables.c ../salloc.c \
+ ../ddns.c ../dhcpleasequery.c ../dhcpv6.c ../mdb6.c \
+ ../dhcpd.c
+
+DHCPLIBS = $(top_builddir)/common/libdhcp.a $(top_builddir)/omapip/libomapi.a \
+ $(top_builddir)/dhcpctl/libdhcpctl.a $(top_builddir)/dst/libdst.a \
+ $(top_builddir)/minires/libres.a
+
+ATF_TESTS =
+TESTS =
+if HAVE_ATF
+
+check: $(ATF_TESTS)
+ atf-run | atf-report
+
+ATF_TESTS += dhcpd_unittests legacy_unittests hash_unittests
+
+dhcpd_unittests_SOURCES = $(DHCPSRC)
+dhcpd_unittests_SOURCES += simple_unittest.c
+
+dhcpd_unittests_LDADD = $(ATF_LDFLAGS)
+dhcpd_unittests_LDADD += $(DHCPLIBS)
+
+dhcpd_unittests_LDFLAGS = $(AM_LDFLAGS) $(ATF_LDFLAGS)
+
+hash_unittests_SOURCES = $(DHCPSRC) hash_unittest.c
+hash_unittests_LDADD = $(DHCPLIBS) $(ATF_LDFLAGS)
+
+
+# This is a legacy unittest. It replaces main() with something that was in mdb6.c
+legacy_unittests_SOURCES = $(DHCPSRC) mdb6_unittest.c
+legacy_unittests_LDADD = $(DHCPLIBS) $(ATF_LDFLAGS)
+
+endif
+
+check_PROGRAMS = $(ATF_TESTS) $(TESTS) \ No newline at end of file
diff --git a/server/tests/hash_unittest.c b/server/tests/hash_unittest.c
new file mode 100644
index 00000000..da2046d2
--- /dev/null
+++ b/server/tests/hash_unittest.c
@@ -0,0 +1,603 @@
+/*
+ * Copyright (c) 2012 by Internet Systems Consortium, Inc. ("ISC")
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+ * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *
+ * Internet Systems Consortium, Inc.
+ * 950 Charter Street
+ * Redwood City, CA 94063
+ * <info@isc.org>
+ * https://www.isc.org/
+ *
+ */
+
+#include "config.h"
+#include <atf-c.h>
+#include <omapip/omapip_p.h>
+#include "dhcpd.h"
+
+/*
+ * The following structures are kept here for reference only. As hash functions
+ * are somewhat convoluted, they are copied here for the reference. Original
+ * location is specified. Keep in mind that it may change over time:
+ *
+ * copied from server/omapi.c:49 *
+ * omapi_object_type_t *dhcp_type_lease;
+ * omapi_object_type_t *dhcp_type_pool;
+ * omapi_object_type_t *dhcp_type_class;
+ * omapi_object_type_t *dhcp_type_subclass;
+ * omapi_object_type_t *dhcp_type_host;
+ *
+ * copied from server/salloc.c:138
+ * OMAPI_OBJECT_ALLOC (lease, struct lease, dhcp_type_lease)
+ * OMAPI_OBJECT_ALLOC (class, struct class, dhcp_type_class)
+ * OMAPI_OBJECT_ALLOC (subclass, struct class, dhcp_type_subclass)
+ * OMAPI_OBJECT_ALLOC (pool, struct pool, dhcp_type_pool)
+ * OMAPI_OBJECT_ALLOC (host, struct host_decl, dhcp_type_host)
+ *
+ * copied from server/mdb.c:2686
+ * HASH_FUNCTIONS(lease_ip, const unsigned char *, struct lease, lease_ip_hash_t,
+ * lease_reference, lease_dereference, do_ip4_hash)
+ * HASH_FUNCTIONS(lease_id, const unsigned char *, struct lease, lease_id_hash_t,
+ * lease_reference, lease_dereference, do_id_hash)
+ * HASH_FUNCTIONS (host, const unsigned char *, struct host_decl, host_hash_t,
+ * host_reference, host_dereference, do_string_hash)
+ * HASH_FUNCTIONS (class, const char *, struct class, class_hash_t,
+ * class_reference, class_dereference, do_string_hash)
+ *
+ * copied from server/mdb.c:46
+ * host_hash_t *host_hw_addr_hash;
+ * host_hash_t *host_uid_hash;
+ * host_hash_t *host_name_hash;
+ * lease_id_hash_t *lease_uid_hash;
+ * lease_ip_hash_t *lease_ip_addr_hash;
+ * lease_id_hash_t *lease_hw_addr_hash;
+ */
+
+/**
+ * @brief sets client-id field in host declaration
+ *
+ * @param host pointer to host declaration
+ * @param uid pointer to client-id data
+ * @param uid_len length of the client-id data
+ *
+ * @return 1 if successful, 0 otherwise
+ */
+int lease_set_clientid(struct host_decl *host, const unsigned char *uid, int uid_len) {
+
+ /* clean-up this mess and set client-identifier in a sane way */
+ int real_len = uid_len;
+ if (uid_len == 0) {
+ real_len = strlen((const char *)uid) + 1;
+ }
+
+ memset(&host->client_identifier, 0, sizeof(host->client_identifier));
+ host->client_identifier.len = uid_len;
+ if (!buffer_allocate(&host->client_identifier.buffer, real_len, MDL)) {
+ return 0;
+ }
+ host->client_identifier.data = host->client_identifier.buffer->data;
+ memcpy((char *)host->client_identifier.data, uid, real_len);
+
+ return 1;
+}
+
+/// @brief executes uid hash test for specified client-ids (2 hosts)
+///
+/// Creates two host structures, adds first host to the uid hash,
+/// then adds second host to the hash, then removes first host,
+/// then removed the second. Many checks are performed during all
+/// operations.
+///
+/// @param clientid1 client-id of the first host
+/// @param clientid1_len client-id1 length (may be 0 for strings)
+/// @param clientid2 client-id of the second host
+/// @param clientid2_len client-id2 length (may be 0 for strings)
+void lease_hash_test_2hosts(unsigned char clientid1[], size_t clientid1_len,
+ unsigned char clientid2[], size_t clientid2_len) {
+
+ printf("Checking hash operation for 2 hosts: clientid1-len=%lu"
+ "clientid2-len=%lu\n", (unsigned long) clientid1_len,
+ (unsigned long) clientid2_len);
+
+ dhcp_db_objects_setup ();
+ dhcp_common_objects_setup ();
+
+ /* check that there is actually zero hosts in the hash */
+ /* @todo: host_hash_for_each() */
+
+ struct host_decl *host1 = 0, *host2 = 0;
+ struct host_decl *check = 0;
+
+ /* === step 1: allocate hosts === */
+ ATF_CHECK_MSG(host_allocate(&host1, MDL) == ISC_R_SUCCESS,
+ "Failed to allocate host");
+ ATF_CHECK_MSG(host_allocate(&host2, MDL) == ISC_R_SUCCESS,
+ "Failed to allocate host");
+
+ ATF_CHECK_MSG(host_new_hash(&host_uid_hash, HOST_HASH_SIZE, MDL) != 0,
+ "Unable to create new hash");
+
+ ATF_CHECK_MSG(buffer_allocate(&host1->client_identifier.buffer,
+ clientid1_len, MDL) != 0,
+ "Can't allocate uid buffer for host1");
+
+ ATF_CHECK_MSG(buffer_allocate(&host2->client_identifier.buffer,
+ clientid2_len, MDL) != 0,
+ "Can't allocate uid buffer for host2");
+
+ /* setting up host1->client_identifier is actually not needed */
+ /*
+ ATF_CHECK_MSG(lease_set_clientid(host1, clientid1, actual1_len) != 0,
+ "Failed to set client-id for host1");
+
+ ATF_CHECK_MSG(lease_set_clientid(host2, clientid2, actual2_len) != 0,
+ "Failed to set client-id for host2");
+ */
+
+ ATF_CHECK_MSG(host1->refcnt == 1, "Invalid refcnt for host1");
+ ATF_CHECK_MSG(host2->refcnt == 1, "Invalid refcnt for host2");
+
+ /* verify that our hosts are not in the hash yet */
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid1,
+ clientid1_len, MDL) == 0,
+ "Host1 is not supposed to be in the uid_hash.");
+
+ ATF_CHECK_MSG(!check, "Host1 is not supposed to be in the uid_hash.");
+
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid2,
+ clientid2_len, MDL) == 0,
+ "Host2 is not supposed to be in the uid_hash.");
+ ATF_CHECK_MSG(!check, "Host2 is not supposed to be in the uid_hash.");
+
+
+ /* === step 2: add first host to the hash === */
+ host_hash_add(host_uid_hash, clientid1, clientid1_len, host1, MDL);
+
+ /* 2 pointers expected: ours (host1) and the one stored in hash */
+ ATF_CHECK_MSG(host1->refcnt == 2, "Invalid refcnt for host1");
+ /* 1 pointer expected: just ours (host2) */
+ ATF_CHECK_MSG(host2->refcnt == 1, "Invalid refcnt for host2");
+
+ /* verify that host1 is really in the hash and the we can find it */
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid1,
+ clientid1_len, MDL),
+ "Host1 was supposed to be in the uid_hash.");
+ ATF_CHECK_MSG(check, "Host1 was supposed to be in the uid_hash.");
+
+ /* Hey! That's not the host we were looking for! */
+ ATF_CHECK_MSG(check == host1, "Wrong host returned by host_hash_lookup");
+
+ /* 3 pointers: host1, (stored in hash), check */
+ ATF_CHECK_MSG(host1->refcnt == 3, "Invalid refcnt for host1");
+
+ /* reference count should be increased because we not have a pointer */
+
+ host_dereference(&check, MDL); /* we don't need it now */
+
+ ATF_CHECK_MSG(check == NULL, "check pointer is supposed to be NULL");
+
+ /* 2 pointers: host1, (stored in hash) */
+ ATF_CHECK_MSG(host1->refcnt == 2, "Invalid refcnt for host1");
+
+ /* verify that host2 is not in the hash */
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid2,
+ clientid2_len, MDL) == 0,
+ "Host2 was not supposed to be in the uid_hash[2].");
+ ATF_CHECK_MSG(check == NULL, "Host2 was not supposed to be in the hash.");
+
+
+ /* === step 3: add second hot to the hash === */
+ host_hash_add(host_uid_hash, clientid2, clientid2_len, host2, MDL);
+
+ /* 2 pointers expected: ours (host1) and the one stored in hash */
+ ATF_CHECK_MSG(host2->refcnt == 2, "Invalid refcnt for host2");
+
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid2,
+ clientid2_len, MDL),
+ "Host2 was supposed to be in the uid_hash.");
+ ATF_CHECK_MSG(check, "Host2 was supposed to be in the uid_hash.");
+
+ /* Hey! That's not the host we were looking for! */
+ ATF_CHECK_MSG(check == host2, "Wrong host returned by host_hash_lookup");
+
+ /* 3 pointers: host1, (stored in hash), check */
+ ATF_CHECK_MSG(host2->refcnt == 3, "Invalid refcnt for host1");
+
+ host_dereference(&check, MDL); /* we don't need it now */
+
+ /* now we have 2 hosts in the hash */
+
+ /* verify that host1 is still in the hash and the we can find it */
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid1,
+ clientid1_len, MDL),
+ "Host1 was supposed to be in the uid_hash.");
+ ATF_CHECK_MSG(check, "Host1 was supposed to be in the uid_hash.");
+
+ /* Hey! That's not the host we were looking for! */
+ ATF_CHECK_MSG(check == host1, "Wrong host returned by host_hash_lookup");
+
+ /* 3 pointers: host1, (stored in hash), check */
+ ATF_CHECK_MSG(host1->refcnt == 3, "Invalid refcnt for host1");
+
+ host_dereference(&check, MDL); /* we don't need it now */
+
+
+ /**
+ * @todo check that there is actually two hosts in the hash.
+ * Use host_hash_for_each() for that.
+ */
+
+ /* === step 4: remove first host from the hash === */
+
+ /* delete host from hash */
+ host_hash_delete(host_uid_hash, clientid1, clientid1_len, MDL);
+
+ ATF_CHECK_MSG(host1->refcnt == 1, "Invalid refcnt for host1");
+ ATF_CHECK_MSG(host2->refcnt == 2, "Invalid refcnt for host2");
+
+ /* verify that host1 is no longer in the hash */
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid1,
+ clientid1_len, MDL) == 0,
+ "Host1 is not supposed to be in the uid_hash.");
+ ATF_CHECK_MSG(!check, "Host1 is not supposed to be in the uid_hash.");
+
+ /* host2 should be still there, though */
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid2,
+ clientid2_len, MDL),
+ "Host2 was supposed to still be in the uid_hash.");
+ host_dereference(&check, MDL);
+
+ /* === step 5: remove second host from the hash === */
+ host_hash_delete(host_uid_hash, clientid2, clientid2_len, MDL);
+
+ ATF_CHECK_MSG(host1->refcnt == 1, "Invalid refcnt for host1");
+ ATF_CHECK_MSG(host2->refcnt == 1, "Invalid refcnt for host2");
+
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid2,
+ clientid2_len, MDL) == 0,
+ "Host2 was not supposed to be in the uid_hash anymore.");
+
+ host_dereference(&host1, MDL);
+ host_dereference(&host2, MDL);
+
+ /*
+ * No easy way to check if the host object were actually released.
+ * We could run it in valgrind and check for memory leaks.
+ */
+
+#if defined (DEBUG_MEMORY_LEAKAGE) && defined (DEBUG_MEMORY_LEAKAGE_ON_EXIT)
+ /* @todo: Should be called in cleanup */
+ free_everything ();
+#endif
+}
+
+/// @brief executes uid hash test for specified client-ids (3 hosts)
+///
+/// Creates three host structures, adds first host to the uid hash,
+/// then adds second host to the hash, then removes first host,
+/// then removed the second. Many checks are performed during all
+/// operations.
+///
+/// @param clientid1 client-id of the first host
+/// @param clientid1_len client-id1 length (may be 0 for strings)
+/// @param clientid2 client-id of the second host
+/// @param clientid2_len client-id2 length (may be 0 for strings)
+/// @param clientid3 client-id of the second host
+/// @param clientid3_len client-id2 length (may be 0 for strings)
+void lease_hash_test_3hosts(unsigned char clientid1[], size_t clientid1_len,
+ unsigned char clientid2[], size_t clientid2_len,
+ unsigned char clientid3[], size_t clientid3_len) {
+
+ printf("Checking hash operation for 3 hosts: clientid1-len=%lu"
+ " clientid2-len=%lu clientid3-len=%lu\n",
+ (unsigned long) clientid1_len, (unsigned long) clientid2_len,
+ (unsigned long) clientid3_len);
+
+ dhcp_db_objects_setup ();
+ dhcp_common_objects_setup ();
+
+ /* check that there is actually zero hosts in the hash */
+ /* @todo: host_hash_for_each() */
+
+ struct host_decl *host1 = 0, *host2 = 0, *host3 = 0;
+ struct host_decl *check = 0;
+
+ /* === step 1: allocate hosts === */
+ ATF_CHECK_MSG(host_allocate(&host1, MDL) == ISC_R_SUCCESS,
+ "Failed to allocate host");
+ ATF_CHECK_MSG(host_allocate(&host2, MDL) == ISC_R_SUCCESS,
+ "Failed to allocate host");
+ ATF_CHECK_MSG(host_allocate(&host3, MDL) == ISC_R_SUCCESS,
+ "Failed to allocate host");
+
+ ATF_CHECK_MSG(host_new_hash(&host_uid_hash, HOST_HASH_SIZE, MDL) != 0,
+ "Unable to create new hash");
+
+ ATF_CHECK_MSG(buffer_allocate(&host1->client_identifier.buffer,
+ clientid1_len, MDL) != 0,
+ "Can't allocate uid buffer for host1");
+ ATF_CHECK_MSG(buffer_allocate(&host2->client_identifier.buffer,
+ clientid2_len, MDL) != 0,
+ "Can't allocate uid buffer for host2");
+ ATF_CHECK_MSG(buffer_allocate(&host3->client_identifier.buffer,
+ clientid3_len, MDL) != 0,
+ "Can't allocate uid buffer for host3");
+
+ /* verify that our hosts are not in the hash yet */
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid1,
+ clientid1_len, MDL) == 0,
+ "Host1 is not supposed to be in the uid_hash.");
+
+ ATF_CHECK_MSG(!check, "Host1 is not supposed to be in the uid_hash.");
+
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid2,
+ clientid2_len, MDL) == 0,
+ "Host2 is not supposed to be in the uid_hash.");
+ ATF_CHECK_MSG(!check, "Host2 is not supposed to be in the uid_hash.");
+
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid3,
+ clientid3_len, MDL) == 0,
+ "Host3 is not supposed to be in the uid_hash.");
+ ATF_CHECK_MSG(!check, "Host3 is not supposed to be in the uid_hash.");
+
+ /* === step 2: add hosts to the hash === */
+ host_hash_add(host_uid_hash, clientid1, clientid1_len, host1, MDL);
+ host_hash_add(host_uid_hash, clientid2, clientid2_len, host2, MDL);
+ host_hash_add(host_uid_hash, clientid3, clientid3_len, host3, MDL);
+
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid1,
+ clientid1_len, MDL),
+ "Host1 was supposed to be in the uid_hash.");
+ /* Hey! That's not the host we were looking for! */
+ ATF_CHECK_MSG(check == host1, "Wrong host returned by host_hash_lookup");
+ host_dereference(&check, MDL); /* we don't need it now */
+
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid2,
+ clientid2_len, MDL),
+ "Host2 was supposed to be in the uid_hash.");
+ ATF_CHECK_MSG(check, "Host2 was supposed to be in the uid_hash.");
+ /* Hey! That's not the host we were looking for! */
+ ATF_CHECK_MSG(check == host2, "Wrong host returned by host_hash_lookup");
+ host_dereference(&check, MDL); /* we don't need it now */
+
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid3,
+ clientid3_len, MDL),
+ "Host3 was supposed to be in the uid_hash.");
+ ATF_CHECK_MSG(check, "Host3 was supposed to be in the uid_hash.");
+ /* Hey! That's not the host we were looking for! */
+ ATF_CHECK_MSG(check == host3, "Wrong host returned by host_hash_lookup");
+ host_dereference(&check, MDL); /* we don't need it now */
+
+ /* === step 4: remove first host from the hash === */
+
+ /* delete host from hash */
+ host_hash_delete(host_uid_hash, clientid1, clientid1_len, MDL);
+
+ /* verify that host1 is no longer in the hash */
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid1,
+ clientid1_len, MDL) == 0,
+ "Host1 is not supposed to be in the uid_hash.");
+ ATF_CHECK_MSG(!check, "Host1 is not supposed to be in the uid_hash.");
+
+ /* host2 and host3 should be still there, though */
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid2,
+ clientid2_len, MDL),
+ "Host2 was supposed to still be in the uid_hash.");
+ host_dereference(&check, MDL);
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid3,
+ clientid3_len, MDL),
+ "Host3 was supposed to still be in the uid_hash.");
+ host_dereference(&check, MDL);
+
+ /* === step 5: remove second host from the hash === */
+ host_hash_delete(host_uid_hash, clientid2, clientid2_len, MDL);
+
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid2,
+ clientid2_len, MDL) == 0,
+ "Host2 was not supposed to be in the uid_hash anymore.");
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid3,
+ clientid3_len, MDL),
+ "Host3 was supposed to still be in the uid_hash.");
+ host_dereference(&check, MDL);
+
+ /* === step 6: remove the last (third) host from the hash === */
+ host_hash_delete(host_uid_hash, clientid3, clientid3_len, MDL);
+
+ ATF_CHECK_MSG(host_hash_lookup(&check, host_uid_hash, clientid3,
+ clientid3_len, MDL) == 0,
+ "Host3 was not supposed to be in the uid_hash anymore.");
+ host_dereference(&check, MDL);
+
+
+ host_dereference(&host1, MDL);
+ host_dereference(&host2, MDL);
+ host_dereference(&host3, MDL);
+
+ /*
+ * No easy way to check if the host object were actually released.
+ * We could run it in valgrind and check for memory leaks.
+ */
+
+#if defined (DEBUG_MEMORY_LEAKAGE) && defined (DEBUG_MEMORY_LEAKAGE_ON_EXIT)
+ /* @todo: Should be called in cleanup */
+ free_everything ();
+#endif
+}
+
+ATF_TC(lease_hash_basic_2hosts);
+
+ATF_TC_HEAD(lease_hash_basic_2hosts, tc) {
+ atf_tc_set_md_var(tc, "descr", "Basic lease hash tests");
+ /*
+ * The following functions are tested:
+ * host_allocate(), host_new_hash(), buffer_allocate(), host_hash_lookup()
+ * host_hash_add(), host_hash_delete()
+ */
+}
+
+ATF_TC_BODY(lease_hash_basic_2hosts, tc) {
+
+ unsigned char clientid1[] = { 0x1, 0x2, 0x3 };
+ unsigned char clientid2[] = { 0xff, 0xfe };
+
+ lease_hash_test_2hosts(clientid1, sizeof(clientid1),
+ clientid2, sizeof(clientid2));
+}
+
+
+ATF_TC(lease_hash_string_2hosts);
+
+ATF_TC_HEAD(lease_hash_string_2hosts, tc) {
+ atf_tc_set_md_var(tc, "descr", "string-based lease hash tests");
+ /*
+ * The following functions are tested:
+ * host_allocate(), host_new_hash(), buffer_allocate(), host_hash_lookup()
+ * host_hash_add(), host_hash_delete()
+ */
+}
+
+ATF_TC_BODY(lease_hash_string_2hosts, tc) {
+
+ unsigned char clientid1[] = "Alice";
+ unsigned char clientid2[] = "Bob";
+
+ lease_hash_test_2hosts(clientid1, 0, clientid2, 0);
+}
+
+
+ATF_TC(lease_hash_negative1);
+
+ATF_TC_HEAD(lease_hash_negative1, tc) {
+ atf_tc_set_md_var(tc, "descr", "Negative tests for lease hash");
+}
+
+ATF_TC_BODY(lease_hash_negative1, tc) {
+
+ unsigned char clientid1[] = { 0x1 };
+ unsigned char clientid2[] = { 0x0 };
+
+ lease_hash_test_2hosts(clientid1, 0, clientid2, 1);
+}
+
+
+
+ATF_TC(lease_hash_string_3hosts);
+ATF_TC_HEAD(lease_hash_string_3hosts, tc) {
+ atf_tc_set_md_var(tc, "descr", "string-based lease hash tests");
+ /*
+ * The following functions are tested:
+ * host_allocate(), host_new_hash(), buffer_allocate(), host_hash_lookup()
+ * host_hash_add(), host_hash_delete()
+ */
+}
+ATF_TC_BODY(lease_hash_string_3hosts, tc) {
+
+ unsigned char clientid1[] = "Alice";
+ unsigned char clientid2[] = "Bob";
+ unsigned char clientid3[] = "Charlie";
+
+ lease_hash_test_3hosts(clientid1, 0, clientid2, 0, clientid3, 0);
+}
+
+
+ATF_TC(lease_hash_basic_3hosts);
+ATF_TC_HEAD(lease_hash_basic_3hosts, tc) {
+ atf_tc_set_md_var(tc, "descr", "Basic lease hash tests");
+ /*
+ * The following functions are tested:
+ * host_allocate(), host_new_hash(), buffer_allocate(), host_hash_lookup()
+ * host_hash_add(), host_hash_delete()
+ */
+}
+ATF_TC_BODY(lease_hash_basic_3hosts, tc) {
+
+ unsigned char clientid1[] = { 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9 };
+ unsigned char clientid2[] = { 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8 };
+ unsigned char clientid3[] = { 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7 };
+
+ lease_hash_test_3hosts(clientid1, sizeof(clientid1),
+ clientid2, sizeof(clientid2),
+ clientid3, sizeof(clientid3));
+}
+
+/* this test is a direct reproduction of 29851 issue */
+ATF_TC(uid_hash_rt29851);
+
+ATF_TC_HEAD(uid_hash_rt29851, tc) {
+ atf_tc_set_md_var(tc, "descr", "Uid hash tests");
+
+ /*
+ * this test should last less than millisecond. If its execution
+ * is longer than 3 second, we hit infinite loop.
+ */
+ atf_tc_set_md_var(tc, "timeout", "3");
+}
+
+ATF_TC_BODY(uid_hash_rt29851, tc) {
+
+ unsigned char clientid1[] = { 0x0 };
+ unsigned char clientid2[] = { 0x0 };
+ unsigned char clientid3[] = { 0x0 };
+
+ int clientid1_len = 1;
+ int clientid2_len = 1;
+ int clientid3_len = 0;
+
+ struct lease *lease1 = 0, *lease2 = 0, *lease3 = 0;
+
+ dhcp_db_objects_setup ();
+ dhcp_common_objects_setup ();
+
+ ATF_CHECK(lease_id_new_hash(&lease_uid_hash, LEASE_HASH_SIZE, MDL));
+
+ ATF_CHECK(lease_allocate (&lease1, MDL) == ISC_R_SUCCESS);
+ ATF_CHECK(lease_allocate (&lease2, MDL) == ISC_R_SUCCESS);
+ ATF_CHECK(lease_allocate (&lease3, MDL) == ISC_R_SUCCESS);
+
+ lease1->uid = clientid1;
+ lease2->uid = clientid2;
+ lease3->uid = clientid3;
+
+ lease1->uid_len = clientid1_len;
+ lease2->uid_len = clientid2_len;
+ lease3->uid_len = clientid3_len;
+
+ uid_hash_add(lease1);
+ /* uid_hash_delete(lease2); // not necessary for actual issue repro */
+ uid_hash_add(lease3);
+
+ /* lease2->uid_len = 0; // not necessary for actual issue repro */
+ /* uid_hash_delete(lease2); // not necessary for actual issue repro */
+ /* uid_hash_delete(lease3); // not necessary for actual issue repro */
+ uid_hash_delete(lease1);
+
+ /* lease2->uid_len = 1; // not necessary for actual issue repro */
+ uid_hash_add(lease1);
+ uid_hash_delete(lease2);
+}
+
+
+
+
+
+
+ATF_TP_ADD_TCS(tp) {
+ ATF_TP_ADD_TC(tp, lease_hash_basic_2hosts);
+ ATF_TP_ADD_TC(tp, lease_hash_basic_3hosts);
+ ATF_TP_ADD_TC(tp, lease_hash_string_2hosts);
+ ATF_TP_ADD_TC(tp, lease_hash_string_3hosts);
+ ATF_TP_ADD_TC(tp, lease_hash_negative1);
+ ATF_TP_ADD_TC(tp, uid_hash_rt29851);
+ return (atf_no_error());
+}
diff --git a/server/tests/mdb6_unittest.c b/server/tests/mdb6_unittest.c
new file mode 100644
index 00000000..99e9e2e7
--- /dev/null
+++ b/server/tests/mdb6_unittest.c
@@ -0,0 +1,715 @@
+/*
+ * Copyright (C) 2007-2012 by Internet Systems Consortium, Inc. ("ISC")
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+ * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+ * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+ * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+ * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include "config.h"
+
+#include <sys/types.h>
+#include <time.h>
+#include <netinet/in.h>
+
+#include <stdarg.h>
+#include "dhcpd.h"
+#include "omapip/omapip.h"
+#include "omapip/hash.h"
+#include <dst/md5.h>
+
+#include <atf-c.h>
+
+#include <stdlib.h>
+
+void build_prefix6(struct in6_addr *pref, const struct in6_addr *net_start_pref,
+ int pool_bits, int pref_bits,
+ const struct data_string *input);
+
+ATF_TC(iaaddr_basic);
+ATF_TC_HEAD(iaaddr_basic, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case checks that basic "
+ "IAADDR manipulation is possible.");
+}
+ATF_TC_BODY(iaaddr_basic, tc)
+{
+ struct iasubopt *iaaddr;
+ struct iasubopt *iaaddr_copy;
+ /*
+ * Test 0: Basic iaaddr manipulation.
+ */
+ iaaddr = NULL;
+ if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_allocate() %s:%d", MDL);
+ }
+ if (iaaddr->state != FTS_FREE) {
+ atf_tc_fail("ERROR: bad state %s:%d", MDL);
+ }
+ if (iaaddr->heap_index != -1) {
+ atf_tc_fail("ERROR: bad heap_index %s:%d", MDL);
+ }
+ iaaddr_copy = NULL;
+ if (iasubopt_reference(&iaaddr_copy, iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_reference() %s:%d", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_reference() %s:%d", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr_copy, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_reference() %s:%d", MDL);
+ }
+}
+
+
+ATF_TC(iaaddr_negative);
+ATF_TC_HEAD(iaaddr_negative, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case checks that IAADDR "
+ "option code can handle various negative scenarios.");
+}
+ATF_TC_BODY(iaaddr_negative, tc)
+{
+ struct iasubopt *iaaddr;
+ struct iasubopt *iaaddr_copy;
+
+ /* bogus allocate arguments */
+ if (iasubopt_allocate(NULL, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: iasubopt_allocate() %s:%d", MDL);
+ }
+ iaaddr = (struct iasubopt *)1;
+ if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: iasubopt_allocate() %s:%d", MDL);
+ }
+
+ /* bogus reference arguments */
+ iaaddr = NULL;
+ if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_allocate() %s:%d", MDL);
+ }
+ if (iasubopt_reference(NULL, iaaddr, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: iasubopt_reference() %s:%d", MDL);
+ }
+ iaaddr_copy = (struct iasubopt *)1;
+ if (iasubopt_reference(&iaaddr_copy, iaaddr,
+ MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: iasubopt_reference() %s:%d", MDL);
+ }
+ iaaddr_copy = NULL;
+ if (iasubopt_reference(&iaaddr_copy, NULL, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: iasubopt_reference() %s:%d", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_reference() %s:%d", MDL);
+ }
+
+ /* bogus dereference arguments */
+ if (iasubopt_dereference(NULL, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: iasubopt_dereference() %s:%d", MDL);
+ }
+ iaaddr = NULL;
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: iasubopt_dereference() %s:%d", MDL);
+ }
+}
+
+
+ATF_TC(ia_na_basic);
+ATF_TC_HEAD(ia_na_basic, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case checks that IA_NA code can "
+ "handle various basic scenarios.");
+}
+ATF_TC_BODY(ia_na_basic, tc)
+{
+ uint32_t iaid;
+ struct ia_xx *ia_na;
+ struct ia_xx *ia_na_copy;
+ struct iasubopt *iaaddr;
+
+ /*
+ * Test 2: Basic ia_na manipulation.
+ */
+ iaid = 666;
+ ia_na = NULL;
+ if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_allocate() %s:%d\n", MDL);
+ }
+ if (memcmp(ia_na->iaid_duid.data, &iaid, sizeof(iaid)) != 0) {
+ atf_tc_fail("ERROR: bad IAID_DUID %s:%d\n", MDL);
+ }
+ if (memcmp(ia_na->iaid_duid.data+sizeof(iaid), "TestDUID", 8) != 0) {
+ atf_tc_fail("ERROR: bad IAID_DUID %s:%d\n", MDL);
+ }
+ if (ia_na->num_iasubopt != 0) {
+ atf_tc_fail("ERROR: bad num_iasubopt %s:%d\n", MDL);
+ }
+ ia_na_copy = NULL;
+ if (ia_reference(&ia_na_copy, ia_na, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_reference() %s:%d\n", MDL);
+ }
+ iaaddr = NULL;
+ if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_allocate() %s:%d\n", MDL);
+ }
+ if (ia_add_iasubopt(ia_na, iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_add_iasubopt() %s:%d\n", MDL);
+ }
+ ia_remove_iasubopt(ia_na, iaaddr, MDL);
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_reference() %s:%d\n", MDL);
+ }
+ if (ia_dereference(&ia_na, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_dereference() %s:%d\n", MDL);
+ }
+ if (ia_dereference(&ia_na_copy, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_dereference() %s:%d\n", MDL);
+ }
+}
+
+
+ATF_TC(ia_na_manyaddrs);
+ATF_TC_HEAD(ia_na_manyaddrs, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case checks that IA_NA can "
+ "handle lots of addresses.");
+}
+ATF_TC_BODY(ia_na_manyaddrs, tc)
+{
+ uint32_t iaid;
+ struct ia_xx *ia_na;
+ struct iasubopt *iaaddr;
+ int i;
+ /*
+ * Test 3: lots of iaaddr in our ia_na
+ */
+
+ /* lots of iaaddr that we delete */
+ iaid = 666;
+ ia_na = NULL;
+ if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_allocate() %s:%d\n", MDL);
+ }
+ for (i=0; i<100; i++) {
+ iaaddr = NULL;
+ if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_allocate() %s:%d\n", MDL);
+ }
+ if (ia_add_iasubopt(ia_na, iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_add_iasubopt() %s:%d\n", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_reference() %s:%d\n", MDL);
+ }
+ }
+
+#if 0
+ for (i=0; i<100; i++) {
+ iaaddr = ia_na->iasubopt[random() % ia_na->num_iasubopt];
+ ia_remove_iasubopt(ia_na, iaaddr, MDL);
+ /* TODO: valgrind reports problem here: Invalid read of size 8
+ * Address 0x51e6258 is 56 bytes inside a block of size 88 free'd */
+ }
+#endif
+ if (ia_dereference(&ia_na, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_dereference() %s:%d\n", MDL);
+ }
+
+ /* lots of iaaddr, let dereference cleanup */
+ iaid = 666;
+ ia_na = NULL;
+ if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_allocate() %s:%d\n", MDL);
+ }
+ for (i=0; i<100; i++) {
+ iaaddr = NULL;
+ if (iasubopt_allocate(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_allocate() %s:%d\n", MDL);
+ }
+ if (ia_add_iasubopt(ia_na, iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_add_iasubopt() %s:%d\n", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_reference() %s:%d\n", MDL);
+ }
+ }
+ if (ia_dereference(&ia_na, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_dereference() %s:%d\n", MDL);
+ }
+}
+
+ATF_TC(ia_na_negative);
+ATF_TC_HEAD(ia_na_negative, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case checks that IA_NA option "
+ "code can handle various negative scenarios.");
+}
+ATF_TC_BODY(ia_na_negative, tc)
+{
+ uint32_t iaid;
+ struct ia_xx *ia_na;
+ struct ia_xx *ia_na_copy;
+ /*
+ * Test 4: Errors in ia_na.
+ */
+ /* bogus allocate arguments */
+ if (ia_allocate(NULL, 123, "", 0, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ia_allocate() %s:%d\n", MDL);
+ }
+ ia_na = (struct ia_xx *)1;
+ if (ia_allocate(&ia_na, 456, "", 0, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ia_allocate() %s:%d\n", MDL);
+ }
+
+ /* bogus reference arguments */
+ iaid = 666;
+ ia_na = NULL;
+ if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_allocate() %s:%d\n", MDL);
+ }
+ if (ia_reference(NULL, ia_na, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ia_reference() %s:%d\n", MDL);
+ }
+ ia_na_copy = (struct ia_xx *)1;
+ if (ia_reference(&ia_na_copy, ia_na, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ia_reference() %s:%d\n", MDL);
+ }
+ ia_na_copy = NULL;
+ if (ia_reference(&ia_na_copy, NULL, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ia_reference() %s:%d\n", MDL);
+ }
+ if (ia_dereference(&ia_na, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_dereference() %s:%d\n", MDL);
+ }
+
+ /* bogus dereference arguments */
+ if (ia_dereference(NULL, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ia_dereference() %s:%d\n", MDL);
+ }
+
+ /* bogus remove */
+ iaid = 666;
+ ia_na = NULL;
+ if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_allocate() %s:%d\n", MDL);
+ }
+ ia_remove_iasubopt(ia_na, NULL, MDL);
+ if (ia_dereference(&ia_na, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_dereference() %s:%d\n", MDL);
+ }
+}
+
+ATF_TC(ipv6_pool_basic);
+ATF_TC_HEAD(ipv6_pool_basic, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case checks that IPv6 pool "
+ "manipulation is possible.");
+}
+ATF_TC_BODY(ipv6_pool_basic, tc)
+{
+ struct iasubopt *iaaddr;
+ struct in6_addr addr;
+ struct ipv6_pool *pool;
+ struct ipv6_pool *pool_copy;
+ char addr_buf[INET6_ADDRSTRLEN];
+ char *uid;
+ struct data_string ds;
+ struct iasubopt *expired_iaaddr;
+ unsigned int attempts;
+
+ /*
+ * Test 5: Basic ipv6_pool manipulation.
+ */
+
+ /* allocate, reference */
+ inet_pton(AF_INET6, "1:2:3:4::", &addr);
+ pool = NULL;
+ if (ipv6_pool_allocate(&pool, 0, &addr, 64, 128, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
+ }
+ if (pool->num_active != 0) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ if (pool->bits != 64) {
+ atf_tc_fail("ERROR: bad bits %s:%d\n", MDL);
+ }
+ inet_ntop(AF_INET6, &pool->start_addr, addr_buf, sizeof(addr_buf));
+ if (strcmp(inet_ntop(AF_INET6, &pool->start_addr, addr_buf,
+ sizeof(addr_buf)), "1:2:3:4::") != 0) {
+ atf_tc_fail("ERROR: bad start_addr %s:%d\n", MDL);
+ }
+ pool_copy = NULL;
+ if (ipv6_pool_reference(&pool_copy, pool, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
+ }
+
+ /* create_lease6, renew_lease6, expire_lease6 */
+ uid = "client0";
+ memset(&ds, 0, sizeof(ds));
+ ds.len = strlen(uid);
+ if (!buffer_allocate(&ds.buffer, ds.len, MDL)) {
+ atf_tc_fail("Out of memory\n");
+ }
+ ds.data = ds.buffer->data;
+ memcpy((char *)ds.data, uid, ds.len);
+ if (create_lease6(pool, &iaaddr,
+ &attempts, &ds, 1) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: create_lease6() %s:%d\n", MDL);
+ }
+ if (pool->num_inactive != 1) {
+ atf_tc_fail("ERROR: bad num_inactive %s:%d\n", MDL);
+ }
+ if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: renew_lease6() %s:%d\n", MDL);
+ }
+ if (pool->num_active != 1) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ expired_iaaddr = NULL;
+ if (expire_lease6(&expired_iaaddr, pool, 0) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: expire_lease6() %s:%d\n", MDL);
+ }
+ if (expired_iaaddr != NULL) {
+ atf_tc_fail("ERROR: should not have expired a lease %s:%d\n", MDL);
+ }
+ if (pool->num_active != 1) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ if (expire_lease6(&expired_iaaddr, pool, 1000) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: expire_lease6() %s:%d\n", MDL);
+ }
+ if (expired_iaaddr == NULL) {
+ atf_tc_fail("ERROR: should have expired a lease %s:%d\n", MDL);
+ }
+ if (iasubopt_dereference(&expired_iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_dereference() %s:%d\n", MDL);
+ }
+ if (pool->num_active != 0) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_dereference() %s:%d\n", MDL);
+ }
+
+ /* release_lease6, decline_lease6 */
+ if (create_lease6(pool, &iaaddr, &attempts,
+ &ds, 1) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: create_lease6() %s:%d\n", MDL);
+ }
+ if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: renew_lease6() %s:%d\n", MDL);
+ }
+ if (pool->num_active != 1) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ if (release_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: decline_lease6() %s:%d\n", MDL);
+ }
+ if (pool->num_active != 0) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_dereference() %s:%d\n", MDL);
+ }
+ if (create_lease6(pool, &iaaddr, &attempts,
+ &ds, 1) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: create_lease6() %s:%d\n", MDL);
+ }
+ if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: renew_lease6() %s:%d\n", MDL);
+ }
+ if (pool->num_active != 1) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ if (decline_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: decline_lease6() %s:%d\n", MDL);
+ }
+ if (pool->num_active != 1) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_dereference() %s:%d\n", MDL);
+ }
+
+ /* dereference */
+ if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
+ }
+ if (ipv6_pool_dereference(&pool_copy, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
+ }
+}
+
+ATF_TC(ipv6_pool_negative);
+ATF_TC_HEAD(ipv6_pool_negative, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case checks that IPv6 pool "
+ "can handle negative cases.");
+}
+ATF_TC_BODY(ipv6_pool_negative, tc)
+{
+ struct in6_addr addr;
+ struct ipv6_pool *pool;
+ struct ipv6_pool *pool_copy;
+
+ /*
+ * Test 6: Error ipv6_pool manipulation
+ */
+ if (ipv6_pool_allocate(NULL, 0, &addr,
+ 64, 128, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
+ }
+ pool = (struct ipv6_pool *)1;
+ if (ipv6_pool_allocate(&pool, 0, &addr,
+ 64, 128, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
+ }
+ if (ipv6_pool_reference(NULL, pool, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
+ }
+ pool_copy = (struct ipv6_pool *)1;
+ if (ipv6_pool_reference(&pool_copy, pool, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
+ }
+ pool_copy = NULL;
+ if (ipv6_pool_reference(&pool_copy, NULL, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ipv6_pool_reference() %s:%d\n", MDL);
+ }
+ if (ipv6_pool_dereference(NULL, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
+ }
+ if (ipv6_pool_dereference(&pool_copy, MDL) != ISC_R_INVALIDARG) {
+ atf_tc_fail("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
+ }
+}
+
+ATF_TC(expire_order);
+ATF_TC_HEAD(expire_order, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case checks that order "
+ "of lease expiration is handled properly.");
+}
+ATF_TC_BODY(expire_order, tc)
+{
+ struct iasubopt *iaaddr;
+ struct ipv6_pool *pool;
+ struct in6_addr addr;
+ int i;
+ struct data_string ds;
+ struct iasubopt *expired_iaaddr;
+ unsigned int attempts;
+
+ /*
+ * Test 7: order of expiration
+ */
+ pool = NULL;
+ if (ipv6_pool_allocate(&pool, 0, &addr, 64, 128, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
+ }
+ for (i=10; i<100; i+=10) {
+ if (create_lease6(pool, &iaaddr, &attempts,
+ &ds, i) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: create_lease6() %s:%d\n", MDL);
+ }
+ if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: renew_lease6() %s:%d\n", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_dereference() %s:%d\n", MDL);
+ }
+ if (pool->num_active != (i / 10)) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ }
+ if (pool->num_active != 9) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ for (i=10; i<100; i+=10) {
+ if (expire_lease6(&expired_iaaddr,
+ pool, 1000) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: expire_lease6() %s:%d\n", MDL);
+ }
+ if (expired_iaaddr == NULL) {
+ atf_tc_fail("ERROR: should have expired a lease %s:%d\n",
+ MDL);
+ }
+ if (pool->num_active != (9 - (i / 10))) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ if (expired_iaaddr->hard_lifetime_end_time != i) {
+ atf_tc_fail("ERROR: bad hard_lifetime_end_time %s:%d\n",
+ MDL);
+ }
+ if (iasubopt_dereference(&expired_iaaddr, MDL) !=
+ ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_dereference() %s:%d\n", MDL);
+ }
+ }
+ if (pool->num_active != 0) {
+ atf_tc_fail("ERROR: bad num_active %s:%d\n", MDL);
+ }
+ expired_iaaddr = NULL;
+ if (expire_lease6(&expired_iaaddr, pool, 1000) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: expire_lease6() %s:%d\n", MDL);
+ }
+ if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
+ }
+}
+
+
+ATF_TC(small_pool);
+ATF_TC_HEAD(small_pool, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case checks that small pool "
+ "is handled properly.");
+}
+ATF_TC_BODY(small_pool, tc)
+{
+ struct in6_addr addr;
+ struct ipv6_pool *pool;
+ struct iasubopt *iaaddr;
+ struct data_string ds;
+ unsigned int attempts;
+
+ /*
+ * Test 8: small pool
+ */
+ pool = NULL;
+ addr.s6_addr[14] = 0x81;
+ if (ipv6_pool_allocate(&pool, 0, &addr, 127, 128, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
+ }
+ if (create_lease6(pool, &iaaddr, &attempts,
+ &ds, 42) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: create_lease6() %s:%d\n", MDL);
+ }
+ if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: renew_lease6() %s:%d\n", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_dereference() %s:%d\n", MDL);
+ }
+ if (create_lease6(pool, &iaaddr, &attempts,
+ &ds, 11) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: create_lease6() %s:%d\n", MDL);
+ }
+ if (renew_lease6(pool, iaaddr) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: renew_lease6() %s:%d\n", MDL);
+ }
+ if (iasubopt_dereference(&iaaddr, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: iasubopt_dereference() %s:%d\n", MDL);
+ }
+ if (create_lease6(pool, &iaaddr, &attempts,
+ &ds, 11) != ISC_R_NORESOURCES) {
+ atf_tc_fail("ERROR: create_lease6() %s:%d\n", MDL);
+ }
+ if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
+ }
+ addr.s6_addr[14] = 0;
+}
+
+ATF_TC(many_pools);
+ATF_TC_HEAD(many_pools, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case checks that functions "
+ "across all pools are working correctly.");
+}
+ATF_TC_BODY(many_pools, tc)
+{
+ struct in6_addr addr;
+ struct ipv6_pool *pool;
+
+ /*
+ * Test 9: functions across all pools
+ */
+ pool = NULL;
+ if (ipv6_pool_allocate(&pool, 0, &addr, 64, 128, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_allocate() %s:%d\n", MDL);
+ }
+ if (add_ipv6_pool(pool) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: add_ipv6_pool() %s:%d\n", MDL);
+ }
+ if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
+ }
+ pool = NULL;
+ if (find_ipv6_pool(&pool, 0, &addr) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: find_ipv6_pool() %s:%d\n", MDL);
+ }
+ if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
+ }
+ inet_pton(AF_INET6, "1:2:3:4:ffff:ffff:ffff:ffff", &addr);
+ pool = NULL;
+ if (find_ipv6_pool(&pool, 0, &addr) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: find_ipv6_pool() %s:%d\n", MDL);
+ }
+ if (ipv6_pool_dereference(&pool, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ipv6_pool_dereference() %s:%d\n", MDL);
+ }
+ inet_pton(AF_INET6, "1:2:3:5::", &addr);
+ pool = NULL;
+ if (find_ipv6_pool(&pool, 0, &addr) != ISC_R_NOTFOUND) {
+ atf_tc_fail("ERROR: find_ipv6_pool() %s:%d\n", MDL);
+ }
+ inet_pton(AF_INET6, "1:2:3:3:ffff:ffff:ffff:ffff", &addr);
+ pool = NULL;
+ if (find_ipv6_pool(&pool, 0, &addr) != ISC_R_NOTFOUND) {
+ atf_tc_fail("ERROR: find_ipv6_pool() %s:%d\n", MDL);
+ }
+
+/* iaid = 666;
+ ia_na = NULL;
+ if (ia_allocate(&ia_na, iaid, "TestDUID", 8, MDL) != ISC_R_SUCCESS) {
+ atf_tc_fail("ERROR: ia_allocate() %s:%d\n", MDL);
+ }*/
+
+ {
+ struct in6_addr r;
+ struct data_string ds;
+ u_char data[16];
+ char buf[64];
+ int i, j;
+
+ memset(&ds, 0, sizeof(ds));
+ memset(data, 0xaa, sizeof(data));
+ ds.len = 16;
+ ds.data = data;
+
+ inet_pton(AF_INET6, "3ffe:501:ffff:100::", &addr);
+ for (i = 32; i < 42; i++)
+ for (j = i + 1; j < 49; j++) {
+ memset(&r, 0, sizeof(r));
+ memset(buf, 0, 64);
+ build_prefix6(&r, &addr, i, j, &ds);
+ inet_ntop(AF_INET6, &r, buf, 64);
+ printf("%d,%d-> %s/%d\n", i, j, buf, j);
+ }
+ }
+}
+
+ATF_TP_ADD_TCS(tp)
+{
+ ATF_TP_ADD_TC(tp, iaaddr_basic);
+ ATF_TP_ADD_TC(tp, iaaddr_negative);
+ ATF_TP_ADD_TC(tp, ia_na_basic);
+ ATF_TP_ADD_TC(tp, ia_na_manyaddrs);
+ ATF_TP_ADD_TC(tp, ia_na_negative);
+ ATF_TP_ADD_TC(tp, ipv6_pool_basic);
+ ATF_TP_ADD_TC(tp, ipv6_pool_negative);
+ ATF_TP_ADD_TC(tp, expire_order);
+ ATF_TP_ADD_TC(tp, small_pool);
+ ATF_TP_ADD_TC(tp, many_pools);
+
+ return (atf_no_error());
+}
diff --git a/server/tests/simple_unittest.c b/server/tests/simple_unittest.c
new file mode 100644
index 00000000..e6d04b90
--- /dev/null
+++ b/server/tests/simple_unittest.c
@@ -0,0 +1,77 @@
+/*
+ * Copyright (C) 2012 Internet Systems Consortium, Inc. ("ISC")
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+ * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+ * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+ * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+ * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include <config.h>
+#include <atf-c.h>
+
+/* That is an example ATF test case, tailored to ISC DHCP sources.
+ For detailed description with examples, see man 3 atf-c-api. */
+
+/* this macro defines a name of a test case. Typical test case constists
+ of an initial test declaration (ATF_TC()) followed by 3 phases:
+
+ - Initialization: ATF_TC_HEAD()
+ - Main body: ATF_TC_BODY()
+ - Cleanup: ATF_TC_CLEANUP()
+
+ In many cases initialization or cleanup are not needed. Use
+ ATF_TC_WITHOUT_HEAD() or ATF_TC_WITH_CLEANUP() as needed. */
+ATF_TC(simple_test_case);
+
+
+ATF_TC_HEAD(simple_test_case, tc)
+{
+ atf_tc_set_md_var(tc, "descr", "This test case is a simple DHCP test.");
+}
+ATF_TC_BODY(simple_test_case, tc)
+{
+ int condition = 1;
+ int this_is_linux = 1;
+ /* Failing condition will fail the test, but the code
+ itself will continue */
+ ATF_CHECK( 2 > 1 );
+
+ /* assert style check. Test will abort if the condition is not met. */
+ ATF_REQUIRE( 5 > 4 );
+
+ ATF_CHECK_EQ(4, 2 + 2); /* Non-fatal test. */
+ ATF_REQUIRE_EQ(4, 2 + 2); /* Fatal test. */
+
+ /* tests can also explicitly report test result */
+ if (!condition) {
+ atf_tc_fail("Condition not met!"); /* Explicit failure. */
+ }
+
+ if (!this_is_linux) {
+ atf_tc_skip("Skipping test. This Linux-only test.");
+ }
+
+ if (condition && this_is_linux) {
+ /* no extra comments for pass needed. It just passed. */
+ atf_tc_pass();
+ }
+
+}
+
+/* This macro defines main() method that will call specified
+ test cases. tp and simple_test_case names can be whatever you want
+ as long as it is a valid variable identifier. */
+ATF_TP_ADD_TCS(tp)
+{
+ ATF_TP_ADD_TC(tp, simple_test_case);
+
+ return (atf_no_error());
+}
diff --git a/tests/HOWTO-unit-test b/tests/HOWTO-unit-test
index b38185c9..b84beba3 100644
--- a/tests/HOWTO-unit-test
+++ b/tests/HOWTO-unit-test
@@ -1,153 +1,63 @@
Introduction
------------
+That is only a brief overview of tests in ISC DHCP. For more thorough
+description, see ISC DHCP Developer's Guide. You can generate it, by
+having Doxygen installed and doing:
+
+ cd doc
+ make devel
+
+and then opening doc/html/index.html
+
+Tests Overview
+--------------
+
In DHCP, a unit test exercises a particular piece of code in
isolation. There is a separate unit test per module or API. Each unit
test lives in a directory beneath the code it is designed to exercise.
-So, we have:
+So, we (will eventually) have:
+ server/tests/
client/tests/
common/tests/
dhcpctl/tests/
And so on.
-Ideally each function would be invoked with every possible type of
-input, and each branch of every function would be checked. In practice
-we try to be a bit more pragmatic, and target the most basic
-operations, as well tricky code, and areas we have seen bugs in the
-past.
-
+We are using ATF (Automated Test Framework) as a framework to run our
+unittests. See ISC DHCP Developer's Guide for much more thorough
+description of unit-test and ATF framework in general.
Running Unit Tests
------------------
-In order to run the unit tests for DHCP, use:
+In order to run the unit tests for DHCP, enable ATF support during configure:
+
+$ ./configure --with-atf
+
+And then use:
$ make check
-This will run all of the unit tests.
+This will run all of the unit tests. Make sure that ATF is actually
+installed and that you have atf-run and atf-report tool in your PATH.
You can run a single test by going to the appropriate test directory
and invoking the test directly:
-$ cd common/tests
-$ make test_alloc
-$ ./test_alloc
+$ cd server/tests
+$ atf-run | atf-report
There are also a number of options that you can use when running a
-test. To see these, use the "-u" flag on the program.
-
+test. See atf-run and atf-report documentation.
Adding a New Unit Test
----------------------
-To add an additional test to an existing test program, you must create
-a function for the new test in the C source file:
-
-static void
-mynewtest(void) {
- static const char *test_desc = "describe the test";
-
- t_assert("mynewtest", 1, T_REQUIRED, test_desc);
-
- /* ... test code ... */
-
- t_result(T_PASS);
-}
-
-Then add this function to the T_testlist[] array in the file:
-
-testspec_t T_testlist[] = {
- ...
- { mynewtest, "some new test" },
- { NULL, NULL }
-};
-
-Then you should be able to compile and run your new test.
-
+See ISC DHCP Developer's Guide.
Adding a New Unit Test Program
------------------------------
-To add a new program, such as when a new module is added, you can copy
-the "unit_test_sample.c" file (in this directory) to a new name, add
-the new file as a target in Makefile.am, and begin adding tests. Do
-not forget to add it to CVS via "cvs add".
-
-If there is no "tests" directory for a given subdirectory, then one
-must be created. This can be done by:
-
-1. Creating the directory:
-
- $ mkdir $subdir/tests
- $ cvs add tests
-
-2. Adding the subdirectory to the build system:
-
- Add to $subdir/Makefile.am:
-
- SUBDIRS = tests
-
- Add to the AC_OUTPUT macro in configure.ac:
-
- $subdir/tests/Makefile
-
-3. Create a Makefile.am in the new directory, something like this:
-
- AM_CPPFLAGS = -I../..
-
- check_PROGRAMS = test_foo
-
- TESTS = test_foo
-
- test_foo_SOURCES = test_foo.c
- test_foo_LDADD = ../../tests/libt_api.a # plus others...
-
-
-See existing Makefile.am for examples, and the Automake documentation:
-
- http://www.gnu.org/software/automake/manual/html_node/Tests.html
-
-
-Support Functions
------------------
-
-Here are a few of the most useful functions defined in t_api that you
-can use in testing:
-
- void
- t_assert(const char *component, int anum, int class,
- const char *what, ...);
-
- The name of this function is slightly misleading. It
- actually just prints out an error message in the test
- output.
-
- void
- t_info(const char *format, ...);
-
- Prints out a message in the test output. You should
- include "\n" at the end.
-
- void
- t_result(int result);
-
- Prints out the result in the test output. You should
- use one of the constants for this:
-
- T_PASS
- T_FAIL
- T_UNRESOLVED
- T_UNSUPPORTED
- T_UNTESTED
- T_THREADONLY
-
-Additional Testing
-------------------
-
-Other static or runtime testing is always an option. For instance, you
-can use valgrind to check for memory leaks.
-
-
-$Id: HOWTO-unit-test,v 1.2 2007/11/16 11:04:12 shane Exp $
+See ISC DHCP Developer's Guide.