(cl:in-package :cl-user)
-;; Actually there's no real side-effect here. (But see below.) The
-;; impurity we're avoiding is the sigchld handler that RUN-PROGRAM
-;; sets up, which interfers with the manual unix process control done
-;; by the test framework (sometimes the handler will manage to WAIT3 a
-;; process before run-tests WAITPIDs it).
-
-(let* ((process (sb-ext:run-program "/bin/cat" '() :wait nil
- :output :stream :input :stream))
- (out (process-input process))
- (in (process-output process)))
- (unwind-protect
- (loop for i from 0 to 255 do
- (write-byte i out)
- (force-output out)
- (assert (= (read-byte in) i)))
- (process-close process)))
+;; In addition to definitions lower down the impurity we're avoiding
+;; is the sigchld handler that RUN-PROGRAM sets up, which interfers
+;; with the manual unix process control done by the test framework
+;; (sometimes the handler will manage to WAIT3 a process before
+;; run-tests WAITPIDs it).
+
+(with-test (:name :run-program-cat-1 :skipped-on :win32)
+ (let* ((process (sb-ext:run-program "/bin/cat" '() :wait nil
+ :output :stream :input :stream))
+ (out (process-input process))
+ (in (process-output process)))
+ (unwind-protect
+ (loop for i from 0 to 255 do
+ (write-byte i out)
+ (force-output out)
+ (assert (= (read-byte in) i)))
+ (process-close process))))
+
+(with-test (:name :run-program-cat-2 :skipped-on '(or (not :sb-thread) :win32))
+ ;; Tests that reading from a FIFO is interruptible.
+ (let* ((process (sb-ext:run-program "/bin/cat" '()
+ :wait nil
+ :output :stream :input :stream))
+ (in (process-input process))
+ (out (process-output process))
+ (sem (sb-thread:make-semaphore))
+ (state :init)
+ (writer (sb-thread:make-thread (lambda ()
+ (sb-thread:wait-on-semaphore sem)
+ (setf state :sleep)
+ (sleep 2)
+ (setf state :write)
+ (write-line "OK" in)
+ (finish-output in))))
+ (timeout nil)
+ (got nil)
+ (unwind nil))
+ (sb-thread:signal-semaphore sem)
+ (handler-case
+ (with-timeout 0.1
+ (unwind-protect
+ (setf got (read-line out))
+ (setf unwind state)))
+ (timeout ()
+ (setf timeout t)))
+ (assert (not got))
+ (assert timeout)
+ (assert (eq unwind :sleep))
+ (sb-thread:join-thread writer)
+ (assert (equal "OK" (read-line out)))))
+
+(defclass buffer-stream (sb-gray:fundamental-binary-input-stream sb-gray:fundamental-binary-output-stream)
+ ((buffer :initform (make-array 128
+ :element-type '(unsigned-byte 8)
+ :adjustable t
+ :fill-pointer 0))
+ (mark :initform 0)))
+
+(defmethod stream-element-type ((stream buffer-stream))
+ '(unsigned-byte 8))
+
+(defmethod sb-gray:stream-read-sequence ((stream buffer-stream) seq &optional (start 0) end)
+ (let* ((buffer (slot-value stream 'buffer))
+ (end (or end (length seq)))
+ (mark (slot-value stream 'mark))
+ (fill-pointer (fill-pointer buffer))
+ (new-mark (+ mark (min fill-pointer (- end start)))))
+ (setf (slot-value stream 'mark) new-mark)
+ (replace seq buffer
+ :start1 start :end1 end
+ :start2 mark :end2 fill-pointer)
+ (min end (+ start (- fill-pointer mark)))))
+
+(defmethod sb-gray:stream-write-sequence ((stream buffer-stream) seq &optional (start 0) end)
+ (let* ((buffer (slot-value stream 'buffer))
+ (end (or end (length seq)))
+ (fill-pointer (fill-pointer buffer))
+ (new-fill (min (array-total-size buffer) (+ fill-pointer (- end start)))))
+ (setf (fill-pointer buffer) new-fill)
+ (replace buffer seq
+ :start1 fill-pointer
+ :start2 start :end2 end)
+ seq))
-;;; Test driving an external program (ed) through pipes wrapped in
+(with-test (:name :run-program-cat-3 :skipped-on :win32)
+ ;; User-defined binary input and output streams.
+ (let ((in (make-instance 'buffer-stream))
+ (out (make-instance 'buffer-stream))
+ (data #(0 1 2 3 4 5 6 7 8 9 10 11 12)))
+ (write-sequence data in)
+ (let ((process (sb-ext:run-program "/bin/cat" '() :wait t :output out :input in))
+ (buf (make-array (length data))))
+ (assert (= 13 (read-sequence buf out)))
+ (assert (= 0 (read-sequence (make-array 8) out)))
+ (assert (equalp buf data)))))
+
+(with-test (:name :run-program-cat-4 :skipped-on :win32)
+ ;; Null broadcast stream as output
+ (let* ((process (sb-ext:run-program "/bin/cat" '() :wait nil
+ :output (make-broadcast-stream)
+ :input :stream))
+ (in (process-input process)))
+ (unwind-protect
+ (progn
+ (write-string "foobar" in)
+ (close in)
+ (process-wait process))
+ (process-close process))))
+
+;;; Test driving an external program (cat) through pipes wrapped in
;;; composite streams.
(require :sb-posix)
-(defvar *tmpfile* "run-program-ed-test.tmp")
+#-win32
+(progn
+ (defun make-pipe ()
+ (multiple-value-bind (in out) (sb-posix:pipe)
+ (let ((input (sb-sys:make-fd-stream in
+ :input t
+ :external-format :ascii
+ :buffering :none :name "in"))
+ (output (sb-sys:make-fd-stream out
+ :output t
+ :external-format :ascii
+ :buffering :none :name "out")))
+ (make-two-way-stream input output))))
+
+ (defparameter *cat-in-pipe* (make-pipe))
+ (defparameter *cat-in* (make-synonym-stream '*cat-in-pipe*))
+ (defparameter *cat-out-pipe* (make-pipe))
+ (defparameter *cat-out* (make-synonym-stream '*cat-out-pipe*)))
+
+(with-test (:name :run-program-cat-5 :fails-on :win32)
+ (let ((cat (run-program "/bin/cat" nil :input *cat-in* :output *cat-out*
+ :wait nil)))
+ (dolist (test '("This is a test!"
+ "This is another test!"
+ "This is the last test...."))
+ (write-line test *cat-in*)
+ (assert (equal test (read-line *cat-out*))))
+ (process-close cat)))
+
+;;; The above test used to use ed, but there were buffering issues: on some platforms
+;;; buffering of stdin and stdout depends on their TTYness, and ed isn't sufficiently
+;;; agressive about flushing them. So, here's another test using :PTY.
+
+#-win32 (progn ;; kludge: It would be nicer to disable individual test cases,
+ ;; but we are not using WITH-TEST yet here.
+
+(defparameter *tmpfile* "run-program-ed-test.tmp")
(with-open-file (f *tmpfile*
:direction :output
:if-exists :supersede)
(write-line "bar" f))
-(defun make-pipe ()
- (multiple-value-bind (in out) (sb-posix:pipe)
- (let ((input (sb-sys:make-fd-stream in
- :input t
- :external-format :ascii
- :buffering :none :name "in"))
- (output (sb-sys:make-fd-stream out
- :output t
- :external-format :ascii
- :buffering :none :name "out")))
- (make-two-way-stream input output))))
-
-(defvar *in-pipe* (make-pipe))
-(defvar *in* (make-synonym-stream '*in-pipe*))
-(defvar *out-pipe* (make-pipe))
-(defvar *out* (make-synonym-stream '*out-pipe*))
-
-(defvar *ed*
- (run-program "/bin/ed" (list *tmpfile*) :input *in* :output *out* :wait nil))
-
-(defun real-input (stream)
- (two-way-stream-input-stream (symbol-value (synonym-stream-symbol stream))))
-
-(defun magic-read-line (stream)
- ;; KLUDGE 1: The otherwise out :buffering :none is worth nothing,
- (let ((input (real-input stream)))
- (with-output-to-string (s)
- ;; KLUDGE 2: Something funny going on with buffering, as plain
- ;; READ-CHAR will hang here waiting for the newline, also
- ;; -NO-HANG will return too early without the sleep.
- ;;
- ;; Shoot me now. --NS 2006-06-09
- (loop for c = (progn (sleep 0.2) (read-char-no-hang input))
- while (and c (not (eq #\newline c)))
- do (write-char c s)))))
+(defparameter *ed*
+ (run-program "/bin/ed" (list *tmpfile*) :wait nil :pty t))
+
+(defparameter *ed-pipe* (make-two-way-stream (process-pty *ed*) (process-pty *ed*)))
+(defparameter *ed-in* (make-synonym-stream '*ed-pipe*))
+(defparameter *ed-out* (make-synonym-stream '*ed-pipe*))
+
+(defun read-linish (stream)
+ (with-output-to-string (s)
+ (loop for c = (read-char stream)
+ while (and c (not (eq #\newline c)))
+ ;; Some eds like to send \r\n
+ do (unless (eq #\return c)
+ (write-char c s)))))
(defun assert-ed (command response)
(when command
- (write-line command *in*)
- (force-output *in*))
- (let ((got (magic-read-line *out*)))
- (unless (equal response got)
- (error "wanted ~S from ed, got ~S" response got)))
+ (write-line command *ed-in*)
+ (force-output *ed-in*))
+ (when response
+ (let ((got (read-linish *ed-out*)))
+ (unless (equal response got)
+ (error "wanted '~A' from ed, got '~A'" response got))))
*ed*)
-(assert-ed nil "4")
-(assert-ed ".s/bar/baz/g" "")
-(assert-ed "w" "4")
-(assert-ed "q" "")
-(process-wait *ed*)
+(unwind-protect
+ (with-test (:name :run-program-ed)
+ (assert-ed nil "4")
+ (assert-ed ".s/bar/baz/g" nil)
+ (assert-ed "w" "4")
+ (assert-ed "q" nil)
+ (process-wait *ed*)
+ (with-open-file (f *tmpfile*)
+ (assert (equal "baz" (read-line f)))))
+ (delete-file *tmpfile*))
+
+) ;; #-win32
+
+;; Around 1.0.12 there was a regression when :INPUT or :OUTPUT was a
+;; pathname designator. Since these use the same code, it should
+;; suffice to test just :INPUT.
+(let ((file))
+ (unwind-protect
+ (progn (with-open-file (f "run-program-test.tmp" :direction :output)
+ (setf file (truename f))
+ (write-line "Foo" f))
+ (assert (run-program "cat" ()
+ :input file :output t
+ :search t :wait t)))
+ (when file
+ (delete-file file))))
+
+;;; This used to crash on Darwin and trigger recursive lock errors on
+;;; every platform.
+(with-test (:name (:run-program :stress) :fails-on :win32)
+ ;; Do it a hundred times in batches of 10 so that with a low limit
+ ;; of the number of processes the test can have a chance to pass.
+ (loop
+ repeat 10 do
+ (map nil
+ #'sb-ext:process-wait
+ (loop repeat 10
+ collect
+ (sb-ext:run-program "/bin/echo" '
+ ("It would be nice if this didn't crash.")
+ :wait nil :output nil)))))
+
+(with-test (:name (:run-program :pty-stream) :fails-on :win32)
+ (assert (equal "OK"
+ (subseq
+ (with-output-to-string (s)
+ (assert (= 42 (process-exit-code
+ (run-program "/bin/sh" '("-c" "echo OK; exit 42") :wait t
+ :pty s))))
+ s)
+ 0
+ 2))))
+
+;; Check whether RUN-PROGRAM puts its child process into the foreground
+;; when stdin is inherited. If it fails to do so we will receive a SIGTTIN.
+;;
+;; We can't check for the signal itself since run-program.c resets the
+;; forked process' signal mask to defaults. But the default is `stop'
+;; of which we can be notified asynchronously by providing a status hook.
+(with-test (:name (:run-program :inherit-stdin) :fails-on :win32)
+ (let (stopped)
+ (flet ((status-hook (proc)
+ (case (sb-ext:process-status proc)
+ (:stopped (setf stopped t)))))
+ (let ((proc (sb-ext:run-program "/bin/ed" nil :search nil :wait nil
+ :input t :output t
+ :status-hook #'status-hook)))
+ ;; Give the program a generous time to generate the SIGTTIN.
+ ;; If it hasn't done so after that time we can consider it
+ ;; to be working (i.e. waiting for input without generating SIGTTIN).
+ (sleep 0.5)
+ ;; either way we have to signal it to terminate
+ (process-kill proc sb-posix:sigterm)
+ (process-close proc)
+ (assert (not stopped))))))
+
+
+;; Check that in when you do run-program with :wait t that causes
+;; encoding error, it does not affect the following run-program
+(with-test (:name (:run-program :clean-exit-after-encoding-error)
+ :fails-on :win32)
+ (let ((had-error-p nil))
+ (flet ((barf (&optional (format :default))
+ (with-output-to-string (stream)
+ (run-program #-netbsd "/usr/bin/perl" #+netbsd "/usr/pkg/bin/perl"
+ '("-e" "print \"\\x20\\xfe\\xff\\x0a\"")
+ :output stream
+ :external-format format)))
+ (no-barf ()
+ (with-output-to-string (stream)
+ (run-program "/bin/echo"
+ '("This is a test")
+ :output stream))))
+ (handler-case
+ (barf :utf-8)
+ (error ()
+ (setq had-error-p t)))
+ (assert had-error-p)
+ ;; now run the harmless program
+ (setq had-error-p nil)
+ (handler-case
+ (no-barf)
+ (error ()
+ (setq had-error-p t)))
+ (assert (not had-error-p)))))
+
+(with-test (:name (:run-program :no-such-thing))
+ (assert (search "Couldn't execute"
+ (handler-case
+ (progn (run-program "no-such-program-we-hope" '()) nil)
+ (error (e)
+ (princ-to-string e))))))
+
+(with-test (:name (:run-program :not-executable))
+ (assert (search "Couldn't execute"
+ (handler-case
+ (progn (run-program "run-program.impure.lisp" '()) nil)
+ (error (e)
+ (princ-to-string e))))))
+
+#-win32
+(with-test (:name (:run-program :if-input-does-not-exist))
+ (let ((file (pathname (sb-posix:mktemp "rpXXXXXX"))))
+ (assert (null (sb-ext:run-program "/bin/cat" '() :input file)))
+ (assert (null (sb-ext:run-program "/bin/cat" '() :output #.(or *compile-file-truename*
+ *load-truename*)
+ :if-output-exists nil)))))
-(with-open-file (f *tmpfile*)
- (assert (equal "baz" (read-line f))))
-;(delete-file *tmp*)
+(with-test (:name (:run-program :set-directory))
+ (let* ((directory #-win32 "/"
+ #+win32 "c:\\")
+ (out (sb-ext:process-output
+ (sb-ext:run-program #-win32 "/bin/sh"
+ #-win32 '("-c" "pwd")
+ #+win32 "cmd.exe"
+ #+win32 '("/c" "cd")
+ :output :stream
+ :directory directory
+ :search t))))
+ (assert
+ (equal directory
+ (string-right-trim '(#\Return) (read-line out))))))