diff mbox series

[v1] Refactor mount02 test using new LTP API

Message ID 20231124123118.20441-2-andrea.cervesato@suse.de
State Changes Requested
Headers show
Series [v1] Refactor mount02 test using new LTP API | expand

Commit Message

Andrea Cervesato Nov. 24, 2023, 12:31 p.m. UTC
From: Andrea Cervesato <andrea.cervesato@suse.com>

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
 testcases/kernel/syscalls/mount/mount02.c | 222 ++++++++--------------
 1 file changed, 74 insertions(+), 148 deletions(-)

Comments

Martin Doucha Feb. 8, 2024, 4:43 p.m. UTC | #1
Hi,
suggestions below.

On 24. 11. 23 13:31, Andrea Cervesato wrote:
> From: Andrea Cervesato <andrea.cervesato@suse.com>
> 
> Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
> ---
>   testcases/kernel/syscalls/mount/mount02.c | 222 ++++++++--------------
>   1 file changed, 74 insertions(+), 148 deletions(-)
> 
> diff --git a/testcases/kernel/syscalls/mount/mount02.c b/testcases/kernel/syscalls/mount/mount02.c
> index 392b4fd3a..965e75fe9 100644
> --- a/testcases/kernel/syscalls/mount/mount02.c
> +++ b/testcases/kernel/syscalls/mount/mount02.c
> @@ -1,76 +1,50 @@
> +// SPDX-License-Identifier: GPL-2.0-or-later
>   /*
>    * Copyright (c) Wipro Technologies Ltd, 2002.  All Rights Reserved.
> - *  AUTHOR: Nirmala Devi Dhanasekar <nirmala.devi@wipro.com>
> - * Copyright (c) 2014 Cyril Hrubis <chrubis@suse.cz>
> - *
> - * This program is free software; you can redistribute it and/or modify it
> - * under the terms of version 2 of the GNU General Public License as
> - * published by the Free Software Foundation.

The correct SPDX header for this test is:
// SPDX-License-Identifier: GPL-2.0-only

We cannot change the test licence without permission from the original 
author.

> - *
> - * This program is distributed in the hope that it would be useful, but
> - * WITHOUT ANY WARRANTY; without even the implied warranty of
> - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
> + *               Nirmala Devi Dhanasekar <nirmala.devi@wipro.com>
> + * Copyright (C) 2023 SUSE LLC Andrea Cervesato <andrea.cervesato@suse.com>
> + */
> +
> +/*\
> + * [Description]
>    *
> - * You should have received a copy of the GNU General Public License along
> - * with this program; if not, write the Free Software Foundation, Inc.,
> - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
> + * Check for basic errors returned by mount(2) system call.
>    *
> + * - ENODEV if filesystem type not configured
> + * - ENOTBLK if specialfile is not a block device
> + * - EBUSY if specialfile is already mounted or it  cannot  be remounted
> + *   read-only, because it still holds files open for writing.
> + * - EINVAL if specialfile or device is invalid or a remount was attempted,
> + *   while source was not already mounted on target.
> + * - EFAULT if special file or device file points to invalid address space.
> + * - ENAMETOOLONG if pathname was longer than MAXPATHLEN.
> + * - ENOENT if pathname was empty or has a nonexistent component.
> + * - ENOTDIR if not a directory.
>    */
>   
> -/*
> -
> -   DESCRIPTION
> -	Check for basic errors returned by mount(2) system call.
> -
> -	Verify that mount(2) returns -1 and sets errno to
> -	1) ENODEV if filesystem type not configured
> -	2) ENOTBLK if specialfile is not a block device
> -	3) EBUSY if specialfile is already mounted or
> -		it  cannot  be remounted read-only, because it still holds
> -		files open for writing.
> -	4) EINVAL if specialfile or device is invalid or
> -		 a remount was attempted, while source was not already
> -		 mounted on target.
> -	5) EFAULT if specialfile or device file points to invalid address space.
> -	6) ENAMETOOLONG if pathname was longer than MAXPATHLEN.
> -	7) ENOENT if pathname was empty or has a nonexistent component.
> -	8) ENOTDIR if not a directory.
> -*/
> -
> -#include <errno.h>
> +#include "tst_test.h"
>   #include <sys/mount.h>
> -#include <sys/types.h>
> -#include <sys/stat.h>
>   #include <sys/sysmacros.h>
> -#include <fcntl.h>
> -#include "test.h"
> -#include "safe_macros.h"
> -
> -static void setup(void);
> -static void cleanup(void);
>   
> -char *TCID = "mount02";
> -
> -#define DIR_MODE	(S_IRWXU | S_IRUSR | S_IXUSR | S_IRGRP | S_IXGRP)
> -#define FILE_MODE	(S_IRWXU | S_IRWXG | S_IRWXO)
> +#define MNTPOINT "mntpoint"
>   
>   static char path[PATH_MAX + 2];
>   static const char *long_path = path;
> +static const char *device;
>   static const char *fs_type;
> +static const char *null;
>   static const char *wrong_fs_type = "error";
> -static const char *mntpoint = "mntpoint";
> -static const char *device;
> -static const char *null = NULL;
> -static const char *fault = (void*)-1;
> +static const char *mntpoint = MNTPOINT;
> +static const char *fault = (void *)-1;
>   static const char *nonexistent = "nonexistent";
>   static const char *char_dev = "char_device";
>   static const char *file = "filename";
>   static int fd;
>   
> -static void do_umount(void);
> -static void close_umount(void);
> -static void do_mount(void);
> -static void mount_open(void);
> +static void pre_mount(void);
> +static void post_umount(void);
> +static void pre_create_file(void);
> +static void post_delete_file(void);
>   
>   static struct test_case {
>   	const char **device;
> @@ -80,12 +54,11 @@ static struct test_case {
>   	int exp_errno;
>   	void (*setup)(void);
>   	void (*cleanup)(void);
> -} tc[] = {
> +} test_cases[] = {
>   	{&device, &mntpoint, &wrong_fs_type, 0, ENODEV, NULL, NULL},
>   	{&char_dev, &mntpoint, &fs_type, 0, ENOTBLK, NULL, NULL},
> -	{&device, &mntpoint, &fs_type, 0, EBUSY, do_mount, do_umount},
> -	{&device, &mntpoint, &fs_type, MS_REMOUNT | MS_RDONLY, EBUSY,
> -	 mount_open, close_umount},
> +	{&device, &mntpoint, &fs_type, 0, EBUSY, pre_mount, post_umount},
> +	{&device, &mntpoint, &fs_type, MS_REMOUNT | MS_RDONLY, EBUSY, pre_create_file, post_delete_file},
>   	{&null, &mntpoint, &fs_type, 0, EINVAL, NULL, NULL},
>   	{&device, &mntpoint, &null, 0, EINVAL, NULL, NULL},
>   	{&device, &mntpoint, &fs_type, MS_REMOUNT, EINVAL, NULL, NULL},
> @@ -96,117 +69,70 @@ static struct test_case {
>   	{&device, &file, &fs_type, 0, ENOTDIR, NULL, NULL},
>   };
>   
> -int TST_TOTAL = ARRAY_SIZE(tc);
> -
> -static void verify_mount(struct test_case *tc)
> +static void pre_mount(void)
>   {
> -	if (tc->setup)
> -		tc->setup();
> -
> -	TEST(mount(*tc->device, *tc->mntpoint, *tc->fs_type, tc->flag, NULL));
> -
> -	if (TEST_RETURN != -1) {
> -		tst_resm(TFAIL, "mount() succeded unexpectedly (ret=%li)",
> -		         TEST_RETURN);
> -		goto cleanup;
> -	}
> -
> -	if (TEST_ERRNO != tc->exp_errno) {
> -		tst_resm(TFAIL | TTERRNO,
> -		         "mount() was expected to fail with %s(%i)",
> -		         tst_strerrno(tc->exp_errno), tc->exp_errno);
> -		goto cleanup;
> -	}
> -
> -	tst_resm(TPASS | TTERRNO, "mount() failed expectedly");
> -
> -cleanup:
> -	if (tc->cleanup)
> -		tc->cleanup();
> +	SAFE_MOUNT(device, mntpoint, fs_type, 0, NULL);
>   }
>   
> -int main(int ac, char **av)
> +static void post_umount(void)
>   {
> -	int lc, i;
> -
> -	tst_parse_opts(ac, av, NULL, NULL);
> -
> -	setup();
> -
> -	for (lc = 0; TEST_LOOPING(lc); lc++) {
> -		tst_count = 0;
> -
> -		for (i = 0; i < TST_TOTAL; ++i)
> -			verify_mount(tc + i);
> -	}
> -
> -	cleanup();
> -	tst_exit();
> +	if (tst_is_mounted(MNTPOINT))
> +		SAFE_UMOUNT(MNTPOINT);
>   }
>   
> -static void do_mount(void)
> +static void pre_create_file(void)
>   {
> -	if (mount(device, mntpoint, fs_type, 0, NULL))
> -		tst_brkm(TBROK | TERRNO, cleanup, "Failed to mount(mntpoint)");
> +	pre_mount();
> +	fd = SAFE_OPEN("mntpoint/file", O_CREAT | O_RDWR, 0700);
>   }
>   
> -static void mount_open(void)
> +static void post_delete_file(void)
>   {
> -	do_mount();
> -
> -	fd = SAFE_OPEN(cleanup, "mntpoint/file", O_CREAT | O_RDWR, S_IRWXU);
> +	SAFE_CLOSE(fd);
> +	post_umount();
>   }
>   
> -static void close_umount(void)
> +static void setup(void)
>   {
> -	SAFE_CLOSE(cleanup, fd);
> -	do_umount();
> +	device = tst_device->dev;
> +	fs_type = tst_device->fs_type;
> +
> +	memset(path, 'a', PATH_MAX + 1);
> +
> +	SAFE_MKNOD(char_dev, S_IFCHR | 0777, 0);
> +	SAFE_TOUCH(file, 0777, 0);
>   }
>   
> -static void do_umount(void)
> +static void cleanup(void)
>   {
> -	if (tst_umount(mntpoint))
> -		tst_brkm(TBROK | TERRNO, cleanup, "Failed to umount(mntpoint)");
> +	if (tst_is_mounted(MNTPOINT))
> +		SAFE_UMOUNT(MNTPOINT);
>   }
>   
> -static void setup(void)
> +static void run(unsigned int i)
>   {
> -	dev_t dev;
> -
> -	tst_sig(FORK, DEF_HANDLER, cleanup);
> -
> -	tst_require_root();
> -
> -	tst_tmpdir();
> -
> -	SAFE_TOUCH(cleanup, file, FILE_MODE, NULL);
> -
> -	fs_type = tst_dev_fs_type();
> -	device = tst_acquire_device(cleanup);
> -
> -	if (!device)
> -		tst_brkm(TCONF, cleanup, "Failed to obtain block device");
> +	struct test_case *tc = &test_cases[i];
>   
> -	tst_mkfs(cleanup, device, fs_type, NULL, NULL);
> -
> -	SAFE_MKDIR(cleanup, mntpoint, DIR_MODE);
> -
> -	memset(path, 'a', PATH_MAX + 1);
> +	if (tc->setup)
> +		tc->setup();
>   
> -	dev = makedev(1, 3);
> -	if (mknod(char_dev, S_IFCHR | FILE_MODE, dev)) {
> -		tst_brkm(TBROK | TERRNO, cleanup,
> -			 "failed to mknod(char_dev, S_IFCHR | FILE_MODE, %lu)",
> -			 dev);
> -	}
> +	TST_EXP_FAIL(mount(*tc->device, *tc->mntpoint, *tc->fs_type, tc->flag, NULL),
> +		tc->exp_errno,
> +		"Expecting %s",
> +		tst_strerrno(tc->exp_errno));

This will print something like:
TPASS: Expecting ENOTBLK : ENOTBLK
TPASS: Expecting EBUSY : EBUSY
TPASS: Expecting EBUSY : EBUSY
TPASS: Expecting EINVAL : EINVAL
TPASS: Expecting EINVAL : EINVAL
TPASS: Expecting EINVAL : EINVAL

Could you add a bit more useful testcase descriptions? Something like
- mounting device with wrong FS type
- mounting character device
- mounting NULL path

>   
> -	TEST_PAUSE;
> +	if (tc->cleanup)
> +		tc->cleanup();
>   }
>   
> -static void cleanup(void)
> -{
> -	if (device)
> -		tst_release_device(device);
> -
> -	tst_rmdir();
> -}
> +static struct tst_test test = {
> +	.tcnt = ARRAY_SIZE(test_cases),
> +	.test = run,
> +	.setup = setup,
> +	.cleanup = cleanup,
> +	.needs_root = 1,
> +	.needs_device = 1,

.needs_device is forced by .format_device.

> +	.needs_tmpdir = 1,
> +	.format_device = 1,
> +	.mntpoint = MNTPOINT,
> +};
diff mbox series

Patch

diff --git a/testcases/kernel/syscalls/mount/mount02.c b/testcases/kernel/syscalls/mount/mount02.c
index 392b4fd3a..965e75fe9 100644
--- a/testcases/kernel/syscalls/mount/mount02.c
+++ b/testcases/kernel/syscalls/mount/mount02.c
@@ -1,76 +1,50 @@ 
+// SPDX-License-Identifier: GPL-2.0-or-later
 /*
  * Copyright (c) Wipro Technologies Ltd, 2002.  All Rights Reserved.
- *  AUTHOR: Nirmala Devi Dhanasekar <nirmala.devi@wipro.com>
- * Copyright (c) 2014 Cyril Hrubis <chrubis@suse.cz>
- *
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of version 2 of the GNU General Public License as
- * published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it would be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ *               Nirmala Devi Dhanasekar <nirmala.devi@wipro.com>
+ * Copyright (C) 2023 SUSE LLC Andrea Cervesato <andrea.cervesato@suse.com>
+ */
+
+/*\
+ * [Description]
  *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ * Check for basic errors returned by mount(2) system call.
  *
+ * - ENODEV if filesystem type not configured
+ * - ENOTBLK if specialfile is not a block device
+ * - EBUSY if specialfile is already mounted or it  cannot  be remounted
+ *   read-only, because it still holds files open for writing.
+ * - EINVAL if specialfile or device is invalid or a remount was attempted,
+ *   while source was not already mounted on target.
+ * - EFAULT if special file or device file points to invalid address space.
+ * - ENAMETOOLONG if pathname was longer than MAXPATHLEN.
+ * - ENOENT if pathname was empty or has a nonexistent component.
+ * - ENOTDIR if not a directory.
  */
 
-/*
-
-   DESCRIPTION
-	Check for basic errors returned by mount(2) system call.
-
-	Verify that mount(2) returns -1 and sets errno to
-	1) ENODEV if filesystem type not configured
-	2) ENOTBLK if specialfile is not a block device
-	3) EBUSY if specialfile is already mounted or
-		it  cannot  be remounted read-only, because it still holds
-		files open for writing.
-	4) EINVAL if specialfile or device is invalid or
-		 a remount was attempted, while source was not already
-		 mounted on target.
-	5) EFAULT if specialfile or device file points to invalid address space.
-	6) ENAMETOOLONG if pathname was longer than MAXPATHLEN.
-	7) ENOENT if pathname was empty or has a nonexistent component.
-	8) ENOTDIR if not a directory.
-*/
-
-#include <errno.h>
+#include "tst_test.h"
 #include <sys/mount.h>
-#include <sys/types.h>
-#include <sys/stat.h>
 #include <sys/sysmacros.h>
-#include <fcntl.h>
-#include "test.h"
-#include "safe_macros.h"
-
-static void setup(void);
-static void cleanup(void);
 
-char *TCID = "mount02";
-
-#define DIR_MODE	(S_IRWXU | S_IRUSR | S_IXUSR | S_IRGRP | S_IXGRP)
-#define FILE_MODE	(S_IRWXU | S_IRWXG | S_IRWXO)
+#define MNTPOINT "mntpoint"
 
 static char path[PATH_MAX + 2];
 static const char *long_path = path;
+static const char *device;
 static const char *fs_type;
+static const char *null;
 static const char *wrong_fs_type = "error";
-static const char *mntpoint = "mntpoint";
-static const char *device;
-static const char *null = NULL;
-static const char *fault = (void*)-1;
+static const char *mntpoint = MNTPOINT;
+static const char *fault = (void *)-1;
 static const char *nonexistent = "nonexistent";
 static const char *char_dev = "char_device";
 static const char *file = "filename";
 static int fd;
 
-static void do_umount(void);
-static void close_umount(void);
-static void do_mount(void);
-static void mount_open(void);
+static void pre_mount(void);
+static void post_umount(void);
+static void pre_create_file(void);
+static void post_delete_file(void);
 
 static struct test_case {
 	const char **device;
@@ -80,12 +54,11 @@  static struct test_case {
 	int exp_errno;
 	void (*setup)(void);
 	void (*cleanup)(void);
-} tc[] = {
+} test_cases[] = {
 	{&device, &mntpoint, &wrong_fs_type, 0, ENODEV, NULL, NULL},
 	{&char_dev, &mntpoint, &fs_type, 0, ENOTBLK, NULL, NULL},
-	{&device, &mntpoint, &fs_type, 0, EBUSY, do_mount, do_umount},
-	{&device, &mntpoint, &fs_type, MS_REMOUNT | MS_RDONLY, EBUSY,
-	 mount_open, close_umount},
+	{&device, &mntpoint, &fs_type, 0, EBUSY, pre_mount, post_umount},
+	{&device, &mntpoint, &fs_type, MS_REMOUNT | MS_RDONLY, EBUSY, pre_create_file, post_delete_file},
 	{&null, &mntpoint, &fs_type, 0, EINVAL, NULL, NULL},
 	{&device, &mntpoint, &null, 0, EINVAL, NULL, NULL},
 	{&device, &mntpoint, &fs_type, MS_REMOUNT, EINVAL, NULL, NULL},
@@ -96,117 +69,70 @@  static struct test_case {
 	{&device, &file, &fs_type, 0, ENOTDIR, NULL, NULL},
 };
 
-int TST_TOTAL = ARRAY_SIZE(tc);
-
-static void verify_mount(struct test_case *tc)
+static void pre_mount(void)
 {
-	if (tc->setup)
-		tc->setup();
-
-	TEST(mount(*tc->device, *tc->mntpoint, *tc->fs_type, tc->flag, NULL));
-
-	if (TEST_RETURN != -1) {
-		tst_resm(TFAIL, "mount() succeded unexpectedly (ret=%li)",
-		         TEST_RETURN);
-		goto cleanup;
-	}
-
-	if (TEST_ERRNO != tc->exp_errno) {
-		tst_resm(TFAIL | TTERRNO,
-		         "mount() was expected to fail with %s(%i)",
-		         tst_strerrno(tc->exp_errno), tc->exp_errno);
-		goto cleanup;
-	}
-
-	tst_resm(TPASS | TTERRNO, "mount() failed expectedly");
-
-cleanup:
-	if (tc->cleanup)
-		tc->cleanup();
+	SAFE_MOUNT(device, mntpoint, fs_type, 0, NULL);
 }
 
-int main(int ac, char **av)
+static void post_umount(void)
 {
-	int lc, i;
-
-	tst_parse_opts(ac, av, NULL, NULL);
-
-	setup();
-
-	for (lc = 0; TEST_LOOPING(lc); lc++) {
-		tst_count = 0;
-
-		for (i = 0; i < TST_TOTAL; ++i)
-			verify_mount(tc + i);
-	}
-
-	cleanup();
-	tst_exit();
+	if (tst_is_mounted(MNTPOINT))
+		SAFE_UMOUNT(MNTPOINT);
 }
 
-static void do_mount(void)
+static void pre_create_file(void)
 {
-	if (mount(device, mntpoint, fs_type, 0, NULL))
-		tst_brkm(TBROK | TERRNO, cleanup, "Failed to mount(mntpoint)");
+	pre_mount();
+	fd = SAFE_OPEN("mntpoint/file", O_CREAT | O_RDWR, 0700);
 }
 
-static void mount_open(void)
+static void post_delete_file(void)
 {
-	do_mount();
-
-	fd = SAFE_OPEN(cleanup, "mntpoint/file", O_CREAT | O_RDWR, S_IRWXU);
+	SAFE_CLOSE(fd);
+	post_umount();
 }
 
-static void close_umount(void)
+static void setup(void)
 {
-	SAFE_CLOSE(cleanup, fd);
-	do_umount();
+	device = tst_device->dev;
+	fs_type = tst_device->fs_type;
+
+	memset(path, 'a', PATH_MAX + 1);
+
+	SAFE_MKNOD(char_dev, S_IFCHR | 0777, 0);
+	SAFE_TOUCH(file, 0777, 0);
 }
 
-static void do_umount(void)
+static void cleanup(void)
 {
-	if (tst_umount(mntpoint))
-		tst_brkm(TBROK | TERRNO, cleanup, "Failed to umount(mntpoint)");
+	if (tst_is_mounted(MNTPOINT))
+		SAFE_UMOUNT(MNTPOINT);
 }
 
-static void setup(void)
+static void run(unsigned int i)
 {
-	dev_t dev;
-
-	tst_sig(FORK, DEF_HANDLER, cleanup);
-
-	tst_require_root();
-
-	tst_tmpdir();
-
-	SAFE_TOUCH(cleanup, file, FILE_MODE, NULL);
-
-	fs_type = tst_dev_fs_type();
-	device = tst_acquire_device(cleanup);
-
-	if (!device)
-		tst_brkm(TCONF, cleanup, "Failed to obtain block device");
+	struct test_case *tc = &test_cases[i];
 
-	tst_mkfs(cleanup, device, fs_type, NULL, NULL);
-
-	SAFE_MKDIR(cleanup, mntpoint, DIR_MODE);
-
-	memset(path, 'a', PATH_MAX + 1);
+	if (tc->setup)
+		tc->setup();
 
-	dev = makedev(1, 3);
-	if (mknod(char_dev, S_IFCHR | FILE_MODE, dev)) {
-		tst_brkm(TBROK | TERRNO, cleanup,
-			 "failed to mknod(char_dev, S_IFCHR | FILE_MODE, %lu)",
-			 dev);
-	}
+	TST_EXP_FAIL(mount(*tc->device, *tc->mntpoint, *tc->fs_type, tc->flag, NULL),
+		tc->exp_errno,
+		"Expecting %s",
+		tst_strerrno(tc->exp_errno));
 
-	TEST_PAUSE;
+	if (tc->cleanup)
+		tc->cleanup();
 }
 
-static void cleanup(void)
-{
-	if (device)
-		tst_release_device(device);
-
-	tst_rmdir();
-}
+static struct tst_test test = {
+	.tcnt = ARRAY_SIZE(test_cases),
+	.test = run,
+	.setup = setup,
+	.cleanup = cleanup,
+	.needs_root = 1,
+	.needs_device = 1,
+	.needs_tmpdir = 1,
+	.format_device = 1,
+	.mntpoint = MNTPOINT,
+};