/* Miniature re-implementation of the "check" library. This is intended to support just enough of check to run the Expat tests. This interface is based entirely on the portion of the check library being used. __ __ _ ___\ \/ /_ __ __ _| |_ / _ \\ /| '_ \ / _` | __| | __// \| |_) | (_| | |_ \___/_/\_\ .__/ \__,_|\__| |_| XML parser Copyright (c) 2004-2006 Fred L. Drake, Jr. Copyright (c) 2016-2023 Sebastian Pipping Copyright (c) 2017 Rhodri James Copyright (c) 2018 Marco Maggi Copyright (c) 2019 David Loffredo Copyright (c) 2023-2024 Sony Corporation / Snild Dolkow Licensed under the MIT license: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #if defined(NDEBUG) # undef NDEBUG /* because test suite relies on assert(...) at the moment */ #endif #include #include #include #include #include #include #include "internal.h" /* for UNUSED_P only */ #include "minicheck.h" Suite * suite_create(const char *name) { Suite *suite = (Suite *)calloc(1, sizeof(Suite)); if (suite != NULL) { suite->name = name; } return suite; } TCase * tcase_create(const char *name) { TCase *tc = (TCase *)calloc(1, sizeof(TCase)); if (tc != NULL) { tc->name = name; } return tc; } void suite_add_tcase(Suite *suite, TCase *tc) { assert(suite != NULL); assert(tc != NULL); assert(tc->next_tcase == NULL); tc->next_tcase = suite->tests; suite->tests = tc; } void tcase_add_checked_fixture(TCase *tc, tcase_setup_function setup, tcase_teardown_function teardown) { assert(tc != NULL); tc->setup = setup; tc->teardown = teardown; } void tcase_add_test(TCase *tc, tcase_test_function test) { assert(tc != NULL); if (tc->allocated == tc->ntests) { int nalloc = tc->allocated + 100; size_t new_size = sizeof(tcase_test_function) * nalloc; tcase_test_function *const new_tests = (tcase_test_function *)realloc(tc->tests, new_size); assert(new_tests != NULL); tc->tests = new_tests; tc->allocated = nalloc; } tc->tests[tc->ntests] = test; tc->ntests++; } static void tcase_free(TCase *tc) { if (! tc) { return; } free(tc->tests); free(tc); } static void suite_free(Suite *suite) { if (! suite) { return; } while (suite->tests != NULL) { TCase *next = suite->tests->next_tcase; tcase_free(suite->tests); suite->tests = next; } free(suite); } SRunner * srunner_create(Suite *suite) { SRunner *const runner = (SRunner *)calloc(1, sizeof(SRunner)); if (runner != NULL) { runner->suite = suite; } return runner; } static jmp_buf env; #define SUBTEST_LEN (50) // informative, but not too long static char const *_check_current_function = NULL; static char _check_current_subtest[SUBTEST_LEN]; static int _check_current_lineno = -1; static char const *_check_current_filename = NULL; void _check_set_test_info(char const *function, char const *filename, int lineno) { _check_current_function = function; set_subtest("%s", ""); _check_current_lineno = lineno; _check_current_filename = filename; } void set_subtest(char const *fmt, ...) { va_list ap; va_start(ap, fmt); vsnprintf(_check_current_subtest, SUBTEST_LEN, fmt, ap); va_end(ap); // replace line feeds with spaces, for nicer error logs for (size_t i = 0; i < SUBTEST_LEN; ++i) { if (_check_current_subtest[i] == '\n') { _check_current_subtest[i] = ' '; } } _check_current_subtest[SUBTEST_LEN - 1] = '\0'; // ensure termination } static void handle_success(int verbosity) { if (verbosity >= CK_VERBOSE) { printf("PASS: %s\n", _check_current_function); } } static void handle_failure(SRunner *runner, int verbosity, const char *context, const char *phase_info) { runner->nfailures++; if (verbosity != CK_SILENT) { if (strlen(_check_current_subtest) != 0) { phase_info = _check_current_subtest; } printf("FAIL [%s]: %s (%s at %s:%d)\n", context, _check_current_function, phase_info, _check_current_filename, _check_current_lineno); } } void srunner_run_all(SRunner *runner, const char *context, int verbosity) { Suite *suite; TCase *volatile tc; assert(runner != NULL); suite = runner->suite; tc = suite->tests; while (tc != NULL) { volatile int i; for (i = 0; i < tc->ntests; ++i) { runner->nchecks++; set_subtest("%s", ""); if (tc->setup != NULL) { /* setup */ if (setjmp(env)) { handle_failure(runner, verbosity, context, "during setup"); continue; } tc->setup(); } /* test */ if (setjmp(env)) { handle_failure(runner, verbosity, context, "during actual test"); continue; } (tc->tests[i])(); set_subtest("%s", ""); /* teardown */ if (tc->teardown != NULL) { if (setjmp(env)) { handle_failure(runner, verbosity, context, "during teardown"); continue; } tc->teardown(); } handle_success(verbosity); } tc = tc->next_tcase; } } void srunner_summarize(SRunner *runner, int verbosity) { if (verbosity != CK_SILENT) { int passed = runner->nchecks - runner->nfailures; double percentage = ((double)passed) / runner->nchecks; int display = (int)(percentage * 100); printf("%d%%: Checks: %d, Failed: %d\n", display, runner->nchecks, runner->nfailures); } } void _fail(const char *file, int line, const char *msg) { /* Always print the error message so it isn't lost. In this case, we have a failure, so there's no reason to be quiet about what it is. */ _check_current_filename = file; _check_current_lineno = line; if (msg != NULL) { const int has_newline = (msg[strlen(msg) - 1] == '\n'); fprintf(stderr, "ERROR: %s%s", msg, has_newline ? "" : "\n"); } longjmp(env, 1); } int srunner_ntests_failed(SRunner *runner) { assert(runner != NULL); return runner->nfailures; } void srunner_free(SRunner *runner) { if (! runner) { return; } suite_free(runner->suite); free(runner); }