3 This directory contains regression tests for make(1).
5 To invoke the tests install prove(1) from ports/devel/p5-Test-Harness and
6 run 'prove -r'. Alternatively one can use 'sh ./all.sh test' and scan the
9 ----------------------------------------------------------------------------
11 The rest of this file is intented for developers.
13 The tests are invoked via the test.sh script or prove(1) from p5-Test-Harness.
14 Tests are normally executed in a special test directory that is built under
15 /tmp. The reason for this is, that make tests are generally influenced by
16 all file in a directory, by files in one of make's obscure object directories
17 as well as in other directories make happens to look into. Therefor the
18 test scripts build a clean environment in the temp directory and the
19 tests are executed by cd-ing into that directory and invoking make. The
20 output of the make run (standard output, standard error and the exit status)
21 are written into files that are created in another directory. So the layout
22 for the shell/builtin test looks like:
24 ./shell/builtin/ - directory with test stuff
25 /tmp/make.${USER}/shell/builtin - actual test directory
26 /tmp/make.${USER}/shell/builtin.OUTPUT - output files
28 So a full test consists of the following steps:
30 setup - Set up the test environment by creating the test directory
31 and populating it with the needed files. If the test
32 directory already exists an error is printed.
34 run - Run the test and produce the output into the output
37 show - Show the result files on the screen.
39 compare - Compare the results in the output directory with those
40 in the test source directory. This just prints whether
41 the test was ok or not in the format used by prove(1).
43 diff - Diff the output files and the expected output files.
45 reset - Reset the test to its initial state.
47 clean - Remove both the test directory and the output directory.
49 Each of these steps can independently be invoked with the test script
50 contained in each directory. These test scripts are called test.t.
51 Additionally the scripts understand the following commands:
53 test - Run setup, run and compare.
55 prove - Run setup, run, compare and clean. This is identically
56 to invoking the script without an argument.
58 desc - Print a short test description.
60 update - Update the expected results from the actual results.
62 The test script has the following syntax:
64 % test.t [-v] [-m path_to_make_binary] command
66 To invoke it via prove(1) use:
68 % [MAKE_PROG=path_to_make_binary] prove [options] [files/directories]
71 % sh test.t -m `pwd`/../obj/make run
72 % MAKE_PROG=/usr/obj/usr/src/usr.bin/make/make prove -r
74 The test scripts use the following environment variables that can be set
75 by the user in the test script's environment:
78 - Base directory for working files. If not set
79 /tmp/make.${USER} is used.
82 - Path to the make program to test. If not set
83 /usr/bin/make is used.
85 The following variables are available to test scripts:
88 - test source base directory. This is determined by
89 repeatedly doing cd .. and checking for common.sh.
90 Therefor this can fail if a test source directory is
91 actually a symbolic link and is physically not located
92 below the directory containing common.sh.
95 - subdirectory below WORK_BASE and SRC_BASE for current test
98 - ${WORK_BASE}/${SUBDIR}
101 - ${SRC_BASE}/${SUBDIR}
103 The following variables and functions may be defined by the test script.
104 This also lists special filenames.
107 A one-line description of the test.
110 A list of pairs of directory names and modes. These
111 directories are created during setup and reset. When
112 the directory already exists (during reset) only the
113 mode change is applied.
115 TEST_MAKE_DIRS="subdir 775 subdir/sub 555"
118 A list of pairs of file names and modes. These files
119 are copied from the source to the working directory
120 during setup and reset. When the file already exists
121 (during reset) only the mode change is applied. Files
122 may be copied from/to sub-directories. The sub-directory
123 in the working directory must already exists (see
126 TEST_COPY_FILES="libtest.a 444 subdir/libfoo.a 444"
129 List of pairs of file names and arguments to touch(1).
130 During setup and reset for each list element touch(1)
133 TEST_TOUCH="file1 '-t 200501011257'"
136 List of pairs of filenames. Each pair is passed to ln(1).
137 All names are prefixed with the working directory.
140 If a file with this name exists in the source directory
141 it is automatically copied to the working directory.
144 If this function exists it is executed at the end of the
148 If this function exists it is executed at the end of the
152 A list of file to be deleted when resetting.
155 Number of tests in this script. If not set this is assumed
159 Arguments to make for test number <number>. If not set
160 the default argument of test<number> is used. To run a test
161 without argument to make, set TEST_<number> to the empty string.
164 To skip a test (for whatever reason) this should be set
165 to a string explaining the reason for skipping the test.
168 For a test that should fail this is a short string describing
169 what the problem in make(1) is that should be fixed.
172 Function to run a test. This function gets a single argument
173 which is the number of the test to executed. The default
174 function evaluates the variable TEST_<number> and calls
175 make with the arguments in this variable.