1 ;;;; tests related to Lisp streams
3 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; While most of SBCL is derived from the CMU CL system, the test
7 ;;;; files (like this one) were written from scratch after the fork
10 ;;;; This software is in the public domain and is provided with
11 ;;;; absolutely no warranty. See the COPYING and CREDITS files for
12 ;;;; more information.
14 (load "assertoid.lisp")
15 (use-package "ASSERTOID")
17 ;;; type errors for inappropriate stream arguments, fixed in
20 (declare (optimize (safety 3)))
21 (assert (raises-error?
(make-two-way-stream (make-string-output-stream)
22 (make-string-output-stream))
24 (assert (raises-error?
(make-two-way-stream (make-string-input-stream "foo")
25 (make-string-input-stream "bar"))
27 ;; the following two aren't actually guaranteed, because ANSI, as it
28 ;; happens, doesn't say "should signal an error" for
29 ;; MAKE-ECHO-STREAM. It's still good to have, but if future
30 ;; maintenance work causes this test to fail because of these
31 ;; MAKE-ECHO-STREAM clauses, consider simply removing these clauses
32 ;; from the test. -- CSR, 2002-10-06
33 (assert (raises-error?
(make-echo-stream (make-string-output-stream)
34 (make-string-output-stream))
36 (assert (raises-error?
(make-echo-stream (make-string-input-stream "foo")
37 (make-string-input-stream "bar"))
39 (assert (raises-error?
(make-concatenated-stream
40 (make-string-output-stream)
41 (make-string-input-stream "foo"))
44 ;;; bug 225: STRING-STREAM was not a class
45 (eval `(defgeneric bug225
(s)
46 ,@(mapcar (lambda (class)
47 `(:method
:around
((s ,class
)) (cons ',class
(call-next-method))))
48 '(stream string-stream sb-impl
::string-input-stream
49 sb-impl
::string-output-stream
))
50 (:method
(class) nil
)))
52 (assert (equal (bug225 (make-string-input-stream "hello"))
53 '(sb-impl::string-input-stream string-stream stream
)))
54 (assert (equal (bug225 (make-string-output-stream))
55 '(sb-impl::string-output-stream string-stream stream
)))
58 ;;; improper buffering on (SIGNED-BYTE 8) streams (fixed by David Lichteblau):
59 (let ((p "signed-byte-8-test.data"))
62 :element-type
'(unsigned-byte 8)
63 :if-exists
:supersede
)
65 (with-open-file (s p
:element-type
'(signed-byte 8))
66 (assert (= (read-byte s
) -
1)))
69 ;;; :IF-EXISTS got :ERROR and NIL the wrong way round (reported by
71 (let* ((p "this-file-will-exist")
72 (stream (open p
:direction
:output
:if-exists
:error
)))
73 (assert (null (with-open-file (s p
:direction
:output
:if-exists nil
) s
)))
74 (assert (raises-error?
75 (with-open-file (s p
:direction
:output
:if-exists
:error
))))
79 (assert (raises-error?
(read-byte (make-string-input-stream "abc"))
81 (assert (raises-error?
(with-open-file (s "/dev/zero")
84 ;;; bidirectional streams getting confused about their position
85 (let ((p "bidirectional-stream-test"))
86 (with-open-file (s p
:direction
:output
:if-exists
:supersede
)
87 (with-standard-io-syntax
88 (format s
"~S ~S ~S~%" 'these
'are
'symbols
)))
89 (with-open-file (s p
:direction
:io
:if-exists
:overwrite
)
91 (with-standard-io-syntax
94 (let ((line (read-line s
))
95 (want "THESE INSERTMBOLS"))
96 (unless (equal line want
)
97 (error "wanted ~S, got ~S" want line
))))
100 ;;; :DIRECTION :IO didn't work on non-existent pathnames
101 (let ((p "direction-io-test"))
102 (ignore-errors (delete-file p
))
103 (with-open-file (s p
:direction
:io
)
106 (file-position s
:start
)
107 (assert (char= (read-char s
) #\
1)))
110 ;;; FILE-POSITION on broadcast-streams is mostly uncontroversial
111 (assert (= 0 (file-position (make-broadcast-stream))))
112 (assert (file-position (make-broadcast-stream) :start
))
113 (assert (file-position (make-broadcast-stream) 0))
114 (assert (not (file-position (make-broadcast-stream) 1)))
115 (let ((s (make-broadcast-stream)))
117 (assert (not (file-position s
1)))
118 (assert (= 0 (file-position s
))))
120 (let ((p "broadcast-stream-test"))
121 (ignore-errors (delete-file p
))
122 (with-open-file (f p
:direction
:output
)
123 (let ((s (make-broadcast-stream f
)))
124 (assert (= 0 (file-position s
)))
125 (assert (file-position s
:start
))
126 (assert (file-position s
0))
128 (assert (= 1 (file-position s
))) ; unicode...
129 (assert (file-position s
0))))
132 ;;; CLOSING a non-new streams should not delete them, and superseded
133 ;;; files should be restored.
134 (let ((test "test-file-for-close-should-not-delete"))
135 (macrolet ((test-mode (mode)
137 (catch :close-test-exit
138 (with-open-file (f test
:direction
:output
:if-exists
,mode
)
139 (write-line "test" f
)
140 (throw :close-test-exit t
)))
141 (assert (and (probe-file test
) ,mode
)))))
144 (with-open-file (f test
:direction
:output
)
145 (write-line "test" f
))
147 (test-mode :overwrite
)
148 ;; FIXME: We really should recover supersede files as well, according to
149 ;; CLOSE in CLHS, but at the moment we don't.
150 ;; (test-mode :supersede)
152 (test-mode :rename-and-delete
))
153 (when (probe-file test
)
154 (delete-file test
)))))
156 ;;; test for read-write invariance of signed bytes, from Bruno Haible
157 ;;; cmucl-imp 2004-09-06
158 (defun bin-stream-test (&key
(size (integer-length most-positive-fixnum
))
159 (type 'unsigned-byte
) (file-name "stream-impure.tmp")
161 (bytes (if (eq type
'signed-byte
)
162 (loop :repeat num-bytes
:collect
163 (- (random (ash 1 size
))
165 (loop :repeat num-bytes
:collect
166 (random (ash 1 size
))))))
167 (with-open-file (foo file-name
:direction
:output
:if-exists
:supersede
168 :element-type
(list type size
))
170 (write-byte byte foo
)))
172 (with-open-file (foo file-name
:direction
:input
173 :element-type
(list type size
))
174 (list (stream-element-type foo
) (file-length foo
) bytes
175 (loop :for byte
:in bytes
:for nb
= (read-byte foo
) :collect nb
176 :unless
(= nb byte
) :do
177 (flet ((by-out (sz by
)
178 (format nil
"~v,'0,' ,4:b"
179 (+ sz
(floor sz
4)) by
)))
180 (error "~& * [(~s ~s)] ~a != ~a~%" type size
181 (by-out size byte
) (by-out size nb
))))))
182 (delete-file file-name
)))
183 (loop for size from
2 to
40 do
(bin-stream-test :size size
:type
'signed-byte
))
185 ;;; Check READ-SEQUENCE signals a TYPE-ERROR when the sequence can't
186 ;;; contain a stream element.
188 ;;; These tests check READ-SEQUENCE correctness, not whether the fast
189 ;;; or slow paths are being taken for each element type. To check the
190 ;;; fast or slow paths, trace ANSI-STREAM-READ-BYTE (slow path) and/or
193 ;;; (trace sb-impl::ansi-stream-read-byte sb-impl::read-n-bytes)
195 ;;; The order should be ANSI-STREAM-READ-BYTE, READ-N-BYTES,
196 ;;; READ-N-BYTES, ANSI-STREAM-READ-BYTE, ANSI-STREAM-READ-BYTE.
198 (let ((pathname "read-sequence.data"))
200 ;; Create the binary data.
201 (with-open-file (stream pathname
203 :if-exists
:supersede
204 :element-type
'(unsigned-byte 8))
205 (write-byte 255 stream
))
207 ;; Check the slow path for generic vectors.
208 (let ((sequence (make-array 1)))
209 (with-open-file (stream pathname
211 :element-type
'(unsigned-byte 8))
212 (read-sequence sequence stream
)
213 (assert (equalp sequence
#(255)))))
215 (let ((sequence (make-array 1)))
216 (with-open-file (stream pathname
218 :external-format
:latin-1
219 :element-type
'character
)
220 (read-sequence sequence stream
)
221 (assert (equalp sequence
#(#.
(code-char 255))))))
223 ;; Check the fast path works for (UNSIGNED-BYTE 8) and (SIGNED-BYTE
225 (let ((sequence (make-array 1 :element-type
'(unsigned-byte 8))))
226 (with-open-file (stream pathname
228 :element-type
'(unsigned-byte 8))
229 (read-sequence sequence stream
)
230 (assert (equalp sequence
#(255)))))
232 (let ((sequence (make-array 1 :element-type
'(signed-byte 8))))
233 (with-open-file (stream pathname
235 :element-type
'(signed-byte 8))
236 (read-sequence sequence stream
)
237 (assert (equalp sequence
#(-1)))))
239 ;; A bivalent stream can be read to a unsigned-byte vector, a
240 ;; string, or a generic vector
242 (let ((sequence (make-array 1 :element-type
'(unsigned-byte 8))))
243 (with-open-file (stream pathname
245 :element-type
:default
)
246 (read-sequence sequence stream
)
247 (assert (equalp sequence
#(255)))))
249 (let ((sequence (make-array 1 :element-type
'character
)))
250 (with-open-file (stream pathname
252 :external-format
:latin-1
253 :element-type
:default
)
254 (read-sequence sequence stream
)
255 (assert (equalp sequence
#(#.
(code-char 255))))))
257 (let ((sequence (make-array 1)))
258 (with-open-file (stream pathname
260 :external-format
:latin-1
261 :element-type
:default
)
262 (read-sequence sequence stream
)
263 (assert (equalp sequence
#(#.
(code-char 255))))))
265 ;; Check that a TYPE-ERROR is signalled for incompatible (sequence,
268 (let ((sequence (make-array 1 :element-type
'(signed-byte 8))))
269 (with-open-file (stream pathname
271 :element-type
'(unsigned-byte 8))
273 (read-sequence sequence stream
)
274 (error "READ-SEQUENCE didn't signal an error"))
275 (type-error (condition)
276 (assert (= (type-error-datum condition
) 255))
277 (assert (subtypep (type-error-expected-type condition
)
278 '(signed-byte 8)))))))
280 (let ((sequence (make-array 1 :element-type
'(unsigned-byte 8))))
281 (with-open-file (stream pathname
283 :element-type
'(signed-byte 8))
285 (read-sequence sequence stream
)
286 (error "READ-SEQUENCE didn't signal an error"))
287 (type-error (condition)
288 (assert (= (type-error-datum condition
) -
1))
289 (assert (subtypep (type-error-expected-type condition
)
290 '(unsigned-byte 8)))))))
292 ;; Can't read a signed-byte from a bivalent stream
294 (let ((sequence (make-array 1 :element-type
'(signed-byte 8))))
295 (with-open-file (stream pathname
297 :external-format
:latin1
298 :element-type
:default
)
300 (read-sequence sequence stream
)
301 (error "READ-SEQUENCE didn't signal an error"))
302 (type-error (condition)
303 (assert (eql (type-error-datum condition
) (code-char 255)))
304 (assert (subtypep (type-error-expected-type condition
)
305 '(signed-byte 8)))))))
306 (delete-file pathname
))
308 ;;; Check WRITE-SEQUENCE signals a TYPE-ERROR when the stream can't
309 ;;; write a sequence element.
311 ;;; These tests check WRITE-SEQUENCE correctness, not whether the fast
312 ;;; or slow paths are being taken for each element type. See the
313 ;;; READ-SEQUENCE tests above for more information.
315 ;;; (trace sb-impl::output-unsigned-byte-full-buffered sb-impl::output-signed-byte-full-buffered sb-impl::output-raw-bytes)
317 (let ((pathname "write-sequence.data")
318 (generic-sequence (make-array 1 :initial-contents
'(255)))
319 (generic-character-sequence (make-array 1 :initial-element
#\a))
320 (generic-mixed-sequence (make-array 2 :initial-element
#\a))
321 (string (make-array 1 :element-type
'character
322 :initial-element
(code-char 255)))
323 (unsigned-sequence (make-array 1
324 :element-type
'(unsigned-byte 8)
325 :initial-contents
'(255)))
326 (signed-sequence (make-array 1
327 :element-type
'(signed-byte 8)
328 :initial-contents
'(-1))))
330 (setf (aref generic-mixed-sequence
1) 255)
332 ;; Check the slow path for generic vectors.
333 (with-open-file (stream pathname
335 :if-exists
:supersede
336 :element-type
'(unsigned-byte 8))
337 (write-sequence generic-sequence stream
))
339 (with-open-file (stream pathname
341 :if-exists
:supersede
342 :element-type
'character
)
343 (write-sequence generic-character-sequence stream
))
345 ;; Check the fast path for unsigned and signed vectors.
346 (with-open-file (stream pathname
348 :if-exists
:supersede
349 :element-type
'(unsigned-byte 8))
350 (write-sequence unsigned-sequence stream
))
352 (with-open-file (stream pathname
354 :if-exists
:supersede
355 :element-type
'(signed-byte 8))
356 (write-sequence signed-sequence stream
))
358 ;; Bivalent streams on unsigned-byte vectors, strings, and a simple
359 ;; vector with mixed characters and bytes
361 (with-open-file (stream pathname
363 :if-exists
:supersede
364 :element-type
:default
)
365 (write-sequence unsigned-sequence stream
))
367 (with-open-file (stream pathname
369 :external-format
:latin-1
370 :if-exists
:supersede
371 :element-type
:default
)
372 (write-sequence string stream
))
374 (with-open-file (stream pathname
376 :external-format
:latin-1
377 :if-exists
:supersede
378 :element-type
:default
)
379 (write-sequence generic-mixed-sequence stream
))
381 ;; Check a TYPE-ERROR is signalled for unsigned and signed vectors
382 ;; which are incompatible with the stream element type.
383 (with-open-file (stream pathname
385 :if-exists
:supersede
386 :element-type
'(signed-byte 8))
388 (write-sequence unsigned-sequence stream
)
389 (error "WRITE-SEQUENCE didn't signal an error"))
390 (type-error (condition)
391 (assert (= (type-error-datum condition
) 255))
392 (assert (subtypep (type-error-expected-type condition
)
393 '(signed-byte 8))))))
395 (with-open-file (stream pathname
397 :if-exists
:supersede
398 :element-type
'(unsigned-byte 8))
400 (write-sequence signed-sequence stream
)
401 (error "WRITE-SEQUENCE didn't signal an error"))
402 (type-error (condition)
403 (assert (= (type-error-datum condition
) -
1))
404 (assert (subtypep (type-error-expected-type condition
)
405 '(unsigned-byte 8))))))
407 (with-open-file (stream pathname
409 :if-exists
:supersede
410 :element-type
:default
)
412 (write-sequence signed-sequence stream
)
413 (error "WRITE-SEQUENCE didn't signal an error"))
414 (type-error (condition)
415 (assert (= (type-error-datum condition
) -
1))
416 (assert (subtypep (type-error-expected-type condition
)
417 '(unsigned-byte 8))))))
419 (delete-file pathname
))
421 ;;; writing looong lines. takes way too long and way too much space
422 ;;; to test on 64 bit platforms
423 #-
#.
(cl:if
(cl:= sb-vm
:n-word-bits
64) '(and) '(or))
424 (let ((test "long-lines-write-test.tmp"))
426 (with-open-file (f test
428 :external-format
:ascii
429 :element-type
'character
430 :if-does-not-exist
:create
431 :if-exists
:supersede
)
432 (let* ((n (truncate most-positive-fixnum
16))
435 (buffer (make-string n
)))
439 (write-sequence buffer f
))
440 (assert (= p
(sb-impl::fd-stream-char-pos f
)))
442 (assert (= (+ 1 p
) (sb-impl::fd-stream-char-pos f
)))
443 (assert (typep p
'bignum
))))
444 (when (probe-file test
)
445 (delete-file test
))))
447 ;;; read-sequence misreported the amount read and lost position
448 (let ((string (make-array (* 3 sb-impl
::+ansi-stream-in-buffer-length
+)
449 :element-type
'character
)))
450 (dotimes (i (length string
))
451 (setf (char string i
) (code-char (mod i char-code-limit
))))
452 (with-open-file (f "read-sequence-character-test-data.tmp"
453 :if-exists
:supersede
455 :external-format
:utf-8
)
456 (write-sequence string f
))
458 (with-open-file (f "read-sequence-character-test-data.tmp"
459 :if-does-not-exist
:error
461 :external-format
:utf-8
)
462 (let ((buffer (make-array 128 :element-type
'character
))
464 (with-output-to-string (datum)
465 (loop for n-read
= (read-sequence buffer f
)
466 do
(write-sequence buffer datum
:start
0 :end n-read
)
467 (assert (<= (incf total n-read
) (length string
)))
468 while
(and (= n-read
128))))))))
469 (assert (equal copy string
)))
470 (delete-file "read-sequence-character-test-data.tmp"))
472 ;;; ANSI-STREAM-OUTPUT-STREAM-P used to assume that a SYNONYM-STREAM's
473 ;;; target was an ANSI stream, but it could be a user-defined stream,
474 ;;; e.g., a SLIME stream.
475 (defclass user-output-stream
(fundamental-output-stream)
478 (let ((*stream
* (make-instance 'user-output-stream
)))
479 (declare (special *stream
*))
480 (with-open-stream (stream (make-synonym-stream '*stream
*))
481 (assert (output-stream-p stream
))))
483 (defclass user-input-stream
(fundamental-input-stream)
486 (let ((*stream
* (make-instance 'user-input-stream
)))
487 (declare (special *stream
*))
488 (with-open-stream (stream (make-synonym-stream '*stream
*))
489 (assert (input-stream-p stream
))))
491 ;;; READ-LINE on ANSI-STREAM did not return T for the last line
492 ;;; (reported by Yoshinori Tahara)
493 (let ((pathname "test-read-line-eol"))
494 (with-open-file (out pathname
:direction
:output
:if-exists
:supersede
)
496 (let ((result (with-open-file (in pathname
)
497 (list (multiple-value-list (read-line in nil nil
))
498 (multiple-value-list (read-line in nil nil
))
499 (multiple-value-list (read-line in nil nil
))))))
500 (delete-file pathname
)
501 (assert (equal result
'(("a" nil
) ("b" t
) (nil t
))))))
503 ;;; READ-LINE used to work on closed streams because input buffers were left in place
504 (with-test (:name
:bug-425
)
506 (let ((f (open "stream.impure.lisp" :direction
:input
)))
507 (assert (stringp (read-line f
)))
512 (sb-int:closed-stream-error
() :fii
)))))
514 (let ((f (open "stream.impure.lisp" :direction
:input
)))
515 (assert (stringp (read-line f nil nil
)))
520 (sb-int:closed-stream-error
() :faa
))))))
522 (with-test (:name
:regression-1.0
.12.22)
523 (with-open-file (s "stream.impure.lisp" :direction
:input
)
524 (let ((buffer (make-string 20)))
525 (assert (= 2 (read-sequence buffer s
:start
0 :end
2)))
526 (assert (= 3 (read-sequence buffer s
:start
2 :end
3)))
527 (file-position s
:end
)
528 (assert (= 3 (read-sequence buffer s
:start
3))))))
530 ;;; In 1.0.27 (and also 0.9.16; presumably in between, too), binary
531 ;;; input operations on a bivalent stream did something bad after
532 ;;; unread-char: READ-BYTE would return the character, and
533 ;;; READ-SEQUENCE into a byte buffer would lose when attempting to
534 ;;; store the character in the vector.
535 (let ((pathname "bivalent-stream-unread-char-test.tmp"))
536 (with-open-file (s pathname
537 :element-type
:default
538 :direction
:io
:if-exists
:rename
)
540 (file-position s
:start
)
541 (unread-char (read-char s
) s
)
542 (assert (integerp (read-byte s
))))
543 (delete-file pathname
))
545 (let ((pathname "bivalent-stream-unread-char-test.tmp"))
546 (with-open-file (s pathname
547 :element-type
:default
548 :direction
:io
:if-exists
:rename
)
550 (file-position s
:start
)
551 (unread-char (read-char s
) s
)
552 (assert (let ((buffer (make-array 10 :element-type
'(unsigned-byte 8))))
553 (read-sequence buffer s
))))
554 (delete-file pathname
))
557 (let ((pathname "bivalent-stream-unread-char-test.tmp"))
558 (with-open-file (s pathname
559 :element-type
:default
560 :direction
:io
:if-exists
:rename
561 :external-format
:utf8
)
562 (write-char (code-char 192) s
)
563 (file-position s
:start
)
564 (unread-char (read-char s
) s
)
565 (assert (integerp (read-byte s
))))
566 (delete-file pathname
))
569 (let ((pathname "bivalent-stream-unread-char-test.tmp"))
570 (with-open-file (s pathname
571 :element-type
:default
572 :direction
:io
:if-exists
:rename
573 :external-format
:utf8
)
574 (write-char (code-char 192) s
)
575 (file-position s
:start
)
576 (unread-char (read-char s
) s
)
577 (assert (let ((buffer (make-array 10 :element-type
'(unsigned-byte 8))))
578 (read-sequence buffer s
))))
579 (delete-file pathname
))
581 (with-test (:name
:delete-file-on-streams
)
582 (with-open-file (f "delete-file-on-stream-test.tmp"
587 (write-line "still open" f
)
588 (file-position f
:start
)
589 (assert (equal "still open" (read-line f
)))))
590 (assert (not (probe-file "delete-file-on-stream-test.tmp"))))
592 ;;; READ-CHAR-NO-HANG on bivalent streams (as returned by RUN-PROGRAM)
593 ;;; was wrong. CSR managed to promote the wrongness to all streams in
594 ;;; the 1.0.32.x series, breaking slime instantly.
595 (with-test (:name
:read-char-no-hang-after-unread-char
)
596 (let* ((process (run-program "/bin/sh" '("-c" "echo a && sleep 10")
597 :output
:stream
:wait nil
))
598 (stream (process-output process
))
599 (char (read-char stream
)))
600 (assert (char= char
#\a))
601 (unread-char char stream
)
602 (assert (char= (read-char stream
) #\a))
603 (assert (char= (read-char stream
) #\Newline
))
604 (let ((time (get-universal-time)))
605 ;; no input, not yet known to be at EOF: should return
607 (read-char-no-hang stream
)
608 (assert (< (- (get-universal-time) time
) 2)))))