Merge lp:~oif-team/geis/tdd-harness into lp:geis

[Stephen M. Webb]

Added unit testing infrastructure.

[Chase Douglas (chasedouglas)]

Me likey!

review: Approve

[Duncan McGreggor (oubiwann)]

Wait! No! Don't merge yet!

review: Needs Information

[Duncan McGreggor (oubiwann)]

Okay, so I wanted to get that out right away before it got merged :-) I have some concerns, but first:

AWESOME JOB! Thanks for doing this TDD effort!

However, I really liked CUnit as a framework for unit testing. Suites are cool and useful, and CUnit supports them (with per-suite set-ups/tear-downs).

Can you give the reasons that you chose check as the testing framework?

review: Needs Information

[Stephen M. Webb (bregma)]

* check also supports suites, including nested suites and per-suite fixture setup/teardown
* cunit is a port of the massive Java JUnit framework, it's a rather overengineered solution to a simple problem
* check forks tests, cunit doesn't -- meaning a single crash causes the entire run to fail instead of reporting errors
* check only emits results, it doesn't come with an embedded gui runner

In short, check is a smaller and lighter yet complete (for our purposes) unit test framework.

[Henrik Rydberg (rydberg)]

Small is good. Light is good. Complete is good. Code looks good. All is good. :-)

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2010-08-12 15:43:49 +0000
+++ .bzrignore	2010-10-21 01:06:04 +0000
@@ -29,4 +29,6 @@
 libtool
 Makefile
 stamp-*
+testsuite/check/check_geis_internals
+testsuite/check/*.log
 testsuite/geistest/geistest

=== modified file 'ChangeLog'
--- ChangeLog	2010-10-18 14:15:01 +0000
+++ ChangeLog	2010-10-21 01:06:04 +0000
@@ -1,3 +1,22 @@
[phone]  Stephen M. Webb  <[e-mail]>
+
+  Added unit tests for internal geis_instance_table.
+
+  * testsuite/check/check_instance_table.c: new file
+  * testsuite/check/Makefile.am (check_geis_internals_SOURCES): added it
+    (MOSTLYCLEANFILES): new target to clean up unit test logs
+  * testsuite/check/check_geis_internals.c (main): added unit test suite
+
[phone]  Stephen M. Webb  <[e-mail]>
+
+  Added unit test infrastructure based on 'check'.
+
+  * testsuite/check/Makefile.am: new file
+  * testsuite/check/check_geis_internals.c: new file
+  * testsuite/Makefile.am (SUBDIRS): added check target
+  * configure.ac: added new stanza for detecting check package
+    (AC_CONFIG_FILES): added testsuite/check/Makefile
+
 2010-10-18  Stephen M. Webb  <[e-mail]>
 
   Added configury check for xcb-proto package >= 1.6 (LP: #661946).

=== modified file 'configure.ac'
--- configure.ac	2010-10-18 14:15:01 +0000
+++ configure.ac	2010-10-21 01:06:04 +0000
@@ -54,6 +54,12 @@
   AC_DEFINE([GEIS_DSO_PRIVATE],[1],[symbol visibility is supported])
 fi
 
+# Check for TDD tools
+PKG_CHECK_MODULES([CHECK], [check >= 0.9.8],
+                  [have_check=yes],
+                  AC_MSG_WARN([package 'check' not found: unit testing disabled]))
+AM_CONDITIONAL([HAVE_CHECK],[test "x$have_check" = xyes])
+
 
 AC_CONFIG_FILES([Makefile
                  libutouch-geis.pc
@@ -62,5 +68,6 @@
                  libutouch-geis-xcb/Makefile
                  libutouch-geis-xcb/xcb_gesture.xml
                  testsuite/Makefile
+                 testsuite/check/Makefile
                  testsuite/geistest/Makefile])
 AC_OUTPUT

=== modified file 'testsuite/Makefile.am'
--- testsuite/Makefile.am	2010-07-26 01:40:31 +0000
+++ testsuite/Makefile.am	2010-10-21 01:06:04 +0000
@@ -1,1 +1,1 @@
-SUBDIRS = geistest
+SUBDIRS = check geistest

=== added directory 'testsuite/check'
=== added file 'testsuite/check/Makefile.am'
--- testsuite/check/Makefile.am	1970-01-01 00:00:00 +0000
+++ testsuite/check/Makefile.am	2010-10-21 01:06:04 +0000
@@ -0,0 +1,32 @@
+#
+# @file testsuite/check/Makefile.am 
+# @brief automake recipe for the geis testsuite unit testing directory
+#
+
+if HAVE_CHECK
+  test_targets = check_geis_internals
+else
+  test_targets = 
+endif
+
+TESTS = $(test_targets)
+
+check_PROGRAMS = $(test_targets)
+
+check_geis_internals_SOURCES = \
+	check_instance_table.c \
+	check_geis_internals.c
+
+check_geis_internals_CFLAGS = \
+	-I$(top_srcdir) \
+	$(CHECK_CFLAGS)
+
+check_geis_internals_LDADD = \
+	$(top_builddir)/libutouch-geis-xcb/.libs/libutouch-geis.a \
+	$(X11XCB_LIBS) \
+	$(XCB_LIBS) \
+	$(XI2_LIBS) \
+	$(CHECK_LIBS)
+
+MOSTLYCLEANFILES = geis_internals.log
+

=== added file 'testsuite/check/check_geis_internals.c'
--- testsuite/check/check_geis_internals.c	1970-01-01 00:00:00 +0000
+++ testsuite/check/check_geis_internals.c	2010-10-21 01:06:04 +0000
@@ -0,0 +1,26 @@
+/**
+ * test driver for unit testing of geis internals
+ */
+#include <check.h>
+
+extern Suite *make_instance_table_suite();
+
+
+int
+main(int argc, char* argv[])
+{
+  int num_failed = 0;
+
+  Suite *s = suite_create("\"geis internals\"");
+
+  SRunner *sr = srunner_create(s);
+  srunner_add_suite(sr, make_instance_table_suite());
+
+  srunner_set_log(sr, "geis_internals.log");
+  srunner_run_all(sr, CK_NORMAL);
+  num_failed = srunner_ntests_failed(sr);
+
+  srunner_free(sr);
+
+  return !(num_failed == 0);
+}

=== added file 'testsuite/check/check_instance_table.c'
--- testsuite/check/check_instance_table.c	1970-01-01 00:00:00 +0000
+++ testsuite/check/check_instance_table.c	2010-10-21 01:06:04 +0000
@@ -0,0 +1,87 @@
+/**
+ * unit tests for the geis_instance_table module
+ */
+#include <check.h>
+
+#include "libutouch-geis-xcb/geis_instance.h"
+#include "libutouch-geis-xcb/geis_instance_table.h"
+
+/* fixtures */
+static GeisInstanceTable fixture_table;
+static GeisInstance      fixture_instance;
+static const uint32_t    fixture_window_id = 0x32;
+
+/* fixture setup */
+static void
+construct_table()
+{
+  fixture_table = geis_instance_table_new(1);
+  fixture_instance = geis_instance_new(fixture_window_id);
+}
+
+/* fixture teardown */
+static void
+destroy_table()
+{
+  geis_instance_free(fixture_instance);
+  geis_instance_table_free(fixture_table);
+}
+
+/* verify table construction/destruction */
+START_TEST(construction)
+{
+  GeisInstanceTable table = geis_instance_table_new(1);
+  fail_unless(table != NULL, "failed to create instance_table");
+  geis_instance_table_free(table);
+}
+END_TEST
+
+
+/* verify table insertion */
+START_TEST(insertion)
+{
+  geis_instance_table_add(fixture_table, fixture_instance);
+}
+END_TEST
+
+
+/* verify table find operation (positive results) */
+START_TEST(find_success)
+{
+  geis_instance_table_add(fixture_table, fixture_instance);
+  GeisInstance instance = geis_instance_table_get(fixture_table, fixture_window_id);
+  fail_if(instance == NULL, "expected instance not found");
+  fail_unless(geis_instance_get_window_id(instance) == fixture_window_id);
+}
+END_TEST
+
+
+/* verify table find operation (negative results) */
+START_TEST(find_fail)
+{
+  GeisInstance instance = geis_instance_table_get(fixture_table, 0x5a);
+  fail_unless(instance == NULL, "unexpected instance found");
+}
+END_TEST
+
+
+/* boilerplate */
+Suite *
+make_instance_table_suite()
+{
+  Suite *s = suite_create("geis_instance_table");
+
+  TCase *create = tcase_create("table-creation");
+  tcase_add_test(create, construction);
+  suite_add_tcase(s, create);
+
+  TCase *usage = tcase_create("table-usage");
+  tcase_add_checked_fixture(usage, construct_table, destroy_table);
+  tcase_add_test(usage, insertion);
+  tcase_add_test(usage, find_success);
+  tcase_add_test(usage, find_fail);
+  suite_add_tcase(s, usage);
+
+  return s;
+}
+