1 /* GNU test program (ksb and mjb) */
3 /* Modified to run with the GNU shell by bfox. */
5 /* Copyright (C) 1987-2005, 2007-2009 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. */
25 #include <sys/types.h>
27 #define TEST_STANDALONE 1
33 /* The official name of this program (e.g., no `g' prefix). */
35 # define PROGRAM_NAME "["
37 # define PROGRAM_NAME "test"
42 #include "stat-time.h"
43 #include "strnumcmp.h"
46 # include <sys/param.h>
49 /* Exit status for syntax errors, etc. */
50 enum { TEST_TRUE
, TEST_FALSE
, TEST_FAILURE
};
52 #if defined TEST_STANDALONE
53 # define test_exit(val) exit (val)
55 static jmp_buf test_exit_buf
;
56 static int test_error_return
= 0;
57 # define test_exit(val) test_error_return = val, longjmp (test_exit_buf, 1)
58 #endif /* !TEST_STANDALONE */
60 static int pos
; /* The offset of the current argument in ARGV. */
61 static int argc
; /* The number of arguments present in ARGV. */
62 static char **argv
; /* The argument list. */
64 static bool test_unop (char const *s
);
65 static bool unary_operator (void);
66 static bool binary_operator (bool);
67 static bool two_arguments (void);
68 static bool three_arguments (void);
69 static bool posixtest (int);
71 static bool expr (void);
72 static bool term (void);
73 static bool and (void);
74 static bool or (void);
76 static void test_syntax_error (char const *format
, char const *arg
)
78 static void beyond (void) ATTRIBUTE_NORETURN
;
81 test_syntax_error (char const *format
, char const *arg
)
83 fprintf (stderr
, "%s: ", argv
[0]);
84 fprintf (stderr
, format
, arg
);
87 test_exit (TEST_FAILURE
);
90 /* Increment our position in the argument list. Check that we're not
91 past the end of the argument list. This check is supressed if the
111 * beyond - call when we're beyond the end of the argument list (an
117 test_syntax_error (_("missing argument after %s"), quote (argv
[argc
- 1]));
120 /* If the characters pointed to by STRING constitute a valid number,
121 return a pointer to the start of the number, skipping any blanks or
122 leading '+'. Otherwise, report an error and exit. */
124 find_int (char const *string
)
127 char const *number_start
;
129 for (p
= string
; isblank (to_uchar (*p
)); p
++)
147 while (isblank (to_uchar (*p
)))
153 test_syntax_error (_("invalid integer %s"), quote (string
));
156 /* Find the modification time of FILE, and stuff it into *MTIME.
157 Return true if successful. */
159 get_mtime (char const *filename
, struct timespec
*mtime
)
162 bool ok
= (stat (filename
, &finfo
) == 0);
164 static struct timespec
const zero
;
168 *mtime
= get_stat_mtime (&finfo
);
172 /* Return true if S is one of the test command's binary operators. */
174 binop (char const *s
)
176 return ((STREQ (s
, "=")) || (STREQ (s
, "!=")) || (STREQ (s
, "-nt")) ||
177 (STREQ (s
, "-ot")) || (STREQ (s
, "-ef")) || (STREQ (s
, "-eq")) ||
178 (STREQ (s
, "-ne")) || (STREQ (s
, "-lt")) || (STREQ (s
, "-le")) ||
179 (STREQ (s
, "-gt")) || (STREQ (s
, "-ge")));
183 * term - parse a term and return 1 or 0 depending on whether the term
184 * evaluates to true or false, respectively.
187 * '-'('h'|'d'|'f'|'r'|'s'|'w'|'c'|'b'|'p'|'u'|'g'|'k') filename
188 * '-'('L'|'x') filename
190 * '-'('z'|'n') string
192 * string ('!='|'=') string
193 * <int> '-'(eq|ne|le|lt|ge|gt) <int>
194 * file '-'(nt|ot|ef) file
198 * positive and negative integers
204 bool negated
= false;
206 /* Deal with leading `not's. */
207 while (pos
< argc
&& argv
[pos
][0] == '!' && argv
[pos
][1] == '\0')
216 /* A paren-bracketed argument. */
217 if (argv
[pos
][0] == '(' && argv
[pos
][1] == '\0')
224 pos
+ nargs
< argc
&& ! STREQ (argv
[pos
+ nargs
], ")");
232 value
= posixtest (nargs
);
234 test_syntax_error (_("')' expected"), NULL
);
236 if (argv
[pos
][0] != ')' || argv
[pos
][1])
237 test_syntax_error (_("')' expected, found %s"), argv
[pos
]);
241 /* Are there enough arguments left that this could be dyadic? */
242 else if (4 <= argc
- pos
&& STREQ (argv
[pos
], "-l") && binop (argv
[pos
+ 2]))
243 value
= binary_operator (true);
244 else if (3 <= argc
- pos
&& binop (argv
[pos
+ 1]))
245 value
= binary_operator (false);
247 /* It might be a switch type argument. */
248 else if (argv
[pos
][0] == '-' && argv
[pos
][1] && argv
[pos
][2] == '\0')
250 if (test_unop (argv
[pos
]))
251 value
= unary_operator ();
253 test_syntax_error (_("%s: unary operator expected"), argv
[pos
]);
257 value
= (argv
[pos
][0] != '\0');
261 return negated
^ value
;
265 binary_operator (bool l_is_l
)
268 struct stat stat_buf
, stat_spare
;
269 /* Is the right integer expression of the form '-l string'? */
276 if ((op
< argc
- 2) && STREQ (argv
[op
+ 1], "-l"))
284 if (argv
[op
][0] == '-')
286 /* check for eq, nt, and stuff */
287 if ((((argv
[op
][1] == 'l' || argv
[op
][1] == 'g')
288 && (argv
[op
][2] == 'e' || argv
[op
][2] == 't'))
289 || (argv
[op
][1] == 'e' && argv
[op
][2] == 'q')
290 || (argv
[op
][1] == 'n' && argv
[op
][2] == 'e'))
293 char lbuf
[INT_BUFSIZE_BOUND (uintmax_t)];
294 char rbuf
[INT_BUFSIZE_BOUND (uintmax_t)];
295 char const *l
= (l_is_l
296 ? umaxtostr (strlen (argv
[op
- 1]), lbuf
)
297 : find_int (argv
[op
- 1]));
298 char const *r
= (r_is_l
299 ? umaxtostr (strlen (argv
[op
+ 2]), rbuf
)
300 : find_int (argv
[op
+ 1]));
301 int cmp
= strintcmp (l
, r
);
302 bool xe_operator
= (argv
[op
][2] == 'e');
304 return (argv
[op
][1] == 'l' ? cmp
< xe_operator
305 : argv
[op
][1] == 'g' ? cmp
> - xe_operator
306 : (cmp
!= 0) == xe_operator
);
315 if (argv
[op
][2] == 't' && !argv
[op
][3])
317 /* nt - newer than */
318 struct timespec lt
, rt
;
322 test_syntax_error (_("-nt does not accept -l"), NULL
);
323 le
= get_mtime (argv
[op
- 1], <
);
324 re
= get_mtime (argv
[op
+ 1], &rt
);
325 return le
&& (!re
|| timespec_cmp (lt
, rt
) > 0);
330 if (argv
[op
][2] == 'f' && !argv
[op
][3])
332 /* ef - hard link? */
335 test_syntax_error (_("-ef does not accept -l"), NULL
);
336 return (stat (argv
[op
- 1], &stat_buf
) == 0
337 && stat (argv
[op
+ 1], &stat_spare
) == 0
338 && stat_buf
.st_dev
== stat_spare
.st_dev
339 && stat_buf
.st_ino
== stat_spare
.st_ino
);
344 if ('t' == argv
[op
][2] && '\000' == argv
[op
][3])
346 /* ot - older than */
347 struct timespec lt
, rt
;
351 test_syntax_error (_("-ot does not accept -l"), NULL
);
352 le
= get_mtime (argv
[op
- 1], <
);
353 re
= get_mtime (argv
[op
+ 1], &rt
);
354 return re
&& (!le
|| timespec_cmp (lt
, rt
) < 0);
359 /* FIXME: is this dead code? */
360 test_syntax_error (_("unknown binary operator"), argv
[op
]);
363 if (argv
[op
][0] == '=' && !argv
[op
][1])
365 bool value
= STREQ (argv
[pos
], argv
[pos
+ 2]);
370 if (STREQ (argv
[op
], "!="))
372 bool value
= !STREQ (argv
[pos
], argv
[pos
+ 2]);
382 unary_operator (void)
384 struct stat stat_buf
;
386 switch (argv
[pos
][1])
391 /* All of the following unary operators use unary_advance (), which
392 checks to make sure that there is an argument, and then advances
393 pos right past it. This means that pos - 1 is the location of the
396 case 'a': /* file exists in the file system? */
399 return stat (argv
[pos
- 1], &stat_buf
) == 0;
401 case 'r': /* file is readable? */
403 return euidaccess (argv
[pos
- 1], R_OK
) == 0;
405 case 'w': /* File is writable? */
407 return euidaccess (argv
[pos
- 1], W_OK
) == 0;
409 case 'x': /* File is executable? */
411 return euidaccess (argv
[pos
- 1], X_OK
) == 0;
413 case 'O': /* File is owned by you? */
415 return (stat (argv
[pos
- 1], &stat_buf
) == 0
416 && (geteuid () == stat_buf
.st_uid
));
418 case 'G': /* File is owned by your group? */
420 return (stat (argv
[pos
- 1], &stat_buf
) == 0
421 && (getegid () == stat_buf
.st_gid
));
423 case 'f': /* File is a file? */
425 /* Under POSIX, -f is true if the given file exists
426 and is a regular file. */
427 return (stat (argv
[pos
- 1], &stat_buf
) == 0
428 && S_ISREG (stat_buf
.st_mode
));
430 case 'd': /* File is a directory? */
432 return (stat (argv
[pos
- 1], &stat_buf
) == 0
433 && S_ISDIR (stat_buf
.st_mode
));
435 case 's': /* File has something in it? */
437 return (stat (argv
[pos
- 1], &stat_buf
) == 0
438 && 0 < stat_buf
.st_size
);
440 case 'S': /* File is a socket? */
442 return (stat (argv
[pos
- 1], &stat_buf
) == 0
443 && S_ISSOCK (stat_buf
.st_mode
));
445 case 'c': /* File is character special? */
447 return (stat (argv
[pos
- 1], &stat_buf
) == 0
448 && S_ISCHR (stat_buf
.st_mode
));
450 case 'b': /* File is block special? */
452 return (stat (argv
[pos
- 1], &stat_buf
) == 0
453 && S_ISBLK (stat_buf
.st_mode
));
455 case 'p': /* File is a named pipe? */
457 return (stat (argv
[pos
- 1], &stat_buf
) == 0
458 && S_ISFIFO (stat_buf
.st_mode
));
460 case 'L': /* Same as -h */
463 case 'h': /* File is a symbolic link? */
465 return (lstat (argv
[pos
- 1], &stat_buf
) == 0
466 && S_ISLNK (stat_buf
.st_mode
));
468 case 'u': /* File is setuid? */
470 return (stat (argv
[pos
- 1], &stat_buf
) == 0
471 && (stat_buf
.st_mode
& S_ISUID
));
473 case 'g': /* File is setgid? */
475 return (stat (argv
[pos
- 1], &stat_buf
) == 0
476 && (stat_buf
.st_mode
& S_ISGID
));
478 case 'k': /* File has sticky bit set? */
480 return (stat (argv
[pos
- 1], &stat_buf
) == 0
481 && (stat_buf
.st_mode
& S_ISVTX
));
483 case 't': /* File (fd) is a terminal? */
488 arg
= find_int (argv
[pos
- 1]);
490 fd
= strtol (arg
, NULL
, 10);
491 return (errno
!= ERANGE
&& 0 <= fd
&& fd
<= INT_MAX
&& isatty (fd
));
494 case 'n': /* True if arg has some length. */
496 return argv
[pos
- 1][0] != 0;
498 case 'z': /* True if arg has no length. */
500 return argv
[pos
- 1][0] == '\0';
517 if (! (pos
< argc
&& STREQ (argv
[pos
], "-a")))
536 if (! (pos
< argc
&& STREQ (argv
[pos
], "-o")))
552 return or (); /* Same with this. */
555 /* Return true if OP is one of the test command's unary operators. */
557 test_unop (char const *op
)
564 case 'a': case 'b': case 'c': case 'd': case 'e':
565 case 'f': case 'g': case 'h': case 'k': case 'n':
566 case 'o': case 'p': case 'r': case 's': case 't':
567 case 'u': case 'w': case 'x': case 'z':
568 case 'G': case 'L': case 'O': case 'S': case 'N':
578 return argv
[pos
++][0] != '\0';
586 if (STREQ (argv
[pos
], "!"))
589 value
= ! one_argument ();
591 else if (argv
[pos
][0] == '-'
592 && argv
[pos
][1] != '\0'
593 && argv
[pos
][2] == '\0')
595 if (test_unop (argv
[pos
]))
596 value
= unary_operator ();
598 test_syntax_error (_("%s: unary operator expected"), argv
[pos
]);
606 three_arguments (void)
610 if (binop (argv
[pos
+ 1]))
611 value
= binary_operator (false);
612 else if (STREQ (argv
[pos
], "!"))
615 value
= !two_arguments ();
617 else if (STREQ (argv
[pos
], "(") && STREQ (argv
[pos
+ 2], ")"))
620 value
= one_argument ();
623 else if (STREQ (argv
[pos
+ 1], "-a") || STREQ (argv
[pos
+ 1], "-o"))
626 test_syntax_error (_("%s: binary operator expected"), argv
[pos
+1]);
630 /* This is an implementation of a Posix.2 proposal by David Korn. */
632 posixtest (int nargs
)
639 value
= one_argument ();
643 value
= two_arguments ();
647 value
= three_arguments ();
651 if (STREQ (argv
[pos
], "!"))
654 value
= !three_arguments ();
657 if (STREQ (argv
[pos
], "(") && STREQ (argv
[pos
+ 3], ")"))
660 value
= two_arguments ();
675 #if defined TEST_STANDALONE
680 if (status
!= EXIT_SUCCESS
)
681 fprintf (stderr
, _("Try `%s --help' for more information.\n"),
686 Usage: test EXPRESSION\n\
688 or: [ EXPRESSION ]\n\
693 Exit with the status determined by EXPRESSION.\n\
696 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
697 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
700 An omitted EXPRESSION defaults to false. Otherwise,\n\
701 EXPRESSION is true or false and sets exit status. It is one of:\n\
705 ( EXPRESSION ) EXPRESSION is true\n\
706 ! EXPRESSION EXPRESSION is false\n\
707 EXPRESSION1 -a EXPRESSION2 both EXPRESSION1 and EXPRESSION2 are true\n\
708 EXPRESSION1 -o EXPRESSION2 either EXPRESSION1 or EXPRESSION2 is true\n\
712 -n STRING the length of STRING is nonzero\n\
713 STRING equivalent to -n STRING\n\
714 -z STRING the length of STRING is zero\n\
715 STRING1 = STRING2 the strings are equal\n\
716 STRING1 != STRING2 the strings are not equal\n\
720 INTEGER1 -eq INTEGER2 INTEGER1 is equal to INTEGER2\n\
721 INTEGER1 -ge INTEGER2 INTEGER1 is greater than or equal to INTEGER2\n\
722 INTEGER1 -gt INTEGER2 INTEGER1 is greater than INTEGER2\n\
723 INTEGER1 -le INTEGER2 INTEGER1 is less than or equal to INTEGER2\n\
724 INTEGER1 -lt INTEGER2 INTEGER1 is less than INTEGER2\n\
725 INTEGER1 -ne INTEGER2 INTEGER1 is not equal to INTEGER2\n\
729 FILE1 -ef FILE2 FILE1 and FILE2 have the same device and inode numbers\n\
730 FILE1 -nt FILE2 FILE1 is newer (modification date) than FILE2\n\
731 FILE1 -ot FILE2 FILE1 is older than FILE2\n\
735 -b FILE FILE exists and is block special\n\
736 -c FILE FILE exists and is character special\n\
737 -d FILE FILE exists and is a directory\n\
738 -e FILE FILE exists\n\
741 -f FILE FILE exists and is a regular file\n\
742 -g FILE FILE exists and is set-group-ID\n\
743 -G FILE FILE exists and is owned by the effective group ID\n\
744 -h FILE FILE exists and is a symbolic link (same as -L)\n\
745 -k FILE FILE exists and has its sticky bit set\n\
748 -L FILE FILE exists and is a symbolic link (same as -h)\n\
749 -O FILE FILE exists and is owned by the effective user ID\n\
750 -p FILE FILE exists and is a named pipe\n\
751 -r FILE FILE exists and read permission is granted\n\
752 -s FILE FILE exists and has a size greater than zero\n\
755 -S FILE FILE exists and is a socket\n\
756 -t FD file descriptor FD is opened on a terminal\n\
757 -u FILE FILE exists and its set-user-ID bit is set\n\
758 -w FILE FILE exists and write permission is granted\n\
759 -x FILE FILE exists and execute (or search) permission is granted\n\
763 Except for -h and -L, all FILE-related tests dereference symbolic links.\n\
764 Beware that parentheses need to be escaped (e.g., by backslashes) for shells.\n\
765 INTEGER may also be -l STRING, which evaluates to the length of STRING.\n\
769 NOTE: [ honors the --help and --version options, but test does not.\n\
770 test treats each of those as it treats any other nonempty STRING.\n\
772 printf (USAGE_BUILTIN_WARNING
, _("test and/or ["));
773 emit_bug_reporting_address ();
777 #endif /* TEST_STANDALONE */
779 #if !defined TEST_STANDALONE
780 # define main test_command
784 proper_name ("Kevin Braunsdorf"), \
785 proper_name ("Matthew Bradburn")
794 main (int margc
, char **margv
)
798 #if !defined TEST_STANDALONE
801 code
= setjmp (test_exit_buf
);
804 return (test_error_return
);
805 #else /* TEST_STANDALONE */
806 initialize_main (&margc
, &margv
);
807 set_program_name (margv
[0]);
808 setlocale (LC_ALL
, "");
809 bindtextdomain (PACKAGE
, LOCALEDIR
);
810 textdomain (PACKAGE
);
812 initialize_exit_failure (TEST_FAILURE
);
813 atexit (close_stdout
);
814 #endif /* TEST_STANDALONE */
820 /* Recognize --help or --version, but only when invoked in the
821 "[" form, when the last argument is not "]". Use direct
822 parsing, rather than parse_long_options, to avoid accepting
823 abbreviations. POSIX allows "[ --help" and "[ --version" to
824 have the usual GNU behavior, but it requires "test --help"
825 and "test --version" to exit silently with status 0. */
828 if (STREQ (margv
[1], "--help"))
829 usage (EXIT_SUCCESS
);
831 if (STREQ (margv
[1], "--version"))
833 version_etc (stdout
, PROGRAM_NAME
, PACKAGE_NAME
, Version
, AUTHORS
,
835 test_exit (EXIT_SUCCESS
);
838 if (margc
< 2 || !STREQ (margv
[margc
- 1], "]"))
839 test_syntax_error (_("missing `]'"), NULL
);
848 test_exit (TEST_FALSE
);
850 value
= posixtest (argc
- 1);
853 test_syntax_error (_("extra argument %s"), quote (argv
[pos
]));
855 test_exit (value
? TEST_TRUE
: TEST_FALSE
);