netsurf/test/utils.c

/*
 * 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 "utils/config.h"

#include <assert.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <check.h>

#include "utils/string.h"
#include "utils/corestrings.h"

#define NELEMS(x)  (sizeof(x) / sizeof((x)[0]))
#define SLEN(x) (sizeof((x)) - 1)

struct test_pairs {
	const unsigned long long int test;
	const char* res;
};

static const struct test_pairs human_friendly_bytesize_test_vec[] = {
	{                  0ULL,         "0Bytes" },
	{               0x2AULL,        "42Bytes" },
	{              0x400ULL,      "1024Bytes" },
	{              0x401ULL,    "1.00KiBytes" },
	{             0xA9AEULL,   "42.42KiBytes" },
	{           0x100000ULL, "1024.00KiBytes" },
	{           0x100001ULL,    "1.00MiBytes" },
	{          0x2A6B852ULL,   "42.42MiBytes" },
	{         0x40000000ULL, "1024.00MiBytes" },
	{         0x40000001ULL,    "1.00GiBytes" },
	{         0x80000000ULL,    "2.00GiBytes" },
	{         0xC0000000ULL,    "3.00GiBytes" },
	{        0x100000000ULL,    "4.00GiBytes" },
	{      0x10000000000ULL, "1024.00GiBytes" },
	{      0x10000000001ULL,    "1.00TiBytes" },
	{    0x4000000000000ULL, "1024.00TiBytes" },
	{    0x4000000000001ULL,    "1.00PiBytes" },
	{ 0x1000000000000000ULL, "1024.00PiBytes" },
	{ 0x1000000000000100ULL,    "1.00EiBytes" }, /* precision loss */
	{ 0xFFFFFFFFFFFFFFFFULL,   "16.00EiBytes" },
};

/**
 * check each response one at a time
 */
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

/**
 * check each response one after another
 */
START_TEST(human_friendly_bytesize_all_test)
{
	char *res_str;
	const struct test_pairs *tst;
	unsigned int idx;

	for (idx = 0; idx < NELEMS(human_friendly_bytesize_test_vec); idx++) {
		tst = &human_friendly_bytesize_test_vec[idx];

		res_str = human_friendly_bytesize(tst->test);

		/* ensure result data is correct */
		ck_assert_str_eq(res_str, tst->res);
	}
}
END_TEST

static 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));

	tcase_add_test(tc, human_friendly_bytesize_all_test);

	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 " },
	{
		"   A string  with \t  \r \n  \t   lots\tof\nwhitespace\r    ",
		" A string with lots of whitespace "
	},
};

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

static 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;
}


START_TEST(corestrings_init_fini_test)
{
	nserror res;

	res = corestrings_init();
	ck_assert_int_eq(res, NSERROR_OK);

	corestrings_fini();
}
END_TEST

START_TEST(corestrings_double_init_test)
{
	nserror res;

	res = corestrings_init();
	ck_assert_int_eq(res, NSERROR_OK);

	res = corestrings_init();
	ck_assert_int_eq(res, NSERROR_OK);

	corestrings_fini();
}
END_TEST

START_TEST(corestrings_double_fini_test)
{
	nserror res;

	res = corestrings_init();
	ck_assert_int_eq(res, NSERROR_OK);

	corestrings_fini();

	corestrings_fini();
}
END_TEST


static TCase *corestrings_case_create(void)
{
	TCase *tc;
	tc = tcase_create("Corestrings");

	tcase_add_test(tc, corestrings_init_fini_test);
	tcase_add_test(tc, corestrings_double_init_test);
	tcase_add_test(tc, corestrings_double_fini_test);

	return tc;
}



START_TEST(string_utils_cnv_space2nbsp_test)
{
	char *res;
	char comparison[64];

	snprintf(comparison, 64,
		 "%c%cA%c%cstring%c%c%c%cwith%c%c%c%c%c%cwhitespace%c%c",
		 0xC2, 0xA0, 0xC2, 0xA0, 0xC2, 0xA0, 0xC2, 0xA0,
		 0xC2, 0xA0, 0xC2, 0xA0, 0xC2, 0xA0, 0xC2, 0xA0);

	res = cnv_space2nbsp(" A string  with \t whitespace ");
	ck_assert(res != NULL);
	ck_assert_str_eq(res, comparison);

	free(res);
}
END_TEST

START_TEST(string_utils_strcasestr_test)
{

	char *res;
	const char *haystack = "A big old long haystack string that has a small Needle in the middle of it with a different case";

	res = strcasestr(haystack, "notfound");
	ck_assert(res == NULL);

	res = strcasestr(haystack, "needle");
	ck_assert(res != NULL);

	ck_assert_str_eq(res, haystack + 48);

}
END_TEST

START_TEST(string_utils_strchrnul_test)
{

	char *res;
	const char *haystack = "A big old long haystack string that has a small Needle in the middle of it with a different case";

	res = strchrnul(haystack, 'Z');
	ck_assert(res != NULL);
	ck_assert(*res == 0);

	res = strchrnul(haystack, 'N');
	ck_assert(res != NULL);

	ck_assert_str_eq(res, haystack + 48);

}
END_TEST


static TCase *string_utils_case_create(void)
{
	TCase *tc;
	tc = tcase_create("String utilities");

	tcase_add_test(tc, string_utils_cnv_space2nbsp_test);
	tcase_add_test(tc, string_utils_strcasestr_test);
	tcase_add_test(tc, string_utils_strchrnul_test);

	return tc;
}


/**
 * api tests
 */
START_TEST(string_utils_snstrjoin_api_test)
{
	nserror res;
	char outstr[32];
	char *resstr = &outstr[0];
	size_t resstrlen = 32;

	/* bad count parameters */
	res = snstrjoin(&resstr, &resstrlen, ',', 0, "1");
	ck_assert_int_eq(res, NSERROR_BAD_PARAMETER);

	res = snstrjoin(&resstr, &resstrlen, ',', 17, "1");
	ck_assert_int_eq(res, NSERROR_BAD_PARAMETER);

	/* if there is a buffer must set length */
	res = snstrjoin(&resstr, NULL, ',', 4, "1", "2", "3", "4");
	ck_assert_int_eq(res, NSERROR_BAD_PARAMETER);

	/* null argument value is bad parameter */
	res = snstrjoin(&resstr, &resstrlen, ',', 4, "1", NULL, "3", "4");
	ck_assert_int_eq(res, NSERROR_BAD_PARAMETER);

	/* attempt to use an undersize buffer */
	resstrlen = 1;
	res = snstrjoin(&resstr, &resstrlen, ',', 4, "1", "2", "3", "4");
	ck_assert_int_eq(res, NSERROR_NOSPACE);

}
END_TEST


/**
 * good four parameter join
 */
START_TEST(string_utils_snstrjoin_four_test)
{
	nserror res;
	char *resstr = NULL;
	size_t resstrlen;

	res = snstrjoin(&resstr, &resstrlen, ',', 4, "1", "2", "3", "4");
	ck_assert_int_eq(res, NSERROR_OK);
	ck_assert(resstr != NULL);
	ck_assert_int_eq(resstrlen, 8);
	ck_assert_str_eq(resstr, "1,2,3,4");
	free(resstr);
}
END_TEST


/**
 * good three parameter join with no length
 */
START_TEST(string_utils_snstrjoin_three_test)
{
	nserror res;
	char *resstr = NULL;

	res = snstrjoin(&resstr, NULL, ',', 3, "1", "2,", "3");
	ck_assert_int_eq(res, NSERROR_OK);
	ck_assert(resstr != NULL);
	ck_assert_str_eq(resstr, "1,2,3");
	free(resstr);
}
END_TEST

/**
 * good two parameter join into pre allocated buffer
 */
START_TEST(string_utils_snstrjoin_two_test)
{
	nserror res;
	char outstr[32];
	char *resstr = &outstr[0];
	size_t resstrlen = 32;

	res = snstrjoin(&resstr, &resstrlen, ',', 2, "1", "2");
	ck_assert_int_eq(res, NSERROR_OK);
	ck_assert(resstr != NULL);
	ck_assert_int_eq(resstrlen, 4);
	ck_assert_str_eq(resstr, "1,2");
}
END_TEST


static TCase *snstrjoin_case_create(void)
{
	TCase *tc;
	tc = tcase_create("snstrjoin utilities");

	tcase_add_test(tc, string_utils_snstrjoin_api_test);
	tcase_add_test(tc, string_utils_snstrjoin_four_test);
	tcase_add_test(tc, string_utils_snstrjoin_three_test);
	tcase_add_test(tc, string_utils_snstrjoin_three_test);
	tcase_add_test(tc, string_utils_snstrjoin_two_test);

	return tc;
}


/*
 * Utility test suite creation
 */
static Suite *utils_suite_create(void)
{
	Suite *s;
	s = suite_create("Utility API");

	suite_add_tcase(s, human_friendly_bytesize_case_create());
	suite_add_tcase(s, squash_whitespace_case_create());
	suite_add_tcase(s, corestrings_case_create());
	suite_add_tcase(s, snstrjoin_case_create());
	suite_add_tcase(s, string_utils_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;
}