tests/interface.pure.lisp

   1 ;;;; tests for problems in the interface presented to the user/programmer
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   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
   8 ;;;; from CMU CL.
   9 ;;;;
  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.
  13
  14 (in-package :cl-user)
  15
  16 (load "test-util.lisp")
  17 (load "compiler-test-util.lisp")
  18 (use-package :test-util)
  19 \f
  20 ;;;; properties of symbols, e.g. presence of doc strings for public symbols
  21
  22 ;;; FIXME: It would probably be good to require here that every
  23 ;;; external symbol either has a doc string or has some good excuse
  24 ;;; (like being an accessor for a structure which has a doc string).
  25 \f
  26 ;;;; tests of interface machinery
  27
  28 ;;; APROPOS should accept a package designator, not just a package, and
  29 ;;; furthermore do the right thing when it gets a package designator.
  30 ;;; (bug reported and fixed by Alexey Dejneka sbcl-devel 2001-10-17)
  31 (assert (< 0
  32            (length (apropos-list "PRINT" :cl))
  33            (length (apropos-list "PRINT"))))
  34 ;;; Further, it should correctly deal with the external-only flag (bug
  35 ;;; reported by cliini on #lisp IRC 2003-05-30, fixed in sbcl-0.8.0.1x
  36 ;;; by CSR)
  37 (assert (= (length (apropos-list "" "CL"))
  38            (length (apropos-list "" "CL" t))))
  39 (assert (< 0
  40            (length (apropos-list "" "SB-VM" t))
  41            (length (apropos-list "" "SB-VM"))))
  42 \f
  43 ;;; DESCRIBE shouldn't fail on rank-0 arrays (bug reported and fixed
  44 ;;; by Lutz Euler sbcl-devel 2002-12-03)
  45 (describe #0a0)
  46 (describe #(1 2 3))
  47 (describe #2a((1 2) (3 4)))
  48
  49 ;;; TYPEP, SUBTYPEP, UPGRADED-ARRAY-ELEMENT-TYPE and
  50 ;;; UPGRADED-COMPLEX-PART-TYPE should be able to deal with NIL as an
  51 ;;; environment argument
  52 (typep 1 'fixnum nil)
  53 (subtypep 'fixnum 'integer nil)
  54 (upgraded-array-element-type '(mod 5) nil)
  55 (upgraded-complex-part-type '(single-float 0.0 1.0) nil)
  56
  57 #+sb-doc
  58 (with-test (:name :sb-ext-documentation)
  59   ;;; We should have documentation for our extension package:
  60  (assert (documentation (find-package "SB-EXT") t)))
  61
  62 ;; This is trying to assert that you didn't mistakenly write
  63 ;; "#!+sb-doc (important-form)" in source code
  64 ;; but it's an absolutely terrible test, because it is nothing more
  65 ;; than a change detector. There are two possible improvements:
  66 ;; 1. eliminate the change-detection nature of the test by documenting
  67 ;;    all functions in CL, so that the magic constant 605 goes away.
  68 ;;    This would still be an indirect test.
  69 ;; 2. stop littering up the source code with #!+sb-doc,
  70 ;;    always write docstrings, and have 'make-target-2-load.lisp' remove them
  71 ;;    if desired. This would eliminate >1100 reader conditionals,
  72 ;;    comprising nearly 68% of all reader conditionals in SBCL source.
  73 #+sb-doc
  74 (with-test (:name :cl-documentation)
  75   (let ((n 0))
  76     (do-symbols (s 'cl)
  77       (if (fboundp s)
  78           (when (documentation s 'function)
  79             (incf n))))
  80     (assert (= n 605))))
  81
  82 ;;; DECLARE should not be a special operator
  83 (assert (not (special-operator-p 'declare)))
  84
  85 ;;; WITH-TIMEOUT should accept more than one form in its body.
  86 (with-test (:name :with-timeout-forms)
  87   (handler-bind ((sb-ext:timeout #'continue))
  88     (sb-ext:with-timeout 3
  89       (sleep 2)
  90       (sleep 2))))
  91
  92 ;;; SLEEP should not cons except on 32-bit platforms when
  93 ;;; (> (mod seconds 1) (* most-positive-fixnum 1e-9))
  94 (with-test (:name (sleep :non-consing) :fails-on :win32)
  95   (handler-case (sb-ext:with-timeout 5
  96                   (ctu:assert-no-consing (sleep 0.00001s0))
  97                   (locally (declare (notinline sleep))
  98                     (ctu:assert-no-consing (sleep 0.00001s0))
  99                     (ctu:assert-no-consing (sleep 0.00001d0))
 100                     (ctu:assert-no-consing (sleep 1/100000003))))
 101     (timeout ())))
 102
 103 ;;; Changes to make SLEEP cons less led to SLEEP
 104 ;;; not sleeping at all on 32-bit platforms when
 105 ;;; (> (mod seconds 1) (* most-positive-fixnum 1e-9)).
 106 (with-test (:name :bug-1194673)
 107   (assert (eq :timeout
 108               (handler-case
 109                   (with-timeout 0.01
 110                     (sleep 0.6))
 111                 (timeout ()
 112                   :timeout)))))
 113
 114 ;;; SLEEP should work with large integers as well
 115 (with-test (:name (sleep :pretty-much-forever))
 116   (assert (eq :timeout
 117               (handler-case
 118                   (sb-ext:with-timeout 1
 119                     (sleep (ash 1 (* 2 sb-vm:n-word-bits))))
 120                 (sb-ext:timeout ()
 121                   :timeout)))))
 122
 123 ;;; DOCUMENTATION should return nil, not signal slot-unbound
 124 (documentation 'fixnum 'type)
 125 (documentation 'class 'type)
 126 (documentation (find-class 'class) 'type)
 127 (documentation 'foo 'structure)
 128
 129 ;;; DECODE-UNIVERSAL-TIME should accept second-resolution time-zones.
 130 (macrolet ((test (ut time-zone list)
 131              (destructuring-bind (sec min hr date mon yr day tz)
 132                  list
 133                `(multiple-value-bind (sec min hr date mon yr day dst tz)
 134                     (decode-universal-time ,ut ,time-zone)
 135                   (declare (ignore dst))
 136                   (assert (= sec ,sec))
 137                   (assert (= min ,min))
 138                   (assert (= hr ,hr))
 139                   (assert (= date ,date))
 140                   (assert (= mon ,mon))
 141                   (assert (= yr ,yr))
 142                   (assert (= day ,day))
 143                   (assert (= tz ,tz))))))
 144   (test (* 86400 365) -1/3600 (1 0 0 1 1 1901 1 -1/3600))
 145   (test (* 86400 365) 0 (0 0 0 1 1 1901 1 0))
 146   (test (* 86400 365) 1/3600 (59 59 23 31 12 1900 0 1/3600)))
 147
 148 ;;; DECODE-UNIVERSAL-TIME shouldn't fail when the time is outside UNIX
 149 ;;; 32-bit time_t and a timezone wasn't passed
 150 (decode-universal-time 0 nil)
 151
 152 ;;; ENCODE-UNIVERSAL-TIME should be able to encode the universal time
 153 ;;; 0 when passed a representation in a timezone where the
 154 ;;; representation of 0 as a decoded time is in 1899.
 155 (encode-universal-time 0 0 23 31 12 1899 1)
 156
 157 ;;; DISASSEMBLE shouldn't fail on purified functions
 158 (disassemble 'cl:+ :stream (make-broadcast-stream))
 159 (disassemble 'sb-ext:run-program :stream (make-broadcast-stream))
 160
 161 ;;; minimal test of GC: see stress-gc.{sh,lisp} for a more
 162 ;;; comprehensive test.
 163 (loop repeat 2
 164       do (compile nil '(lambda (x) x))
 165       do (sb-ext:gc :full t))
 166
 167 ;;; On x86-64, the instruction definitions for CMP*[PS][SD] were broken
 168 ;;; so that the disassembler threw an error when they were used with
 169 ;;; one operand in memory.
 170 (with-test (:name :bug-814702)
 171   (disassemble (lambda (x)
 172                  (= #C(2.0f0 3.0f0)
 173                     (the (complex single-float) x)))
 174                :stream (make-broadcast-stream))
 175   (disassemble (lambda (x y)
 176                  (= (the (complex single-float) x)
 177                     (the (complex single-float) y)))
 178                :stream (make-broadcast-stream)))
 179
 180 #+x86-64
 181 ;; The labeler for LEA would choke on an illegal encoding
 182 ;; instead of showing what it illegally encodes, such as LEA RAX, RSP
 183 (with-test (:name :x86-lea-disassemble-illegal-op)
 184   (let ((a (coerce '(#x48 #x8D #xC4) '(array (unsigned-byte 8) (3)))))
 185     (sb-sys:with-pinned-objects (a)
 186       (sb-disassem::disassemble-memory (sb-sys:sap-int (sb-sys:vector-sap a)) 3
 187                                        :stream (make-broadcast-stream)))))
 188
 189 ;; Assert that disassemblies of identically-acting functions are identical
 190 ;; if address printing is turned off. Should work on any backend, I think.
 191 (with-test (:name :disassemble-without-addresses)
 192   (flet ((disassembly-text (lambda-expr)
 193          (let ((string
 194                 (let ((sb-disassem::*disassem-location-column-width* 0)
 195                       (*print-pretty* nil)) ; prevent function name wraparound
 196                   (with-output-to-string (s)
 197                     (disassemble lambda-expr :stream s)))))
 198            ;; Return all except the first two lines. This is subject to change
 199            ;; any time we muck with the layout unfortunately.
 200            (subseq string
 201                    (1+ (position #\Newline string
 202                                  :start (1+ (position #\Newline string))))))))
 203   (let ((string1 (disassembly-text '(lambda (x) (car x))))
 204         (string2 (disassembly-text '(lambda (y) (car y)))))
 205     (assert (string= string1 string2)))))
 206
 207 (with-test (:name :disassemble-assembly-routine)
 208   (let ((code
 209          (block nil
 210            (sb-vm::map-allocated-objects
 211             (lambda (obj type size)
 212               (declare (ignore size))
 213               (when (= type sb-vm:code-header-widetag)
 214                 (return obj)))
 215             :read-only))))
 216     (assert code) ; found something to disassemble
 217     (sb-disassem:disassemble-code-component code
 218      :stream (make-broadcast-stream))))
 219
 220 ;;; Check that SLEEP called with ratios (with no common factors with
 221 ;;; 1000000000, and smaller than 1/1000000000) works more or less as
 222 ;;; expected.
 223 (with-test (:name :sleep-ratios)
 224   (let ((fun0a (compile nil '(lambda () (sleep 1/7))))
 225         (fun0b (compile nil '(lambda () (sleep 1/100000000000000000000000000))))
 226         (fun1 (compile nil '(lambda (x) (sleep x))))
 227         (start-time (get-universal-time)))
 228     (sleep 1/7)
 229     (sleep 1/100000000000000000000000000)
 230     (funcall fun0a)
 231     (funcall fun0b)
 232     (funcall fun1 1/7)
 233     (funcall fun1 1/100000000000000000000000000)
 234     (assert (< (- (get-universal-time) start-time) 2))))
 235
 236 (with-test (:name :version-assert-ok)
 237   (sb-ext:assert-version->= 1 1 13))
 238
 239 (with-test (:name :version-assert-fails)
 240   (assert-error
 241    (sb-ext:assert-version->= most-positive-fixnum)))
 242
 243 (with-test (:name :bug-1095483)
 244   (assert-error (fboundp '(cas "foo"))))