Commit | Line | Data |
---|---|---|
1be6b49c | 1 | #!../libguile/guile \ |
000ee07f JB |
2 | -e main -s |
3 | !# | |
4 | ||
5 | ;;;; guile-test --- run the Guile test suite | |
6 | ;;;; Jim Blandy <jimb@red-bean.com> --- May 1999 | |
7 | ;;;; | |
6e7d5622 | 8 | ;;;; Copyright (C) 1999, 2001, 2006 Free Software Foundation, Inc. |
068a9d87 | 9 | ;;;; |
53befeb7 NJ |
10 | ;;;; This program is free software; you can redistribute it and/or |
11 | ;;;; modify it under the terms of the GNU Lesser General Public | |
12 | ;;;; License as published by the Free Software Foundation; either | |
13 | ;;;; version 3, or (at your option) any later version. | |
068a9d87 | 14 | ;;;; |
000ee07f JB |
15 | ;;;; This program is distributed in the hope that it will be useful, |
16 | ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
53befeb7 | 18 | ;;;; GNU Lesser General Public License for more details. |
068a9d87 | 19 | ;;;; |
53befeb7 NJ |
20 | ;;;; You should have received a copy of the GNU Lesser General Public |
21 | ;;;; License along with this software; see the file COPYING.LESSER. | |
22 | ;;;; If not, write to the Free Software Foundation, Inc., 51 Franklin | |
23 | ;;;; Street, Fifth Floor, Boston, MA 02110-1301 USA | |
000ee07f JB |
24 | |
25 | ||
1ff7abbe | 26 | ;;;; Usage: [guile -e main -s] guile-test [OPTIONS] [TEST ...] |
000ee07f JB |
27 | ;;;; |
28 | ;;;; Run tests from the Guile test suite. Report failures and | |
29 | ;;;; unexpected passes to the standard output, along with a summary of | |
30 | ;;;; all the results. Record each reported test outcome in the log | |
1ff7abbe DH |
31 | ;;;; file, `guile.log'. The exit status is #f if any of the tests |
32 | ;;;; fail or pass unexpectedly. | |
000ee07f JB |
33 | ;;;; |
34 | ;;;; Normally, guile-test scans the test directory, and executes all | |
35 | ;;;; files whose names end in `.test'. (It assumes they contain | |
36 | ;;;; Scheme code.) However, you can have it execute specific tests by | |
37 | ;;;; listing their filenames on the command line. | |
38 | ;;;; | |
068a9d87 | 39 | ;;;; The option `--test-suite' can be given to specify the test |
1ff7abbe DH |
40 | ;;;; directory. If no such option is given, the test directory is |
41 | ;;;; taken from the environment variable TEST_SUITE_DIR (if defined), | |
068a9d87 | 42 | ;;;; otherwise a default directory that is hardcoded in this file is |
1ff7abbe DH |
43 | ;;;; used (see "Installation" below). |
44 | ;;;; | |
000ee07f JB |
45 | ;;;; If present, the `--log-file LOG' option tells `guile-test' to put |
46 | ;;;; the log output in a file named LOG. | |
47 | ;;;; | |
068a9d87 TTN |
48 | ;;;; If present, the `--debug' option will enable a debugging mode. |
49 | ;;;; | |
50 | ;;;; If present, the `--flag-unresolved' option will cause guile-test | |
51 | ;;;; to exit with failure status if any tests are UNRESOLVED. | |
1ff7abbe DH |
52 | ;;;; |
53 | ;;;; | |
000ee07f JB |
54 | ;;;; Installation: |
55 | ;;;; | |
1ff7abbe DH |
56 | ;;;; If you change the #! line at the top of this script to point at |
57 | ;;;; the Guile interpreter you want to test, you can call this script | |
58 | ;;;; as an executable instead of having to pass it as a parameter to | |
59 | ;;;; guile via "guile -e main -s guile-test". Further, you can edit | |
60 | ;;;; the definition of default-test-suite to point to the parent | |
61 | ;;;; directory of the `tests' tree, which makes it unnecessary to set | |
62 | ;;;; the environment variable `TEST_SUITE_DIR'. | |
63 | ;;;; | |
000ee07f JB |
64 | ;;;; |
65 | ;;;; Shortcomings: | |
66 | ;;;; | |
67 | ;;;; At the moment, due to a simple-minded implementation, test files | |
68 | ;;;; must live in the test directory, and you must specify their names | |
69 | ;;;; relative to the top of the test directory. If you want to send | |
1ff7abbe | 70 | ;;;; me a patch that fixes this, but still leaves sane test names in |
000ee07f JB |
71 | ;;;; the log file, that would be great. At the moment, all the tests |
72 | ;;;; I care about are in the test directory, though. | |
73 | ;;;; | |
74 | ;;;; It would be nice if you could specify the Guile interpreter you | |
75 | ;;;; want to test on the command line. As it stands, if you want to | |
76 | ;;;; change which Guile interpreter you're testing, you need to edit | |
77 | ;;;; the #! line at the top of this file, which is stupid. | |
78 | ||
8aa28a91 DH |
79 | (define (main . args) |
80 | (let ((module (resolve-module '(test-suite guile-test)))) | |
81 | (apply (module-ref module 'main) args))) | |
82 | ||
83 | (define-module (test-suite guile-test) | |
84 | :use-module (test-suite lib) | |
85 | :use-module (ice-9 getopt-long) | |
86 | :use-module (ice-9 and-let-star) | |
87 | :use-module (ice-9 rdelim) | |
88 | :export (main data-file-name test-file-name)) | |
89 | ||
1ff7abbe DH |
90 | \f |
91 | ;;; User configurable settings: | |
92 | (define default-test-suite | |
66301f9a | 93 | (string-append (getenv "HOME") "/bogus-path/test-suite")) |
1ff7abbe DH |
94 | |
95 | \f | |
efb07c89 DH |
96 | ;;; Variables that will receive their actual values later. |
97 | (define test-suite default-test-suite) | |
98 | ||
66301f9a GH |
99 | (define tmp-dir #f) |
100 | ||
efb07c89 | 101 | \f |
000ee07f JB |
102 | ;;; General utilities, that probably should be in a library somewhere. |
103 | ||
1ff7abbe DH |
104 | ;;; Enable debugging |
105 | (define (enable-debug-mode) | |
106 | (write-line %load-path) | |
107 | (set! %load-verbosely #t) | |
108 | (debug-enable 'backtrace 'debug)) | |
109 | ||
000ee07f JB |
110 | ;;; Traverse the directory tree at ROOT, applying F to the name of |
111 | ;;; each file in the tree, including ROOT itself. For a subdirectory | |
112 | ;;; SUB, if (F SUB) is true, we recurse into SUB. Do not follow | |
113 | ;;; symlinks. | |
114 | (define (for-each-file f root) | |
115 | ||
068a9d87 | 116 | ;; A "hard directory" is a path that denotes a directory and is not a |
000ee07f JB |
117 | ;; symlink. |
118 | (define (file-is-hard-directory? filename) | |
119 | (eq? (stat:type (lstat filename)) 'directory)) | |
120 | ||
121 | (let visit ((root root)) | |
122 | (let ((should-recur (f root))) | |
123 | (if (and should-recur (file-is-hard-directory? root)) | |
124 | (let ((dir (opendir root))) | |
125 | (let loop () | |
126 | (let ((entry (readdir dir))) | |
068a9d87 | 127 | (cond |
000ee07f JB |
128 | ((eof-object? entry) #f) |
129 | ((or (string=? entry ".") | |
1febd88c TTN |
130 | (string=? entry "..") |
131 | (string=? entry "CVS") | |
132 | (string=? entry "RCS")) | |
000ee07f JB |
133 | (loop)) |
134 | (else | |
135 | (visit (string-append root "/" entry)) | |
136 | (loop)))))))))) | |
137 | ||
000ee07f JB |
138 | \f |
139 | ;;; The test driver. | |
140 | ||
efb07c89 | 141 | \f |
66301f9a | 142 | ;;; Localizing test files and temporary data files. |
efb07c89 DH |
143 | |
144 | (define (data-file-name filename) | |
66301f9a | 145 | (in-vicinity tmp-dir filename)) |
efb07c89 DH |
146 | |
147 | (define (test-file-name test) | |
148 | (in-vicinity test-suite test)) | |
000ee07f JB |
149 | |
150 | ;;; Return a list of all the test files in the test tree. | |
1ff7abbe | 151 | (define (enumerate-tests test-dir) |
1ff7abbe | 152 | (let ((root-len (+ 1 (string-length test-dir))) |
000ee07f JB |
153 | (tests '())) |
154 | (for-each-file (lambda (file) | |
155 | (if (has-suffix? file ".test") | |
156 | (let ((short-name | |
157 | (substring file root-len))) | |
158 | (set! tests (cons short-name tests)))) | |
159 | #t) | |
1ff7abbe | 160 | test-dir) |
000ee07f JB |
161 | |
162 | ;; for-each-file presents the files in whatever order it finds | |
163 | ;; them in the directory. We sort them here, so they'll always | |
164 | ;; appear in the same order. This makes it easier to compare test | |
165 | ;; log files mechanically. | |
166 | (sort tests string<?))) | |
167 | ||
168 | (define (main args) | |
169 | (let ((options (getopt-long args | |
068a9d87 | 170 | `((test-suite |
1ff7abbe DH |
171 | (single-char #\t) |
172 | (value #t)) | |
068a9d87 TTN |
173 | (flag-unresolved |
174 | (single-char #\u)) | |
175 | (log-file | |
1ff7abbe DH |
176 | (single-char #\l) |
177 | (value #t)) | |
068a9d87 | 178 | (debug |
1ff7abbe | 179 | (single-char #\d)))))) |
000ee07f JB |
180 | (define (opt tag default) |
181 | (let ((pair (assq tag options))) | |
182 | (if pair (cdr pair) default))) | |
1ff7abbe DH |
183 | |
184 | (if (opt 'debug #f) | |
185 | (enable-debug-mode)) | |
186 | ||
efb07c89 DH |
187 | (set! test-suite |
188 | (or (opt 'test-suite #f) | |
189 | (getenv "TEST_SUITE_DIR") | |
190 | default-test-suite)) | |
191 | ||
66301f9a GH |
192 | ;; directory where temporary files are created. |
193 | ;; when run from "make check", this must be under the build-dir, | |
194 | ;; not the src-dir. | |
195 | (set! tmp-dir (getcwd)) | |
196 | ||
efb07c89 | 197 | (let* ((tests |
1ff7abbe | 198 | (let ((foo (opt '() '()))) |
068a9d87 | 199 | (if (null? foo) |
1ff7abbe DH |
200 | (enumerate-tests test-suite) |
201 | foo))) | |
068a9d87 | 202 | (log-file |
1ff7abbe | 203 | (opt 'log-file "guile.log"))) |
000ee07f JB |
204 | |
205 | ;; Open the log file. | |
206 | (let ((log-port (open-output-file log-file))) | |
207 | ||
208 | ;; Register some reporters. | |
1ff7abbe DH |
209 | (let ((global-pass #t) |
210 | (counter (make-count-reporter))) | |
000ee07f JB |
211 | (register-reporter (car counter)) |
212 | (register-reporter (make-log-reporter log-port)) | |
213 | (register-reporter user-reporter) | |
1ff7abbe DH |
214 | (register-reporter (lambda results |
215 | (case (car results) | |
068a9d87 TTN |
216 | ((unresolved) |
217 | (and (opt 'flag-unresolved #f) | |
218 | (set! global-pass #f))) | |
219 | ((fail upass error) | |
1ff7abbe | 220 | (set! global-pass #f))))) |
000ee07f JB |
221 | |
222 | ;; Run the tests. | |
223 | (for-each (lambda (test) | |
ddb9c4ca | 224 | (display (string-append "Running " test "\n")) |
000ee07f | 225 | (with-test-prefix test |
efb07c89 | 226 | (load (test-file-name test)))) |
000ee07f JB |
227 | tests) |
228 | ||
229 | ;; Display the final counts, both to the user and in the log | |
230 | ;; file. | |
231 | (let ((counts ((cadr counter)))) | |
232 | (print-counts counts) | |
233 | (print-counts counts log-port)) | |
234 | ||
1ff7abbe DH |
235 | (close-port log-port) |
236 | (quit global-pass)))))) | |
000ee07f JB |
237 | |
238 | \f | |
239 | ;;; Local Variables: | |
240 | ;;; mode: scheme | |
241 | ;;; End: |