The branch main has been updated by asomers: URL: https://cgit.FreeBSD.org/src/commit/?id=113c262b2ad157790e19188bf298b7205bd1887b
commit 113c262b2ad157790e19188bf298b7205bd1887b Author: Jitendra Bhati <[email protected]> AuthorDate: 2026-05-21 01:40:13 +0000 Commit: Alan Somers <[email protected]> CommitDate: 2026-05-22 17:38:21 +0000 lib/libc/tests/gen: add fts_open() error and edge case tests Add ATF test cases covering fts_open() error conditions and edge cases: - invalid option bits (outside FTS_OPTIONMASK) yield EINVAL - empty argv yields EINVAL - empty path string yields FTS_NS with ENOENT - nonexistent path yields FTS_NS, not open failure - trailing slash does not crash (SVN r49851 regression) - unreadable directory yields FTS_D then FTS_DNR, never FTS_DP - multiple root paths are all visited left to right Sponsored by: Google LLC (GSoC 2026) Reviewed by: asomers MFC after: 1 week Pull Request: https://github.com/freebsd/freebsd-src/pull/2217 --- lib/libc/tests/gen/Makefile | 1 + lib/libc/tests/gen/fts_open_test.c | 230 +++++++++++++++++++++++++++++++++++++ 2 files changed, 231 insertions(+) diff --git a/lib/libc/tests/gen/Makefile b/lib/libc/tests/gen/Makefile index 054b1b426b3d..9c1c1cb75bcf 100644 --- a/lib/libc/tests/gen/Makefile +++ b/lib/libc/tests/gen/Makefile @@ -11,6 +11,7 @@ ATF_TESTS_C+= fpclassify2_test ATF_TESTS_C+= fts_blocks_test .endif ATF_TESTS_C+= fts_misc_test +ATF_TESTS_C+= fts_open_test ATF_TESTS_C+= fts_options_test ATF_TESTS_C+= ftw_test ATF_TESTS_C+= getentropy_test diff --git a/lib/libc/tests/gen/fts_open_test.c b/lib/libc/tests/gen/fts_open_test.c new file mode 100644 index 000000000000..e6120b09006b --- /dev/null +++ b/lib/libc/tests/gen/fts_open_test.c @@ -0,0 +1,230 @@ +/* + * Copyright (c) 2026 Jitendra Bhati + * + * SPDX-License-Identifier: BSD-2-Clause + */ + +/* + * Tests for fts_open() error conditions and edge cases. + */ + +#include <sys/stat.h> + +#include <errno.h> +#include <fcntl.h> +#include <fts.h> +#include <stdbool.h> +#include <stdio.h> +#include <stdlib.h> +#include <unistd.h> + +#include <atf-c.h> + +#include "fts_test.h" + +/* + * Option bits outside FTS_OPTIONMASK must fail with EINVAL. + */ +ATF_TC(invalid_options); +ATF_TC_HEAD(invalid_options, tc) +{ + atf_tc_set_md_var(tc, "descr", + "fts_open with out-of-mask option bits fails with EINVAL"); +} +ATF_TC_BODY(invalid_options, tc) +{ + char *paths[] = { ".", NULL }; + + ATF_REQUIRE_ERRNO(EINVAL, fts_open(paths, 0x10000, NULL) == NULL); +} + +/* + * Empty argv (NULL as first element) must fail with EINVAL. + */ +ATF_TC(empty_argv); +ATF_TC_HEAD(empty_argv, tc) +{ + atf_tc_set_md_var(tc, "descr", + "fts_open with NULL first argv element fails with EINVAL"); +} +ATF_TC_BODY(empty_argv, tc) +{ + char *paths[] = { NULL }; + + ATF_REQUIRE_ERRNO(EINVAL, + fts_open(paths, FTS_PHYSICAL, NULL) == NULL); +} + +/* + * An empty string in argv is a valid path but stat("") fails with ENOENT. + * fts_open() succeeds; the resulting FTSENT has fts_info == FTS_NS and + * fts_errno == ENOENT. + */ +ATF_TC(empty_path_string); +ATF_TC_HEAD(empty_path_string, tc) +{ + atf_tc_set_md_var(tc, "descr", + "empty string in argv produces FTS_NS entry"); +} +ATF_TC_BODY(empty_path_string, tc) +{ + char *paths[] = { "", NULL }; + FTS *fts; + FTSENT *ent; + + ATF_REQUIRE((fts = fts_open(paths, FTS_PHYSICAL, NULL)) != NULL); + + ent = fts_read(fts); + ATF_REQUIRE(ent != NULL); + ATF_CHECK_EQ(FTS_NS, ent->fts_info); + ATF_CHECK_EQ(ENOENT, ent->fts_errno); + + fts_close(fts); +} + +/* + * A nonexistent path produces an FTS_NS entry rather than causing + * fts_open() itself to fail. fts_open() does not validate whether + * paths exist. errno must be 0 after the traversal ends normally. + */ +ATF_TC(nonexistent_path); +ATF_TC_HEAD(nonexistent_path, tc) +{ + atf_tc_set_md_var(tc, "descr", + "nonexistent path produces FTS_NS entry, not fts_open failure"); +} +ATF_TC_BODY(nonexistent_path, tc) +{ + char *paths[] = { "this-path-does-not-exist", NULL }; + FTS *fts; + FTSENT *ent; + + ATF_REQUIRE((fts = fts_open(paths, FTS_PHYSICAL, NULL)) != NULL); + + ent = fts_read(fts); + ATF_REQUIRE(ent != NULL); + ATF_CHECK_EQ(FTS_NS, ent->fts_info); + ATF_CHECK_EQ(ENOENT, ent->fts_errno); + + /* + * Next fts_read must return NULL with errno == 0 — + * end-of-traversal, not an error. + */ + errno = 1; /* sentinel — fts_read must clear this */ + ATF_CHECK_EQ(NULL, fts_read(fts)); + ATF_CHECK_EQ(0, errno); + + ATF_REQUIRE_EQ_MSG(0, fts_close(fts), "fts_close(): %m"); +} + +/* + * A path with a trailing slash must not crash and must traverse the + * directory normally. This is a regression test for SVN r49851. + */ +ATF_TC(trailing_slash); +ATF_TC_HEAD(trailing_slash, tc) +{ + atf_tc_set_md_var(tc, "descr", + "trailing slash on root path must not crash (SVN r49851)"); +} +ATF_TC_BODY(trailing_slash, tc) +{ + char *paths[] = { "dir/", NULL }; + FTS *fts; + FTSENT *ent; + int seen_dir, seen_file; + + ATF_REQUIRE_EQ(0, mkdir("dir", 0755)); + ATF_REQUIRE_EQ(0, close(creat("dir/file", 0644))); + + ATF_REQUIRE((fts = fts_open(paths, FTS_PHYSICAL, NULL)) != NULL); + + seen_dir = 0; + seen_file = 0; + while ((ent = fts_read(fts)) != NULL) { + if (ent->fts_info == FTS_D || ent->fts_info == FTS_DP) + seen_dir = 1; + if (ent->fts_info == FTS_F) + seen_file = 1; + } + + ATF_CHECK_EQ_MSG(0, errno, + "fts_read loop should end with errno 0, not %d", errno); + ATF_CHECK_MSG(seen_dir != 0, "directory was never visited"); + ATF_CHECK_MSG(seen_file != 0, "file inside dir was never visited"); + + ATF_REQUIRE_EQ_MSG(0, fts_close(fts), "fts_close(): %m"); +} + +/* + * An unreadable directory must produce FTS_D then FTS_DNR. It must NOT + * produce FTS_DP because fts never successfully entered it. + * + * Requires an unprivileged user because root ignores directory permissions. + */ +ATF_TC(unreadable_dir); +ATF_TC_HEAD(unreadable_dir, tc) +{ + atf_tc_set_md_var(tc, "descr", + "unreadable directory yields FTS_D then FTS_DNR, never FTS_DP"); + atf_tc_set_md_var(tc, "require.user", "unprivileged"); +} +ATF_TC_BODY(unreadable_dir, tc) +{ + ATF_REQUIRE_EQ(0, mkdir("unr", 0000)); + fts_test(tc, &(struct fts_testcase){ + (char *[]){ "unr", NULL }, + FTS_PHYSICAL, + (struct fts_expect[]){ + { FTS_D, "unr", "unr" }, + { FTS_DNR, "unr", "unr" }, + { 0 } + }, + }); +} + +/* + * Multiple root paths must all be visited left-to-right, each tree + * traversed completely before moving to the next root. + */ +ATF_TC(multiple_roots); +ATF_TC_HEAD(multiple_roots, tc) +{ + atf_tc_set_md_var(tc, "descr", + "fts_open visits multiple root paths left-to-right"); +} +ATF_TC_BODY(multiple_roots, tc) +{ + ATF_REQUIRE_EQ(0, mkdir("a", 0755)); + ATF_REQUIRE_EQ(0, mkdir("b", 0755)); + ATF_REQUIRE_EQ(0, close(creat("a/x", 0644))); + ATF_REQUIRE_EQ(0, close(creat("b/y", 0644))); + + fts_test(tc, &(struct fts_testcase){ + (char *[]){ "a", "b", NULL }, + FTS_PHYSICAL, + (struct fts_expect[]){ + { FTS_D, "a", "a" }, + { FTS_F, "x", "x" }, + { FTS_DP, "a", "a" }, + { FTS_D, "b", "b" }, + { FTS_F, "y", "y" }, + { FTS_DP, "b", "b" }, + { 0 } + }, + }); +} + +ATF_TP_ADD_TCS(tp) +{ + fts_check_debug(); + ATF_TP_ADD_TC(tp, invalid_options); + ATF_TP_ADD_TC(tp, empty_argv); + ATF_TP_ADD_TC(tp, empty_path_string); + ATF_TP_ADD_TC(tp, nonexistent_path); + ATF_TP_ADD_TC(tp, trailing_slash); + ATF_TP_ADD_TC(tp, unreadable_dir); + ATF_TP_ADD_TC(tp, multiple_roots); + + return (atf_no_error()); +}
