[LTP] [PATCH 1/2] syscalls/stat01, 02, 05: Cleanup && Convert to new API

[Cyril Hrubis <chrubis@suse.cz>]

Hi!
> diff --git a/testcases/kernel/syscalls/stat/stat02.c b/testcases/kernel/syscalls/stat/stat02.c
> index aeaa7ab82..4e0ab5a03 100644
> --- a/testcases/kernel/syscalls/stat/stat02.c
> +++ b/testcases/kernel/syscalls/stat/stat02.c
> @@ -1,228 +1,106 @@
> -/*
> - *
> - *   Copyright (c) International Business Machines  Corp., 2001
> - *
> - *   This program is free software;  you can redistribute it and/or modify
> - *   it under the terms of the GNU General Public License as published by
> - *   the Free Software Foundation; either version 2 of the License, or
> - *   (at your option) any later version.
> - *
> - *   This program is distributed in the hope that it will be useful,
> - *   but WITHOUT ANY WARRANTY;  without even the implied warranty of
> - *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
> - *   the GNU General Public License for more details.
> - *
> - *   You should have received a copy of the GNU General Public License
> - *   along with this program;  if not, write to the Free Software
> - *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
> - */
> -
> -/*
> - * Test Name: stat02
> +// SPDX-License-Identifier: GPL-2.0-or-later
> +/* Copyright (c) International Business Machines  Corp., 2001
> + *	07/2001 John George
> + *		-Ported
>   *
> - * Test Description:
>   *  Verify that, stat(2) succeeds to get the status of a file and fills the
>   *  stat structure elements though process doesn't have read access to the
>   *  file.
> - *
> - * Expected Result:
> - *  stat() should return value 0 on success and the stat structure elements
> - *  should be filled with specified 'file' information.
> - *
> - * Algorithm:
> - *  Setup:
> - *   Setup signal handling.
> - *   Create temporary directory.
> - *   Pause for SIGUSR1 if option specified.
> - *
> - *  Test:
> - *   Loop if the proper options are given.
> - *   Execute system call
> - *   Check return code, if system call failed (return=-1)
> - *   	Log the errno and Issue a FAIL message.
> - *   Otherwise,
> - *   	Verify the Functionality of system call
> - *      if successful,
> - *      	Issue Functionality-Pass message.
> - *      Otherwise,
> - *		Issue Functionality-Fail message.
> - *  Cleanup:
> - *   Print errno log and/or timing stats if options given
> - *   Delete the temporary directory created.
> - *
> - * Usage:  <for command-line>
> - *  stat02 [-c n] [-e] [-f] [-i n] [-I x] [-p x] [-t]
> - *	where,  -c n : Run n copies concurrently.
> - *		-e   : Turn on errno logging.
> - *		-f   : Turn off functionality Testing.
> - *		-i n : Execute test n times.
> - *		-I x : Execute test for x seconds.
> - *		-P x : Pause for x seconds between iterations.
> - *		-t   : Turn on syscall timing.
> - *
> - * History
> - *	07/2001 John George
> - *		-Ported
> - *
> - * Restrictions:
> - *
>   */
> -#include <stdio.h>
> +
>  #include <sys/types.h>
>  #include <fcntl.h>
>  #include <sys/stat.h>
>  #include <errno.h>
> -#include <string.h>
> -#include <signal.h>
>  #include <pwd.h>
> +#include "tst_test.h"
>  
> -#include "test.h"
> -#include "safe_macros.h"
> -
> -#define FILE_MODE	S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH
> -#define TESTFILE	"testfile"
> +#define FILE_MODE       0644
> +#define TESTFILE        "testfile"
>  #define FILE_SIZE       1024
> -#define BUF_SIZE	256
> -#define NEW_MODE	0222
> -#define MASK		0777
> -
> -char *TCID = "stat02";
> -int TST_TOTAL = 1;
> +#define BUF_SIZE        256
> +#define NEW_MODE        0222
> +#define MASK            0777
>  
> -uid_t user_id;			/* eff. user id/group id of test process */
> +uid_t user_id;
>  gid_t group_id;
> -char nobody_uid[] = "nobody";
>  struct passwd *ltpuser;
>  
> -void setup();
> -void cleanup();
> -
> -int main(int ac, char **av)
> +static void verify_stat(void)
>  {
> -	struct stat stat_buf;	/* stat structure buffer */
> -	int lc;
> -
> -	tst_parse_opts(ac, av, NULL, NULL);
> -
> -	setup();
> -
> -	for (lc = 0; TEST_LOOPING(lc); lc++) {
> -
> -		tst_count = 0;
> -
> -		/*
> -		 * Call stat(2) to get the status of
> -		 * specified 'file' into stat structure.
> -		 */
> -		TEST(stat(TESTFILE, &stat_buf));
> -
> -		if (TEST_RETURN == -1) {
> -			tst_resm(TFAIL,
> -				 "stat(%s, &stat_buf) Failed, errno=%d : %s",
> -				 TESTFILE, TEST_ERRNO, strerror(TEST_ERRNO));
> -		} else {
> -			stat_buf.st_mode &= ~S_IFREG;
> -			/*
> -			 * Verify the data returned by stat(2)
> -			 * aganist the expected data.
> -			 */
> -			if ((stat_buf.st_uid != user_id) ||
> -			    (stat_buf.st_gid != group_id) ||
> -			    (stat_buf.st_size != FILE_SIZE) ||
> -			    ((stat_buf.st_mode & MASK) != NEW_MODE)) {
> -				tst_resm(TFAIL, "Functionality of "
> -					 "stat(2) on '%s' Failed",
> -					 TESTFILE);
> -			} else {
> -				tst_resm(TPASS, "Functionality of "
> -					 "stat(2) on '%s' Succcessful",
> -					 TESTFILE);
> -			}
> -		}
> -		tst_count++;	/* incr TEST_LOOP counter */
> +	struct stat stat_buf;
> +	int fail = 0;
> +
> +	TEST(stat(TESTFILE, &stat_buf));
> +
> +	if (TST_RET == -1) {
> +		tst_res(TFAIL | TTERRNO, "fstat(%s) failed", TESTFILE);
> +		return;
>  	}
>  
> -	cleanup();
> -	tst_exit();
> -}
> +	if (stat_buf.st_uid != user_id) {
> +		tst_res(TINFO, "stat_buf.st_uid = %i expected %i",
> +			stat_buf.st_uid, user_id);
> +		fail++;
> +	}
>  
> -/*
> - * void
> - * setup() -  Performs setup function for the test.
> - *  Creat a temporary directory and change directory to it.
> - *  Creat a testfile and write some data into it.
> - *  Modify the mode permissions of testfile such that test process
> - *  has read-only access to testfile.
> - */
> -void setup(void)
> -{
> -	int i, fd;		/* counter, file handle for file */
> -	char tst_buff[BUF_SIZE];	/* data buffer for file */
> -	int wbytes;		/* no. of bytes written to file */
> -	int write_len = 0;
> +	if (stat_buf.st_gid != group_id) {
> +		tst_res(TINFO, "stat_buf.st_gid = %i expected %i",
> +			stat_buf.st_gid, group_id);
> +		fail++;
> +	}
>  
> -	tst_require_root();
> +	if (stat_buf.st_size != FILE_SIZE) {
> +		tst_res(TINFO, "stat_buf.st_size = %li expected %i",
> +			(long)stat_buf.st_size, FILE_SIZE);
> +		fail++;
> +	}
>  
> -	tst_sig(NOFORK, DEF_HANDLER, cleanup);
> +	if ((stat_buf.st_mode & MASK) != NEW_MODE) {
> +		tst_res(TINFO, "stat_buf.st_mode = %o expected %o",
> +			(stat_buf.st_mode & MASK), NEW_MODE);
> +		fail++;
> +	}
>  
> -	/* Switch to nobody user for correct error code collection */
> -	ltpuser = getpwnam(nobody_uid);
> -	if (setuid(ltpuser->pw_uid) == -1) {
> -		tst_resm(TINFO, "setuid failed to "
> -			 "to set the effective uid to %d", ltpuser->pw_uid);
> -		perror("setuid");
> +	if (fail) {
> +		tst_res(TFAIL, "functionality of stat incorrect");
> +		return;
>  	}
>  
> -	/* Pause if that option was specified
> -	 * TEST_PAUSE contains the code to fork the test with the -i option.
> -	 * You want to make sure you do this before you create your temporary
> -	 * directory.
> -	 */
> -	TEST_PAUSE;
> +	tst_res(TPASS, "functionality of stat correct");
> +}
> +
> +void setup(void)
> +{
> +	int i, fd;
> +	char tst_buff[BUF_SIZE];

The tst_ prefix is reserved for the library, it shouldn't be used in the
testcases.

> +	int write_len = 0;
>  
> -	tst_tmpdir();
> +	ltpuser = SAFE_GETPWNAM("nobody");
> +	SAFE_SETUID(ltpuser->pw_uid);
>  
> -	if ((fd = open(TESTFILE, O_RDWR | O_CREAT, FILE_MODE)) == -1) {
> -		tst_brkm(TBROK, cleanup,
> -			 "open(%s, O_RDWR|O_CREAT, %#o) Failed, errno=%d : %s",
> -			 TESTFILE, FILE_MODE, errno, strerror(errno));
> -	}
> +	fd = SAFE_OPEN(TESTFILE, O_WRONLY | O_CREAT, FILE_MODE);
>  
> -	/* Fill the test buffer with the known data */
>  	for (i = 0; i < BUF_SIZE; i++) {
>  		tst_buff[i] = 'a';
>  	}
>  
>  	/* Write to the file 1k data from the buffer */
>  	while (write_len < FILE_SIZE) {
> -		if ((wbytes = write(fd, tst_buff, sizeof(tst_buff))) <= 0) {
> -			tst_brkm(TBROK | TERRNO, cleanup, "write to %s failed",
> -				 TESTFILE);
> -		} else {
> -			write_len += wbytes;
> -		}
> -	}
> -
> -	if (close(fd) == -1) {
> -		tst_resm(TWARN | TERRNO, "closing %s failed", TESTFILE);
> +		SAFE_WRITE(1, fd, tst_buff, sizeof(tst_buff));
> +		write_len += BUF_SIZE;
>  	}
> -
> -	/* Modify mode permissions on the testfile */
> -	SAFE_CHMOD(cleanup, TESTFILE, NEW_MODE);
> +	SAFE_CLOSE(fd);

We do have tst_fill_file() function exactly for this purpose.

> -	/* Get the uid/gid of the process */
> +	SAFE_CHMOD(TESTFILE, NEW_MODE);
>  	user_id = getuid();
>  	group_id = getgid();
> -
>  }
>  
> -/*
> - * cleanup() - performs all ONE TIME cleanup for this test at
> - *	       completion or premature exit.
> - *  Remove the temporary directory and file created.
> - */
> -void cleanup(void)
> -{
> -
> -	tst_rmdir();
> -}
> +static struct tst_test test = {
> +	.setup = setup,
> +	.test_all = verify_stat,
> +	.needs_root = 1,
> +	.needs_tmpdir = 1,
> +};

In order to keep the coverage the same we should ideally test both with
and without read permission on the file.

Also since we are removing tests 01, 02 and 05 it would be a bit better
to name the resulting test stat01.c.

Other than that this is a great cleanup.

-- 
Cyril Hrubis
chrubis@suse.cz