1 /* GNU test program (ksb and mjb) */
3 /* Modified to run with the GNU shell by bfox. */
5 /* Copyright (C) 1987-2012 Free Software Foundation, Inc.
7 This program is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 /* Define TEST_STANDALONE to get the /bin/test version. Otherwise, you get
21 the shell builtin version. */
23 /* Without this pragma, gcc 4.6.2 20111027 mistakenly suggests that
24 the advance function might be candidate for attribute 'pure'. */
25 #if (__GNUC__ == 4 && 6 <= __GNUC_MINOR__) || 4 < __GNUC__
26 # pragma GCC diagnostic ignored "-Wsuggest-attribute=pure"
31 #include <sys/types.h>
33 #define TEST_STANDALONE 1
39 /* The official name of this program (e.g., no 'g' prefix). */
41 # define PROGRAM_NAME "["
43 # define PROGRAM_NAME "test"
48 #include "stat-time.h"
49 #include "strnumcmp.h"
52 # include <sys/param.h>
55 /* Exit status for syntax errors, etc. */
56 enum { TEST_TRUE, TEST_FALSE, TEST_FAILURE };
58 #if defined TEST_STANDALONE
59 # define test_exit(val) exit (val)
61 static jmp_buf test_exit_buf;
62 static int test_error_return = 0;
63 # define test_exit(val) test_error_return = val, longjmp (test_exit_buf, 1)
64 #endif /* !TEST_STANDALONE */
66 static int pos; /* The offset of the current argument in ARGV. */
67 static int argc; /* The number of arguments present in ARGV. */
68 static char **argv; /* The argument list. */
70 static bool test_unop (char const *s);
71 static bool unary_operator (void);
72 static bool binary_operator (bool);
73 static bool two_arguments (void);
74 static bool three_arguments (void);
75 static bool posixtest (int);
77 static bool expr (void);
78 static bool term (void);
79 static bool and (void);
80 static bool or (void);
82 static void test_syntax_error (char const *format, char const *arg)
84 static void beyond (void) ATTRIBUTE_NORETURN;
87 test_syntax_error (char const *format, char const *arg)
89 fprintf (stderr, "%s: ", argv[0]);
90 fprintf (stderr, format, arg);
93 test_exit (TEST_FAILURE);
96 /* Increment our position in the argument list. Check that we're not
97 past the end of the argument list. This check is supressed if the
105 if (f && pos >= argc)
117 * beyond - call when we're beyond the end of the argument list (an
123 test_syntax_error (_("missing argument after %s"), quote (argv[argc - 1]));
126 /* If the characters pointed to by STRING constitute a valid number,
127 return a pointer to the start of the number, skipping any blanks or
128 leading '+'. Otherwise, report an error and exit. */
130 find_int (char const *string)
133 char const *number_start;
135 for (p = string; isblank (to_uchar (*p)); p++)
153 while (isblank (to_uchar (*p)))
159 test_syntax_error (_("invalid integer %s"), quote (string));
162 /* Find the modification time of FILE, and stuff it into *MTIME.
163 Return true if successful. */
165 get_mtime (char const *filename, struct timespec *mtime)
168 bool ok = (stat (filename, &finfo) == 0);
170 static struct timespec const zero;
174 *mtime = get_stat_mtime (&finfo);
178 /* Return true if S is one of the test command's binary operators. */
180 binop (char const *s)
182 return ((STREQ (s, "=")) || (STREQ (s, "!=")) || (STREQ (s, "==")) ||
183 (STREQ (s, "-nt")) ||
184 (STREQ (s, "-ot")) || (STREQ (s, "-ef")) || (STREQ (s, "-eq")) ||
185 (STREQ (s, "-ne")) || (STREQ (s, "-lt")) || (STREQ (s, "-le")) ||
186 (STREQ (s, "-gt")) || (STREQ (s, "-ge")));
190 * term - parse a term and return 1 or 0 depending on whether the term
191 * evaluates to true or false, respectively.
194 * '-'('h'|'d'|'f'|'r'|'s'|'w'|'c'|'b'|'p'|'u'|'g'|'k') filename
195 * '-'('L'|'x') filename
197 * '-'('z'|'n') string
199 * string ('!='|'=') string
200 * <int> '-'(eq|ne|le|lt|ge|gt) <int>
201 * file '-'(nt|ot|ef) file
205 * positive and negative integers
211 bool negated = false;
213 /* Deal with leading 'not's. */
214 while (pos < argc && argv[pos][0] == '!' && argv[pos][1] == '\0')
223 /* A paren-bracketed argument. */
224 if (argv[pos][0] == '(' && argv[pos][1] == '\0')
231 pos + nargs < argc && ! STREQ (argv[pos + nargs], ")");
239 value = posixtest (nargs);
241 test_syntax_error (_("')' expected"), NULL);
243 if (argv[pos][0] != ')' || argv[pos][1])
244 test_syntax_error (_("')' expected, found %s"), argv[pos]);
248 /* Are there enough arguments left that this could be dyadic? */
249 else if (4 <= argc - pos && STREQ (argv[pos], "-l") && binop (argv[pos + 2]))
250 value = binary_operator (true);
251 else if (3 <= argc - pos && binop (argv[pos + 1]))
252 value = binary_operator (false);
254 /* It might be a switch type argument. */
255 else if (argv[pos][0] == '-' && argv[pos][1] && argv[pos][2] == '\0')
257 if (test_unop (argv[pos]))
258 value = unary_operator ();
260 test_syntax_error (_("%s: unary operator expected"), argv[pos]);
264 value = (argv[pos][0] != '\0');
268 return negated ^ value;
272 binary_operator (bool l_is_l)
275 struct stat stat_buf, stat_spare;
276 /* Is the right integer expression of the form '-l string'? */
283 if ((op < argc - 2) && STREQ (argv[op + 1], "-l"))
291 if (argv[op][0] == '-')
293 /* check for eq, nt, and stuff */
294 if ((((argv[op][1] == 'l' || argv[op][1] == 'g')
295 && (argv[op][2] == 'e' || argv[op][2] == 't'))
296 || (argv[op][1] == 'e' && argv[op][2] == 'q')
297 || (argv[op][1] == 'n' && argv[op][2] == 'e'))
300 char lbuf[INT_BUFSIZE_BOUND (uintmax_t)];
301 char rbuf[INT_BUFSIZE_BOUND (uintmax_t)];
302 char const *l = (l_is_l
303 ? umaxtostr (strlen (argv[op - 1]), lbuf)
304 : find_int (argv[op - 1]));
305 char const *r = (r_is_l
306 ? umaxtostr (strlen (argv[op + 2]), rbuf)
307 : find_int (argv[op + 1]));
308 int cmp = strintcmp (l, r);
309 bool xe_operator = (argv[op][2] == 'e');
311 return (argv[op][1] == 'l' ? cmp < xe_operator
312 : argv[op][1] == 'g' ? cmp > - xe_operator
313 : (cmp != 0) == xe_operator);
322 if (argv[op][2] == 't' && !argv[op][3])
324 /* nt - newer than */
325 struct timespec lt, rt;
328 if (l_is_l || r_is_l)
329 test_syntax_error (_("-nt does not accept -l"), NULL);
330 le = get_mtime (argv[op - 1], <);
331 re = get_mtime (argv[op + 1], &rt);
332 return le && (!re || timespec_cmp (lt, rt) > 0);
337 if (argv[op][2] == 'f' && !argv[op][3])
339 /* ef - hard link? */
341 if (l_is_l || r_is_l)
342 test_syntax_error (_("-ef does not accept -l"), NULL);
343 return (stat (argv[op - 1], &stat_buf) == 0
344 && stat (argv[op + 1], &stat_spare) == 0
345 && stat_buf.st_dev == stat_spare.st_dev
346 && stat_buf.st_ino == stat_spare.st_ino);
351 if ('t' == argv[op][2] && '\000' == argv[op][3])
353 /* ot - older than */
354 struct timespec lt, rt;
357 if (l_is_l || r_is_l)
358 test_syntax_error (_("-ot does not accept -l"), NULL);
359 le = get_mtime (argv[op - 1], <);
360 re = get_mtime (argv[op + 1], &rt);
361 return re && (!le || timespec_cmp (lt, rt) < 0);
366 /* FIXME: is this dead code? */
367 test_syntax_error (_("unknown binary operator"), argv[op]);
370 if (argv[op][0] == '=' && (!argv[op][1] ||
371 ((argv[op][1] == '=') && !argv[op][2])))
373 bool value = STREQ (argv[pos], argv[pos + 2]);
378 if (STREQ (argv[op], "!="))
380 bool value = !STREQ (argv[pos], argv[pos + 2]);
390 unary_operator (void)
392 struct stat stat_buf;
394 switch (argv[pos][1])
399 /* All of the following unary operators use unary_advance (), which
400 checks to make sure that there is an argument, and then advances
401 pos right past it. This means that pos - 1 is the location of the
404 case 'a': /* file exists in the file system? */
407 return stat (argv[pos - 1], &stat_buf) == 0;
409 case 'r': /* file is readable? */
411 return euidaccess (argv[pos - 1], R_OK) == 0;
413 case 'w': /* File is writable? */
415 return euidaccess (argv[pos - 1], W_OK) == 0;
417 case 'x': /* File is executable? */
419 return euidaccess (argv[pos - 1], X_OK) == 0;
421 case 'O': /* File is owned by you? */
424 if (stat (argv[pos - 1], &stat_buf) != 0)
427 uid_t euid = geteuid ();
429 return ! (euid == NO_UID && errno) && euid == stat_buf.st_uid;
432 case 'G': /* File is owned by your group? */
435 if (stat (argv[pos - 1], &stat_buf) != 0)
438 gid_t egid = getegid ();
440 return ! (egid == NO_GID && errno) && egid == stat_buf.st_gid;
443 case 'f': /* File is a file? */
445 /* Under POSIX, -f is true if the given file exists
446 and is a regular file. */
447 return (stat (argv[pos - 1], &stat_buf) == 0
448 && S_ISREG (stat_buf.st_mode));
450 case 'd': /* File is a directory? */
452 return (stat (argv[pos - 1], &stat_buf) == 0
453 && S_ISDIR (stat_buf.st_mode));
455 case 's': /* File has something in it? */
457 return (stat (argv[pos - 1], &stat_buf) == 0
458 && 0 < stat_buf.st_size);
460 case 'S': /* File is a socket? */
462 return (stat (argv[pos - 1], &stat_buf) == 0
463 && S_ISSOCK (stat_buf.st_mode));
465 case 'c': /* File is character special? */
467 return (stat (argv[pos - 1], &stat_buf) == 0
468 && S_ISCHR (stat_buf.st_mode));
470 case 'b': /* File is block special? */
472 return (stat (argv[pos - 1], &stat_buf) == 0
473 && S_ISBLK (stat_buf.st_mode));
475 case 'p': /* File is a named pipe? */
477 return (stat (argv[pos - 1], &stat_buf) == 0
478 && S_ISFIFO (stat_buf.st_mode));
480 case 'L': /* Same as -h */
483 case 'h': /* File is a symbolic link? */
485 return (lstat (argv[pos - 1], &stat_buf) == 0
486 && S_ISLNK (stat_buf.st_mode));
488 case 'u': /* File is setuid? */
490 return (stat (argv[pos - 1], &stat_buf) == 0
491 && (stat_buf.st_mode & S_ISUID));
493 case 'g': /* File is setgid? */
495 return (stat (argv[pos - 1], &stat_buf) == 0
496 && (stat_buf.st_mode & S_ISGID));
498 case 'k': /* File has sticky bit set? */
500 return (stat (argv[pos - 1], &stat_buf) == 0
501 && (stat_buf.st_mode & S_ISVTX));
503 case 't': /* File (fd) is a terminal? */
508 arg = find_int (argv[pos - 1]);
510 fd = strtol (arg, NULL, 10);
511 return (errno != ERANGE && 0 <= fd && fd <= INT_MAX && isatty (fd));
514 case 'n': /* True if arg has some length. */
516 return argv[pos - 1][0] != 0;
518 case 'z': /* True if arg has no length. */
520 return argv[pos - 1][0] == '\0';
537 if (! (pos < argc && STREQ (argv[pos], "-a")))
556 if (! (pos < argc && STREQ (argv[pos], "-o")))
572 return or (); /* Same with this. */
575 /* Return true if OP is one of the test command's unary operators. */
577 test_unop (char const *op)
584 case 'a': case 'b': case 'c': case 'd': case 'e':
585 case 'f': case 'g': case 'h': case 'k': case 'n':
586 case 'o': case 'p': case 'r': case 's': case 't':
587 case 'u': case 'w': case 'x': case 'z':
588 case 'G': case 'L': case 'O': case 'S': case 'N':
598 return argv[pos++][0] != '\0';
606 if (STREQ (argv[pos], "!"))
609 value = ! one_argument ();
611 else if (argv[pos][0] == '-'
612 && argv[pos][1] != '\0'
613 && argv[pos][2] == '\0')
615 if (test_unop (argv[pos]))
616 value = unary_operator ();
618 test_syntax_error (_("%s: unary operator expected"), argv[pos]);
626 three_arguments (void)
630 if (binop (argv[pos + 1]))
631 value = binary_operator (false);
632 else if (STREQ (argv[pos], "!"))
635 value = !two_arguments ();
637 else if (STREQ (argv[pos], "(") && STREQ (argv[pos + 2], ")"))
640 value = one_argument ();
643 else if (STREQ (argv[pos + 1], "-a") || STREQ (argv[pos + 1], "-o"))
646 test_syntax_error (_("%s: binary operator expected"), argv[pos+1]);
650 /* This is an implementation of a Posix.2 proposal by David Korn. */
652 posixtest (int nargs)
659 value = one_argument ();
663 value = two_arguments ();
667 value = three_arguments ();
671 if (STREQ (argv[pos], "!"))
674 value = !three_arguments ();
677 if (STREQ (argv[pos], "(") && STREQ (argv[pos + 3], ")"))
680 value = two_arguments ();
695 #if defined TEST_STANDALONE
700 if (status != EXIT_SUCCESS)
705 Usage: test EXPRESSION\n\
707 or: [ EXPRESSION ]\n\
712 Exit with the status determined by EXPRESSION.\n\
715 fputs (HELP_OPTION_DESCRIPTION, stdout);
716 fputs (VERSION_OPTION_DESCRIPTION, stdout);
719 An omitted EXPRESSION defaults to false. Otherwise,\n\
720 EXPRESSION is true or false and sets exit status. It is one of:\n\
724 ( EXPRESSION ) EXPRESSION is true\n\
725 ! EXPRESSION EXPRESSION is false\n\
726 EXPRESSION1 -a EXPRESSION2 both EXPRESSION1 and EXPRESSION2 are true\n\
727 EXPRESSION1 -o EXPRESSION2 either EXPRESSION1 or EXPRESSION2 is true\n\
731 -n STRING the length of STRING is nonzero\n\
732 STRING equivalent to -n STRING\n\
733 -z STRING the length of STRING is zero\n\
734 STRING1 = STRING2 the strings are equal\n\
735 STRING1 != STRING2 the strings are not equal\n\
739 INTEGER1 -eq INTEGER2 INTEGER1 is equal to INTEGER2\n\
740 INTEGER1 -ge INTEGER2 INTEGER1 is greater than or equal to INTEGER2\n\
741 INTEGER1 -gt INTEGER2 INTEGER1 is greater than INTEGER2\n\
742 INTEGER1 -le INTEGER2 INTEGER1 is less than or equal to INTEGER2\n\
743 INTEGER1 -lt INTEGER2 INTEGER1 is less than INTEGER2\n\
744 INTEGER1 -ne INTEGER2 INTEGER1 is not equal to INTEGER2\n\
748 FILE1 -ef FILE2 FILE1 and FILE2 have the same device and inode numbers\n\
749 FILE1 -nt FILE2 FILE1 is newer (modification date) than FILE2\n\
750 FILE1 -ot FILE2 FILE1 is older than FILE2\n\
754 -b FILE FILE exists and is block special\n\
755 -c FILE FILE exists and is character special\n\
756 -d FILE FILE exists and is a directory\n\
757 -e FILE FILE exists\n\
760 -f FILE FILE exists and is a regular file\n\
761 -g FILE FILE exists and is set-group-ID\n\
762 -G FILE FILE exists and is owned by the effective group ID\n\
763 -h FILE FILE exists and is a symbolic link (same as -L)\n\
764 -k FILE FILE exists and has its sticky bit set\n\
767 -L FILE FILE exists and is a symbolic link (same as -h)\n\
768 -O FILE FILE exists and is owned by the effective user ID\n\
769 -p FILE FILE exists and is a named pipe\n\
770 -r FILE FILE exists and read permission is granted\n\
771 -s FILE FILE exists and has a size greater than zero\n\
774 -S FILE FILE exists and is a socket\n\
775 -t FD file descriptor FD is opened on a terminal\n\
776 -u FILE FILE exists and its set-user-ID bit is set\n\
777 -w FILE FILE exists and write permission is granted\n\
778 -x FILE FILE exists and execute (or search) permission is granted\n\
782 Except for -h and -L, all FILE-related tests dereference symbolic links.\n\
783 Beware that parentheses need to be escaped (e.g., by backslashes) for shells.\n\
784 INTEGER may also be -l STRING, which evaluates to the length of STRING.\n\
788 NOTE: [ honors the --help and --version options, but test does not.\n\
789 test treats each of those as it treats any other nonempty STRING.\n\
791 printf (USAGE_BUILTIN_WARNING, _("test and/or ["));
792 emit_ancillary_info ();
796 #endif /* TEST_STANDALONE */
798 #if !defined TEST_STANDALONE
799 # define main test_command
803 proper_name ("Kevin Braunsdorf"), \
804 proper_name ("Matthew Bradburn")
813 main (int margc, char **margv)
817 #if !defined TEST_STANDALONE
820 code = setjmp (test_exit_buf);
823 return (test_error_return);
824 #else /* TEST_STANDALONE */
825 initialize_main (&margc, &margv);
826 set_program_name (margv[0]);
827 setlocale (LC_ALL, "");
828 bindtextdomain (PACKAGE, LOCALEDIR);
829 textdomain (PACKAGE);
831 initialize_exit_failure (TEST_FAILURE);
832 atexit (close_stdout);
833 #endif /* TEST_STANDALONE */
839 /* Recognize --help or --version, but only when invoked in the
840 "[" form, when the last argument is not "]". Use direct
841 parsing, rather than parse_long_options, to avoid accepting
842 abbreviations. POSIX allows "[ --help" and "[ --version" to
843 have the usual GNU behavior, but it requires "test --help"
844 and "test --version" to exit silently with status 0. */
847 if (STREQ (margv[1], "--help"))
848 usage (EXIT_SUCCESS);
850 if (STREQ (margv[1], "--version"))
852 version_etc (stdout, PROGRAM_NAME, PACKAGE_NAME, Version, AUTHORS,
854 test_exit (EXIT_SUCCESS);
857 if (margc < 2 || !STREQ (margv[margc - 1], "]"))
858 test_syntax_error (_("missing ']'"), NULL);
867 test_exit (TEST_FALSE);
869 value = posixtest (argc - 1);
872 test_syntax_error (_("extra argument %s"), quote (argv[pos]));
874 test_exit (value ? TEST_TRUE : TEST_FALSE);