contrib/bsd-sockets/tests.lisp

   1 (defpackage "BSD-SOCKETS-TEST"
   2   (:use "CL" "BSD-SOCKETS" "RT"))
   3
   4 #||
   5
   6 <H1>Tests</h1>
   7
   8 There should be at least one test for pretty much everything you can do
   9 with the package.  In some places I've been more diligent than others; more
  10 tests gratefully accepted.
  11
  12 Tests are in the file <tt>tests.lisp</tt> and also make good examples.
  13
  14 ||#
  15
  16 (in-package :bsd-sockets-test)
  17
  18 ;;; a real address
  19 (deftest make-inet-address
  20   (equalp (make-inet-address "127.0.0.1")  #(127 0 0 1))
  21   t)
  22 ;;; and an address with bit 8 set on some octets
  23 (deftest make-inet-address2
  24   (equalp (make-inet-address "242.1.211.3")  #(242 1 211 3))
  25   t)
  26
  27 (deftest make-inet-socket
  28   ;; make a socket
  29   (let ((s (make-instance 'inet-socket :type :stream :protocol (get-protocol-by-name "tcp"))))
  30     (and (> (socket-file-descriptor s) 1) t))
  31   t)
  32
  33 (deftest make-inet-socket-keyword
  34     ;; make a socket
  35     (let ((s (make-instance 'inet-socket :type :stream :protocol :tcp)))
  36       (and (> (socket-file-descriptor s) 1) t))
  37   t)
  38
  39 (deftest make-inet-socket-wrong
  40     ;; fail to make a socket: check correct error return.  There's no nice
  41     ;; way to check the condition stuff on its own, which is a shame
  42     (handler-case
  43         (make-instance 'inet-socket :type :stream :protocol (get-protocol-by-name "udp"))
  44       ((or socket-type-not-supported-error protocol-not-supported-error) (c)
  45         (declare (ignorable c)) t)
  46       (:no-error nil))
  47   t)
  48
  49 (deftest make-inet-socket-keyword-wrong
  50     ;; same again with keywords
  51     (handler-case
  52         (make-instance 'inet-socket :type :stream :protocol :udp)
  53       ((or protocol-not-supported-error socket-type-not-supported-error) (c)
  54         (declare (ignorable c)) t)
  55       (:no-error nil))
  56   t)
  57
  58
  59 (deftest non-block-socket
  60   (let ((s (make-instance 'inet-socket :type :stream :protocol :tcp)))
  61     (setf (non-blocking-mode s) t)
  62     (non-blocking-mode s))
  63   t)
  64
  65 (defun do-gc-portably ()
  66   ;; cmucl on linux has generational gc with a keyword argument,
  67   ;; sbcl GC function takes same arguments no matter what collector is in
  68   ;; use
  69   #+(or sbcl gencgc) (SB-EXT:gc :full t)
  70   ;; other platforms have full gc or nothing
  71   #-(or sbcl gencgc) (sb-ext:gc))
  72
  73 (deftest inet-socket-bind
  74   (let ((s (make-instance 'inet-socket :type :stream :protocol (get-protocol-by-name "tcp"))))
  75     ;; Given the functions we've got so far, if you can think of a
  76     ;; better way to make sure the bind succeeded than trying it
  77     ;; twice, let me know
  78     ;; 1974 has no special significance, unless you're the same age as me
  79     (do-gc-portably) ;gc should clear out any old sockets bound to this port
  80     (socket-bind s (make-inet-address "127.0.0.1") 1974)
  81     (handler-case
  82         (let ((s2 (make-instance 'inet-socket :type :stream :protocol (get-protocol-by-name "tcp"))))
  83           (socket-bind s2 (make-inet-address "127.0.0.1") 1974)
  84           nil)
  85       (address-in-use-error () t)))
  86   t)
  87
  88 (deftest simple-sockopt-test
  89   ;; test we can set SO_REUSEADDR on a socket and retrieve it, and in
  90   ;; the process that all the weird macros in sockopt happened right.
  91   (let ((s (make-instance 'inet-socket :type :stream :protocol (get-protocol-by-name "tcp"))))
  92     (setf (sockopt-reuse-address s) t)
  93     (sockopt-reuse-address s))
  94   t)
  95
  96 (defun read-buf-nonblock (buffer stream)
  97   "Like READ-SEQUENCE, but returns early if the full quantity of data isn't there to be read.  Blocks if no input at all"
  98   (let ((eof (gensym)))
  99     (do ((i 0 (1+ i))
 100          (c (read-char stream nil eof)
 101             (read-char-no-hang stream nil eof)))
 102         ((or (>= i (length buffer)) (not c) (eq c eof)) i)
 103       (setf (elt buffer i) c))))
 104
 105 ;;; these require that the echo services are turned on in inetd
 106
 107 (deftest simple-tcp-client
 108     (let ((s (make-instance 'inet-socket :type :stream :protocol :tcp))
 109           (data (make-string 200)))
 110       (socket-connect s #(127 0 0 1) 7)
 111       (let ((stream (socket-make-stream s :input t :output t :buffering :none)))
 112         (format stream "here is some text")
 113         (let ((data (subseq data 0 (read-buf-nonblock data stream))))
 114           (format t "~&Got ~S back from TCP echo server~%" data)
 115           (> (length data) 0))))
 116   t)
 117
 118 (deftest simple-udp-client
 119   (let ((s (make-instance 'inet-socket :type :datagram :protocol (get-protocol-by-name "udp")))
 120         (data (make-string 200)))
 121     (format t "Socket type is ~A~%" (sockopt-type s))
 122     (socket-connect s #(127 0 0 1) 7)
 123     (let ((stream (socket-make-stream s :input t :output t :buffering :none)))
 124       (format stream "here is some text")
 125       (let ((data (subseq data 0 (read-buf-nonblock data stream))))
 126         (format t "~&Got ~S back from UDP echo server~%" data)
 127         (> (length data) 0))))
 128   t)
 129
 130 #||
 131 <h2>Unix-domain sockets</h2>
 132
 133 A fairly rudimentary test that connects to the syslog socket and sends a
 134 message.  Priority 7 is kern.debug; you'll probably want to look at
 135 /etc/syslog.conf or local equivalent to find out where the message ended up
 136 ||#
 137
 138 (deftest simple-unix-client
 139     (let ((s (make-instance 'unix-socket :type :datagram)))
 140       (format t "~A~%" s)
 141       (socket-connect s "/dev/log")
 142       (let ((stream (socket-make-stream s :input t :output t :buffering :none)))
 143         (format stream
 144                 "<7>bsd-sockets: Don't panic.  We're testing unix-domain client code; this message can safely be ignored")
 145         t))
 146   t)
 147
 148
 149 ;;; these require that the internet (or bits of it, atleast) is available
 150
 151 (deftest get-host-by-name
 152   (equalp (car (host-ent-addresses (get-host-by-name "a.root-servers.net")))
 153           #(198 41 0 4))
 154   t)
 155
 156 (deftest get-host-by-address
 157     (host-ent-name (get-host-by-address #(198 41 0 4)))
 158   "a.root-servers.net")
 159
 160 (deftest get-host-by-name-wrong
 161   (handler-case
 162    (get-host-by-name "foo.tninkpad.telent.net")
 163    (NAME-SERVICE-ERROR () t)
 164    (:no-error nil))
 165   t)
 166
 167 (defun http-stream (host port request)
 168   (let ((s (make-instance 'inet-socket :type :stream :protocol :tcp)))
 169     (socket-connect
 170      s (car (host-ent-addresses (get-host-by-name host))) port)
 171     (let ((stream (socket-make-stream s :input t :output t :buffering :none)))
 172       (format stream "~A HTTP/1.0~%~%" request))
 173     s))
 174
 175 (deftest simple-http-client-1
 176     (handler-case
 177         (let ((s (http-stream "ww.telent.net" 80 "HEAD /")))
 178           (let ((data (make-string 200)))
 179             (setf data (subseq data 0
 180                                (read-buf-nonblock data
 181                                                   (socket-make-stream s))))
 182             (princ data)
 183             (> (length data) 0)))
 184       (network-unreachable-error () 'network-unreachable))
 185   t)
 186
 187
 188 (deftest sockopt-receive-buffer
 189     ;; on Linux x86, the receive buffer size appears to be doubled in the
 190     ;; kernel: we set a size of x and then getsockopt() returns 2x.
 191     ;; This is why we compare with >= instead of =
 192     (handler-case
 193         (let ((s (http-stream "ww.telent.net" 80 "HEAD /")))
 194           (setf (sockopt-receive-buffer s) 1975)
 195           (let ((data (make-string 200)))
 196             (setf data (subseq data 0
 197                                (read-buf-nonblock data
 198                                                   (socket-make-stream s))))
 199             (and (> (length data) 0)
 200                  (>= (sockopt-receive-buffer s) 1975))))
 201       (network-unreachable-error () 'network-unreachable))
 202   t)
 203
 204
 205 ;;; we don't have an automatic test for some of this yet.  There's no
 206 ;;; simple way to run servers and have something automatically connect
 207 ;;; to them as client, unless we spawn external programs.  Then we
 208 ;;; have to start telling people what external programs they should
 209 ;;; have installed.  Which, eventually, we will, but not just yet
 210
 211
 212 ;;; to check with this: can display packets from multiple peers
 213 ;;; peer address is shown correctly for each packet
 214 ;;; packet length is correct
 215 ;;; long (>500 byte) packets have the full length shown (doesn't work)
 216
 217 (defun udp-server (port)
 218   (let ((s (make-instance 'inet-socket :type :datagram :protocol :udp)))
 219     (socket-bind s #(0 0 0 0) port)
 220     (loop
 221      (multiple-value-bind (buf len address port) (socket-receive s nil 500)
 222        (format t "Received ~A bytes from ~A:~A - ~A ~%"
 223                len address port (subseq buf 0 (min 10 len)))))))
 224
 225