add tests for utility string handling

test/Makefile

@@ -1,7 +1,7 @@
 #
 # NetSurf unit tests
 
-TESTS := nsurl urldbtest nsoption bloom hashtable urlescape #llcache
+TESTS := nsurl urldbtest nsoption bloom hashtable urlescape utils #llcache
 
 # nsurl sources
 nsurl_SRCS := utils/corestrings.c utils/nsurl.c utils/idna.c \
@@ -37,6 +37,10 @@ hashtable_SRCS := utils/hashtable.c test/log.c test/hashtable.c
 # url escape test sources
 urlescape_SRCS := utils/url.c test/log.c test/urlescape.c
 
+# utility test sources
+utils_SRCS := utils/utils.c utils/messages.c utils/hashtable.c \
+		test/log.c test/utils.c
+
 # Coverage builds need additional flags
 ifeq ($(MAKECMDGOALS),coverage)
   COV_CFLAGS ?= -fprofile-arcs -ftest-coverage -O0

test/utils.c

@@ -0,0 +1,155 @@
+/*
+ * Copyright 2016 Vincent Sanders <vince@netsurf-browser.org>
+ *
+ * This file is part of NetSurf, http://www.netsurf-browser.org/
+ *
+ * NetSurf 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; version 2 of the License.
+ *
+ * NetSurf 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, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * \file
+ * Tests for utility functions.
+ */
+
+#include <assert.h>
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <check.h>
+
+#include "utils/string.h"
+
+#define NELEMS(x)  (sizeof(x) / sizeof((x)[0]))
+#define SLEN(x) (sizeof((x)) - 1)
+
+struct test_pairs {
+	const unsigned long test;
+	const char* res;
+};
+
+static const struct test_pairs human_friendly_bytesize_test_vec[] = {
+	{ 0, "0.00Bytes" },
+	{ 1024, "1024.00Bytes" },
+	{ 1025, "1.00kBytes" },
+	{ 1048576, "1024.00kBytes" },
+	{ 1048577, "1.00MBytes" },
+	{ 1073741824, "1024.00MBytes" },
+	{ 1073741888, "1024.00MBytes" }, /* spot the rounding error */
+	{ 1073741889, "1.00GBytes" },
+	{ 2147483648, "2.00GBytes" },
+	{ 3221225472, "3.00GBytes" },
+	{ 4294967295, "4.00GBytes" },
+};
+
+START_TEST(human_friendly_bytesize_test)
+{
+	char *res_str;
+	const struct test_pairs *tst = &human_friendly_bytesize_test_vec[_i];
+
+	res_str = human_friendly_bytesize(tst->test);
+
+	/* ensure result data is correct */
+	ck_assert_str_eq(res_str, tst->res);
+}
+END_TEST
+
+TCase *human_friendly_bytesize_case_create(void)
+{
+	TCase *tc;
+	tc = tcase_create("Human friendly bytesize");
+
+	tcase_add_loop_test(tc, human_friendly_bytesize_test,
+			    0, NELEMS(human_friendly_bytesize_test_vec));
+
+	return tc;
+}
+
+struct test_strings {
+	const char* test;
+	const char* res;
+};
+
+static const struct test_strings squash_whitespace_test_vec[] = {
+	{ "", "" },
+	{ " ", " " },
+	{ "    ", " " },
+	{ " \n\r\t   ", " " },
+	{ " a ", " a " },
+	{ " a   b ", " a b " },
+};
+
+START_TEST(squash_whitespace_test)
+{
+	char *res_str;
+	const struct test_strings *tst = &squash_whitespace_test_vec[_i];
+
+	res_str = squash_whitespace(tst->test);
+	ck_assert(res_str != NULL);
+
+	/* ensure result data is correct */
+	ck_assert_str_eq(res_str, tst->res);
+
+	free(res_str);
+}
+END_TEST
+
+START_TEST(squash_whitespace_api_test)
+{
+	char *res_str;
+
+	res_str = squash_whitespace(NULL);
+	ck_assert(res_str != NULL);
+
+	free(res_str);
+}
+END_TEST
+
+TCase *squash_whitespace_case_create(void)
+{
+	TCase *tc;
+	tc = tcase_create("Squash whitespace");
+
+	tcase_add_test_raise_signal(tc, squash_whitespace_api_test, 6);
+
+	tcase_add_loop_test(tc, squash_whitespace_test,
+			    0, NELEMS(squash_whitespace_test_vec));
+
+	return tc;
+}
+
+Suite *utils_suite_create(void)
+{
+	Suite *s;
+	s = suite_create("String utils");
+
+	suite_add_tcase(s, human_friendly_bytesize_case_create());
+	suite_add_tcase(s, squash_whitespace_case_create());
+
+	return s;
+}
+
+int main(int argc, char **argv)
+{
+	int number_failed;
+	SRunner *sr;
+
+	sr = srunner_create(utils_suite_create());
+
+	srunner_run_all(sr, CK_ENV);
+
+	number_failed = srunner_ntests_failed(sr);
+	srunner_free(sr);
+
+	return (number_failed == 0) ? EXIT_SUCCESS : EXIT_FAILURE;
+}

utils/utils.c

@@ -43,12 +43,14 @@
 #include "utils/string.h"
 #include "utils/utils.h"
 
-/* exported interface documented in utils/utils.h */
+/* exported interface documented in utils/string.h */
 char *squash_whitespace(const char *s)
 {
 	char *c;
 	int i = 0, j = 0;
 
+	assert(s != NULL);
+
 	c = malloc(strlen(s) + 1);
 	if (c != NULL) {
 		do {
@@ -208,7 +210,7 @@ nserror snstrjoin(char **str, size_t *size, char sep, size_t nelm, ...)
  */
 #define BYTESIZE_BUFFER_SIZE 20
 
-/* exported interface documented in utils/utils.h */
+/* exported interface documented in utils/string.h */
 char *human_friendly_bytesize(unsigned long bsize) {
 	static char buffer1[BYTESIZE_BUFFER_SIZE];
 	static char buffer2[BYTESIZE_BUFFER_SIZE];