Skip to contentSkip to conversation

selftests: tmpfs: Add kselftest support

PATCH Superseded Shivam Chaudhary 2 participants 7 messages Jan 2, 2025 – Jan 3, 2025 Kselftest

v7 of 8 Superseded Latest is v8 →

lore
Share & tools
lore
#0 lore raw

v7 cover selftests: tmpfs: Add kselftest support

This version 7 patch series replace direct error handling methods with ksft macros, which provide better reporting.Currently, when the tmpfs test runs, it does not display any output if it passes,and if it fails (particularly when not run as root),it simply exits without any warning or message.

This series of patch adds:

1. Add 'ksft_print_header()' and 'ksft_set_plan()' to structure test outputs more effectively.

2. skip if not run as root.

3. Replace direct error handling with 'ksft_test_result_*', macros for better reporting.

v6->v7:
- Improve the handling of failure macros.
v6 v1: https://lore.kernel.org/all/[email protected]/
v6 v2: https://lore.kernel.org/all/[email protected]/

v5->v6:
- Skip if not run as root.
v5 v1: https://lore.kernel.org/all/[email protected]/
v5 v2: https://lore.kernel.org/all/[email protected]/

v4->v5:
- Remove unnecessary pass messages.
- Remove unnecessary use of KSFT_SKIP.
- Add appropriate use of ksft_exit_fail_msg.
v4 v1: https://lore.kernel.org/all/[email protected]/
v4 v2: https://lore.kernel.org/all/[email protected]/

v3->v4:
- Start a patchset
- Split patch into smaller patches to make it easy to review.
Patch1 Replace 'ksft_test_result_skip' with 'KSFT_SKIP' during root run check. Patch2 Replace 'ksft_test_result_fail' with 'KSFT_SKIP' where fail does not make sense,
or failure could be due to not unsupported APIs with appropriate warnings.

v3: https://lore.kernel.org/all/[email protected]/

v2->v3:
- Remove extra ksft_set_plan()
- Remove function for unshare()
- Fix the comment style
v2: https://lore.kernel.org/all/[email protected]/

v1->v2:
- Make the commit message more clear.
v1: https://lore.kernel.org/all/[email protected]/T/#u

thanks
Shivam

Shivam Chaudhary (2):
selftests: tmpfs: Add Test-skip if not run as root
selftests: tmpfs: Add kselftest support to tmpfs

 .../selftests/tmpfs/bug-link-o-tmpfile.c      | 40 ++++++++++++-------
 1 file changed, 26 insertions(+), 14 deletions(-)
Signature · 1 line
2.34.1
#1 lore raw

PATCH v7 1/2 selftests: tmpfs: Add Test-skip if not run as root

Add 'ksft_exit_skip()', if not run as root, with an appropriate Warning.

Add 'ksft_print_header()' and 'ksft_set_plan()' to structure test outputs more effectively.

Test logs:

Before Change:
- Without root
error: unshare, errno 1

- With root
No, output

After change:

- Without root
TAP version 13
1..1
ok 2 # SKIP This test needs root to run!
Totals: pass:0 fail:0 xfail:0 xpass:0 skip:1 error:0

- With root
TAP version 13
1..1

---
 tools/testing/selftests/tmpfs/bug-link-o-tmpfile.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)
tools/testing/selftests/tmpfs/bug-link-o-tmpfile.c +12 -0
index b5c3ddb90942..657b64857e82 100644
@@ -23,10 +23,22 @@
 #include <sys/mount.h>
 #include <unistd.h>
 
+#include "../kselftest.h"
+
 int main(void)
 {
 	int fd;
 
+	// Setting up kselftest framework
+	ksft_print_header();
+	ksft_set_plan(1);
+
+	// Check if test is run as root
+	if (geteuid()) {
+		ksft_exit_skip("This test needs root to run!\n");
+		return 1;
+	}
+
 	if (unshare(CLONE_NEWNS) == -1) {
 		if (errno == ENOSYS || errno == EPERM) {
 			fprintf(stderr, "error: unshare, errno %d\n", errno);
Signature · 1 line
2.34.1
maintainer
#2 lore raw

Re: [PATCH v7 1/2] selftests: tmpfs: Add Test-skip if not run as root

Quoted 23 lines · Shivam Chaudhary

Add 'ksft_exit_skip()', if not run as root, with an appropriate Warning.

Add 'ksft_print_header()' and 'ksft_set_plan()' to structure test outputs more effectively.

Test logs:

Before Change:
- Without root
error: unshare, errno 1

- With root
No, output

After change:

- Without root
TAP version 13
1..1
ok 2 # SKIP This test needs root to run!
Totals: pass:0 fail:0 xfail:0 xpass:0 skip:1 error:0

Quoted 3 lines

- With root
TAP version 13
1..1

How are you running this test to see the before ad after results?

thanks,
-- Shuah

#3 lore raw

Re: [PATCH v7 1/2] selftests: tmpfs: Add Test-skip if not run as root

Quoted 24 lines · Shuah Khan
Quoted 23 lines · Shivam Chaudhary

Add 'ksft_exit_skip()', if  not run as root, with an appropriate Warning.

Add 'ksft_print_header()' and 'ksft_set_plan()' to structure test outputs more effectively.

Test logs:

Before Change:
- Without root
  error: unshare, errno 1

- With root
  No, output

After change:

- Without root
TAP version 13
1..1
ok 2 # SKIP This test needs root to run!
Totals: pass:0 fail:0 xfail:0 xpass:0 skip:1 error:0

Quoted 6 lines
Quoted 3 lines

- With root
TAP version 13
1..1

How are you running this test to see the before ad after results?

I'm doing the unit test, meaning, I'm building the test separatley and running it

to ensure the the code works as expected.

thanks

--Shivam

maintainer
#4 lore raw

Re: [PATCH v7 1/2] selftests: tmpfs: Add Test-skip if not run as root

Quoted 30 lines · Shivam Chaudhary
Quoted 28 lines · Shuah Khan
Quoted 26 lines · Shivam Chaudhary

Add 'ksft_exit_skip()', if  not run as root, with an appropriate Warning.

Add 'ksft_print_header()' and 'ksft_set_plan()' to structure test outputs more effectively.

Test logs:

Before Change:
- Without root
  error: unshare, errno 1

- With root
  No, output

After change:

- Without root
TAP version 13
1..1
ok 2 # SKIP This test needs root to run!
Totals: pass:0 fail:0 xfail:0 xpass:0 skip:1 error:0

- With root
TAP version 13
1..1

Quoted 7 lines
Quoted 2 lines

How are you running this test to see the before ad after results?

I'm doing the unit test, meaning, I'm building the test separatley and running it

to ensure the the code works as expected.

When you run "make kselftest TARGETS=tmpfs", do you see duplicate ktap output?

Rum the command and send me the output.

thanks,
-- Shuah

#5 lore raw

PATCH v7 2/2 selftests: tmpfs: Add kselftest support to tmpfs

In reply to Shivam Chaudhary

Replace direct error handling with 'ksft_test_result_*' macros for better reporting.

Test logs:

Before change:
- Without root
error: unshare, errno 1

- With root
No, output

After change:
- Without root
TAP version 13
1..1
ok 2 # SKIP This test needs root to run!
Totals: pass:0 fail:0 xfail:0 xpass:0 skip:1 error:0

- With root
TAP version 13
1..1
ok 1 Test : Success
Totals: pass:1 fail:0 xfail:0 xpass:0 skip:0 error:0

---
 .../selftests/tmpfs/bug-link-o-tmpfile.c      | 28 +++++++++----------
 1 file changed, 14 insertions(+), 14 deletions(-)
tools/testing/selftests/tmpfs/bug-link-o-tmpfile.c +14 -14
index 657b64857e82..290f11a81d2b 100644
@@ -41,39 +41,39 @@ int main(void)
 
 	if (unshare(CLONE_NEWNS) == -1) {
 		if (errno == ENOSYS || errno == EPERM) {
-			fprintf(stderr, "error: unshare, errno %d\n", errno);
-			return 4;
+			ksft_exit_skip("unshare() error: unshare, errno %d\n", errno);
+		} else {
+			ksft_exit_fail_msg("unshare() error: unshare, errno %d\n", errno);
 		}
-		fprintf(stderr, "error: unshare, errno %d\n", errno);
-		return 1;
 	}
+
 	if (mount(NULL, "/", NULL, MS_PRIVATE|MS_REC, NULL) == -1) {
-		fprintf(stderr, "error: mount '/', errno %d\n", errno);
-		return 1;
+		ksft_exit_fail_msg("mount() error: Root filesystem private mount: Fail %d\n", errno);
 	}
 
 	/* Our heroes: 1 root inode, 1 O_TMPFILE inode, 1 permanent inode. */
 	if (mount(NULL, "/tmp", "tmpfs", 0, "nr_inodes=3") == -1) {
-		fprintf(stderr, "error: mount tmpfs, errno %d\n", errno);
-		return 1;
+		ksft_exit_fail_msg("mount() error: Mounting tmpfs on /tmp: Fail %d\n", errno);
 	}
 
 	fd = openat(AT_FDCWD, "/tmp", O_WRONLY|O_TMPFILE, 0600);
 	if (fd == -1) {
-		fprintf(stderr, "error: open 1, errno %d\n", errno);
-		return 1;
+		ksft_exit_fail_msg("openat() error: Open first temporary file: Fail %d\n", errno);
 	}
+
 	if (linkat(fd, "", AT_FDCWD, "/tmp/1", AT_EMPTY_PATH) == -1) {
-		fprintf(stderr, "error: linkat, errno %d\n", errno);
-		return 1;
+		ksft_exit_fail_msg("linkat() error: Linking the temporary file: Fail %d\n", errno);
+		/* Ensure fd is closed on failure */
+		close(fd);
 	}
 	close(fd);
 
 	fd = openat(AT_FDCWD, "/tmp", O_WRONLY|O_TMPFILE, 0600);
 	if (fd == -1) {
-		fprintf(stderr, "error: open 2, errno %d\n", errno);
-		return 1;
+		ksft_exit_fail_msg("openat() error: Opening the second temporary file: Fail %d\n", errno);
 	}
 
+	ksft_test_result_pass("Test : Success\n");
+	ksft_exit_pass();
 	return 0;
 }
Signature · 1 line
2.34.1
maintainer
#6 lore raw

Re: [PATCH v7 2/2] selftests: tmpfs: Add kselftest support to tmpfs

Quoted 75 lines · Shivam Chaudhary

Replace direct error handling with 'ksft_test_result_*' macros for better reporting.

Test logs:

Before change:
- Without root
error: unshare, errno 1

- With root
No, output

After change:
- Without root
TAP version 13
1..1
ok 2 # SKIP This test needs root to run!
Totals: pass:0 fail:0 xfail:0 xpass:0 skip:1 error:0

- With root
TAP version 13
1..1
ok 1 Test : Success
Totals: pass:1 fail:0 xfail:0 xpass:0 skip:0 error:0

---
  .../selftests/tmpfs/bug-link-o-tmpfile.c      | 28 +++++++++----------
  1 file changed, 14 insertions(+), 14 deletions(-)
tools/testing/selftests/tmpfs/bug-link-o-tmpfile.c +11 -12
index 657b64857e82..290f11a81d2b 100644
@@ -41,39 +41,39 @@ int main(void)
 
  	if (unshare(CLONE_NEWNS) == -1) {
  		if (errno == ENOSYS || errno == EPERM) {
-			fprintf(stderr, "error: unshare, errno %d\n", errno);
-			return 4;
+			ksft_exit_skip("unshare() error: unshare, errno %d\n", errno);
+		} else {
+			ksft_exit_fail_msg("unshare() error: unshare, errno %d\n", errno);
  		}
-		fprintf(stderr, "error: unshare, errno %d\n", errno);
-		return 1;
  	}
+
  	if (mount(NULL, "/", NULL, MS_PRIVATE|MS_REC, NULL) == -1) {
-		fprintf(stderr, "error: mount '/', errno %d\n", errno);
-		return 1;
+		ksft_exit_fail_msg("mount() error: Root filesystem private mount: Fail %d\n", errno);
  	}
 
  	/* Our heroes: 1 root inode, 1 O_TMPFILE inode, 1 permanent inode. */
  	if (mount(NULL, "/tmp", "tmpfs", 0, "nr_inodes=3") == -1) {
-		fprintf(stderr, "error: mount tmpfs, errno %d\n", errno);
-		return 1;
+		ksft_exit_fail_msg("mount() error: Mounting tmpfs on /tmp: Fail %d\n", errno);
  	}
 
  	fd = openat(AT_FDCWD, "/tmp", O_WRONLY|O_TMPFILE, 0600);
  	if (fd == -1) {
-		fprintf(stderr, "error: open 1, errno %d\n", errno);
-		return 1;
+		ksft_exit_fail_msg("openat() error: Open first temporary file: Fail %d\n", errno);
  	}
+
  	if (linkat(fd, "", AT_FDCWD, "/tmp/1", AT_EMPTY_PATH) == -1) {
-		fprintf(stderr, "error: linkat, errno %d\n", errno);
-		return 1;
+		ksft_exit_fail_msg("linkat() error: Linking the temporary file: Fail %d\n", errno);
+		/* Ensure fd is closed on failure */
+		close(fd);
  	}

tools/testing/selftests/tmpfs/bug-link-o-tmpfile.c int main(void) · line 76

Quoted 10 lines
tools/testing/selftests/tmpfs/bug-link-o-tmpfile.c +2 -2
  	close(fd);
 
  	fd = openat(AT_FDCWD, "/tmp", O_WRONLY|O_TMPFILE, 0600);
  	if (fd == -1) {
-		fprintf(stderr, "error: open 2, errno %d\n", errno);
-		return 1;
+		ksft_exit_fail_msg("openat() error: Opening the second temporary file: Fail %d\n", errno);
  	}
 
+	ksft_test_result_pass("Test : Success\n");

There is no need to print success here.

tools/testing/selftests/tmpfs/bug-link-o-tmpfile.c int main(void) · line 79

Quoted 3 lines
tools/testing/selftests/tmpfs/bug-link-o-tmpfile.c +1 -0
+	ksft_exit_pass();
  	return 0;
  }

thanks,
-- Shuah