From 208642cfbb53781602af1fa77c67322c0aab0ad9 Mon Sep 17 00:00:00 2001 From: Amisha Chhajed Date: Thu, 29 Jan 2026 17:42:19 +0530 Subject: [PATCH 1/2] u-string-list: add unit tests for string-list methods Unit tests in u-string-list.c does not cover several methods in string-list, this gap in coverage makes it difficult to ensure no regressions are introduced in future changes. Add unit tests for the following methods to enhance coverage: string_list_remove_empty_items() unsorted_string_list_has_string() unsorted_string_list_delete_item() string_list_has_string() string_list_insert() string_list_sort() string_list_remove() Signed-off-by: Amisha Chhajed Signed-off-by: Junio C Hamano --- t/unit-tests/u-string-list.c | 209 +++++++++++++++++++++++++++++++++++ 1 file changed, 209 insertions(+) diff --git a/t/unit-tests/u-string-list.c b/t/unit-tests/u-string-list.c index a2457d7b1e..d469a06eca 100644 --- a/t/unit-tests/u-string-list.c +++ b/t/unit-tests/u-string-list.c @@ -243,6 +243,138 @@ void test_string_list__filter(void) t_string_list_clear(&list, 0); } +static void t_string_list_has_string( + struct string_list *list, + const char *string, + int expected) +{ + int has_string = string_list_has_string(list, string); + cl_assert_equal_i(has_string, expected); +} + +void test_string_list__has_string(void) +{ + struct string_list list = STRING_LIST_INIT_DUP; + + t_create_string_list_dup(&list, 0, NULL); + t_string_list_has_string(&list, "", 0); + + t_create_string_list_dup(&list, 0, "a", "b", "c", NULL); + t_string_list_has_string(&list, "a", 1); + t_string_list_has_string(&list, "b", 1); + t_string_list_has_string(&list, "c", 1); + t_string_list_has_string(&list, "d", 0); + + t_string_list_clear(&list, 0); +} + +static void t_string_list_insert(struct string_list *expected_strings, ...) +{ + struct string_list strings_to_insert = STRING_LIST_INIT_DUP; + struct string_list list = STRING_LIST_INIT_DUP; + va_list ap; + + va_start(ap, expected_strings); + t_vcreate_string_list_dup(&strings_to_insert, 0, ap); + va_end(ap); + + for (size_t i = 0; i < strings_to_insert.nr; i++) + string_list_insert(&list, strings_to_insert.items[i].string); + + t_string_list_equal(&list, expected_strings); + + string_list_clear(&strings_to_insert, 0); + string_list_clear(&list, 0); +} + +void test_string_list__insert(void) +{ + struct string_list expected_strings = STRING_LIST_INIT_DUP; + + t_create_string_list_dup(&expected_strings, 0, NULL); + t_string_list_insert(&expected_strings, NULL); + + t_create_string_list_dup(&expected_strings, 0, "a", "b", NULL); + t_string_list_insert(&expected_strings, "b", "a", "a", "b", NULL); + + t_create_string_list_dup(&expected_strings, 0, "a", "b", "c", NULL); + t_string_list_insert(&expected_strings, "c", "b", "a", "c", "b", NULL); + + t_create_string_list_dup(&expected_strings, 0, "", "a", NULL); + t_string_list_insert(&expected_strings, "a", "a", "a", "", NULL); + + t_string_list_clear(&expected_strings, 0); +} + +static void t_string_list_sort(struct string_list *list, ...) +{ + struct string_list expected_strings = STRING_LIST_INIT_DUP; + va_list ap; + + va_start(ap, list); + t_vcreate_string_list_dup(&expected_strings, 0, ap); + va_end(ap); + + string_list_sort(list); + t_string_list_equal(list, &expected_strings); + + string_list_clear(&expected_strings, 0); +} + +void test_string_list__sort(void) +{ + struct string_list list = STRING_LIST_INIT_DUP; + + t_create_string_list_dup(&list, 0, NULL); + t_string_list_sort(&list, NULL); + + t_create_string_list_dup(&list, 0, "b", "", "a", NULL); + t_string_list_sort(&list, "", "a", "b", NULL); + + t_create_string_list_dup(&list, 0, "c", "a", "b", "a", NULL); + t_string_list_sort(&list, "a", "a", "b", "c", NULL); + + t_string_list_clear(&list, 0); +} + +static void t_string_list_remove( + struct string_list *expected_strings, + struct string_list *list, + char const *str) +{ + string_list_remove(list, str, 0); + t_string_list_equal(list, expected_strings); +} + +void test_string_list__remove(void) +{ + struct string_list expected_strings = STRING_LIST_INIT_DUP; + struct string_list list = STRING_LIST_INIT_DUP; + + t_create_string_list_dup(&expected_strings, 0, NULL); + t_create_string_list_dup(&list, 0, NULL); + t_string_list_remove(&expected_strings, &list, ""); + + t_create_string_list_dup(&expected_strings, 0, "a", NULL); + t_create_string_list_dup(&list, 0, "a", "a", NULL); + t_string_list_remove(&expected_strings, &list, "a"); + + t_create_string_list_dup(&expected_strings, 0, "a", "b", "b", NULL); + t_create_string_list_dup(&list, 0, "a", "b", "b", "c", NULL); + t_string_list_remove(&expected_strings, &list, "c"); + + t_create_string_list_dup(&expected_strings, 0, "a", "b", "d", NULL); + t_create_string_list_dup(&list, 0, "a", "b", "c", "d", NULL); + t_string_list_remove(&expected_strings, &list, "c"); + + t_create_string_list_dup(&expected_strings, 0, "a", "b", "c", "d", NULL); + t_create_string_list_dup(&list, 0, "a", "b", "c", "d", NULL); + t_string_list_remove(&expected_strings, &list, "e"); + + t_string_list_clear(&expected_strings, 0); + t_string_list_clear(&list, 0); +} + static void t_string_list_remove_duplicates(struct string_list *list, ...) { struct string_list expected_strings = STRING_LIST_INIT_DUP; @@ -304,3 +436,80 @@ void test_string_list__remove_duplicates(void) t_string_list_clear(&list, 0); } + +static void t_string_list_remove_empty_items( + struct string_list *expected_strings, + struct string_list *list) +{ + string_list_remove_empty_items(list, 0); + t_string_list_equal(list, expected_strings); +} + +void test_string_list__remove_empty_items(void) +{ + struct string_list expected_strings = STRING_LIST_INIT_DUP; + struct string_list list = STRING_LIST_INIT_DUP; + + t_create_string_list_dup(&expected_strings, 0, NULL); + t_create_string_list_dup(&list, 0, "", "", "", NULL); + t_string_list_remove_empty_items(&expected_strings, &list); + + t_create_string_list_dup(&expected_strings, 0, "a", "b", NULL); + t_create_string_list_dup(&list, 0, "a", "", "b", "", NULL); + t_string_list_remove_empty_items(&expected_strings, &list); + + t_string_list_clear(&expected_strings, 0); + t_string_list_clear(&list, 0); +} + +static void t_string_list_unsorted_string_list_has_string( + struct string_list *list, + const char *str, int expected) +{ + int has_string = unsorted_string_list_has_string(list, str); + cl_assert_equal_i(has_string, expected); +} + +void test_string_list__unsorted_string_list_has_string(void) +{ + struct string_list list = STRING_LIST_INIT_DUP; + + t_create_string_list_dup(&list, 0, "b", "d", "a", NULL); + t_string_list_unsorted_string_list_has_string(&list, "a", 1); + t_string_list_unsorted_string_list_has_string(&list, "b", 1); + t_string_list_unsorted_string_list_has_string(&list, "c", 0); + t_string_list_unsorted_string_list_has_string(&list, "d", 1); + + t_string_list_clear(&list, 0); +} + +static void t_string_list_unsorted_string_list_delete_item( + struct string_list *expected_list, + struct string_list *list, + int i) +{ + unsorted_string_list_delete_item(list, i, 0); + + t_string_list_equal(list, expected_list); +} + +void test_string_list__unsorted_string_list_delete_item(void) +{ + struct string_list expected_strings = STRING_LIST_INIT_DUP; + struct string_list list = STRING_LIST_INIT_DUP; + + t_create_string_list_dup(&expected_strings, 0, "a", "c", "b", NULL); + t_create_string_list_dup(&list, 0, "a", "d", "b", "c", NULL); + t_string_list_unsorted_string_list_delete_item(&expected_strings, &list, 1); + + t_create_string_list_dup(&expected_strings, 0, NULL); + t_create_string_list_dup(&list, 0, "", NULL); + t_string_list_unsorted_string_list_delete_item(&expected_strings, &list, 0); + + t_create_string_list_dup(&expected_strings, 0, "a", "d", "c", "b", NULL); + t_create_string_list_dup(&list, 0, "a", "d", "c", "b", "d", NULL); + t_string_list_unsorted_string_list_delete_item(&expected_strings, &list, 4); + + t_string_list_clear(&expected_strings, 0); + t_string_list_clear(&list, 0); +} From 2e711acfbdfc0fedf631688d78cde153ba835c93 Mon Sep 17 00:00:00 2001 From: Amisha Chhajed Date: Thu, 29 Jan 2026 17:42:20 +0530 Subject: [PATCH 2/2] string-list: add string_list_sort_u() that mimics "sort -u" Many callsites of string_list_remove_duplicates() call it immdediately after calling string_list_sort(), understandably as the former requires string-list to be sorted, it is clear that these places are sorting only to remove duplicates and for no other reason. Introduce a helper function string_list_sort_u that combines these two calls that often appear together, to simplify these callsites. Replace the current calls of those methods with string_list_sort_u(). Signed-off-by: Amisha Chhajed Signed-off-by: Junio C Hamano --- builtin/clone.c | 3 +-- builtin/fast-export.c | 3 +-- builtin/pack-objects.c | 6 ++---- builtin/sparse-checkout.c | 6 ++---- help.c | 3 +-- notes.c | 3 +-- string-list.c | 6 ++++++ string-list.h | 6 ++++++ t/unit-tests/u-string-list.c | 34 ++++++++++++++++++++++++++++++++++ 9 files changed, 54 insertions(+), 16 deletions(-) diff --git a/builtin/clone.c b/builtin/clone.c index b40cee5968..b14a39a687 100644 --- a/builtin/clone.c +++ b/builtin/clone.c @@ -1136,8 +1136,7 @@ int cmd_clone(int argc, int val; /* remove duplicates */ - string_list_sort(&option_recurse_submodules); - string_list_remove_duplicates(&option_recurse_submodules, 0); + string_list_sort_u(&option_recurse_submodules, 0); /* * NEEDSWORK: In a multi-working-tree world, this needs to be diff --git a/builtin/fast-export.c b/builtin/fast-export.c index b90da5e616..0c5d2386d8 100644 --- a/builtin/fast-export.c +++ b/builtin/fast-export.c @@ -1118,8 +1118,7 @@ static void get_tags_and_duplicates(struct rev_cmdline_info *info) free(full_name); } - string_list_sort(&extra_refs); - string_list_remove_duplicates(&extra_refs, 0); + string_list_sort_u(&extra_refs, 0); } static void handle_tags_and_duplicates(struct string_list *extras) diff --git a/builtin/pack-objects.c b/builtin/pack-objects.c index 5846b6a293..9807dd0eff 100644 --- a/builtin/pack-objects.c +++ b/builtin/pack-objects.c @@ -3855,10 +3855,8 @@ static void read_packs_list_from_stdin(struct rev_info *revs) strbuf_reset(&buf); } - string_list_sort(&include_packs); - string_list_remove_duplicates(&include_packs, 0); - string_list_sort(&exclude_packs); - string_list_remove_duplicates(&exclude_packs, 0); + string_list_sort_u(&include_packs, 0); + string_list_sort_u(&exclude_packs, 0); repo_for_each_pack(the_repository, p) { const char *pack_name = pack_basename(p); diff --git a/builtin/sparse-checkout.c b/builtin/sparse-checkout.c index 15d51e60a8..25de7692c9 100644 --- a/builtin/sparse-checkout.c +++ b/builtin/sparse-checkout.c @@ -292,8 +292,7 @@ static void write_cone_to_file(FILE *fp, struct pattern_list *pl) string_list_insert(&sl, pe->pattern); } - string_list_sort(&sl); - string_list_remove_duplicates(&sl, 0); + string_list_sort_u(&sl, 0); fprintf(fp, "/*\n!/*/\n"); @@ -316,8 +315,7 @@ static void write_cone_to_file(FILE *fp, struct pattern_list *pl) strbuf_release(&parent_pattern); - string_list_sort(&sl); - string_list_remove_duplicates(&sl, 0); + string_list_sort_u(&sl, 0); for (i = 0; i < sl.nr; i++) { char *pattern = escaped_pattern(sl.items[i].string); diff --git a/help.c b/help.c index 3c36d9c218..fefd811f7a 100644 --- a/help.c +++ b/help.c @@ -420,8 +420,7 @@ void list_cmds_by_config(struct string_list *list) if (repo_config_get_string_tmp(the_repository, "completion.commands", &cmd_list)) return; - string_list_sort(list); - string_list_remove_duplicates(list, 0); + string_list_sort_u(list, 0); while (*cmd_list) { struct strbuf sb = STRBUF_INIT; diff --git a/notes.c b/notes.c index 8e00fd8c47..090c48bbd5 100644 --- a/notes.c +++ b/notes.c @@ -921,8 +921,7 @@ int combine_notes_cat_sort_uniq(struct object_id *cur_oid, if (string_list_add_note_lines(&sort_uniq_list, new_oid)) goto out; string_list_remove_empty_items(&sort_uniq_list, 0); - string_list_sort(&sort_uniq_list); - string_list_remove_duplicates(&sort_uniq_list, 0); + string_list_sort_u(&sort_uniq_list, 0); /* create a new blob object from sort_uniq_list */ if (for_each_string_list(&sort_uniq_list, diff --git a/string-list.c b/string-list.c index 08dc00984c..020ed8fef7 100644 --- a/string-list.c +++ b/string-list.c @@ -247,6 +247,12 @@ void string_list_sort(struct string_list *list) QSORT_S(list->items, list->nr, cmp_items, &sort_ctx); } +void string_list_sort_u(struct string_list *list, int free_util) +{ + string_list_sort(list); + string_list_remove_duplicates(list, free_util); +} + struct string_list_item *unsorted_string_list_lookup(struct string_list *list, const char *string) { diff --git a/string-list.h b/string-list.h index fa6ba07853..3ad862a187 100644 --- a/string-list.h +++ b/string-list.h @@ -239,6 +239,12 @@ struct string_list_item *string_list_append_nodup(struct string_list *list, char */ void string_list_sort(struct string_list *list); +/** + * Sort the list and then remove duplicate entries. If free_util is true, + * call free() on the util members of any items that have to be deleted. + */ +void string_list_sort_u(struct string_list *list, int free_util); + /** * Like `string_list_has_string()` but for unsorted lists. Linear in * size of the list. diff --git a/t/unit-tests/u-string-list.c b/t/unit-tests/u-string-list.c index d469a06eca..7ad84cc1cd 100644 --- a/t/unit-tests/u-string-list.c +++ b/t/unit-tests/u-string-list.c @@ -437,6 +437,40 @@ void test_string_list__remove_duplicates(void) t_string_list_clear(&list, 0); } +static void t_string_list_sort_u(struct string_list *list, ...) +{ + struct string_list expected_strings = STRING_LIST_INIT_DUP; + va_list ap; + + va_start(ap, list); + t_vcreate_string_list_dup(&expected_strings, 0, ap); + va_end(ap); + + string_list_sort_u(list, 0); + t_string_list_equal(list, &expected_strings); + + string_list_clear(&expected_strings, 0); +} + +void test_string_list__sort_u(void) +{ + struct string_list list = STRING_LIST_INIT_DUP; + + t_create_string_list_dup(&list, 0, NULL); + t_string_list_sort_u(&list, NULL); + + t_create_string_list_dup(&list, 0, "", "", "", "", NULL); + t_string_list_sort_u(&list, "", NULL); + + t_create_string_list_dup(&list, 0, "b", "a", "a", "", NULL); + t_string_list_sort_u(&list, "", "a", "b", NULL); + + t_create_string_list_dup(&list, 0, "b", "a", "a", "d", "c", "c", NULL); + t_string_list_sort_u(&list, "a", "b", "c", "d", NULL); + + t_string_list_clear(&list, 0); +} + static void t_string_list_remove_empty_items( struct string_list *expected_strings, struct string_list *list)