Skip to content

Commit

Permalink
t/unit-tests: convert ctype tests to use clar
Browse files Browse the repository at this point in the history
Convert the ctype tests to use the new clar unit testing framework.
Introduce a new function `cl_failf()` that allows us to print a
formatted error message, which we can use to point out which of the
characters was classified incorrectly. This results in output like this
on failure:

    # start of suite 1: ctype
    ok 1 - ctype::isspace
    not ok 2 - ctype::isdigit
        ---
        reason: |
          Test failed.
          0x61 is classified incorrectly
        at:
          file: 't/unit-tests/ctype.c'
          line: 38
          function: 'test_ctype__isdigit'
        ---
    ok 3 - ctype::isalpha
    ok 4 - ctype::isalnum
    ok 5 - ctype::is_glob_special
    ok 6 - ctype::is_regex_special
    ok 7 - ctype::is_pathspec_magic
    ok 8 - ctype::isascii
    ok 9 - ctype::islower
    ok 10 - ctype::isupper
    ok 11 - ctype::iscntrl
    ok 12 - ctype::ispunct
    ok 13 - ctype::isxdigit
    ok 14 - ctype::isprint

Signed-off-by: Patrick Steinhardt <[email protected]>
  • Loading branch information
pks-t committed Aug 20, 2024
1 parent 8fd60bd commit 46e7a02
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -1336,13 +1336,13 @@ THIRD_PARTY_SOURCES += sha1dc/%
THIRD_PARTY_SOURCES += $(UNIT_TEST_DIR)/clar/%
THIRD_PARTY_SOURCES += $(UNIT_TEST_DIR)/clar/clar/%

UNIT_TESTS_SUITES += ctype
UNIT_TESTS_SUITES += strvec
UNIT_TESTS_PROG = $(UNIT_TEST_BIN)/unit-tests$(X)
UNIT_TESTS_OBJS = $(patsubst %,$(UNIT_TEST_DIR)/%.o,$(UNIT_TESTS_SUITES))
UNIT_TESTS_OBJS += $(UNIT_TEST_DIR)/clar/clar.o
UNIT_TESTS_OBJS += $(UNIT_TEST_DIR)/unit-test.o

UNIT_TEST_PROGRAMS += t-ctype
UNIT_TEST_PROGRAMS += t-example-decorate
UNIT_TEST_PROGRAMS += t-hash
UNIT_TEST_PROGRAMS += t-hashmap
Expand Down
70 changes: 59 additions & 11 deletions t/unit-tests/t-ctype.c → t/unit-tests/ctype.c
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
#include "test-lib.h"
#include "unit-test.h"

#define TEST_CHAR_CLASS(class, string) do { \
size_t len = ARRAY_SIZE(string) - 1 + \
BUILD_ASSERT_OR_ZERO(ARRAY_SIZE(string) > 0) + \
BUILD_ASSERT_OR_ZERO(sizeof(string[0]) == sizeof(char)); \
if_test (#class " works") { \
for (int i = 0; i < 256; i++) { \
if (!check_int(class(i), ==, !!memchr(string, i, len)))\
test_msg(" i: 0x%02x", i); \
} \
check(!class(EOF)); \
} \
for (int i = 0; i < 256; i++) \
if (class(i) != !!memchr(string, i, len)) \
cl_failf("0x%02x is classified incorrectly", i); \
cl_assert(!class(EOF)); \
} while (0)

#define DIGIT "0123456789"
Expand All @@ -31,21 +28,72 @@
"\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f" \
"\x7f"

int cmd_main(int argc, const char **argv) {
void test_ctype__isspace(void)
{
TEST_CHAR_CLASS(isspace, " \n\r\t");
}

void test_ctype__isdigit(void)
{
TEST_CHAR_CLASS(isdigit, DIGIT);
}

void test_ctype__isalpha(void)
{
TEST_CHAR_CLASS(isalpha, LOWER UPPER);
}

void test_ctype__isalnum(void)
{
TEST_CHAR_CLASS(isalnum, LOWER UPPER DIGIT);
}

void test_ctype__is_glob_special(void)
{
TEST_CHAR_CLASS(is_glob_special, "*?[\\");
}

void test_ctype__is_regex_special(void)
{
TEST_CHAR_CLASS(is_regex_special, "$()*+.?[\\^{|");
}

void test_ctype__is_pathspec_magic(void)
{
TEST_CHAR_CLASS(is_pathspec_magic, "!\"#%&',-/:;<=>@_`~");
}

void test_ctype__isascii(void)
{
TEST_CHAR_CLASS(isascii, ASCII);
}

void test_ctype__islower(void)
{
TEST_CHAR_CLASS(islower, LOWER);
}

void test_ctype__isupper(void)
{
TEST_CHAR_CLASS(isupper, UPPER);
}

void test_ctype__iscntrl(void)
{
TEST_CHAR_CLASS(iscntrl, CNTRL);
}

void test_ctype__ispunct(void)
{
TEST_CHAR_CLASS(ispunct, PUNCT);
}

void test_ctype__isxdigit(void)
{
TEST_CHAR_CLASS(isxdigit, DIGIT "abcdefABCDEF");
TEST_CHAR_CLASS(isprint, LOWER UPPER DIGIT PUNCT " ");
}

return test_done();
void test_ctype__isprint(void)
{
TEST_CHAR_CLASS(isprint, LOWER UPPER DIGIT PUNCT " ");
}
7 changes: 7 additions & 0 deletions t/unit-tests/unit-test.h
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
#include "git-compat-util.h"
#include "clar/clar.h"
#include "clar-decls.h"
#include "strbuf.h"

#define cl_failf(fmt, ...) do { \
char *desc = xstrfmt(fmt, __VA_ARGS__); \
clar__fail(__FILE__, __func__, __LINE__, "Test failed.", desc, 1); \
free(desc); \
} while (0)

0 comments on commit 46e7a02

Please sign in to comment.