1 /* GNU test program (ksb and mjb) */
3 /* Modified to run with the GNU shell by bfox. */
5 /* Copyright (C) 1987-2004 Free Software Foundation, Inc.
7 This file is part of GNU Bash, the Bourne Again SHell.
9 Bash is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free
11 Software Foundation; either version 2, or (at your option) any later
14 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
15 WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software Foundation,
21 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
23 /* Define TEST_STANDALONE to get the /bin/test version. Otherwise, you get
24 the shell builtin version. */
28 #include <sys/types.h>
30 #define TEST_STANDALONE 1
36 /* The official name of this program (e.g., no `g' prefix). */
38 # define PROGRAM_NAME "["
40 # define PROGRAM_NAME "test"
45 #include "euidaccess.h"
48 #ifndef _POSIX_VERSION
49 # include <sys/param.h>
50 #endif /* _POSIX_VERSION */
51 #define whitespace(c) (((c) == ' ') || ((c) == '\t'))
52 #define digit(c) ((c) >= '0' && (c) <= '9')
53 #define digit_value(c) ((c) - '0')
57 #if !defined (_POSIX_VERSION)
58 # include <sys/file.h>
59 #endif /* !_POSIX_VERSION */
61 extern gid_t getegid ();
62 extern uid_t geteuid ();
64 /* Exit status for syntax errors, etc. */
65 enum { TEST_TRUE, TEST_FALSE, TEST_FAILURE };
67 #if defined (TEST_STANDALONE)
68 # define test_exit(val) exit (val)
70 static jmp_buf test_exit_buf;
71 static int test_error_return = 0;
72 # define test_exit(val) test_error_return = val, longjmp (test_exit_buf, 1)
73 #endif /* !TEST_STANDALONE */
75 static int pos; /* The offset of the current argument in ARGV. */
76 static int argc; /* The number of arguments present in ARGV. */
77 static char **argv; /* The argument list. */
79 static bool test_unop (char const *s);
80 static bool binop (char *s);
81 static bool unary_operator (void);
82 static bool binary_operator (bool);
83 static bool two_arguments (void);
84 static bool three_arguments (void);
85 static bool posixtest (int);
87 static bool expr (void);
88 static bool term (void);
89 static bool and (void);
90 static bool or (void);
92 static void test_syntax_error (char const *format, char const *arg)
94 static void beyond (void) ATTRIBUTE_NORETURN;
97 test_syntax_error (char const *format, char const *arg)
99 fprintf (stderr, "%s: ", argv[0]);
100 fprintf (stderr, format, arg);
102 test_exit (TEST_FAILURE);
105 /* Increment our position in the argument list. Check that we're not
106 past the end of the argument list. This check is supressed if the
107 argument is false. */
114 if (f && pos >= argc)
126 * beyond - call when we're beyond the end of the argument list (an
132 test_syntax_error (_("missing argument after %s"), quote (argv[argc - 1]));
135 /* Syntax error for when an integer argument was expected, but
136 something else was found. */
138 integer_expected_error (char const *pch)
140 test_syntax_error (_("%s: integer expression expected\n"), pch);
143 /* Return true if the characters pointed to by STRING constitute a
144 valid number. Stuff the converted number into RESULT if RESULT is
147 is_int (register char *string, intmax_t *result)
158 /* Skip leading whitespace characters. */
159 while (whitespace (*string))
165 /* We allow leading `-' or `+'. */
166 if (*string == '-' || *string == '+')
168 if (!digit (string[1]))
177 while (digit (*string))
180 value = (value * 10) + digit_value (*string);
184 /* Skip trailing whitespace, if any. */
185 while (whitespace (*string))
188 /* Error if not at end of string. */
201 /* Find the modification time of FILE, and stuff it into *AGE.
202 Return true if successful. */
204 age_of (char *filename, time_t *age)
207 bool ok = (stat (filename, &finfo) == 0);
209 *age = finfo.st_mtime;
214 * term - parse a term and return 1 or 0 depending on whether the term
215 * evaluates to true or false, respectively.
218 * '-'('h'|'d'|'f'|'r'|'s'|'w'|'c'|'b'|'p'|'u'|'g'|'k') filename
219 * '-'('L'|'x') filename
221 * '-'('z'|'n') string
223 * string ('!='|'=') string
224 * <int> '-'(eq|ne|le|lt|ge|gt) <int>
225 * file '-'(nt|ot|ef) file
229 * positive and negative integers
235 bool negated = false;
237 /* Deal with leading `not's. */
238 while (pos < argc && argv[pos][0] == '!' && argv[pos][1] == '\0')
247 /* A paren-bracketed argument. */
248 if (argv[pos][0] == '(' && argv[pos][1] == '\0')
255 pos + nargs < argc && ! STREQ (argv[pos + nargs], ")");
263 value = posixtest (nargs);
265 test_syntax_error (_("')' expected\n"), NULL);
267 if (argv[pos][0] != ')' || argv[pos][1])
268 test_syntax_error (_("')' expected, found %s\n"), argv[pos]);
272 /* Are there enough arguments left that this could be dyadic? */
273 else if (4 <= argc - pos && STREQ (argv[pos], "-l") && binop (argv[pos + 2]))
274 value = binary_operator (true);
275 else if (3 <= argc - pos && binop (argv[pos + 1]))
276 value = binary_operator (false);
278 /* It might be a switch type argument. */
279 else if (argv[pos][0] == '-' && argv[pos][1] && argv[pos][2] == '\0')
281 if (test_unop (argv[pos]))
282 value = unary_operator ();
284 test_syntax_error (_("%s: unary operator expected\n"), argv[pos]);
288 value = (argv[pos][0] != '\0');
292 return negated ^ value;
296 binary_operator (bool l_is_l)
299 struct stat stat_buf, stat_spare;
301 /* Is the right integer expression of the form '-l string'? */
308 if ((op < argc - 2) && STREQ (argv[op + 1], "-l"))
316 if (argv[op][0] == '-')
318 /* check for eq, nt, and stuff */
325 if (argv[op][2] == 't' && !argv[op][3])
329 l = strlen (argv[op - 1]);
332 if (!is_int (argv[op - 1], &l))
333 integer_expected_error (_("before -lt"));
337 r = strlen (argv[op + 2]);
340 if (!is_int (argv[op + 1], &r))
341 integer_expected_error (_("after -lt"));
347 if (argv[op][2] == 'e' && !argv[op][3])
351 l = strlen (argv[op - 1]);
354 if (!is_int (argv[op - 1], &l))
355 integer_expected_error (_("before -le"));
358 r = strlen (argv[op + 2]);
361 if (!is_int (argv[op + 1], &r))
362 integer_expected_error (_("after -le"));
370 if (argv[op][2] == 't' && !argv[op][3])
372 /* gt integer greater than */
374 l = strlen (argv[op - 1]);
377 if (!is_int (argv[op - 1], &l))
378 integer_expected_error (_("before -gt"));
381 r = strlen (argv[op + 2]);
384 if (!is_int (argv[op + 1], &r))
385 integer_expected_error (_("after -gt"));
391 if (argv[op][2] == 'e' && !argv[op][3])
393 /* ge - integer greater than or equal to */
395 l = strlen (argv[op - 1]);
398 if (!is_int (argv[op - 1], &l))
399 integer_expected_error (_("before -ge"));
402 r = strlen (argv[op + 2]);
405 if (!is_int (argv[op + 1], &r))
406 integer_expected_error (_("after -ge"));
414 if (argv[op][2] == 't' && !argv[op][3])
416 /* nt - newer than */
421 test_syntax_error (_("-nt does not accept -l\n"), NULL);
422 le = age_of (argv[op - 1], <);
423 re = age_of (argv[op + 1], &rt);
424 return le > re || (le && lt > rt);
427 if (argv[op][2] == 'e' && !argv[op][3])
429 /* ne - integer not equal */
431 l = strlen (argv[op - 1]);
434 if (!is_int (argv[op - 1], &l))
435 integer_expected_error (_("before -ne"));
438 r = strlen (argv[op + 2]);
441 if (!is_int (argv[op + 1], &r))
442 integer_expected_error (_("after -ne"));
450 if (argv[op][2] == 'q' && !argv[op][3])
452 /* eq - integer equal */
454 l = strlen (argv[op - 1]);
457 if (!is_int (argv[op - 1], &l))
458 integer_expected_error (_("before -eq"));
461 r = strlen (argv[op + 2]);
464 if (!is_int (argv[op + 1], &r))
465 integer_expected_error (_("after -eq"));
471 if (argv[op][2] == 'f' && !argv[op][3])
473 /* ef - hard link? */
476 test_syntax_error (_("-ef does not accept -l\n"), NULL);
477 return (stat (argv[op - 1], &stat_buf) == 0
478 && stat (argv[op + 1], &stat_spare) == 0
479 && stat_buf.st_dev == stat_spare.st_dev
480 && stat_buf.st_ino == stat_spare.st_ino);
485 if ('t' == argv[op][2] && '\000' == argv[op][3])
487 /* ot - older than */
492 test_syntax_error (_("-ot does not accept -l\n"), NULL);
493 le = age_of (argv[op - 1], <);
494 re = age_of (argv[op + 1], &rt);
495 return le < re || (re && lt < rt);
500 /* FIXME: is this dead code? */
501 test_syntax_error (_("unknown binary operator\n"), argv[op]);
504 if (argv[op][0] == '=' && !argv[op][1])
506 bool value = STREQ (argv[pos], argv[pos + 2]);
511 if (STREQ (argv[op], "!="))
513 bool value = !STREQ (argv[pos], argv[pos + 2]);
523 unary_operator (void)
525 struct stat stat_buf;
527 switch (argv[pos][1])
532 /* All of the following unary operators use unary_advance (), which
533 checks to make sure that there is an argument, and then advances
534 pos right past it. This means that pos - 1 is the location of the
537 case 'a': /* file exists in the file system? */
540 return stat (argv[pos - 1], &stat_buf) == 0;
542 case 'r': /* file is readable? */
544 return euidaccess (argv[pos - 1], R_OK) == 0;
546 case 'w': /* File is writable? */
548 return euidaccess (argv[pos - 1], W_OK) == 0;
550 case 'x': /* File is executable? */
552 return euidaccess (argv[pos - 1], X_OK) == 0;
554 case 'O': /* File is owned by you? */
556 return (stat (argv[pos - 1], &stat_buf) == 0
557 && (geteuid () == stat_buf.st_uid));
559 case 'G': /* File is owned by your group? */
561 return (stat (argv[pos - 1], &stat_buf) == 0
562 && (getegid () == stat_buf.st_gid));
564 case 'f': /* File is a file? */
566 /* Under POSIX, -f is true if the given file exists
567 and is a regular file. */
568 return (stat (argv[pos - 1], &stat_buf) == 0
569 && S_ISREG (stat_buf.st_mode));
571 case 'd': /* File is a directory? */
573 return (stat (argv[pos - 1], &stat_buf) == 0
574 && S_ISDIR (stat_buf.st_mode));
576 case 's': /* File has something in it? */
578 return (stat (argv[pos - 1], &stat_buf) == 0
579 && 0 < stat_buf.st_size);
581 case 'S': /* File is a socket? */
583 return (stat (argv[pos - 1], &stat_buf) == 0
584 && S_ISSOCK (stat_buf.st_mode));
586 case 'c': /* File is character special? */
588 return (stat (argv[pos - 1], &stat_buf) == 0
589 && S_ISCHR (stat_buf.st_mode));
591 case 'b': /* File is block special? */
593 return (stat (argv[pos - 1], &stat_buf) == 0
594 && S_ISBLK (stat_buf.st_mode));
596 case 'p': /* File is a named pipe? */
598 return (stat (argv[pos - 1], &stat_buf) == 0
599 && S_ISFIFO (stat_buf.st_mode));
601 case 'L': /* Same as -h */
604 case 'h': /* File is a symbolic link? */
606 return (lstat (argv[pos - 1], &stat_buf) == 0
607 && S_ISLNK (stat_buf.st_mode));
609 case 'u': /* File is setuid? */
611 return (stat (argv[pos - 1], &stat_buf) == 0
612 && (stat_buf.st_mode & S_ISUID));
614 case 'g': /* File is setgid? */
616 return (stat (argv[pos - 1], &stat_buf) == 0
617 && (stat_buf.st_mode & S_ISGID));
619 case 'k': /* File has sticky bit set? */
621 return (stat (argv[pos - 1], &stat_buf) == 0
622 && (stat_buf.st_mode & S_ISVTX));
624 case 't': /* File (fd) is a terminal? */
628 if (!is_int (argv[pos - 1], &fd))
629 integer_expected_error (_("after -t"));
630 return INT_MIN <= fd && fd <= INT_MAX && isatty (fd);
633 case 'n': /* True if arg has some length. */
635 return argv[pos - 1][0] != 0;
637 case 'z': /* True if arg has no length. */
639 return argv[pos - 1][0] == '\0';
656 if (! (pos < argc && STREQ (argv[pos], "-a")))
675 if (! (pos < argc && STREQ (argv[pos], "-o")))
691 return or (); /* Same with this. */
694 /* Return true if S is one of the test command's binary operators. */
698 return ((STREQ (s, "=")) || (STREQ (s, "!=")) || (STREQ (s, "-nt")) ||
699 (STREQ (s, "-ot")) || (STREQ (s, "-ef")) || (STREQ (s, "-eq")) ||
700 (STREQ (s, "-ne")) || (STREQ (s, "-lt")) || (STREQ (s, "-le")) ||
701 (STREQ (s, "-gt")) || (STREQ (s, "-ge")));
704 /* Return true if OP is one of the test command's unary operators. */
706 test_unop (char const *op)
713 case 'a': case 'b': case 'c': case 'd': case 'e':
714 case 'f': case 'g': case 'h': case 'k': case 'n':
715 case 'o': case 'p': case 'r': case 's': case 't':
716 case 'u': case 'w': case 'x': case 'z':
717 case 'G': case 'L': case 'O': case 'S': case 'N':
727 return argv[pos++][0] != '\0';
735 if (STREQ (argv[pos], "!"))
738 value = ! one_argument ();
740 else if (argv[pos][0] == '-'
741 && argv[pos][1] != '\0'
742 && argv[pos][2] == '\0')
744 if (test_unop (argv[pos]))
745 value = unary_operator ();
747 test_syntax_error (_("%s: unary operator expected\n"), argv[pos]);
755 three_arguments (void)
759 if (binop (argv[pos + 1]))
760 value = binary_operator (false);
761 else if (STREQ (argv[pos], "!"))
764 value = !two_arguments ();
766 else if (STREQ (argv[pos], "(") && STREQ (argv[pos + 2], ")"))
769 value = one_argument ();
772 else if (STREQ (argv[pos + 1], "-a") || STREQ (argv[pos + 1], "-o"))
775 test_syntax_error (_("%s: binary operator expected\n"), argv[pos+1]);
779 /* This is an implementation of a Posix.2 proposal by David Korn. */
781 posixtest (int nargs)
788 value = one_argument ();
792 value = two_arguments ();
796 value = three_arguments ();
800 if (STREQ (argv[pos], "!"))
803 value = !three_arguments ();
806 if (STREQ (argv[pos], "(") && STREQ (argv[pos + 3], ")"))
809 value = two_arguments ();
824 #if defined (TEST_STANDALONE)
825 # include "long-options.h"
830 if (status != EXIT_SUCCESS)
831 fprintf (stderr, _("Try `%s --help' for more information.\n"),
836 Usage: test EXPRESSION\n\
838 or: [ EXPRESSION ]\n\
841 Exit with the status determined by EXPRESSION.\n\
844 fputs (HELP_OPTION_DESCRIPTION, stdout);
845 fputs (VERSION_OPTION_DESCRIPTION, stdout);
848 An omitted EXPRESSION defaults to false. Otherwise,\n\
849 EXPRESSION is true or false and sets exit status. It is one of:\n\
853 ( EXPRESSION ) EXPRESSION is true\n\
854 ! EXPRESSION EXPRESSION is false\n\
855 EXPRESSION1 -a EXPRESSION2 both EXPRESSION1 and EXPRESSION2 are true\n\
856 EXPRESSION1 -o EXPRESSION2 either EXPRESSION1 or EXPRESSION2 is true\n\
860 [-n] STRING the length of STRING is nonzero\n\
861 -z STRING the length of STRING is zero\n\
862 STRING1 = STRING2 the strings are equal\n\
863 STRING1 != STRING2 the strings are not equal\n\
867 INTEGER1 -eq INTEGER2 INTEGER1 is equal to INTEGER2\n\
868 INTEGER1 -ge INTEGER2 INTEGER1 is greater than or equal to INTEGER2\n\
869 INTEGER1 -gt INTEGER2 INTEGER1 is greater than INTEGER2\n\
870 INTEGER1 -le INTEGER2 INTEGER1 is less than or equal to INTEGER2\n\
871 INTEGER1 -lt INTEGER2 INTEGER1 is less than INTEGER2\n\
872 INTEGER1 -ne INTEGER2 INTEGER1 is not equal to INTEGER2\n\
876 FILE1 -ef FILE2 FILE1 and FILE2 have the same device and inode numbers\n\
877 FILE1 -nt FILE2 FILE1 is newer (modification date) than FILE2\n\
878 FILE1 -ot FILE2 FILE1 is older than FILE2\n\
882 -b FILE FILE exists and is block special\n\
883 -c FILE FILE exists and is character special\n\
884 -d FILE FILE exists and is a directory\n\
885 -e FILE FILE exists\n\
888 -f FILE FILE exists and is a regular file\n\
889 -g FILE FILE exists and is set-group-ID\n\
890 -G FILE FILE exists and is owned by the effective group ID\n\
891 -h FILE FILE exists and is a symbolic link (same as -L)\n\
892 -k FILE FILE exists and has its sticky bit set\n\
895 -L FILE FILE exists and is a symbolic link (same as -h)\n\
896 -O FILE FILE exists and is owned by the effective user ID\n\
897 -p FILE FILE exists and is a named pipe\n\
898 -r FILE FILE exists and is readable\n\
899 -s FILE FILE exists and has a size greater than zero\n\
902 -S FILE FILE exists and is a socket\n\
903 -t FD file descriptor FD is opened on a terminal\n\
904 -u FILE FILE exists and its set-user-ID bit is set\n\
905 -w FILE FILE exists and is writable\n\
906 -x FILE FILE exists and is executable\n\
910 Except for -h and -L, all FILE-related tests dereference symbolic links.\n\
911 Beware that parentheses need to be escaped (e.g., by backslashes) for shells.\n\
912 INTEGER may also be -l STRING, which evaluates to the length of STRING.\n\
914 printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
918 #endif /* TEST_STANDALONE */
920 #if !defined (TEST_STANDALONE)
921 # define main test_command
924 #define AUTHORS "Kevin Braunsdorf", "Matthew Bradburn"
933 main (int margc, char **margv)
937 #if !defined (TEST_STANDALONE)
940 code = setjmp (test_exit_buf);
943 return (test_error_return);
944 #else /* TEST_STANDALONE */
945 initialize_main (&margc, &margv);
946 program_name = margv[0];
947 setlocale (LC_ALL, "");
948 bindtextdomain (PACKAGE, LOCALEDIR);
949 textdomain (PACKAGE);
951 initialize_exit_failure (TEST_FAILURE);
952 atexit (close_stdout);
953 #endif /* TEST_STANDALONE */
959 /* Recognize --help or --version, but only when invoked in the
960 "[" form, and when the last argument is not "]". POSIX
961 allows "[ --help" and "[ --version" to have the usual GNU
962 behavior, but it requires "test --help" and "test --version"
963 to exit silently with status 1. */
964 if (margc < 2 || !STREQ (margv[margc - 1], "]"))
966 parse_long_options (margc, margv, PROGRAM_NAME, GNU_PACKAGE, VERSION,
967 usage, AUTHORS, (char const *) NULL);
968 test_syntax_error (_("missing `]'\n"), NULL);
978 test_exit (TEST_FALSE);
980 value = posixtest (argc - 1);
983 test_syntax_error (_("extra argument %s"), quote (argv[pos]));
985 test_exit (value ? TEST_TRUE : TEST_FALSE);