1 /* GNU test program (ksb and mjb) */
3 /* Modified to run with the GNU shell by bfox. */
5 /* Copyright (C) 1987-2023 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 <https://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"
49 #include "stat-time.h"
50 #include "strnumcmp.h"
56 # include <sys/param.h>
59 /* Exit status for syntax errors, etc. */
60 enum { TEST_TRUE
, TEST_FALSE
, TEST_FAILURE
};
62 #if defined TEST_STANDALONE
63 # define test_exit(val) exit (val)
64 # define test_main_return(val) return val
66 static jmp_buf test_exit_buf
;
67 static int test_error_return
= 0;
68 # define test_exit(val) test_error_return = val, longjmp (test_exit_buf, 1)
69 # define test_main_return(val) test_exit (val)
70 #endif /* !TEST_STANDALONE */
72 static int pos
; /* The offset of the current argument in ARGV. */
73 static int argc
; /* The number of arguments present in ARGV. */
74 static char **argv
; /* The argument list. */
76 static bool unary_operator (void);
77 static bool binary_operator (bool);
78 static bool two_arguments (void);
79 static bool three_arguments (void);
80 static bool posixtest (int);
82 static bool expr (void);
83 static bool term (void);
84 static bool and (void);
85 static bool or (void);
87 static void beyond (void);
89 ATTRIBUTE_FORMAT ((printf
, 1, 2))
91 test_syntax_error (char const *format
, ...)
94 va_start (ap
, format
);
95 verror (0, 0, format
, ap
);
96 test_exit (TEST_FAILURE
);
99 /* Increment our position in the argument list. Check that we're not
100 past the end of the argument list. This check is suppressed if the
101 argument is false. */
108 if (f
&& pos
>= argc
)
120 * beyond - call when we're beyond the end of the argument list (an
123 static _Noreturn
void
126 test_syntax_error (_("missing argument after %s"), quote (argv
[argc
- 1]));
129 /* If the characters pointed to by STRING constitute a valid number,
130 return a pointer to the start of the number, skipping any blanks or
131 leading '+'. Otherwise, report an error and exit. */
133 find_int (char const *string
)
136 char const *number_start
;
138 for (p
= string
; isblank (to_uchar (*p
)); p
++)
156 while (isblank (to_uchar (*p
)))
162 test_syntax_error (_("invalid integer %s"), quote (string
));
165 /* Find the modification time of FILE, and stuff it into *MTIME.
166 Return true if successful. */
168 get_mtime (char const *filename
, struct timespec
*mtime
)
171 bool ok
= (stat (filename
, &finfo
) == 0);
173 *mtime
= get_stat_mtime (&finfo
);
177 /* Return true if S is one of the test command's binary operators. */
179 binop (char const *s
)
181 return ((STREQ (s
, "=")) || (STREQ (s
, "!=")) || (STREQ (s
, "==")) ||
182 (STREQ (s
, "-nt")) ||
183 (STREQ (s
, "-ot")) || (STREQ (s
, "-ef")) || (STREQ (s
, "-eq")) ||
184 (STREQ (s
, "-ne")) || (STREQ (s
, "-lt")) || (STREQ (s
, "-le")) ||
185 (STREQ (s
, "-gt")) || (STREQ (s
, "-ge")));
189 * term - parse a term and return 1 or 0 depending on whether the term
190 * evaluates to true or false, respectively.
193 * '-'('h'|'d'|'f'|'r'|'s'|'w'|'c'|'b'|'p'|'u'|'g'|'k') filename
194 * '-'('L'|'x') filename
196 * '-'('z'|'n') string
198 * string ('!='|'=') string
199 * <int> '-'(eq|ne|le|lt|ge|gt) <int>
200 * file '-'(nt|ot|ef) file
204 * positive and negative integers
210 bool negated
= false;
212 /* Deal with leading 'not's. */
213 while (pos
< argc
&& argv
[pos
][0] == '!' && argv
[pos
][1] == '\0')
222 /* A paren-bracketed argument. */
223 if (argv
[pos
][0] == '(' && argv
[pos
][1] == '\0')
230 pos
+ nargs
< argc
&& ! STREQ (argv
[pos
+ nargs
], ")");
238 value
= posixtest (nargs
);
240 test_syntax_error (_("%s expected"), quote (")"));
242 if (argv
[pos
][0] != ')' || argv
[pos
][1])
243 test_syntax_error (_("%s expected, found %s"),
244 quote_n (0, ")"), quote_n (1, 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')
256 value
= unary_operator ();
259 value
= (argv
[pos
][0] != '\0');
263 return negated
^ value
;
267 binary_operator (bool l_is_l
)
270 struct stat stat_buf
, stat_spare
;
271 /* Is the right integer expression of the form '-l string'? */
278 if ((op
< argc
- 2) && STREQ (argv
[op
+ 1], "-l"))
286 if (argv
[op
][0] == '-')
288 /* check for eq, nt, and stuff */
289 if ((((argv
[op
][1] == 'l' || argv
[op
][1] == 'g')
290 && (argv
[op
][2] == 'e' || argv
[op
][2] == 't'))
291 || (argv
[op
][1] == 'e' && argv
[op
][2] == 'q')
292 || (argv
[op
][1] == 'n' && argv
[op
][2] == 'e'))
295 char lbuf
[INT_BUFSIZE_BOUND (uintmax_t)];
296 char rbuf
[INT_BUFSIZE_BOUND (uintmax_t)];
297 char const *l
= (l_is_l
298 ? umaxtostr (strlen (argv
[op
- 1]), lbuf
)
299 : find_int (argv
[op
- 1]));
300 char const *r
= (r_is_l
301 ? umaxtostr (strlen (argv
[op
+ 2]), rbuf
)
302 : find_int (argv
[op
+ 1]));
303 int cmp
= strintcmp (l
, r
);
304 bool xe_operator
= (argv
[op
][2] == 'e');
306 return (argv
[op
][1] == 'l' ? cmp
< xe_operator
307 : argv
[op
][1] == 'g' ? cmp
> - xe_operator
308 : (cmp
!= 0) == xe_operator
);
317 if (argv
[op
][2] == 't' && !argv
[op
][3])
319 /* nt - newer than */
320 struct timespec lt
, rt
;
323 if (l_is_l
|| r_is_l
)
324 test_syntax_error (_("-nt does not accept -l"));
325 le
= get_mtime (argv
[op
- 1], <
);
326 re
= get_mtime (argv
[op
+ 1], &rt
);
327 return le
&& (!re
|| timespec_cmp (lt
, rt
) > 0);
332 if (argv
[op
][2] == 'f' && !argv
[op
][3])
334 /* ef - hard link? */
336 if (l_is_l
|| r_is_l
)
337 test_syntax_error (_("-ef does not accept -l"));
338 return (stat (argv
[op
- 1], &stat_buf
) == 0
339 && stat (argv
[op
+ 1], &stat_spare
) == 0
340 && stat_buf
.st_dev
== stat_spare
.st_dev
341 && stat_buf
.st_ino
== stat_spare
.st_ino
);
346 if ('t' == argv
[op
][2] && '\000' == argv
[op
][3])
348 /* ot - older than */
349 struct timespec lt
, rt
;
352 if (l_is_l
|| r_is_l
)
353 test_syntax_error (_("-ot does not accept -l"));
354 le
= get_mtime (argv
[op
- 1], <
);
355 re
= get_mtime (argv
[op
+ 1], &rt
);
356 return re
&& (!le
|| timespec_cmp (lt
, rt
) < 0);
361 /* FIXME: is this dead code? */
362 test_syntax_error (_("%s: unknown binary operator"), quote (argv
[op
]));
365 if (argv
[op
][0] == '='
366 && (!argv
[op
][1] || ((argv
[op
][1] == '=') && !argv
[op
][2])))
368 bool value
= STREQ (argv
[pos
], argv
[pos
+ 2]);
373 if (STREQ (argv
[op
], "!="))
375 bool value
= !STREQ (argv
[pos
], argv
[pos
+ 2]);
385 unary_operator (void)
387 struct stat stat_buf
;
389 switch (argv
[pos
][1])
392 test_syntax_error (_("%s: unary operator expected"), quote (argv
[pos
]));
395 /* All of the following unary operators use unary_advance (), which
396 checks to make sure that there is an argument, and then advances
397 pos right past it. This means that pos - 1 is the location of the
400 case 'e': /* file exists in the file system? */
402 return stat (argv
[pos
- 1], &stat_buf
) == 0;
404 case 'r': /* file is readable? */
406 return euidaccess (argv
[pos
- 1], R_OK
) == 0;
408 case 'w': /* File is writable? */
410 return euidaccess (argv
[pos
- 1], W_OK
) == 0;
412 case 'x': /* File is executable? */
414 return euidaccess (argv
[pos
- 1], X_OK
) == 0;
416 case 'N': /* File exists and has been modified since it was last read? */
419 if (stat (argv
[pos
- 1], &stat_buf
) != 0)
421 struct timespec atime
= get_stat_atime (&stat_buf
);
422 struct timespec mtime
= get_stat_mtime (&stat_buf
);
423 return (timespec_cmp (mtime
, atime
) > 0);
426 case 'O': /* File is owned by you? */
429 if (stat (argv
[pos
- 1], &stat_buf
) != 0)
432 uid_t euid
= geteuid ();
434 return ! (euid
== NO_UID
&& errno
) && euid
== stat_buf
.st_uid
;
437 case 'G': /* File is owned by your group? */
440 if (stat (argv
[pos
- 1], &stat_buf
) != 0)
443 gid_t egid
= getegid ();
445 return ! (egid
== NO_GID
&& errno
) && egid
== stat_buf
.st_gid
;
448 case 'f': /* File is a file? */
450 /* Under POSIX, -f is true if the given file exists
451 and is a regular file. */
452 return (stat (argv
[pos
- 1], &stat_buf
) == 0
453 && S_ISREG (stat_buf
.st_mode
));
455 case 'd': /* File is a directory? */
457 return (stat (argv
[pos
- 1], &stat_buf
) == 0
458 && S_ISDIR (stat_buf
.st_mode
));
460 case 's': /* File has something in it? */
462 return (stat (argv
[pos
- 1], &stat_buf
) == 0
463 && 0 < stat_buf
.st_size
);
465 case 'S': /* File is a socket? */
467 return (stat (argv
[pos
- 1], &stat_buf
) == 0
468 && S_ISSOCK (stat_buf
.st_mode
));
470 case 'c': /* File is character special? */
472 return (stat (argv
[pos
- 1], &stat_buf
) == 0
473 && S_ISCHR (stat_buf
.st_mode
));
475 case 'b': /* File is block special? */
477 return (stat (argv
[pos
- 1], &stat_buf
) == 0
478 && S_ISBLK (stat_buf
.st_mode
));
480 case 'p': /* File is a named pipe? */
482 return (stat (argv
[pos
- 1], &stat_buf
) == 0
483 && S_ISFIFO (stat_buf
.st_mode
));
485 case 'L': /* Same as -h */
488 case 'h': /* File is a symbolic link? */
490 return (lstat (argv
[pos
- 1], &stat_buf
) == 0
491 && S_ISLNK (stat_buf
.st_mode
));
493 case 'u': /* File is setuid? */
495 return (stat (argv
[pos
- 1], &stat_buf
) == 0
496 && (stat_buf
.st_mode
& S_ISUID
));
498 case 'g': /* File is setgid? */
500 return (stat (argv
[pos
- 1], &stat_buf
) == 0
501 && (stat_buf
.st_mode
& S_ISGID
));
503 case 'k': /* File has sticky bit set? */
505 return (stat (argv
[pos
- 1], &stat_buf
) == 0
506 && (stat_buf
.st_mode
& S_ISVTX
));
508 case 't': /* File (fd) is a terminal? */
513 arg
= find_int (argv
[pos
- 1]);
515 fd
= strtol (arg
, nullptr, 10);
516 return (errno
!= ERANGE
&& 0 <= fd
&& fd
<= INT_MAX
&& isatty (fd
));
519 case 'n': /* True if arg has some length. */
521 return argv
[pos
- 1][0] != 0;
523 case 'z': /* True if arg has no length. */
525 return argv
[pos
- 1][0] == '\0';
542 if (! (pos
< argc
&& STREQ (argv
[pos
], "-a")))
561 if (! (pos
< argc
&& STREQ (argv
[pos
], "-o")))
577 return or (); /* Same with this. */
583 return argv
[pos
++][0] != '\0';
591 if (STREQ (argv
[pos
], "!"))
594 value
= ! one_argument ();
596 else if (argv
[pos
][0] == '-'
597 && argv
[pos
][1] != '\0'
598 && argv
[pos
][2] == '\0')
600 value
= unary_operator ();
608 three_arguments (void)
612 if (binop (argv
[pos
+ 1]))
613 value
= binary_operator (false);
614 else if (STREQ (argv
[pos
], "!"))
617 value
= !two_arguments ();
619 else if (STREQ (argv
[pos
], "(") && STREQ (argv
[pos
+ 2], ")"))
622 value
= one_argument ();
625 else if (STREQ (argv
[pos
+ 1], "-a") || STREQ (argv
[pos
+ 1], "-o"))
628 test_syntax_error (_("%s: binary operator expected"),
629 quote (argv
[pos
+ 1]));
633 /* This is an implementation of a Posix.2 proposal by David Korn. */
635 posixtest (int nargs
)
642 value
= one_argument ();
646 value
= two_arguments ();
650 value
= three_arguments ();
654 if (STREQ (argv
[pos
], "!"))
657 value
= !three_arguments ();
660 if (STREQ (argv
[pos
], "(") && STREQ (argv
[pos
+ 3], ")"))
663 value
= two_arguments ();
677 #if defined TEST_STANDALONE
682 if (status
!= EXIT_SUCCESS
)
687 Usage: test EXPRESSION\n\
689 or: [ EXPRESSION ]\n\
694 Exit with the status determined by EXPRESSION.\n\
697 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
698 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
701 An omitted EXPRESSION defaults to false. Otherwise,\n\
702 EXPRESSION is true or false and sets exit status. It is one of:\n\
706 ( EXPRESSION ) EXPRESSION is true\n\
707 ! EXPRESSION EXPRESSION is false\n\
708 EXPRESSION1 -a EXPRESSION2 both EXPRESSION1 and EXPRESSION2 are true\n\
709 EXPRESSION1 -o EXPRESSION2 either EXPRESSION1 or EXPRESSION2 is true\n\
713 -n STRING the length of STRING is nonzero\n\
714 STRING equivalent to -n STRING\n\
715 -z STRING the length of STRING is zero\n\
716 STRING1 = STRING2 the strings are equal\n\
717 STRING1 != STRING2 the strings are not equal\n\
721 INTEGER1 -eq INTEGER2 INTEGER1 is equal to INTEGER2\n\
722 INTEGER1 -ge INTEGER2 INTEGER1 is greater than or equal to INTEGER2\n\
723 INTEGER1 -gt INTEGER2 INTEGER1 is greater than INTEGER2\n\
724 INTEGER1 -le INTEGER2 INTEGER1 is less than or equal to INTEGER2\n\
725 INTEGER1 -lt INTEGER2 INTEGER1 is less than INTEGER2\n\
726 INTEGER1 -ne INTEGER2 INTEGER1 is not equal to INTEGER2\n\
730 FILE1 -ef FILE2 FILE1 and FILE2 have the same device and inode numbers\n\
731 FILE1 -nt FILE2 FILE1 is newer (modification date) than FILE2\n\
732 FILE1 -ot FILE2 FILE1 is older than FILE2\n\
736 -b FILE FILE exists and is block special\n\
737 -c FILE FILE exists and is character special\n\
738 -d FILE FILE exists and is a directory\n\
739 -e FILE FILE exists\n\
742 -f FILE FILE exists and is a regular file\n\
743 -g FILE FILE exists and is set-group-ID\n\
744 -G FILE FILE exists and is owned by the effective group ID\n\
745 -h FILE FILE exists and is a symbolic link (same as -L)\n\
746 -k FILE FILE exists and has its sticky bit set\n\
749 -L FILE FILE exists and is a symbolic link (same as -h)\n\
750 -N FILE FILE exists and has been modified since it was last read\n\
751 -O FILE FILE exists and is owned by the effective user ID\n\
752 -p FILE FILE exists and is a named pipe\n\
753 -r FILE FILE exists and the user has read access\n\
754 -s FILE FILE exists and has a size greater than zero\n\
757 -S FILE FILE exists and is a socket\n\
758 -t FD file descriptor FD is opened on a terminal\n\
759 -u FILE FILE exists and its set-user-ID bit is set\n\
760 -w FILE FILE exists and the user has write access\n\
761 -x FILE FILE exists and the user has execute (or search) access\n\
765 Except for -h and -L, all FILE-related tests dereference symbolic links.\n\
766 Beware that parentheses need to be escaped (e.g., by backslashes) for shells.\n\
767 INTEGER may also be -l STRING, which evaluates to the length of STRING.\n\
771 NOTE: Binary -a and -o are inherently ambiguous. Use 'test EXPR1 && test\n\
772 EXPR2' or 'test EXPR1 || test EXPR2' instead.\n\
776 NOTE: [ honors the --help and --version options, but test does not.\n\
777 test treats each of those as it treats any other nonempty STRING.\n\
779 printf (USAGE_BUILTIN_WARNING
, _("test and/or ["));
780 emit_ancillary_info (PROGRAM_NAME
);
784 #endif /* TEST_STANDALONE */
786 #if !defined TEST_STANDALONE
787 # define main test_command
791 proper_name ("Kevin Braunsdorf"), \
792 proper_name ("Matthew Bradburn")
801 main (int margc
, char **margv
)
805 #if !defined TEST_STANDALONE
808 code
= setjmp (test_exit_buf
);
811 return (test_error_return
);
812 #else /* TEST_STANDALONE */
813 initialize_main (&margc
, &margv
);
814 set_program_name (margv
[0]);
815 setlocale (LC_ALL
, "");
816 bindtextdomain (PACKAGE
, LOCALEDIR
);
817 textdomain (PACKAGE
);
819 initialize_exit_failure (TEST_FAILURE
);
820 atexit (close_stdout
);
821 #endif /* TEST_STANDALONE */
827 /* Recognize --help or --version, but only when invoked in the
828 "[" form, when the last argument is not "]". Use direct
829 parsing, rather than parse_long_options, to avoid accepting
830 abbreviations. POSIX allows "[ --help" and "[ --version" to
831 have the usual GNU behavior, but it requires "test --help"
832 and "test --version" to exit silently with status 0. */
835 if (STREQ (margv
[1], "--help"))
836 usage (EXIT_SUCCESS
);
838 if (STREQ (margv
[1], "--version"))
840 version_etc (stdout
, PROGRAM_NAME
, PACKAGE_NAME
, Version
, AUTHORS
,
842 test_main_return (EXIT_SUCCESS
);
845 if (margc
< 2 || !STREQ (margv
[margc
- 1], "]"))
846 test_syntax_error (_("missing %s"), quote ("]"));
855 test_main_return (TEST_FALSE
);
857 value
= posixtest (argc
- 1);
860 test_syntax_error (_("extra argument %s"), quote (argv
[pos
]));
862 test_main_return (value
? TEST_TRUE
: TEST_FALSE
);