From 7529cdaad9e9a52c93ed4d21c2fcccaf3313592c Mon Sep 17 00:00:00 2001 From: Uwe Hermann Date: Wed, 16 Oct 2013 19:37:44 +0200 Subject: [PATCH] Add a testsuite for libsigrokdecode. This uses the Check unit testing framework, just like libsigrok. For now, only a few very basic unit tests are included. Invocation: make check --- .gitignore | 1 + Makefile.am | 2 +- README | 1 + configure.ac | 14 +++++- tests/Makefile.am | 38 +++++++++++++++ tests/check_core.c | 113 +++++++++++++++++++++++++++++++++++++++++++++ tests/check_main.c | 44 ++++++++++++++++++ 7 files changed, 210 insertions(+), 3 deletions(-) create mode 100644 tests/Makefile.am create mode 100644 tests/check_core.c create mode 100644 tests/check_main.c diff --git a/.gitignore b/.gitignore index 3ea67b2..2058312 100644 --- a/.gitignore +++ b/.gitignore @@ -20,6 +20,7 @@ autostuff/ libsigrokdecode.h ChangeLog INSTALL +tests/check_main # recursive autoconf leftovers .deps diff --git a/Makefile.am b/Makefile.am index 15b5310..784562e 100644 --- a/Makefile.am +++ b/Makefile.am @@ -20,7 +20,7 @@ ACLOCAL_AMFLAGS = -I autostuff -SUBDIRS = contrib decoders +SUBDIRS = contrib decoders tests lib_LTLIBRARIES = libsigrokdecode.la diff --git a/README b/README index 5e807ab..7d11ae5 100644 --- a/README +++ b/README @@ -36,6 +36,7 @@ Requirements - pkg-config >= 0.22 - libglib >= 2.24.0 - Python >= 3.0 + - check >= 0.9.4 (optional, only needed to run unit tests) Building and installing diff --git a/configure.ac b/configure.ac index f0dae21..60d9131 100644 --- a/configure.ac +++ b/configure.ac @@ -34,7 +34,7 @@ AC_CONFIG_MACRO_DIR([autostuff]) AC_CONFIG_AUX_DIR([autostuff]) # We require at least automake 1.11 (needed for 'silent rules'). -AM_INIT_AUTOMAKE([1.11 -Wall -Werror check-news]) +AM_INIT_AUTOMAKE([1.11 -Wall -Werror check-news color-tests]) m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) m4_ifdef([AM_PROG_AR], [AM_PROG_AR]) @@ -52,6 +52,9 @@ AC_PROG_CPP AC_PROG_INSTALL AC_PROG_LN_S +# Required for per-target flags or subdir-objects with C sources. +AM_PROG_CC_C_O + # Initialize libtool. LT_INIT @@ -114,6 +117,12 @@ esac AC_SUBST(CPPFLAGS_PYTHON) AC_SUBST(LDFLAGS_PYTHON) +# The Check unit testing framework is optional. Disable if not found. +PKG_CHECK_MODULES([check], [check >= 0.9.4], + [have_check="yes"; CFLAGS="$CFLAGS $check_CFLAGS"; + LIBS="$LIBS $check_LIBS"], [have_check="no"]) +AM_CONDITIONAL(HAVE_CHECK, test x"$have_check" = "xyes") + # Checks for header files. # These are already checked: inttypes.h stdint.h stdlib.h string.h unistd.h. # AC_CHECK_HEADERS([]) @@ -185,6 +194,7 @@ AC_CONFIG_FILES([Makefile decoders/usb_packet/Makefile decoders/usb_signalling/Makefile decoders/xfp/Makefile + tests/Makefile ]) AC_OUTPUT @@ -202,7 +212,7 @@ echo "Detected libraries:" echo # Note: This only works for libs with pkg-config integration. -for lib in "glib-2.0 >= 2.24.0"; do +for lib in "glib-2.0 >= 2.24.0" "check >= 0.9.4"; do if `$PKG_CONFIG --exists $lib`; then ver=`$PKG_CONFIG --modversion $lib` answer="yes ($ver)" diff --git a/tests/Makefile.am b/tests/Makefile.am new file mode 100644 index 0000000..5d04c59 --- /dev/null +++ b/tests/Makefile.am @@ -0,0 +1,38 @@ +## +## This file is part of the libsigrokdecode project. +## +## Copyright (C) 2013 Uwe Hermann +## +## This program is free software; you can redistribute it and/or modify +## it under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 2 of the License, or +## (at your option) any later version. +## +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; if not, write to the Free Software +## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +## + +if HAVE_CHECK + +TESTS = check_main + +check_PROGRAMS = ${TESTS} + +check_main_SOURCES = \ + $(top_builddir)/libsigrokdecode.h \ + check_main.c \ + check_core.c + +check_main_CFLAGS = @check_CFLAGS@ + +check_main_LDADD = $(top_builddir)/libsigrokdecode.la @check_LIBS@ + +check_main_CPPFLAGS = $(CPPFLAGS_PYTHON) + +endif diff --git a/tests/check_core.c b/tests/check_core.c new file mode 100644 index 0000000..cbbb26f --- /dev/null +++ b/tests/check_core.c @@ -0,0 +1,113 @@ +/* + * This file is part of the libsigrokdecode project. + * + * Copyright (C) 2013 Uwe Hermann + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include "../libsigrokdecode.h" /* First, to avoid compiler warning. */ +#include +#include + +static void setup(void) +{ + /* Silence libsigrokdecode while the unit tests run. */ + srd_log_loglevel_set(SRD_LOG_NONE); +} + +static void teardown(void) +{ +} + +/* + * Check various basic init related things. + * + * - Check whether an srd_init() call with path == NULL works. + * If it returns != SRD_OK (or segfaults) this test will fail. + * + * - Check whether a subsequent srd_exit() works. + * If it returns != SRD_OK (or segfaults) this test will fail. + */ +START_TEST(test_init_exit) +{ + int ret; + + ret = srd_init(NULL); + fail_unless(ret == SRD_OK, "srd_init() failed: %d.", ret); + ret = srd_exit(); + fail_unless(ret == SRD_OK, "srd_exit() failed: %d.", ret); +} +END_TEST + +/* + * Check whether nested srd_init()/srd_exit() calls work/fail correctly. + * Two consecutive srd_init() calls without any srd_exit() inbetween are + * not allowed and should fail. However, two consecutive srd_exit() calls + * are currently allowed, the second one will just be a NOP basically. + */ +START_TEST(test_init_exit_2) +{ + int ret; + + ret = srd_init(NULL); + fail_unless(ret == SRD_OK, "srd_init() 1 failed: %d.", ret); + ret = srd_init(NULL); + fail_unless(ret != SRD_OK, "srd_init() 2 didn't fail: %d.", ret); + ret = srd_exit(); + fail_unless(ret == SRD_OK, "srd_exit() 2 failed: %d.", ret); + ret = srd_exit(); + fail_unless(ret == SRD_OK, "srd_exit() 1 failed: %d.", ret); +} +END_TEST + +/* + * Check whether three nested srd_init()/srd_exit() calls work/fail correctly. + */ +START_TEST(test_init_exit_3) +{ + int ret; + + ret = srd_init(NULL); + fail_unless(ret == SRD_OK, "srd_init() 1 failed: %d.", ret); + ret = srd_init(NULL); + fail_unless(ret != SRD_OK, "srd_init() 2 didn't fail: %d.", ret); + ret = srd_init(NULL); + fail_unless(ret != SRD_OK, "srd_init() 3 didn't fail: %d.", ret); + ret = srd_exit(); + fail_unless(ret == SRD_OK, "srd_exit() 3 failed: %d.", ret); + ret = srd_exit(); + fail_unless(ret == SRD_OK, "srd_exit() 2 failed: %d.", ret); + ret = srd_exit(); + fail_unless(ret == SRD_OK, "srd_exit() 1 failed: %d.", ret); +} +END_TEST + +Suite *suite_core(void) +{ + Suite *s; + TCase *tc; + + s = suite_create("core"); + + tc = tcase_create("init_exit"); + tcase_add_checked_fixture(tc, setup, teardown); + tcase_add_test(tc, test_init_exit); + tcase_add_test(tc, test_init_exit_2); + tcase_add_test(tc, test_init_exit_3); + suite_add_tcase(s, tc); + + return s; +} diff --git a/tests/check_main.c b/tests/check_main.c new file mode 100644 index 0000000..e115064 --- /dev/null +++ b/tests/check_main.c @@ -0,0 +1,44 @@ +/* + * This file is part of the libsigrokdecode project. + * + * Copyright (C) 2013 Uwe Hermann + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include "../libsigrokdecode.h" /* First, to avoid compiler warning. */ +#include +#include + +Suite *suite_core(void); + +int main(void) +{ + int ret; + Suite *s; + SRunner *srunner; + + s = suite_create("mastersuite"); + srunner = srunner_create(s); + + /* Add all testsuites to the master suite. */ + srunner_add_suite(srunner, suite_core()); + + srunner_run_all(srunner, CK_VERBOSE); + ret = srunner_ntests_failed(srunner); + srunner_free(srunner); + + return (ret == 0) ? EXIT_SUCCESS : EXIT_FAILURE; +} -- 2.30.2