]> granicus.if.org Git - p11-kit/commitdiff
Add testing and start testing hash table functionality.
authorStef Walter <stefw@collabora.co.uk>
Wed, 26 Jan 2011 18:46:14 +0000 (12:46 -0600)
committerStef Walter <stefw@collabora.co.uk>
Wed, 26 Jan 2011 18:46:14 +0000 (12:46 -0600)
12 files changed:
.gitignore
Makefile.am
configure.ac
module/Makefile.am
module/hash.c
module/hash.h
tests/Makefile.am [new file with mode: 0644]
tests/cutest/CuTest.c [new file with mode: 0644]
tests/cutest/CuTest.h [new file with mode: 0644]
tests/cutest/README.txt [new file with mode: 0644]
tests/cutest/license.txt [new file with mode: 0644]
tests/hash-test.c [new file with mode: 0644]

index aa242e53c2f6b29c9d001583f97ddb699b174e23..8cbe5e9ef895b891548b54864fc596c93f2a4a63 100644 (file)
@@ -2,6 +2,9 @@
 *.la
 *.lo
 *.tar.gz
+*.gcno
+*.gcda
+*.gcov
 
 .deps
 .libs
@@ -29,3 +32,8 @@ Makefile
 Makefile.in
 missing
 stamp-h1
+temp.txt
+
+/tests/coverage
+/tests/coverage.info
+/tests/hash-test
index df12be0f8358ee61d3202d83186671e669f86993..d7e1bc2fd846f391fa013f9f837739ccc0353966 100644 (file)
@@ -1,5 +1,5 @@
 
-SUBDIRS = module
+SUBDIRS = module tests
 
 ACLOCAL_AMFLAGS = -I m4
 
@@ -16,3 +16,13 @@ dist-hook:
        else \
                echo A git clone is required to generate a ChangeLog >&2; \
        fi
+
+if WITH_COVERAGE
+coverage:
+       mkdir -p tests/coverage
+       $(LCOV) --directory . --zerocounters
+       $(MAKE) check
+       $(LCOV) --directory . --capture --output-file tests/coverage.info
+       $(GENHTML) --output-directory tests/coverage tests/coverage.info
+       @echo "file://$(abs_top_builddir)/tests/coverage/index.html"
+endif
index 29b50be135b2d37fb7a4f8e5b93d26772fc16124..079a2c075a741cfbd0dcb1a2596d733ee0f2c654 100644 (file)
@@ -72,6 +72,47 @@ if test "$GCC" = "yes" -a "$set_more_warnings" != "no"; then
        done
 fi
 
+# ----------------------------------------------------------------------
+# Coverage
+
+AC_MSG_CHECKING([whether to build with gcov testing])
+AC_ARG_ENABLE([coverage],
+               AS_HELP_STRING([--enable-coverage],
+                       [Whether to enable coverage testing ]),
+               [],
+               [enable_coverage=no])
+
+AC_MSG_RESULT([$enable_coverage])
+
+if test "$enable_coverage" = "yes"; then
+       if test "$GCC" != "yes"; then
+               AC_MSG_ERROR(Coverage testing requires GCC)
+       fi
+
+       AC_PATH_PROG(GCOV, gcov, no)
+       if test "$GCOV" = "no" ; then
+               AC_MSG_ERROR(gcov tool is not available)
+       fi
+
+       AC_PATH_PROG(LCOV, lcov, no)
+       if test "$LCOV" = "no" ; then
+               AC_MSG_ERROR(lcov tool is not installed)
+       fi
+
+       AC_PATH_PROG(GENHTML, genhtml, no)
+       if test "$GENHTML" = "no" ; then
+               AC_MSG_ERROR(lcov's genhtml tool is not installed)
+       fi
+
+       CFLAGS="$CFLAGS -O0 -g -fprofile-arcs -ftest-coverage"
+       LDFLAGS="$LDFLAGS -lgcov"
+fi
+
+AM_CONDITIONAL([WITH_COVERAGE], [test "$enable_coverage" = "yes"])
+AC_SUBST(LCOV)
+AC_SUBST(GCOV)
+AC_SUBST(GENHTML)
+
 # ---------------------------------------------------------------------
 # Debug mode
 
@@ -89,6 +130,7 @@ fi
 
 AC_CONFIG_FILES([Makefile
                module/Makefile
+               tests/Makefile
                ])
 AC_OUTPUT
 
index c3fcad24b0ed8ee47c1a76225bbb03b5c252bf11..6103485e7fabbdeeda0c914040795bd37e346587 100644 (file)
@@ -10,13 +10,21 @@ MODULE_SRCS = \
        p11-kit-proxy.c \
        p11-kit-private.h p11-kit.h
 
-lib_LTLIBRARIES = p11-kit.la
+lib_LTLIBRARIES = \
+       libp11-kit.la
 
-p11_kit_la_LDFLAGS = \
-       -module -avoid-version \
+noinst_LTLIBRARIES = \
+       libp11-kit-testable.la
+
+libp11_kit_la_LDFLAGS = \
        -no-undefined -export-symbols-regex 'C_GetFunctionList'
 
-p11_kit_la_SOURCES = $(MODULE_SRCS)
+libp11_kit_la_SOURCES = $(MODULE_SRCS)
+
+libp11_kit_testable_la_LDFLAGS = \
+       -no-undefined
+
+libp11_kit_testable_la_SOURCES = $(MODULE_SRCS)
 
 EXTRA_DIST = \
        pkcs11.h
\ No newline at end of file
index 84d57a277f1647d20f230c21ca9c9d73b0f6a062..30efcedb4cea7851184742f0b1f1c200f62c4375 100644 (file)
@@ -424,6 +424,21 @@ hash_ulongptr_equal (const void *ulong_one, const void *ulong_two)
        return *((unsigned long*)ulong_one) == *((unsigned long*)ulong_two);
 }
 
+unsigned int
+hash_intptr_hash (const void *to_int)
+{
+       assert (to_int);
+       return (unsigned int)*((unsigned long*)to_int);
+}
+
+int
+hash_intptr_equal (const void *int_one, const void *int_two)
+{
+       assert (int_one);
+       assert (int_two);
+       return *((unsigned long*)int_one) == *((unsigned long*)int_two);
+}
+
 unsigned int
 hash_direct_hash (const void *ptr)
 {
index 8649ed5235ee57c473fc6d9360ae1259c8515113..eb3c496f1eda66d20c8b1ed3496dd9c78e6cbecb 100644 (file)
@@ -174,6 +174,11 @@ unsigned int       hash_ulongptr_hash          (const void *to_ulong);
 int                hash_ulongptr_equal         (const void *ulong_one,
                                                 const void *ulong_two);
 
+unsigned int       hash_intptr_hash            (const void *to_int);
+
+int                hash_intptr_equal           (const void *int_one,
+                                                const void *int_two);
+
 unsigned int       hash_direct_hash            (const void *ptr);
 
 int                hash_direct_equal           (const void *ptr_one,
diff --git a/tests/Makefile.am b/tests/Makefile.am
new file mode 100644 (file)
index 0000000..56a5620
--- /dev/null
@@ -0,0 +1,17 @@
+
+INCLUDES = \
+       -I$(top_srcdir) \
+       -I$(top_srcdir)/module \
+       -Icutest
+
+noinst_PROGRAMS = \
+       hash-test
+
+hash_test_SOURCES = \
+       hash-test.c
+
+hash_test_LDADD = \
+       $(top_builddir)/module/libp11-kit-testable.la
+
+check-am:
+       ./hash-test
diff --git a/tests/cutest/CuTest.c b/tests/cutest/CuTest.c
new file mode 100644 (file)
index 0000000..dc7ebd9
--- /dev/null
@@ -0,0 +1,339 @@
+#include <assert.h>
+#include <setjmp.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <math.h>
+
+#include "CuTest.h"
+
+/*-------------------------------------------------------------------------*
+ * CuStr
+ *-------------------------------------------------------------------------*/
+
+char* CuStrAlloc(int size)
+{
+       char* newStr = (char*) malloc( sizeof(char) * (size) );
+       return newStr;
+}
+
+char* CuStrCopy(const char* old)
+{
+       int len = strlen(old);
+       char* newStr = CuStrAlloc(len + 1);
+       strcpy(newStr, old);
+       return newStr;
+}
+
+/*-------------------------------------------------------------------------*
+ * CuString
+ *-------------------------------------------------------------------------*/
+
+void CuStringInit(CuString* str)
+{
+       str->length = 0;
+       str->size = STRING_MAX;
+       str->buffer = (char*) malloc(sizeof(char) * str->size);
+       str->buffer[0] = '\0';
+}
+
+CuString* CuStringNew(void)
+{
+       CuString* str = (CuString*) malloc(sizeof(CuString));
+       str->length = 0;
+       str->size = STRING_MAX;
+       str->buffer = (char*) malloc(sizeof(char) * str->size);
+       str->buffer[0] = '\0';
+       return str;
+}
+
+void CuStringDelete(CuString *str)
+{
+        if (!str) return;
+        free(str->buffer);
+        free(str);
+}
+
+void CuStringResize(CuString* str, int newSize)
+{
+       str->buffer = (char*) realloc(str->buffer, sizeof(char) * newSize);
+       str->size = newSize;
+}
+
+void CuStringAppend(CuString* str, const char* text)
+{
+       int length;
+
+       if (text == NULL) {
+               text = "NULL";
+       }
+
+       length = strlen(text);
+       if (str->length + length + 1 >= str->size)
+               CuStringResize(str, str->length + length + 1 + STRING_INC);
+       str->length += length;
+       strcat(str->buffer, text);
+}
+
+void CuStringAppendChar(CuString* str, char ch)
+{
+       char text[2];
+       text[0] = ch;
+       text[1] = '\0';
+       CuStringAppend(str, text);
+}
+
+void CuStringAppendFormat(CuString* str, const char* format, ...)
+{
+       va_list argp;
+       char buf[HUGE_STRING_LEN];
+       va_start(argp, format);
+       vsprintf(buf, format, argp);
+       va_end(argp);
+       CuStringAppend(str, buf);
+}
+
+void CuStringInsert(CuString* str, const char* text, int pos)
+{
+       int length = strlen(text);
+       if (pos > str->length)
+               pos = str->length;
+       if (str->length + length + 1 >= str->size)
+               CuStringResize(str, str->length + length + 1 + STRING_INC);
+       memmove(str->buffer + pos + length, str->buffer + pos, (str->length - pos) + 1);
+       str->length += length;
+       memcpy(str->buffer + pos, text, length);
+}
+
+/*-------------------------------------------------------------------------*
+ * CuTest
+ *-------------------------------------------------------------------------*/
+
+void CuTestInit(CuTest* t, const char* name, TestFunction function)
+{
+       t->name = CuStrCopy(name);
+       t->failed = 0;
+       t->ran = 0;
+       t->message = NULL;
+       t->function = function;
+       t->jumpBuf = NULL;
+}
+
+CuTest* CuTestNew(const char* name, TestFunction function)
+{
+       CuTest* tc = CU_ALLOC(CuTest);
+       CuTestInit(tc, name, function);
+       return tc;
+}
+
+void CuTestDelete(CuTest *t)
+{
+        if (!t) return;
+        free(t->name);
+        free(t);
+}
+
+void CuTestRun(CuTest* tc)
+{
+       jmp_buf buf;
+       tc->jumpBuf = &buf;
+       if (setjmp(buf) == 0)
+       {
+               tc->ran = 1;
+               (tc->function)(tc);
+       }
+       tc->jumpBuf = 0;
+}
+
+static void CuFailInternal(CuTest* tc, const char* file, int line, CuString* string)
+{
+       char buf[HUGE_STRING_LEN];
+
+       sprintf(buf, "%s:%d: ", file, line);
+       CuStringInsert(string, buf, 0);
+
+       tc->failed = 1;
+       tc->message = string->buffer;
+       if (tc->jumpBuf != 0) longjmp(*(tc->jumpBuf), 0);
+}
+
+void CuFail_Line(CuTest* tc, const char* file, int line, const char* message2, const char* message)
+{
+       CuString string;
+
+       CuStringInit(&string);
+       if (message2 != NULL)
+       {
+               CuStringAppend(&string, message2);
+               CuStringAppend(&string, ": ");
+       }
+       CuStringAppend(&string, message);
+       CuFailInternal(tc, file, line, &string);
+}
+
+void CuAssert_Line(CuTest* tc, const char* file, int line, const char* message, int condition)
+{
+       if (condition) return;
+       CuFail_Line(tc, file, line, NULL, message);
+}
+
+void CuAssertStrEquals_LineMsg(CuTest* tc, const char* file, int line, const char* message,
+       const char* expected, const char* actual)
+{
+       CuString string;
+       if ((expected == NULL && actual == NULL) ||
+           (expected != NULL && actual != NULL &&
+            strcmp(expected, actual) == 0))
+       {
+               return;
+       }
+
+       CuStringInit(&string);
+       if (message != NULL)
+       {
+               CuStringAppend(&string, message);
+               CuStringAppend(&string, ": ");
+       }
+       CuStringAppend(&string, "expected <");
+       CuStringAppend(&string, expected);
+       CuStringAppend(&string, "> but was <");
+       CuStringAppend(&string, actual);
+       CuStringAppend(&string, ">");
+       CuFailInternal(tc, file, line, &string);
+}
+
+void CuAssertIntEquals_LineMsg(CuTest* tc, const char* file, int line, const char* message,
+       int expected, int actual)
+{
+       char buf[STRING_MAX];
+       if (expected == actual) return;
+       sprintf(buf, "expected <%d> but was <%d>", expected, actual);
+       CuFail_Line(tc, file, line, message, buf);
+}
+
+void CuAssertDblEquals_LineMsg(CuTest* tc, const char* file, int line, const char* message,
+       double expected, double actual, double delta)
+{
+       char buf[STRING_MAX];
+       if (fabs(expected - actual) <= delta) return;
+       sprintf(buf, "expected <%f> but was <%f>", expected, actual);
+
+       CuFail_Line(tc, file, line, message, buf);
+}
+
+void CuAssertPtrEquals_LineMsg(CuTest* tc, const char* file, int line, const char* message,
+       void* expected, void* actual)
+{
+       char buf[STRING_MAX];
+       if (expected == actual) return;
+       sprintf(buf, "expected pointer <0x%p> but was <0x%p>", expected, actual);
+       CuFail_Line(tc, file, line, message, buf);
+}
+
+
+/*-------------------------------------------------------------------------*
+ * CuSuite
+ *-------------------------------------------------------------------------*/
+
+void CuSuiteInit(CuSuite* testSuite)
+{
+       testSuite->count = 0;
+       testSuite->failCount = 0;
+        memset(testSuite->list, 0, sizeof(testSuite->list));
+}
+
+CuSuite* CuSuiteNew(void)
+{
+       CuSuite* testSuite = CU_ALLOC(CuSuite);
+       CuSuiteInit(testSuite);
+       return testSuite;
+}
+
+void CuSuiteDelete(CuSuite *testSuite)
+{
+        unsigned int n;
+        for (n=0; n < MAX_TEST_CASES; n++)
+        {
+                if (testSuite->list[n])
+                {
+                        CuTestDelete(testSuite->list[n]);
+                }
+        }
+        free(testSuite);
+
+}
+
+void CuSuiteAdd(CuSuite* testSuite, CuTest *testCase)
+{
+       assert(testSuite->count < MAX_TEST_CASES);
+       testSuite->list[testSuite->count] = testCase;
+       testSuite->count++;
+}
+
+void CuSuiteAddSuite(CuSuite* testSuite, CuSuite* testSuite2)
+{
+       int i;
+       for (i = 0 ; i < testSuite2->count ; ++i)
+       {
+               CuTest* testCase = testSuite2->list[i];
+               CuSuiteAdd(testSuite, testCase);
+       }
+}
+
+void CuSuiteRun(CuSuite* testSuite)
+{
+       int i;
+       for (i = 0 ; i < testSuite->count ; ++i)
+       {
+               CuTest* testCase = testSuite->list[i];
+               CuTestRun(testCase);
+               if (testCase->failed) { testSuite->failCount += 1; }
+       }
+}
+
+void CuSuiteSummary(CuSuite* testSuite, CuString* summary)
+{
+       int i;
+       for (i = 0 ; i < testSuite->count ; ++i)
+       {
+               CuTest* testCase = testSuite->list[i];
+               CuStringAppend(summary, testCase->failed ? "F" : ".");
+       }
+       CuStringAppend(summary, "\n\n");
+}
+
+void CuSuiteDetails(CuSuite* testSuite, CuString* details)
+{
+       int i;
+       int failCount = 0;
+
+       if (testSuite->failCount == 0)
+       {
+               int passCount = testSuite->count - testSuite->failCount;
+               const char* testWord = passCount == 1 ? "test" : "tests";
+               CuStringAppendFormat(details, "OK (%d %s)\n", passCount, testWord);
+       }
+       else
+       {
+               if (testSuite->failCount == 1)
+                       CuStringAppend(details, "There was 1 failure:\n");
+               else
+                       CuStringAppendFormat(details, "There were %d failures:\n", testSuite->failCount);
+
+               for (i = 0 ; i < testSuite->count ; ++i)
+               {
+                       CuTest* testCase = testSuite->list[i];
+                       if (testCase->failed)
+                       {
+                               failCount++;
+                               CuStringAppendFormat(details, "%d) %s: %s\n",
+                                       failCount, testCase->name, testCase->message);
+                       }
+               }
+               CuStringAppend(details, "\n!!!FAILURES!!!\n");
+
+               CuStringAppendFormat(details, "Runs: %d ",   testSuite->count);
+               CuStringAppendFormat(details, "Passes: %d ", testSuite->count - testSuite->failCount);
+               CuStringAppendFormat(details, "Fails: %d\n",  testSuite->failCount);
+       }
+}
diff --git a/tests/cutest/CuTest.h b/tests/cutest/CuTest.h
new file mode 100644 (file)
index 0000000..6246eee
--- /dev/null
@@ -0,0 +1,116 @@
+#ifndef CU_TEST_H
+#define CU_TEST_H
+
+#include <setjmp.h>
+#include <stdarg.h>
+
+#define CUTEST_VERSION  "CuTest 1.5"
+
+/* CuString */
+
+char* CuStrAlloc(int size);
+char* CuStrCopy(const char* old);
+
+#define CU_ALLOC(TYPE)         ((TYPE*) malloc(sizeof(TYPE)))
+
+#define HUGE_STRING_LEN        8192
+#define STRING_MAX             256
+#define STRING_INC             256
+
+typedef struct
+{
+       int length;
+       int size;
+       char* buffer;
+} CuString;
+
+void CuStringInit(CuString* str);
+CuString* CuStringNew(void);
+void CuStringRead(CuString* str, const char* path);
+void CuStringAppend(CuString* str, const char* text);
+void CuStringAppendChar(CuString* str, char ch);
+void CuStringAppendFormat(CuString* str, const char* format, ...);
+void CuStringInsert(CuString* str, const char* text, int pos);
+void CuStringResize(CuString* str, int newSize);
+void CuStringDelete(CuString* str);
+
+/* CuTest */
+
+typedef struct CuTest CuTest;
+
+typedef void (*TestFunction)(CuTest *);
+
+struct CuTest
+{
+       char* name;
+       TestFunction function;
+       int failed;
+       int ran;
+       const char* message;
+       jmp_buf *jumpBuf;
+};
+
+void CuTestInit(CuTest* t, const char* name, TestFunction function);
+CuTest* CuTestNew(const char* name, TestFunction function);
+void CuTestRun(CuTest* tc);
+void CuTestDelete(CuTest *t);
+
+/* Internal versions of assert functions -- use the public versions */
+void CuFail_Line(CuTest* tc, const char* file, int line, const char* message2, const char* message);
+void CuAssert_Line(CuTest* tc, const char* file, int line, const char* message, int condition);
+void CuAssertStrEquals_LineMsg(CuTest* tc,
+       const char* file, int line, const char* message,
+       const char* expected, const char* actual);
+void CuAssertIntEquals_LineMsg(CuTest* tc,
+       const char* file, int line, const char* message,
+       int expected, int actual);
+void CuAssertDblEquals_LineMsg(CuTest* tc,
+       const char* file, int line, const char* message,
+       double expected, double actual, double delta);
+void CuAssertPtrEquals_LineMsg(CuTest* tc,
+       const char* file, int line, const char* message,
+       void* expected, void* actual);
+
+/* public assert functions */
+
+#define CuFail(tc, ms)                        CuFail_Line(  (tc), __FILE__, __LINE__, NULL, (ms))
+#define CuAssert(tc, ms, cond)                CuAssert_Line((tc), __FILE__, __LINE__, (ms), (cond))
+#define CuAssertTrue(tc, cond)                CuAssert_Line((tc), __FILE__, __LINE__, "assert failed", (cond))
+
+#define CuAssertStrEquals(tc,ex,ac)           CuAssertStrEquals_LineMsg((tc),__FILE__,__LINE__,NULL,(ex),(ac))
+#define CuAssertStrEquals_Msg(tc,ms,ex,ac)    CuAssertStrEquals_LineMsg((tc),__FILE__,__LINE__,(ms),(ex),(ac))
+#define CuAssertIntEquals(tc,ex,ac)           CuAssertIntEquals_LineMsg((tc),__FILE__,__LINE__,NULL,(ex),(ac))
+#define CuAssertIntEquals_Msg(tc,ms,ex,ac)    CuAssertIntEquals_LineMsg((tc),__FILE__,__LINE__,(ms),(ex),(ac))
+#define CuAssertDblEquals(tc,ex,ac,dl)        CuAssertDblEquals_LineMsg((tc),__FILE__,__LINE__,NULL,(ex),(ac),(dl))
+#define CuAssertDblEquals_Msg(tc,ms,ex,ac,dl) CuAssertDblEquals_LineMsg((tc),__FILE__,__LINE__,(ms),(ex),(ac),(dl))
+#define CuAssertPtrEquals(tc,ex,ac)           CuAssertPtrEquals_LineMsg((tc),__FILE__,__LINE__,NULL,(ex),(ac))
+#define CuAssertPtrEquals_Msg(tc,ms,ex,ac)    CuAssertPtrEquals_LineMsg((tc),__FILE__,__LINE__,(ms),(ex),(ac))
+
+#define CuAssertPtrNotNull(tc,p)        CuAssert_Line((tc),__FILE__,__LINE__,"null pointer unexpected",(p != NULL))
+#define CuAssertPtrNotNullMsg(tc,msg,p) CuAssert_Line((tc),__FILE__,__LINE__,(msg),(p != NULL))
+
+/* CuSuite */
+
+#define MAX_TEST_CASES 1024
+
+#define SUITE_ADD_TEST(SUITE,TEST)     CuSuiteAdd(SUITE, CuTestNew(#TEST, TEST))
+
+typedef struct
+{
+       int count;
+       CuTest* list[MAX_TEST_CASES];
+       int failCount;
+
+} CuSuite;
+
+
+void CuSuiteInit(CuSuite* testSuite);
+CuSuite* CuSuiteNew(void);
+void CuSuiteDelete(CuSuite *testSuite);
+void CuSuiteAdd(CuSuite* testSuite, CuTest *testCase);
+void CuSuiteAddSuite(CuSuite* testSuite, CuSuite* testSuite2);
+void CuSuiteRun(CuSuite* testSuite);
+void CuSuiteSummary(CuSuite* testSuite, CuString* summary);
+void CuSuiteDetails(CuSuite* testSuite, CuString* details);
+
+#endif /* CU_TEST_H */
diff --git a/tests/cutest/README.txt b/tests/cutest/README.txt
new file mode 100644 (file)
index 0000000..96e8853
--- /dev/null
@@ -0,0 +1,211 @@
+HOW TO USE
+
+You can use CuTest to create unit tests to drive your development
+in the style of Extreme Programming. You can also add unit tests to
+existing code to ensure that it works as you suspect.
+
+Your unit tests are an investment. They let you to change your
+code and add new features confidently without worrying about
+accidentally breaking earlier features.
+
+
+LICENSING
+
+For details on licensing see license.txt.
+
+
+GETTING STARTED
+
+To add unit testing to your C code the only files you need are
+CuTest.c and CuTest.h.
+
+CuTestTest.c and AllTests.c have been included to provide an
+example of how to write unit tests and then how to aggregate them
+into suites and into a single AllTests.c file. Suites allow you
+to put group tests into logical sets. AllTests.c combines all the
+suites and runs them.
+
+You should not have to look inside CuTest.c. Looking in
+CuTestTest.c and AllTests.c (for example usage) should be
+sufficient.
+
+After downloading the sources, run your compiler to create an
+executable called AllTests.exe. For example, if you are using
+Windows with the cl.exe compiler you would type:
+
+    cl.exe AllTests.c CuTest.c CuTestTest.c
+    AllTests.exe
+
+This will run all the unit tests associated with CuTest and print
+the output on the console. You can replace cl.exe with gcc or
+your favorite compiler in the command above.
+
+
+DETAILED EXAMPLE
+
+Here is a more detailed example. We will work through a simple
+test first exercise. The goal is to create a library of string
+utilities. First, lets write a function that converts a
+null-terminated string to all upper case.
+
+Ensure that CuTest.c and CuTest.h are accessible from your C
+project. Next, create a file called StrUtil.c with these
+contents:
+
+    #include "CuTest.h"
+
+    char* StrToUpper(char* str) {
+        return str;
+    }
+
+    void TestStrToUpper(CuTest *tc) {
+        char* input = strdup("hello world");
+        char* actual = StrToUpper(input);
+        char* expected = "HELLO WORLD";
+        CuAssertStrEquals(tc, expected, actual);
+    }
+
+    CuSuite* StrUtilGetSuite() {
+        CuSuite* suite = CuSuiteNew();
+        SUITE_ADD_TEST(suite, TestStrToUpper);
+        return suite;
+    }
+
+Create another file called AllTests.c with these contents:
+
+    #include "CuTest.h"
+
+    CuSuite* StrUtilGetSuite();
+
+    void RunAllTests(void) {
+        CuString *output = CuStringNew();
+        CuSuite* suite = CuSuiteNew();
+
+        CuSuiteAddSuite(suite, StrUtilGetSuite());
+
+        CuSuiteRun(suite);
+        CuSuiteSummary(suite, output);
+        CuSuiteDetails(suite, output);
+        printf("%s\n", output->buffer);
+    }
+
+    int main(void) {
+        RunAllTests();
+    }
+
+Then type this on the command line:
+
+    gcc AllTests.c CuTest.c StrUtil.c
+
+to compile. You can replace gcc with your favorite compiler.
+CuTest should be portable enough to handle all Windows and Unix
+compilers. Then to run the tests type:
+
+    a.out
+
+This will print an error because we haven't implemented the
+StrToUpper function correctly. We are just returning the string
+without changing it to upper case.
+
+    char* StrToUpper(char* str) {
+        return str;
+    }
+
+Rewrite this as follows:
+
+    char* StrToUpper(char* str) {
+        char* p;
+        for (p = str ; *p ; ++p) *p = toupper(*p);
+        return str;
+    }
+
+Recompile and run the tests again. The test should pass this
+time.
+
+
+WHAT TO DO NEXT
+
+At this point you might want to write more tests for the
+StrToUpper function. Here are some ideas:
+
+TestStrToUpper_EmptyString :  pass in ""
+TestStrToUpper_UpperCase   :  pass in "HELLO WORLD"
+TestStrToUpper_MixedCase   :  pass in "HELLO world"
+TestStrToUpper_Numbers     :  pass in "1234 hello"
+
+As you write each one of these tests add it to StrUtilGetSuite
+function. If you don't the tests won't be run. Later as you write
+other functions and write tests for them be sure to include those
+in StrUtilGetSuite also. The StrUtilGetSuite function should
+include all the tests in StrUtil.c
+
+Over time you will create another file called FunkyStuff.c
+containing other functions unrelated to StrUtil. Follow the same
+pattern. Create a FunkyStuffGetSuite function in FunkyStuff.c.
+And add FunkyStuffGetSuite to AllTests.c.
+
+The framework is designed in the way it is so that it is easy to
+organize a lot of tests.
+
+THE BIG PICTURE
+
+Each individual test corresponds to a CuTest. These are grouped
+to form a CuSuite. CuSuites can hold CuTests or other CuSuites.
+AllTests.c collects all the CuSuites in the program into a single
+CuSuite which it then runs as a single CuSuite.
+
+The project is open source so feel free to take a peek under the
+hood at the CuTest.c file to see how it works. CuTestTest.c
+contains tests for CuTest.c. So CuTest tests itself.
+
+Since AllTests.c has a main() you will need to exclude this when
+you are building your product. Here is a nicer way to do this if
+you want to avoid messing with multiple builds. Remove the main()
+in AllTests.c. Note that it just calls RunAllTests(). Instead
+we'll call this directly from the main program.
+
+Now in the main() of the actual program check to see if the
+command line option "--test" was passed. If it was then I call
+RunAllTests() from AllTests.c. Otherwise run the real program.
+
+Shipping the tests with the code can be useful. If you customers
+complain about a problem you can ask them to run the unit tests
+and send you the output. This can help you to quickly isolate the
+piece of your system that is malfunctioning in the customer's
+environment.
+
+CuTest offers a rich set of CuAssert functions. Here is a list:
+
+void CuAssert(CuTest* tc, char* message, int condition);
+void CuAssertTrue(CuTest* tc, int condition);
+void CuAssertStrEquals(CuTest* tc, char* expected, char* actual);
+void CuAssertIntEquals(CuTest* tc, int expected, int actual);
+void CuAssertPtrEquals(CuTest* tc, void* expected, void* actual);
+void CuAssertPtrNotNull(CuTest* tc, void* pointer);
+
+The project is open source and so you can add other more powerful
+asserts to make your tests easier to write and more concise.
+Please feel free to send me changes you make so that I can
+incorporate them into future releases.
+
+If you see any errors in this document please contact me at
+asimjalis@peakprogramming.com.
+
+
+AUTOMATING TEST SUITE GENERATION
+
+make-tests.sh will grep through all the .c files in the current
+directory and generate the code to run all the tests contained in
+them. Using this script you don't have to worry about writing
+AllTests.c or dealing with any of the other suite code.
+
+
+CREDITS
+
+These people have contributed useful code changes to the CuTest project.
+Thanks!
+
+- [02.23.2003] Dave Glowacki <dglo@hyde.ssec.wisc.edu>
+- [04.17.2009] Tobias Lippert <herrmarder@googlemail.com>
+- [11.13.2009] Eli Bendersky <eliben@gmail.com>
+- [12.14.2009] Andrew Brown <abrown@datasci.com>
diff --git a/tests/cutest/license.txt b/tests/cutest/license.txt
new file mode 100644 (file)
index 0000000..3d94167
--- /dev/null
@@ -0,0 +1,38 @@
+NOTE
+
+The license is based on the zlib/libpng license. For more details see
+http://www.opensource.org/licenses/zlib-license.html. The intent of the
+license is to:
+
+- keep the license as simple as possible
+- encourage the use of CuTest in both free and commercial applications
+  and libraries
+- keep the source code together
+- give credit to the CuTest contributors for their work
+
+If you ship CuTest in source form with your source distribution, the
+following license document must be included with it in unaltered form.
+If you find CuTest useful we would like to hear about it.
+
+LICENSE
+
+Copyright (c) 2003 Asim Jalis
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+claim that you wrote the original software. If you use this software in
+a product, an acknowledgment in the product documentation would be
+appreciated but is not required.
+
+2. Altered source versions must be plainly marked as such, and must not
+be misrepresented as being the original software.
+
+3. This notice may not be removed or altered from any source
+distribution.
diff --git a/tests/hash-test.c b/tests/hash-test.c
new file mode 100644 (file)
index 0000000..2efa5a9
--- /dev/null
@@ -0,0 +1,377 @@
+/*
+ * Copyright (c) 2011, Collabora Ltd.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *     * Redistributions of source code must retain the above
+ *       copyright notice, this list of conditions and the
+ *       following disclaimer.
+ *     * Redistributions in binary form must reproduce the
+ *       above copyright notice, this list of conditions and
+ *       the following disclaimer in the documentation and/or
+ *       other materials provided with the distribution.
+ *     * The names of contributors to this software may not be
+ *       used to endorse or promote products derived from this
+ *       software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+ * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+ * DAMAGE.
+ *
+ * Author: Stef Walter <stefw@collabora.co.uk>
+ */
+
+#include "config.h"
+#include "CuTest.h"
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+
+#include "hash.h"
+
+static void
+test_hash_create (CuTest *tc)
+{
+       hash_t *ht;
+
+       ht = hash_create (hash_direct_hash, hash_direct_equal, NULL, NULL);
+       CuAssertPtrNotNull (tc, ht);
+       hash_free (ht);
+}
+
+static void
+test_hash_free_null (CuTest *tc)
+{
+       hash_free (NULL);
+}
+
+static void
+destroy_key (void *data)
+{
+       int *key = data;
+       *key = 1;
+}
+
+static void
+destroy_value (void *data)
+{
+       int *value = data;
+       *value = 2;
+}
+
+static void
+test_hash_free_destroys (CuTest *tc)
+{
+       hash_t *ht;
+       int key = 0;
+       int value = 0;
+
+       ht = hash_create (hash_direct_hash, hash_direct_equal, destroy_key, destroy_value);
+       CuAssertPtrNotNull (tc, ht);
+       if (!hash_set (ht, &key, &value))
+               CuFail (tc, "should not be reached");
+       hash_free (ht);
+
+       CuAssertIntEquals (tc, 1, key);
+       CuAssertIntEquals (tc, 2, value);
+}
+
+static void
+test_hash_iterate (CuTest *tc)
+{
+       hash_t *ht;
+       hash_iter_t hi;
+       int key = 1;
+       int value = 2;
+       void *pkey;
+       void *pvalue;
+       int ret;
+
+       ht = hash_create (hash_direct_hash, hash_direct_equal, NULL, NULL);
+       CuAssertPtrNotNull (tc, ht);
+       if (!hash_set (ht, &key, &value))
+               CuFail (tc, "should not be reached");
+
+       hash_iterate (ht, &hi);
+
+       ret = hash_next (&hi, &pkey, &pvalue);
+       CuAssertIntEquals (tc, 1, ret);
+       CuAssertPtrEquals (tc, pkey, &key);
+       CuAssertPtrEquals (tc, pvalue, &value);
+
+       ret = hash_next (&hi, &pkey, &pvalue);
+       CuAssertIntEquals (tc, 0, ret);
+
+       hash_free (ht);
+}
+
+static void
+test_hash_set_get (CuTest *tc)
+{
+       char *key = "KEY";
+       char *value = "VALUE";
+       char *check;
+       hash_t *ht;
+
+       ht = hash_create (hash_string_hash, hash_string_equal, NULL, NULL);
+       hash_set (ht, key, value);
+       check = hash_get (ht, key);
+       CuAssertPtrEquals (tc, check, value);
+
+       hash_free (ht);
+}
+
+static void
+test_hash_set_get_remove (CuTest *tc)
+{
+       char *key = "KEY";
+       char *value = "VALUE";
+       char *check;
+       hash_t *ht;
+       int ret;
+
+       ht = hash_create (hash_string_hash, hash_string_equal, NULL, NULL);
+
+       if (!hash_set (ht, key, value))
+               CuFail (tc, "should not be reached");
+
+       check = hash_get (ht, key);
+       CuAssertPtrEquals (tc, check, value);
+
+       ret = hash_remove (ht, key);
+       CuAssertIntEquals (tc, ret, 1);
+       ret = hash_remove (ht, key);
+       CuAssertIntEquals (tc, ret, 0);
+
+       check = hash_get (ht, key);
+       CuAssert (tc, "should be null", check == NULL);
+
+       hash_free (ht);
+}
+
+static void
+test_hash_set_get_clear (CuTest *tc)
+{
+       char *key = "KEY";
+       char *value = "VALUE";
+       char *check;
+       hash_t *ht;
+
+       ht = hash_create (hash_direct_hash, hash_direct_equal, NULL, NULL);
+
+       if (!hash_set (ht, key, value))
+               CuFail (tc, "should not be reached");
+
+       check = hash_get (ht, key);
+       CuAssertPtrEquals (tc, check, value);
+
+       hash_clear (ht);
+
+       check = hash_get (ht, key);
+       CuAssert (tc, "should be null", check == NULL);
+
+       hash_free (ht);
+}
+
+static void
+test_hash_remove_destroys (CuTest *tc)
+{
+       hash_t *ht;
+       int key = 0;
+       int value = 0;
+       int ret;
+
+       ht = hash_create (hash_direct_hash, hash_direct_equal, destroy_key, destroy_value);
+       CuAssertPtrNotNull (tc, ht);
+       if (!hash_set (ht, &key, &value))
+               CuFail (tc, "should not be reached");
+
+       ret = hash_remove (ht, &key);
+       CuAssertIntEquals (tc, ret, 1);
+       CuAssertIntEquals (tc, 1, key);
+       CuAssertIntEquals (tc, 2, value);
+
+       /* should not be destroyed again */
+       key = 0;
+       value = 0;
+
+       ret = hash_remove (ht, &key);
+       CuAssertIntEquals (tc, ret, 0);
+       CuAssertIntEquals (tc, 0, key);
+       CuAssertIntEquals (tc, 0, value);
+
+       /* should not be destroyed again */
+       key = 0;
+       value = 0;
+
+       hash_free (ht);
+
+       CuAssertIntEquals (tc, 0, key);
+       CuAssertIntEquals (tc, 0, value);
+}
+
+static void
+test_hash_clear_destroys (CuTest *tc)
+{
+       hash_t *ht;
+       int key = 0;
+       int value = 0;
+
+       ht = hash_create (hash_direct_hash, hash_direct_equal, destroy_key, destroy_value);
+       CuAssertPtrNotNull (tc, ht);
+       if (!hash_set (ht, &key, &value))
+               CuFail (tc, "should not be reached");
+
+       hash_clear (ht);
+       CuAssertIntEquals (tc, 1, key);
+       CuAssertIntEquals (tc, 2, value);
+
+       /* should not be destroyed again */
+       key = 0;
+       value = 0;
+
+       hash_clear (ht);
+       CuAssertIntEquals (tc, 0, key);
+       CuAssertIntEquals (tc, 0, value);
+
+       /* should not be destroyed again */
+       key = 0;
+       value = 0;
+
+       hash_free (ht);
+
+       CuAssertIntEquals (tc, 0, key);
+       CuAssertIntEquals (tc, 0, value);
+}
+
+static unsigned int
+test_hash_intptr_with_collisions (const void *data)
+{
+       /* lots and lots of collisions, only returns 100 values */
+       return (unsigned int)(*((unsigned long*)data) % 100);
+}
+
+static void
+test_hash_add_check_lots_and_collisions (CuTest *tc)
+{
+       hash_t *ht;
+       int *value;
+       int i;
+
+       ht = hash_create (test_hash_intptr_with_collisions,
+                         hash_intptr_equal, NULL, free);
+
+       for (i = 0; i < 20000; ++i) {
+               value = malloc (sizeof (int));
+               *value = i;
+               if (!hash_set (ht, value, value))
+                       CuFail (tc, "should not be reached");
+       }
+
+       for (i = 0; i < 20000; ++i) {
+               value = hash_get (ht, &i);
+               CuAssertPtrNotNull (tc, value);
+               CuAssertIntEquals (tc, i, *value);
+       }
+
+       hash_free (ht);
+}
+
+static void
+test_hash_count (CuTest *tc)
+{
+       hash_t *ht;
+       int *value;
+       int i, ret;
+
+       ht = hash_create (hash_intptr_hash, hash_intptr_equal, NULL, free);
+
+       CuAssertIntEquals (tc, 0, hash_count (ht));
+
+       for (i = 0; i < 20000; ++i) {
+               value = malloc (sizeof (int));
+               *value = i;
+               if (!hash_set (ht, value, value))
+                       CuFail (tc, "should not be reached");
+               CuAssertIntEquals (tc, i + 1, hash_count (ht));
+       }
+
+       for (i = 0; i < 20000; ++i) {
+               ret = hash_remove (ht, &i);
+               CuAssertIntEquals (tc, 1, ret);
+               CuAssertIntEquals (tc, 20000 - (i + 1), hash_count (ht));
+       }
+
+       hash_clear (ht);
+       CuAssertIntEquals (tc, 0, hash_count (ht));
+
+       hash_free (ht);
+}
+
+static void
+test_hash_ulongptr (CuTest *tc)
+{
+       hash_t *ht;
+       unsigned long *value;
+       unsigned long i;
+
+       ht = hash_create (hash_ulongptr_hash, hash_ulongptr_equal, NULL, free);
+
+       for (i = 0; i < 20000; ++i) {
+               value = malloc (sizeof (int));
+               *value = i;
+               if (!hash_set (ht, value, value))
+                       CuFail (tc, "should not be reached");
+       }
+
+       for (i = 0; i < 20000; ++i) {
+               value = hash_get (ht, &i);
+               CuAssertPtrNotNull (tc, value);
+               CuAssertIntEquals (tc, i, *value);
+       }
+
+       hash_free (ht);
+}
+
+int
+main (void)
+{
+       CuString *output = CuStringNew ();
+       CuSuite* suite = CuSuiteNew ();
+       int ret;
+
+       SUITE_ADD_TEST (suite, test_hash_create);
+       SUITE_ADD_TEST (suite, test_hash_set_get);
+       SUITE_ADD_TEST (suite, test_hash_set_get_remove);
+       SUITE_ADD_TEST (suite, test_hash_remove_destroys);
+       SUITE_ADD_TEST (suite, test_hash_set_get_clear);
+       SUITE_ADD_TEST (suite, test_hash_clear_destroys);
+       SUITE_ADD_TEST (suite, test_hash_free_null);
+       SUITE_ADD_TEST (suite, test_hash_free_destroys);
+       SUITE_ADD_TEST (suite, test_hash_iterate);
+       SUITE_ADD_TEST (suite, test_hash_add_check_lots_and_collisions);
+       SUITE_ADD_TEST (suite, test_hash_count);
+       SUITE_ADD_TEST (suite, test_hash_ulongptr);
+
+       CuSuiteRun (suite);
+       CuSuiteSummary (suite, output);
+       CuSuiteDetails (suite, output);
+       printf ("%s\n", output->buffer);
+       ret = suite->failCount;
+       CuSuiteDelete (suite);
+       return ret;
+}
+
+#include "CuTest.c"