kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

Merge branch 'sk/clar-trailer-urlmatch-norm-test' 

A few traditional unit tests have been rewritten to use the clar
framework.

* sk/clar-trailer-urlmatch-norm-test:
  t/unit-tests: convert urlmatch-normalization test to clar
  t/unit-tests: convert trailer test to use clar
maint
Junio C Hamano 2025-04-16 13:54:17 -07:00
parent 743d3a54f2 7d4212b8f3
commit 779534d5a7
5 changed files with 342 additions and 363 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@ -1367,6 +1367,8 @@ CLAR_TEST_SUITES += u-reftable-tree
CLAR_TEST_SUITES += u-strbuf
CLAR_TEST_SUITES += u-strcmp-offset
CLAR_TEST_SUITES += u-strvec
CLAR_TEST_SUITES += u-trailer
CLAR_TEST_SUITES += u-urlmatch-normalization
CLAR_TEST_PROG = $(UNIT_TEST_BIN)/unit-tests$(X)
CLAR_TEST_OBJS = $(patsubst %,$(UNIT_TEST_DIR)/%.o,$(CLAR_TEST_SUITES))
CLAR_TEST_OBJS += $(UNIT_TEST_DIR)/clar/clar.o
@ -1381,8 +1383,6 @@ UNIT_TEST_PROGRAMS += t-reftable-reader
UNIT_TEST_PROGRAMS += t-reftable-readwrite
UNIT_TEST_PROGRAMS += t-reftable-record
UNIT_TEST_PROGRAMS += t-reftable-stack
UNIT_TEST_PROGRAMS += t-trailer
UNIT_TEST_PROGRAMS += t-urlmatch-normalization
UNIT_TEST_PROGS = $(patsubst %,$(UNIT_TEST_BIN)/%$X,$(UNIT_TEST_PROGRAMS))
UNIT_TEST_OBJS += $(UNIT_TEST_DIR)/test-lib.o
UNIT_TEST_OBJS += $(UNIT_TEST_DIR)/lib-reftable.o

4
t/meson.build
View File

@ -12,6 +12,8 @@ clar_test_suites = [
'unit-tests/u-strbuf.c',
'unit-tests/u-strcmp-offset.c',
'unit-tests/u-strvec.c',
'unit-tests/u-trailer.c',
'unit-tests/u-urlmatch-normalization.c',
]

clar_sources = [
@ -60,8 +62,6 @@ unit_test_programs = [
'unit-tests/t-reftable-readwrite.c',
'unit-tests/t-reftable-record.c',
'unit-tests/t-reftable-stack.c',
'unit-tests/t-trailer.c',
'unit-tests/t-urlmatch-normalization.c',
]

foreach unit_test_program : unit_test_programs

317
t/unit-tests/t-trailer.c
View File

@ -1,317 +0,0 @@
#define DISABLE_SIGN_COMPARE_WARNINGS

#include "test-lib.h"
#include "trailer.h"

struct contents {
const char *raw;
const char *key;
const char *val;
};

static void t_trailer_iterator(const char *msg, size_t num_expected,
struct contents *contents)
{
struct trailer_iterator iter;
size_t i = 0;

trailer_iterator_init(&iter, msg);
while (trailer_iterator_advance(&iter)) {
if (num_expected) {
check_str(iter.raw, contents[i].raw);
check_str(iter.key.buf, contents[i].key);
check_str(iter.val.buf, contents[i].val);
}
i++;
}
trailer_iterator_release(&iter);

check_uint(i, ==, num_expected);
}

static void run_t_trailer_iterator(void)
{

static struct test_cases {
const char *name;
const char *msg;
size_t num_expected;
struct contents contents[10];
} tc[] = {
{
"empty input",
"",
0,
{{0}},
},
{
"no newline at beginning",
"Fixes: x\n"
"Acked-by: x\n"
"Reviewed-by: x\n",
0,
{{0}},
},
{
"newline at beginning",
"\n"
"Fixes: x\n"
"Acked-by: x\n"
"Reviewed-by: x\n",
3,
{
{
.raw = "Fixes: x\n",
.key = "Fixes",
.val = "x",
},
{
.raw = "Acked-by: x\n",
.key = "Acked-by",
.val = "x",
},
{
.raw = "Reviewed-by: x\n",
.key = "Reviewed-by",
.val = "x",
},
{
0
},
},
},
{
"without body text",
"subject: foo bar\n"
"\n"
"Fixes: x\n"
"Acked-by: x\n"
"Reviewed-by: x\n",
3,
{
{
.raw = "Fixes: x\n",
.key = "Fixes",
.val = "x",
},
{
.raw = "Acked-by: x\n",
.key = "Acked-by",
.val = "x",
},
{
.raw = "Reviewed-by: x\n",
.key = "Reviewed-by",
.val = "x",
},
{
0
},
},
},
{
"with body text, without divider",
"my subject\n"
"\n"
"my body which is long\n"
"and contains some special\n"
"chars like : = ? !\n"
"hello\n"
"\n"
"Fixes: x\n"
"Acked-by: x\n"
"Reviewed-by: x\n"
"Signed-off-by: x\n",
4,
{
{
.raw = "Fixes: x\n",
.key = "Fixes",
.val = "x",
},
{
.raw = "Acked-by: x\n",
.key = "Acked-by",
.val = "x",
},
{
.raw = "Reviewed-by: x\n",
.key = "Reviewed-by",
.val = "x",
},
{
.raw = "Signed-off-by: x\n",
.key = "Signed-off-by",
.val = "x",
},
{
0
},
},
},
{
"with body text, without divider (second trailer block)",
"my subject\n"
"\n"
"my body which is long\n"
"and contains some special\n"
"chars like : = ? !\n"
"hello\n"
"\n"
"Fixes: x\n"
"Acked-by: x\n"
"Reviewed-by: x\n"
"Signed-off-by: x\n"
"\n"
/*
* Because this is the last trailer block, it takes
* precedence over the first one encountered above.
*/
"Helped-by: x\n"
"Signed-off-by: x\n",
2,
{
{
.raw = "Helped-by: x\n",
.key = "Helped-by",
.val = "x",
},
{
.raw = "Signed-off-by: x\n",
.key = "Signed-off-by",
.val = "x",
},
{
0
},
},
},
{
"with body text, with divider",
"my subject\n"
"\n"
"my body which is long\n"
"and contains some special\n"
"chars like : = ? !\n"
"hello\n"
"\n"
"---\n"
"\n"
/*
* This trailer still counts because the iterator
* always ignores the divider.
*/
"Signed-off-by: x\n",
1,
{
{
.raw = "Signed-off-by: x\n",
.key = "Signed-off-by",
.val = "x",
},
{
0
},
},
},
{
"with non-trailer lines in trailer block",
"subject: foo bar\n"
"\n"
/*
* Even though this trailer block has a non-trailer line
* in it, it's still a valid trailer block because it's
* at least 25% trailers and is Git-generated (see
* git_generated_prefixes[] in trailer.c).
*/
"not a trailer line\n"
"not a trailer line\n"
"not a trailer line\n"
"Signed-off-by: x\n",
/*
* Even though there is only really 1 real "trailer"
* (Signed-off-by), we still have 4 trailer objects
* because we still want to iterate through the entire
* block.
*/
4,
{
{
.raw = "not a trailer line\n",
.key = "not a trailer line",
.val = "",
},
{
.raw = "not a trailer line\n",
.key = "not a trailer line",
.val = "",
},
{
.raw = "not a trailer line\n",
.key = "not a trailer line",
.val = "",
},
{
.raw = "Signed-off-by: x\n",
.key = "Signed-off-by",
.val = "x",
},
{
0
},
},
},
{
"with non-trailer lines (one too many) in trailer block",
"subject: foo bar\n"
"\n"
/*
* This block has only 20% trailers, so it's below the
* 25% threshold.
*/
"not a trailer line\n"
"not a trailer line\n"
"not a trailer line\n"
"not a trailer line\n"
"Signed-off-by: x\n",
0,
{{0}},
},
{
"with non-trailer lines (only 1) in trailer block, but no Git-generated trailers",
"subject: foo bar\n"
"\n"
/*
* This block has only 1 non-trailer out of 10 (IOW, 90%
* trailers) but is not considered a trailer block
* because the 25% threshold only applies to cases where
* there was a Git-generated trailer.
*/
"Reviewed-by: x\n"
"Reviewed-by: x\n"
"Reviewed-by: x\n"
"Helped-by: x\n"
"Helped-by: x\n"
"Helped-by: x\n"
"Acked-by: x\n"
"Acked-by: x\n"
"Acked-by: x\n"
"not a trailer line\n",
0,
{{0}},
},
};

for (int i = 0; i < sizeof(tc) / sizeof(tc[0]); i++) {
TEST(t_trailer_iterator(tc[i].msg,
tc[i].num_expected,
tc[i].contents),
"%s", tc[i].name);
}
}

int cmd_main(int argc UNUSED, const char **argv UNUSED)
{
run_t_trailer_iterator();
return test_done();
}

320
t/unit-tests/u-trailer.c Normal file
View File

@ -0,0 +1,320 @@
#define DISABLE_SIGN_COMPARE_WARNINGS

#include "unit-test.h"
#include "trailer.h"

struct contents {
const char *raw;
const char *key;
const char *val;
};

static void t_trailer_iterator(const char *msg, size_t num_expected,
struct contents *contents)
{
struct trailer_iterator iter;
size_t i = 0;

trailer_iterator_init(&iter, msg);
while (trailer_iterator_advance(&iter)) {
if (num_expected) {
cl_assert_equal_s(iter.raw, contents[i].raw);
cl_assert_equal_s(iter.key.buf, contents[i].key);
cl_assert_equal_s(iter.val.buf, contents[i].val);
}
i++;
}
trailer_iterator_release(&iter);

cl_assert_equal_i(i, num_expected);
}

void test_trailer__empty_input(void)
{
struct contents expected_contents[] = { 0 };
t_trailer_iterator("", 0, expected_contents);
}

void test_trailer__no_newline_start(void)
{
struct contents expected_contents[] = { 0 };

t_trailer_iterator("Fixes: x\n"
"Acked-by: x\n"
"Reviewed-by: x\n",
0,
expected_contents);
}

void test_trailer__newline_start(void)
{
struct contents expected_contents[] = {
{
.raw = "Fixes: x\n",
.key = "Fixes",
.val = "x",
},
{
.raw = "Acked-by: x\n",
.key = "Acked-by",
.val = "x",
},
{
.raw = "Reviewed-by: x\n",
.key = "Reviewed-by",
.val = "x",
},
{
0
},
};

t_trailer_iterator("\n"
"Fixes: x\n"
"Acked-by: x\n"
"Reviewed-by: x\n",
3,
expected_contents);
}

void test_trailer__no_body_text(void)
{
struct contents expected_contents[] = {

{
.raw = "Fixes: x\n",
.key = "Fixes",
.val = "x",
},
{
.raw = "Acked-by: x\n",
.key = "Acked-by",
.val = "x",
},
{
.raw = "Reviewed-by: x\n",
.key = "Reviewed-by",
.val = "x",
},
{
0
},
};

t_trailer_iterator("subject: foo bar\n"
"\n"
"Fixes: x\n"
"Acked-by: x\n"
"Reviewed-by: x\n",
3,
expected_contents);
}

void test_trailer__body_text_no_divider(void)
{
struct contents expected_contents[] = {
{
.raw = "Fixes: x\n",
.key = "Fixes",
.val = "x",
},
{
.raw = "Acked-by: x\n",
.key = "Acked-by",
.val = "x",
},
{
.raw = "Reviewed-by: x\n",
.key = "Reviewed-by",
.val = "x",
},
{
.raw = "Signed-off-by: x\n",
.key = "Signed-off-by",
.val = "x",
},
{
0
},
};

t_trailer_iterator("my subject\n"
"\n"
"my body which is long\n"
"and contains some special\n"
"chars like : = ? !\n"
"hello\n"
"\n"
"Fixes: x\n"
"Acked-by: x\n"
"Reviewed-by: x\n"
"Signed-off-by: x\n",
4,
expected_contents);
}

void test_trailer__body_no_divider_2nd_block(void)
{
struct contents expected_contents[] = {
{
.raw = "Helped-by: x\n",
.key = "Helped-by",
.val = "x",
},
{
.raw = "Signed-off-by: x\n",
.key = "Signed-off-by",
.val = "x",
},
{
0
},
};

t_trailer_iterator("my subject\n"
"\n"
"my body which is long\n"
"and contains some special\n"
"chars like : = ? !\n"
"hello\n"
"\n"
"Fixes: x\n"
"Acked-by: x\n"
"Reviewed-by: x\n"
"Signed-off-by: x\n"
"\n"
/*
* Because this is the last trailer block, it takes
* precedence over the first one encountered above.
*/
"Helped-by: x\n"
"Signed-off-by: x\n",
2,
expected_contents);
}

void test_trailer__body_and_divider(void)
{
struct contents expected_contents[] = {
{
.raw = "Signed-off-by: x\n",
.key = "Signed-off-by",
.val = "x",
},
{
0
},
};

t_trailer_iterator("my subject\n"
"\n"
"my body which is long\n"
"and contains some special\n"
"chars like : = ? !\n"
"hello\n"
"\n"
"---\n"
"\n"
/*
* This trailer still counts because the iterator
* always ignores the divider.
*/
"Signed-off-by: x\n",
1,
expected_contents);
}

void test_trailer__non_trailer_in_block(void)
{
struct contents expected_contents[] = {
{
.raw = "not a trailer line\n",
.key = "not a trailer line",
.val = "",
},
{
.raw = "not a trailer line\n",
.key = "not a trailer line",
.val = "",
},
{
.raw = "not a trailer line\n",
.key = "not a trailer line",
.val = "",
},
{
.raw = "Signed-off-by: x\n",
.key = "Signed-off-by",
.val = "x",
},
{
0
},
};

t_trailer_iterator("subject: foo bar\n"
"\n"
/*
* Even though this trailer block has a non-trailer line
* in it, it's still a valid trailer block because it's
* at least 25% trailers and is Git-generated (see
* git_generated_prefixes[] in trailer.c).
*/
"not a trailer line\n"
"not a trailer line\n"
"not a trailer line\n"
"Signed-off-by: x\n",
/*
* Even though there is only really 1 real "trailer"
* (Signed-off-by), we still have 4 trailer objects
* because we still want to iterate through the entire
* block.
*/
4,
expected_contents);
}

void test_trailer__too_many_non_trailers(void)
{
struct contents expected_contents[] = { 0 };

t_trailer_iterator("subject: foo bar\n"
"\n"
/*
* This block has only 20% trailers, so it's below the
* 25% threshold.
*/
"not a trailer line\n"
"not a trailer line\n"
"not a trailer line\n"
"not a trailer line\n"
"Signed-off-by: x\n",
0,
expected_contents);
}

void test_trailer__one_non_trailer_no_git_trailers(void)
{
struct contents expected_contents[] = { 0 };

t_trailer_iterator("subject: foo bar\n"
"\n"
/*
* This block has only 1 non-trailer out of 10 (IOW, 90%
* trailers) but is not considered a trailer block
* because the 25% threshold only applies to cases where
* there was a Git-generated trailer.
*/
"Reviewed-by: x\n"
"Reviewed-by: x\n"
"Reviewed-by: x\n"
"Helped-by: x\n"
"Helped-by: x\n"
"Helped-by: x\n"
"Acked-by: x\n"
"Acked-by: x\n"
"Acked-by: x\n"
"not a trailer line\n",
0,
expected_contents);
}

60
t/unit-tests/t-urlmatch-normalization.c → t/unit-tests/u-urlmatch-normalization.c
View File

@ -1,12 +1,11 @@
#include "test-lib.h"
#include "unit-test.h"
#include "urlmatch.h"

static void check_url_normalizable(const char *url, unsigned int normalizable)
{
char *url_norm = url_normalize(url, NULL);

if (!check_int(normalizable, ==, url_norm ? 1 : 0))
test_msg("input url: %s", url);
cl_assert_equal_i(normalizable, url_norm ? 1 : 0);
free(url_norm);
}

@ -14,8 +13,7 @@ static void check_normalized_url(const char *url, const char *expect)
{
char *url_norm = url_normalize(url, NULL);

if (!check_str(url_norm, expect))
test_msg("input url: %s", url);
cl_assert_equal_s(url_norm, expect);
free(url_norm);
}

@ -26,13 +24,9 @@ static void compare_normalized_urls(const char *url1, const char *url2,
char *url2_norm = url_normalize(url2, NULL);

if (equal) {
if (!check_str(url1_norm, url2_norm))
test_msg("input url1: %s\n input url2: %s", url1,
url2);
} else if (!check_int(strcmp(url1_norm, url2_norm), !=, 0)) {
test_msg(" normalized url1: %s\n normalized url2: %s\n"
" input url1: %s\n input url2: %s",
url1_norm, url2_norm, url1, url2);
cl_assert_equal_s(url1_norm, url2_norm);
} else {
cl_assert(strcmp(url1_norm, url2_norm) != 0);
}
free(url1_norm);
free(url2_norm);
@ -43,14 +37,12 @@ static void check_normalized_url_length(const char *url, size_t len)
struct url_info info;
char *url_norm = url_normalize(url, &info);

if (!check_int(info.url_len, ==, len))
test_msg(" input url: %s\n normalized url: %s", url,
url_norm);
cl_assert_equal_i(info.url_len, len);
free(url_norm);
}

/* Note that only "file:" URLs should be allowed without a host */
static void t_url_scheme(void)
void test_urlmatch_normalization__scheme(void)
{
check_url_normalizable("", 0);
check_url_normalizable("_", 0);
@ -73,7 +65,7 @@ static void t_url_scheme(void)
check_normalized_url("AbCdeF://x.Y", "abcdef://x.y/");
}

static void t_url_authority(void)
void test_urlmatch_normalization__authority(void)
{
check_url_normalizable("scheme://user:pass@", 0);
check_url_normalizable("scheme://?", 0);
@ -109,7 +101,7 @@ static void t_url_authority(void)
check_url_normalizable("scheme://invalid....:[", 0);
}

static void t_url_port(void)
void test_urlmatch_normalization__port(void)
{
check_url_normalizable("xyz://q@some.host:", 1);
check_url_normalizable("xyz://q@some.host:456/", 1);
@ -139,7 +131,7 @@ static void t_url_port(void)
check_url_normalizable("xyz://[::1]:030f/", 0);
}

static void t_url_port_normalization(void)
void test_urlmatch_normalization__port_normalization(void)
{
check_normalized_url("http://x:800", "http://x:800/");
check_normalized_url("http://x:0800", "http://x:800/");
@ -154,7 +146,7 @@ static void t_url_port_normalization(void)
check_normalized_url("https://x:000000443", "https://x/");
}

static void t_url_general_escape(void)
void test_urlmatch_normalization__general_escape(void)
{
check_url_normalizable("http://x.y?%fg", 0);
check_normalized_url("X://W/%7e%41^%3a", "x://w/~A%5E%3A");
@ -164,7 +156,7 @@ static void t_url_general_escape(void)
check_normalized_url("X://W?!", "x://w/?!");
}

static void t_url_high_bit(void)
void test_urlmatch_normalization__high_bit(void)
{
check_normalized_url(
"x://q/\x01\x02\x03\x04\x05\x06\x07\x08\x0e\x0f\x10\x11\x12",
@ -198,26 +190,26 @@ static void t_url_high_bit(void)
"x://q/%F0%F1%F2%F3%F4%F5%F6%F7%F8%F9%FA%FB%FC%FD%FE%FF");
}

static void t_url_utf8_escape(void)
void test_urlmatch_normalization__utf8_escape(void)
{
check_normalized_url(
"x://q/\xc2\x80\xdf\xbf\xe0\xa0\x80\xef\xbf\xbd\xf0\x90\x80\x80\xf0\xaf\xbf\xbd",
"x://q/%C2%80%DF%BF%E0%A0%80%EF%BF%BD%F0%90%80%80%F0%AF%BF%BD");
}

static void t_url_username_pass(void)
void test_urlmatch_normalization__username_pass(void)
{
check_normalized_url("x://%41%62(^):%70+d@foo", "x://Ab(%5E):p+d@foo/");
}

static void t_url_length(void)
void test_urlmatch_normalization__length(void)
{
check_normalized_url_length("Http://%4d%65:%4d^%70@The.Host", 25);
check_normalized_url_length("http://%41:%42@x.y/%61/", 17);
check_normalized_url_length("http://@x.y/^", 15);
}

static void t_url_dots(void)
void test_urlmatch_normalization__dots(void)
{
check_normalized_url("x://y/.", "x://y/");
check_normalized_url("x://y/./", "x://y/");
@ -244,7 +236,7 @@ static void t_url_dots(void)
* "http://foo" specifies neither a user name nor a password.
* So they should not be equivalent.
*/
static void t_url_equivalents(void)
void test_urlmatch_normalization__equivalents(void)
{
compare_normalized_urls("httP://x", "Http://X/", 1);
compare_normalized_urls("Http://%4d%65:%4d^%70@The.Host", "hTTP://Me:%4D^p@the.HOST:80/", 1);
@ -253,19 +245,3 @@ static void t_url_equivalents(void)
compare_normalized_urls("https://@x.y/^/../abc", "httpS://@x.y:0443/abc", 1);
compare_normalized_urls("https://@x.y/^/..", "httpS://@x.y:0443/", 1);
}

int cmd_main(int argc UNUSED, const char **argv UNUSED)
{
TEST(t_url_scheme(), "url scheme");
TEST(t_url_authority(), "url authority");
TEST(t_url_port(), "url port checks");
TEST(t_url_port_normalization(), "url port normalization");
TEST(t_url_general_escape(), "url general escapes");
TEST(t_url_high_bit(), "url high-bit escapes");
TEST(t_url_utf8_escape(), "url utf8 escapes");
TEST(t_url_username_pass(), "url username/password escapes");
TEST(t_url_length(), "url normalized lengths");
TEST(t_url_dots(), "url . and .. segments");
TEST(t_url_equivalents(), "url equivalents");
return test_done();
}