Merge lp:~stefan.goetz-deactivatedaccount/hipl/unittests into lp:hipl

[Stefan Götz]

This branch introduces the unit test framework 'check' (http://check.sourceforge.net/) to HIPL.

It was recently discussed on hipl-dev how useful unit tests were. I added a small number of tests of very simple HIPL functions to the testing suite and found several code bugs as well as inconsistencies between documentation and implementation. So I think there is at least some value to unit tests. So the question is whether this framework should be adopted in HIPL and whether developers are willing to embrace unit testing, maybe for new code?

[Miika Komu (miika-iki)]

Great! I think this is a welcome addition for everyone. While the changes seem fine to me, I would hope someone else reviews the code too.

What about testing old code? Would it be ok the abuse the unit test framework for benign system tests too? We could test the hipd through loopback using e.g. one of the ways described below:

a. fail_unless(hipd_main(LOOPBACK_TEST_FLAG), ..)
b. use a thread to kick hipd up, fail_unless(hip_map_id_to_addr(..), ..) and fail_unless(ICMPv6 fails as in modules/heartbeat/hipd/heartbeat.c)
c. fail_unless(hip_send_i1(..), ..) and fail_unless(hip_receive_r1(..), ..), etc

[Stefan Götz (stefan.goetz-deactivatedaccount)]

Hi!

> Great! I think this is a welcome addition for everyone.

Yay :-) Do you think it would make sense to have a policy around unit tests?
Something like 'You must not commit added code that is not covered by unit
tests'? It sounds appealing for the code quality but it's also a bit of work,
and there would definitely need to be some form of consensus on the topic, I
guess :)

> I would hope someone else reviews the code too.

A note I had been forgetting: the sample tests fail all over the place, not
because they are buggy but because they find actual implementation problems. I'm
having another branch in the pipes that would take care of these issues in the
hipl code and make all unit tests succeed.

> a. fail_unless(hipd_main(LOOPBACK_TEST_FLAG), ..)
> b. use a thread to kick hipd up, fail_unless(hip_map_id_to_addr(..), ..) and fail_unless(ICMPv6 fails as in modules/heartbeat/hipd/heartbeat.c)
> c. fail_unless(hip_send_i1(..), ..) and fail_unless(hip_receive_r1(..), ..), etc

It might work, although I'm not too sure how gracefully check handles threading.
Maybe one simply needs to try. Would such a test need to be run with root
privileges?

Stefan
--
Stefan Götz, Ph.D. Student
Distributed Systems Group
Chair for Computer Science IV, RWTH Aachen, Germany
http://ds.rwth-aachen.de/members/goetz/

[Miika Komu (miika-iki)]

Hi,

On 10/18/2010 10:52 AM, Stefan Götz wrote:
> Hi!
>
>> Great! I think this is a welcome addition for everyone.
>
> Yay :-) Do you think it would make sense to have a policy around unit tests?
> Something like 'You must not commit added code that is not covered by unit
> tests'? It sounds appealing for the code quality but it's also a bit of work,
> and there would definitely need to be some form of consensus on the topic, I
> guess :)

not a bad idea!

>> I would hope someone else reviews the code too.
>
> A note I had been forgetting: the sample tests fail all over the place, not
> because they are buggy but because they find actual implementation problems. I'm
> having another branch in the pipes that would take care of these issues in the
> hipl code and make all unit tests succeed.

Thanks.

>> a. fail_unless(hipd_main(LOOPBACK_TEST_FLAG), ..)
>> b. use a thread to kick hipd up, fail_unless(hip_map_id_to_addr(..), ..) and fail_unless(ICMPv6 fails as in modules/heartbeat/hipd/heartbeat.c)
>> c. fail_unless(hip_send_i1(..), ..) and fail_unless(hip_receive_r1(..), ..), etc
>
> It might work, although I'm not too sure how gracefully check handles threading.
> Maybe one simply needs to try. Would such a test need to be run with root
> privileges?

Alternatives (a) and (c) could be implemented without threads. All of
the alternatives could be implemented without root privileges if the raw
sockets would be disabled (i.e. hipconf nat plain-udp).

[René Hummen (rene-hummen)]

Your code adds 'check' as a dependency for HIPL on all platforms. I suggest to implement an option in configure.ac that allows configuring 'check' functionality with AC_CHECK_LIB and to surround all occurrences of testing implementations by an if HIP_UNITTEST ... endif in the Makefile.am.

This will remove the dependency for default compilations.

[Stefan Götz (stefan.goetz-deactivatedaccount)]

Hi René!

> Your code adds 'check' as a dependency for HIPL on all platforms. I suggest to implement an option in configure.ac [...]

Hm, please note that only 'make check' has this dependency, i.e., when someone
wants to run the unit tests anyway. So someone who just wants to build the HIPL
binaries from source via 'make' does not depend on check on any platform.

Is it really useful to have a configure option to disable the unit tests, even
if one can simply choose not to run them in the first place?

But you reminded me that the INSTALL file should be updated to note that 'check'
is a recommended dependency for developers.

Stefan

[lp:~stefan.goetz-deactivatedaccount/hipl/unittests]

4999. By Stefan Götz on 2010-10-19

- added line at end of file for good style

5000. By Stefan Götz on 2010-10-19

- added a warning that it is ok for the unit tests to use forward declarations but everyone else should use header files

5001. By Stefan Götz on 2010-10-19

- added a brief semi-explanation why certain forward declarations are necessary

5002. By Stefan Götz on 2010-10-19

- emit a warning at configure time if the check library needed for unit tests is not found

[Stefan Götz (stefan.goetz-deactivatedaccount)]

Hi Rene!

> surround all occurrences of testing
> implementations by an if HIP_UNITTEST ... endif in the Makefile.am.

So I guess what you are asking for is a ./configure command line option that allows one to exclude unit tests and thus the dependency on check from a build?

Stefan

[lp:~stefan.goetz-deactivatedaccount/hipl/unittests]

5003. By Stefan Götz on 2010-10-19

Prevent test units from being compiled and run when the check library is not available
- added the Automake conditional HIP_UNITTESTS
- made the inclusion of the unit tests depend on HIP_UNITTESS in Makefile.am

5004. By Stefan Götz on 2010-10-19

Documented how to unit test for an assertion to occur.

5005. By Stefan Götz on 2010-10-19

Documented the check library as another optional dependency

[Stefan Götz (stefan.goetz-deactivatedaccount)]

I think I addressed all concerns raised here. This branch currently merges into the trunk without conflicts. It's ready to go in, from my side.

[Stefan Götz (stefan.goetz-deactivatedaccount)]

Merge blocker #1:

On 10/19/2010 02:49 PM, Christof Mroz wrote:
> There should be an explicit statement about how to test static functions in
> HACKING, I think. Since tests routines are located in separate files, these
> can't be called so easily. You may say that testing a non-public interface is
> against the "spirit" of unit testing, but a quick google search reveals its
> demand nevertheless.
> I can think of at least one concrete coverage in HIPL that can't trivially be
> "induced" by high-level functions even though the function is referentially
> transparent by nature.
>
> Either way, there should be a consistent and documented policy.

I agree. I will take care of that today or tomorrow.

Merge blocker #2:

(Rene Hummen:) Makefile.am unnecessarily adds the linker option '-lcheck', needs to be removed.

review: Needs Fixing

[lp:~stefan.goetz-deactivatedaccount/hipl/unittests]

5006. By Stefan Götz on 2010-10-19

Clean up automake configuration for unit tests:
- removed unnecessary explicit -lcheck switch in Makefile.am
- used the correct configure variable to decide whether libcheck was found and to automatically generate the -lcheck switch

This fixes merge blocker #2

5007. By Stefan Götz on 2010-10-19

Documented a policy and a how-to on testing static functions.
- added the policy
- clarified the test organisation to be able to refer to it in the policy

This should remove merge blocker #1.

[Stefan Götz (stefan.goetz-deactivatedaccount)]

Revisions 5006 and 5007 address all remaining merge blockers. The branch applies cleanly to the current trunk revision 5028. If there aren't any other issues, I herewith re-request merging this branch to trunk :-)

review: Approve

[Miika Komu (miika-iki)]

Seems good to me.

review: Approve

[lp:~stefan.goetz-deactivatedaccount/hipl/unittests]

5008. By Stefan Götz on 2010-10-20

Handle absence of libcheck correctly
Symptom of bug: The configure script detects the absence of libcheck but running 'make check' tries to compile the unit tests nevertheless and fails.
Cause of bug: configure.ac converts the result of the configure-time test for libcheck into a make-visible variable by testing whether the auto-generated test variable ac_cv_lib_check_suite_create is empty, based on the assumption that is empty if libcheck is absent, and that it is non-empty if libcheck is present. However, ac_cv_lib_check_suite_create is never empty and contains either 'no' or 'yes'.
Bug fix: Test for the variable value 'yes' instead of any non-empty value to determine that libcheck is present.

=== modified file 'INSTALL'
--- INSTALL	2010-10-11 17:00:58 +0000
+++ INSTALL	2010-10-20 08:48:52 +0000
@@ -27,7 +27,8 @@
 Make and gcc. openssl, iptables, libcap and libconfig are required complete
 with development headers. For Perl, Socket6, IO::Socket::INET6, Net::IP and
 Net::DNS modules are required. You can optionally install xmlto to
-build the HOWTO and doxygen to build the code documentation.
+build the HOWTO and doxygen to build the code documentation. Installing the
+optional check library (http://check.sourceforge.net/) enables unit tests. 
 
 On Ubuntu, the following command(s) should solve the dependencies:
 
@@ -35,7 +36,7 @@
     iptables-dev libcap-dev libnet-ip-perl libnet-dns-perl \
     libsocket6-perl libio-socket-inet6-perl
 
-  Optionally: aptitude install pax miredo bzr xmlto doxygen
+  Optionally: aptitude install pax miredo bzr xmlto doxygen check
 
 On Fedora, the following command(s) should solve the dependencies:
 

=== modified file 'Makefile.am'
--- Makefile.am	2010-10-01 17:59:52 +0000
+++ Makefile.am	2010-10-20 08:48:52 +0000
@@ -38,6 +38,16 @@
 lib_LTLIBRARIES += lib/modularization/libmod.la
 
 
+### tests ###
+TESTS           =
+check_PROGRAMS  =
+
+if HIP_UNITTESTS
+TESTS           += check_lib_core
+check_PROGRAMS  += check_lib_core
+endif
+
+
 ### source declarations ###
 
 test_auth_performance_SOURCES = test/auth_performance.c
@@ -151,6 +161,10 @@
 
 lib_modularization_libmod_la_SOURCES = lib/modularization/lmod.c
 
+check_lib_core_SOURCES =    test/check_lib_core.c          \
+                            test/lib/core/hit.c            \
+                            test/lib/core/straddr.c
+
 # Initialize LDADD lists empty, because modules might add entries to LDADD. The
 # module LDADDs need to be included before the standard LDADDs, because modules
 # can depend on the core code.
@@ -166,6 +180,7 @@
 
 ### library dependencies ###
 
+check_lib_core_LDADD           = lib/core/libhipcore.la
 firewall_hipfw_LDADD          += lib/core/libhipcore.la
 hipd_hipd_LDADD               += lib/modularization/libmod.la \
                                  lib/core/libhipcore.la

=== modified file 'configure.ac'
--- configure.ac	2010-10-05 16:45:22 +0000
+++ configure.ac	2010-10-20 08:48:52 +0000
@@ -39,6 +39,10 @@
               AH_TEMPLATE(HAVE_EC_CRYPTO, [Defined to 1 if ec is enabled.]),)
 # We need the math lib in the registration extension.
 AC_CHECK_LIB(m, pow,, AC_MSG_ERROR(Math lib not found))
+# The unit tests depend on 'check' (http://check.sourceforge.net/)
+AC_CHECK_LIB(check, suite_create,,
+			 AC_MSG_WARN(libcheck (http://check.sourceforge.net/) not found: HIPL unit tests are not available),)
+AM_CONDITIONAL(HIP_UNITTESTS, test x"$ac_cv_lib_check_suite_create" = xyes)
 
 # If no --prefix option is passed to configure, $prefix is empty. But we want
 # to expand $sysconfdir, which defaults to ${prefix}/etc. So set $prefix.

=== modified file 'doc/HACKING'
--- doc/HACKING	2010-10-18 16:16:10 +0000
+++ doc/HACKING	2010-10-20 08:48:52 +0000
@@ -684,6 +684,122 @@
 
 Modify the numbers depending on your hardware to suit your needs.
 
+UNIT TESTS
+==========
+You can (and are recommended to) use unit testing to improve code quality.
+
+The command
+
+#> make check
+
+runs the existing unit tests.
+HIPL uses the check framework (http://check.sourceforge.net/) for unit tests.
+It is available in source and binary form, e.g. the Debian package 'check'.
+
+What To Test?
+-------------
+Unit tests check whether implementations conform to their specification (i.e.,
+their documentation). Some rules of thumb for writing tests are:
+
+- test the documented aspects of a function: does it behave as expected? does
+  it catch invalid input as documented?
+
+- test undocumented aspects of a function: how does it handle invalid input
+  (e.g., NULL pointers, empty strings, negative integers) that the compiler
+  cannot catch?
+
+Test coverage: At the very least, tests should ensure that a function can
+handle valid and invalid input as documented. Ideally, they also test corner
+cases and unusual input and state. Obviously, unit tests are limited
+in testing whether a function fully behaves as documented because that can be
+very complex, slow, or impossible on a local system. 
+
+Unit Tests Organizition
+-----------------------
+The unit tests are organized as follows:
+
+- all test code resides in the test directory. The directories below test
+  mirror those in the main hipl directory to organize the tests in the same
+  layout.  
+
+- test programs: There is one test program per hipl component. At the time of
+  this writing, the only test program is check_lib_core for all tests that
+  relate to the files from lib/core. By convention, each test program is
+  called check_<component name> where <component name> is the name of the
+  directory that contains the component. Test programs are defined in
+  Makefile.am.
+
+- test suites: Each test program consists of several test suites, one for each
+  implementation file to test. By convention, the tests of the test suite for
+  lib/core/hit.c are contained in test/lib/core/hit.c, which exports them as a
+  suite to the check_lib_core test program.
+ 
+- tests: Each test suite consists of one or more tests that test a specific
+  aspect of a function from the implementation. For example, the test function
+  test_hip_convert_hit_to_str_valid() in test/lib/core/hit.c tests whether the
+  function hip_convert_hit_to_str() from lib/core/hit.c works as expected with
+  valid input parameters. By convention, the test function is called
+  test_<function under test>_<test aspect>().
+
+Adding Unit Tests
+-----------------
+To add a unit test for the function foo() in the file hipd/bar.c, follow these
+steps:
+
+* If it does not exist, create a test program for the hipd component:
+  - copy an existing test program implementation (test/check_*.c) to
+    test/check_hipd.c
+  - remove the existing "extern Suite" and "srunner_add_suite()" statements
+  - in Makefile.am:
+  	* add the check_hipd test program to TESTS
+  	* add the check_hipd test program to check_PROGRAMS
+  	* add the file test/check_hipd.c to check_hipd_SOURCES 
+  	* add the check library from the check framework and all libraries your
+  	  test program depends on (usually the same as the original component hipd)
+  	  to check_hipd_LDADD
+  - create the directory test/hipd for your test suites
+  - re-run the automake tool chain
+* If it does not exist, create the test suite for the file hipd/bar.c:
+  - copy an existing test suite (test/hipd/*.c) to test/hipd/bar.c.
+  - in test/hipd/bar.c, make sure you include the test target's header file
+    (#include "hipd/bar.h" in this example) 
+  - in test/hipd/bar.c, remove all tests and tcase_add_test() statements
+  - in test/hipd/bar.c, adapt the name of the test suite in the invocation of
+  	suite_create() to "hipd/bar"
+  - add test/hipd/bar.c to check_hipd_SOURCES in Makefile.am
+  - re-run the automake tool chain
+* Create the test case:
+  - implement the test function called test_foo_<test aspect>() in
+    test/hipd/bar.c (see other test suites and the check documentation for
+    details)
+  - register the test function to the test suite by adding a corresponding
+    tcase_add_test() function call to hipd_bar() in test/hipd/bar.c.
+    If you'd like to test for an HIP_ASSERT() to occur, use
+    tcase_add_exit_test().
+  - run "make check"
+
+Testing Static Functions
+------------------------
+Usually, unit tests are not intended to apply to static functions and doing so
+is difficult because these functions are not accessible by test programs
+from outside of the files that define them. However, static functions
+are commonplace in HIPL and often form relevant test targets. Developers are
+thus encouraged to apply unit tests to static functions as well as to
+non-static functions with external visibility.
+
+There are two approaches to making static functions visible within the test
+programs (adopting the names from the organization example above):
+
+a) Instead of including hipd/bar.h, include the implementation file hipd/bar.c
+   directly. While not an elegant solution, it is the simplest approach that
+   should work in most cases.
+
+b) For the test target static foo() create the wrapper foo_test_wrapper() that
+   is not static. Declare all such wrappers in hipd/bar_test_wrappers.h and
+   include that file instead of hipd/bar.h. While more effort, this is cleaner
+   than solution a) and should work where a) prooves problematic.
+
+
 DEBUGGING
 =========
 

=== added file 'test/README.UNITTESTS'
--- test/README.UNITTESTS	1970-01-01 00:00:00 +0000
+++ test/README.UNITTESTS	2010-10-20 08:48:52 +0000
@@ -0,0 +1,5 @@
+Run the unit tests via
+
+#> make check
+
+For more information, see doc/HACKING

=== added file 'test/check_lib_core.c'
--- test/check_lib_core.c	1970-01-01 00:00:00 +0000
+++ test/check_lib_core.c	2010-10-20 08:48:52 +0000
@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2010 Aalto University and RWTH Aachen University.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * @file
+ * @brief Unit tests of lib/core (see doc/HACKING on unit tests).
+ * @author Stefan Goetz <[e-mail]>
+ */
+#include <stdlib.h>
+#include <check.h>
+
+// Import test suite functions from their respective C files via forward
+// declarations.
+// Since each test C file exports only one such function which is only used
+// right here, a dedicated header file for each of them adds unnecessary file
+// clutter in this particular case of unit tests.
+// Do not adopt this HFAS (header-file-avoidance-scheme) (TM) in HIPL production
+// code as header files are generally a good idea, just not here.
+extern Suite *lib_core_hit (void);
+extern Suite *lib_core_straddr (void);
+
+int main(void)
+{
+    int number_failed;
+    SRunner *sr = srunner_create(lib_core_hit());
+    srunner_add_suite(sr, lib_core_straddr());
+    
+    srunner_run_all(sr, CK_NORMAL);
+    number_failed = srunner_ntests_failed(sr);
+    srunner_free(sr);
+    return (number_failed == 0) ? EXIT_SUCCESS : EXIT_FAILURE;
+}
+

=== added directory 'test/lib'
=== added directory 'test/lib/core'
=== added file 'test/lib/core/hit.c'
--- test/lib/core/hit.c	1970-01-01 00:00:00 +0000
+++ test/lib/core/hit.c	2010-10-20 08:48:52 +0000
@@ -0,0 +1,195 @@
+/*
+ * Copyright (c) 2010 Aalto University and RWTH Aachen University.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * @file
+ * @author Stefan Goetz <[e-mail]>
+ */
+#include <check.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdio.h>
+#include "lib/core/hit.h"
+
+START_TEST(test_hip_convert_hit_to_str_valid)
+{
+    char buf[64];
+    hip_hit_t hit;
+    fail_unless(hip_convert_hit_to_str(&hit, "", buf) == 0, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_convert_hit_to_str_null_hit)
+{
+    char buf[64];
+    hip_convert_hit_to_str(NULL, "", buf);
+}
+END_TEST
+
+START_TEST(test_hip_convert_hit_to_str_null_buf)
+{
+    hip_hit_t hit;
+    fail_unless(hip_convert_hit_to_str(&hit, "", NULL) == 1, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_convert_hit_to_str_null_prefix)
+{
+    char buf[64];
+    hip_hit_t hit;
+    fail_unless(hip_convert_hit_to_str(&hit, NULL, buf) == 0, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_convert_hit_to_str_bounds)
+{
+    const char suffix[] = "SFX";
+    const unsigned int BEFORE_LEN = 30;
+    const unsigned int HIT_LEN = 39; // 16 bytes -> 32 hex chars + 7 ':'s
+    const unsigned int SUFFIX_LEN = sizeof(suffix); // includes null char
+    const unsigned int AFTER_LEN = 30;
+    char buf[BEFORE_LEN + HIT_LEN + SUFFIX_LEN + AFTER_LEN] = { 1 };
+    char ones[BEFORE_LEN + HIT_LEN + SUFFIX_LEN + AFTER_LEN] = { 1 };
+    hip_hit_t hit;
+    memset(&hit.s6_addr, 0x22, sizeof(hit.s6_addr));
+
+    // write the HIT string into the middle of the buffer
+    fail_unless(hip_convert_hit_to_str(&hit, suffix, buf + BEFORE_LEN) == 0, NULL);
+    // is the buffer before the HIT untouched?
+    fail_unless(memcmp(buf, ones, BEFORE_LEN) == 0, NULL);
+    // is the first part of the HIT correct?
+    fail_unless(*(buf + BEFORE_LEN) == '2', NULL);
+    // is the last part of the HIT correct?
+    fail_unless(*(buf + BEFORE_LEN + HIT_LEN - 1) == '2', NULL);
+    // is the suffix correct including the terminating null character?
+    fail_unless(memcmp(buf + BEFORE_LEN + HIT_LEN, suffix, SUFFIX_LEN) == 0, NULL);
+    // is the buffer after the suffix untouched?
+    fail_unless(memcmp(buf + BEFORE_LEN + HIT_LEN + SUFFIX_LEN, ones, AFTER_LEN) == 0, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_hit_is_bigger_bigger)
+{
+    const hip_hit_t bigger = IN6ADDR_LOOPBACK_INIT;
+    const hip_hit_t smaller = IN6ADDR_ANY_INIT;
+    fail_unless(hip_hit_is_bigger(&bigger, &smaller) == 1, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_hit_is_bigger_equal_smaller)
+{
+    const hip_hit_t bigger = IN6ADDR_LOOPBACK_INIT;
+    const hip_hit_t smaller = IN6ADDR_ANY_INIT;
+    fail_unless(hip_hit_is_bigger(&smaller, &bigger) == 0, NULL);
+    fail_unless(hip_hit_is_bigger(&bigger, &bigger) == 0, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_hit_is_bigger_first_null)
+{
+    hip_hit_t hit;
+    hip_hit_is_bigger(NULL, &hit);
+}
+END_TEST
+
+START_TEST(test_hip_hit_is_bigger_second_null)
+{
+    hip_hit_t hit;
+    hip_hit_is_bigger(&hit, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_hit_are_equal_equality)
+{
+    const hip_hit_t hit1 = IN6ADDR_LOOPBACK_INIT;
+    const hip_hit_t hit2 = IN6ADDR_LOOPBACK_INIT;
+    fail_unless(hip_hit_are_equal(&hit1, &hit2) == 1, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_hit_are_equal_inequality)
+{
+    const hip_hit_t bigger = IN6ADDR_LOOPBACK_INIT;
+    const hip_hit_t smaller = IN6ADDR_ANY_INIT;
+    fail_unless(hip_hit_are_equal(&bigger, &smaller) == 1, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_hit_are_equal_first_null)
+{
+    hip_hit_t hit;
+    hip_hit_are_equal(NULL, &hit);
+}
+END_TEST
+
+START_TEST(test_hip_hit_are_equal_second_null)
+{
+    hip_hit_t hit;
+    hip_hit_are_equal(&hit, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_hash_hit_valid)
+{
+    const hip_hit_t hit = IN6ADDR_ANY_INIT;
+    hip_hash_hit(&hit);
+}
+END_TEST
+
+START_TEST(test_hip_hash_hit_null)
+{
+    hip_hash_hit(NULL);
+}
+END_TEST
+
+// For unknown reasons, this file does not compile with the following,
+// seemingly useless forward declaration
+Suite *lib_core_hit(void);
+
+Suite *lib_core_hit(void)
+{
+    Suite *s = suite_create("lib/core/hit");
+
+    TCase *tc_core = tcase_create("Core");
+    tcase_add_test(tc_core, test_hip_convert_hit_to_str_valid);
+    tcase_add_exit_test(tc_core, test_hip_convert_hit_to_str_null_hit, 1);
+    tcase_add_test(tc_core, test_hip_convert_hit_to_str_null_buf);
+    tcase_add_test(tc_core, test_hip_convert_hit_to_str_null_prefix);
+    tcase_add_test(tc_core, test_hip_convert_hit_to_str_bounds);
+    tcase_add_test(tc_core, test_hip_hit_is_bigger_bigger);
+    tcase_add_test(tc_core, test_hip_hit_is_bigger_equal_smaller);
+    tcase_add_exit_test(tc_core, test_hip_hit_is_bigger_first_null, 1);
+    tcase_add_exit_test(tc_core, test_hip_hit_is_bigger_second_null, 1);
+    tcase_add_test(tc_core, test_hip_hit_are_equal_equality);
+    tcase_add_test(tc_core, test_hip_hit_are_equal_inequality);
+    tcase_add_exit_test(tc_core, test_hip_hit_are_equal_first_null, 1);
+    tcase_add_exit_test(tc_core, test_hip_hit_are_equal_second_null, 1);
+    tcase_add_test(tc_core, test_hip_hash_hit_valid);
+    tcase_add_exit_test(tc_core, test_hip_hash_hit_null, 1);
+    suite_add_tcase(s, tc_core);
+
+    return s;
+}
+

=== added file 'test/lib/core/straddr.c'
--- test/lib/core/straddr.c	1970-01-01 00:00:00 +0000
+++ test/lib/core/straddr.c	2010-10-20 08:48:52 +0000
@@ -0,0 +1,195 @@
+/*
+ * Copyright (c) 2010 Aalto University and RWTH Aachen University.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * @file
+ * @author Stefan Goetz <[e-mail]>
+ */
+#include <check.h>
+#include <stdlib.h> // free()
+#include "lib/core/straddr.h"
+
+START_TEST(test_convert_string_to_address_v4_valid)
+{
+    const char *str = "127.0.0.1";
+    struct in_addr ip;
+
+    fail_unless(convert_string_to_address_v4(str, &ip) == 0, NULL);
+}
+END_TEST
+
+START_TEST(test_convert_string_to_address_v4_null_str)
+{
+    struct in_addr ip;
+
+    fail_unless(convert_string_to_address_v4(NULL, &ip) < 0, NULL);
+}
+END_TEST
+
+START_TEST(test_convert_string_to_address_v4_null_addr)
+{
+    const char *str = "127.0.0.1";
+
+    fail_unless(convert_string_to_address_v4(str, NULL) < 0, NULL);
+}
+END_TEST
+
+START_TEST(test_convert_string_to_address_v4_invalid)
+{
+    const char *str = " 127.0.0.1";
+    struct in_addr ip;
+
+    fail_unless(convert_string_to_address_v4(str, &ip) < 0, NULL);
+}
+END_TEST
+
+START_TEST(test_convert_string_to_address_valid)
+{
+    const char *str = "fe80::215:58ff:fe29:9c36";
+    struct in6_addr ip;
+
+    fail_unless(convert_string_to_address(str, &ip) == 0, NULL);
+}
+END_TEST
+
+START_TEST(test_convert_string_to_address_null_str)
+{
+    struct in6_addr ip;
+
+    fail_unless(convert_string_to_address(NULL, &ip) < 0, NULL);
+}
+END_TEST
+
+START_TEST(test_convert_string_to_address_null_addr)
+{
+    const char *str = "fe80::215:58ff:fe29:9c36";
+
+    fail_unless(convert_string_to_address(str, NULL) < 0, NULL);
+}
+END_TEST
+
+START_TEST(test_convert_string_to_address_invalid)
+{
+    const char *str = " fe80::215:58ff:fe29:9c36";
+    struct in6_addr ip;
+
+    fail_unless(convert_string_to_address(str, &ip) < 0, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_string_to_lowercase_valid)
+{
+    char to[128] = { 1 };
+    char ones[128] = { 1 };
+    const char from[] = "TesT";
+    const size_t count = sizeof(from) - 1;
+    const unsigned int offset = 32;
+
+    fail_unless(hip_string_to_lowercase(to + offset, from, count) == 0, NULL);
+    // was from correctly converted to lower case?
+    fail_unless(memcmp(to + offset, "test", count) == 0, NULL);
+    // is the beginning of to still intact?
+    fail_unless(memcmp(to, ones, offset) == 0, NULL);
+    // is the rest of to still intact?
+    fail_unless(memcmp(to + offset + count, ones, offset) == 0, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_string_is_digit_valid)
+{
+    fail_unless(hip_string_is_digit("123456789") == 0, NULL);
+    fail_unless(hip_string_is_digit("abc") < 0, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_string_is_digit_null)
+{
+    fail_unless(hip_string_is_digit(NULL) < 0, NULL);
+}
+END_TEST
+
+START_TEST(test_hip_string_is_digit_empty)
+{
+    fail_unless(hip_string_is_digit("") < 0, NULL);
+}
+END_TEST
+
+START_TEST(test_base64_encode_valid)
+{
+    const char b64[] = "VGVzdA==";
+    unsigned char buf[] = "Test";
+    unsigned int len = sizeof(buf) - 1; // do not include null character as per doc
+    unsigned char *result = NULL;
+
+    fail_unless((result = base64_encode(buf, len)) != NULL, NULL);
+    fail_unless(strcmp((char*)result, b64) == 0, NULL);
+    free(result); // note it's not documented that we need to free the returned memory
+}
+END_TEST
+
+START_TEST(test_base64_encode_null_buf)
+{
+    fail_unless(base64_encode(NULL, 42) == NULL, NULL);
+}
+END_TEST
+
+START_TEST(test_base64_encode_empty_buf)
+{
+    unsigned char buf[] = "";
+    unsigned char *result = NULL;
+
+    fail_unless((result = base64_encode(buf, 0)) != NULL, NULL);
+    fail_unless(strlen((char *)result) == 0, NULL);
+}
+END_TEST
+
+// For unknown reasons, this file does not compile with the following,
+// seemingly useless forward declaration
+Suite *lib_core_straddr(void);
+
+Suite *lib_core_straddr(void)
+{
+    Suite *s = suite_create("lib/core/straddr");
+
+    TCase *tc_core = tcase_create("Core");
+    tcase_add_test(tc_core, test_convert_string_to_address_v4_valid);
+    tcase_add_test(tc_core, test_convert_string_to_address_v4_null_str);
+    tcase_add_test(tc_core, test_convert_string_to_address_v4_null_addr);
+    tcase_add_test(tc_core, test_convert_string_to_address_v4_invalid);
+    tcase_add_test(tc_core, test_convert_string_to_address_valid);
+    tcase_add_test(tc_core, test_convert_string_to_address_null_str);
+    tcase_add_test(tc_core, test_convert_string_to_address_null_addr);
+    tcase_add_test(tc_core, test_convert_string_to_address_invalid);
+    tcase_add_test(tc_core, test_hip_string_to_lowercase_valid);
+    tcase_add_test(tc_core, test_hip_string_is_digit_valid);
+    tcase_add_test(tc_core, test_hip_string_is_digit_null);
+    tcase_add_test(tc_core, test_hip_string_is_digit_empty);
+    tcase_add_test(tc_core, test_base64_encode_valid);
+    tcase_add_test(tc_core, test_base64_encode_null_buf);
+    tcase_add_test(tc_core, test_base64_encode_empty_buf);
+    suite_add_tcase(s, tc_core);
+
+    return s;
+}