test-suite/tests/popen.test

   1 ;;;; popen.test --- exercise ice-9/popen.scm      -*- scheme -*-
   2 ;;;;
   3 ;;;; Copyright 2003, 2006, 2010, 2011, 2013, 2014 Free Software Foundation, Inc.
   4 ;;;;
   5 ;;;; This library is free software; you can redistribute it and/or
   6 ;;;; modify it under the terms of the GNU Lesser General Public
   7 ;;;; License as published by the Free Software Foundation; either
   8 ;;;; version 3 of the License, or (at your option) any later version.
   9 ;;;;
  10 ;;;; This library is distributed in the hope that it will be useful,
  11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ;;;; Lesser General Public License for more details.
  14 ;;;;
  15 ;;;; You should have received a copy of the GNU Lesser General Public
  16 ;;;; License along with this library; if not, write to the Free Software
  17 ;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18
  19 (define-module (test-suite test-ice-9-popen)
  20   #:use-module (test-suite lib))
  21
  22 ;; read from PORT until eof is reached, return what's read as a string
  23 (define (read-string-to-eof port)
  24   (do ((lst '() (cons c lst))
  25        (c (read-char port) (read-char port)))
  26       ((eof-object? c)
  27        (list->string (reverse! lst)))))
  28
  29 ;; call (THUNK), with SIGPIPE set to SIG_IGN so that an EPIPE error is
  30 ;; generated rather than a SIGPIPE signal
  31 (define (with-epipe thunk)
  32   (dynamic-wind
  33       (lambda ()
  34         (sigaction SIGPIPE SIG_IGN))
  35       thunk
  36       restore-signals))
  37
  38 (define-syntax-rule (if-supported body ...)
  39   (if (provided? 'fork)
  40       (begin body ...)))
  41
  42 (if-supported
  43  (use-modules (ice-9 popen))
  44
  45
  46  ;;
  47  ;; open-input-pipe
  48  ;;
  49
  50  (with-test-prefix "open-input-pipe"
  51
  52    (pass-if-exception "no args" exception:wrong-num-args
  53      (open-input-pipe))
  54
  55    (pass-if "port?"
  56      (port? (open-input-pipe "echo hello")))
  57
  58    (pass-if "echo hello"
  59      (string=? "hello\n" (read-string-to-eof (open-input-pipe "echo hello"))))
  60
  61    ;; exercise file descriptor setups when stdin is the same as stderr
  62    (pass-if "stdin==stderr"
  63      (let ((port (open-file "/dev/null" "r+")))
  64        (with-input-from-port port
  65          (lambda ()
  66            (with-error-to-port port
  67              (lambda ()
  68                (open-input-pipe "echo hello"))))))
  69      #t)
  70
  71    ;; exercise file descriptor setups when stdout is the same as stderr
  72    (pass-if "stdout==stderr"
  73      (let ((port (open-file "/dev/null" "r+")))
  74        (with-output-to-port port
  75          (lambda ()
  76            (with-error-to-port port
  77              (lambda ()
  78                (open-input-pipe "echo hello"))))))
  79      #t)
  80
  81    (pass-if "open-input-pipe process gets (current-input-port) as stdin"
  82      (let* ((p2c (pipe))
  83             (port (with-input-from-port (car p2c)
  84                     (lambda ()
  85                       (open-input-pipe "read line && echo $line")))))
  86        (display "hello\n" (cdr p2c))
  87        (force-output (cdr p2c))
  88        (let ((result (eq? (read port) 'hello)))
  89          (close-port (cdr p2c))
  90          (close-pipe port)
  91          result)))
  92
  93    ;; After the child closes stdout (which it indicates here by writing
  94    ;; "closed" to stderr), the parent should see eof.  In Guile 1.6.4
  95    ;; and earlier a duplicate of stdout existed in the child, meaning
  96    ;; eof was not seen.
  97    ;;
  98    ;; Note that the objective here is to test that the parent sees EOF
  99    ;; while the child is still alive.  (It is obvious that the parent
 100    ;; must see EOF once the child has died.)  The use of the `p2c'
 101    ;; pipe, and `echo closed' and `read' in the child, allows us to be
 102    ;; sure that we are testing what the parent sees at a point where
 103    ;; the child has closed stdout but is still alive.
 104    (pass-if "no duplicate"
 105      (let* ((c2p (pipe))
 106             (p2c (pipe))
 107             (port (with-error-to-port (cdr c2p)
 108                     (lambda ()
 109                       (with-input-from-port (car p2c)
 110                         (lambda ()
 111                           (open-input-pipe
 112                            (format #f "exec 1>~a; echo closed 1>&2; \
 113 exec 2>~a; read REPLY"
 114                                    %null-device %null-device))))))))
 115        (close-port (cdr c2p)) ;; write side
 116        (let ((result (eof-object? (read-char port))))
 117          (display "hello!\n" (cdr p2c))
 118          (force-output (cdr p2c))
 119          (close-pipe port)
 120          result))))
 121
 122  ;;
 123  ;; open-output-pipe
 124  ;;
 125
 126  (with-test-prefix "open-output-pipe"
 127
 128    (pass-if-exception "no args" exception:wrong-num-args
 129      (open-output-pipe))
 130
 131    (pass-if "port?"
 132      (port? (open-output-pipe "exit 0")))
 133
 134    ;; exercise file descriptor setups when stdin is the same as stderr
 135    (pass-if "stdin==stderr"
 136      (let ((port (open-file "/dev/null" "r+")))
 137        (with-input-from-port port
 138          (lambda ()
 139            (with-error-to-port port
 140              (lambda ()
 141                (open-output-pipe "exit 0"))))))
 142      #t)
 143
 144    ;; exercise file descriptor setups when stdout is the same as stderr
 145    (pass-if "stdout==stderr"
 146      (let ((port (open-file "/dev/null" "r+")))
 147        (with-output-to-port port
 148          (lambda ()
 149            (with-error-to-port port
 150              (lambda ()
 151                (open-output-pipe "exit 0"))))))
 152      #t)
 153
 154    ;; After the child closes stdin (which it indicates here by writing
 155    ;; "closed" to stderr), the parent should see a broken pipe.  We
 156    ;; setup to see this as EPIPE (rather than SIGPIPE).  In Guile 1.6.4
 157    ;; and earlier a duplicate of stdin existed in the child, preventing
 158    ;; the broken pipe occurring.
 159    ;;
 160    ;; Note that the objective here is to test that the parent sees a
 161    ;; broken pipe while the child is still alive.  (It is obvious that
 162    ;; the parent will see a broken pipe once the child has died.)  The
 163    ;; use of the `c2p' pipe, and the repeated `echo closed' in the
 164    ;; child, allows us to be sure that we are testing what the parent
 165    ;; sees at a point where the child has closed stdin but is still
 166    ;; alive.
 167    ;;
 168    ;; Note that `with-epipe' must apply only to the parent and not to
 169    ;; the child process; we rely on the child getting SIGPIPE, to
 170    ;; terminate it (and avoid leaving a zombie).
 171    (pass-if "no duplicate"
 172      (let* ((c2p (pipe))
 173             (port (with-error-to-port (cdr c2p)
 174                     (lambda ()
 175                       (open-output-pipe
 176                        (string-append "exec guile --no-auto-compile -s \""
 177                                       (getenv "TEST_SUITE_DIR")
 178                                       "/tests/popen-child.scm\""))))))
 179        (close-port (cdr c2p)) ;; write side
 180        (with-epipe
 181         (lambda ()
 182           (let ((result
 183                  (and (char? (read-char (car c2p))) ;; wait for child to do its thing
 184                       (catch 'system-error
 185                         (lambda ()
 186                           (write-char #\x port)
 187                           (force-output port)
 188                           #f)
 189                         (lambda (key name fmt args errno-list)
 190                           (= (car errno-list) EPIPE))))))
 191             ;; Now close our reading end of the pipe.  This should give
 192             ;; the child a broken pipe and so allow it to exit.
 193             (close-port (car c2p))
 194             (close-pipe port)
 195             result))))))
 196
 197  ;;
 198  ;; close-pipe
 199  ;;
 200
 201  (with-test-prefix "close-pipe"
 202
 203    (pass-if-exception "no args" exception:wrong-num-args
 204      (close-pipe))
 205
 206    (pass-if "exit 0"
 207      (let ((st (close-pipe (open-output-pipe "exit 0"))))
 208        (and (status:exit-val st)
 209             (= 0 (status:exit-val st)))))
 210
 211    (pass-if "exit 1"
 212      (let ((st (close-pipe (open-output-pipe "exit 1"))))
 213        (and (status:exit-val st)
 214             (= 1 (status:exit-val st)))))))