test-run-program.script 10.1 KB
Newer Older
1
;; -*- Lisp -*-
2
(declaim (optimize (debug 3) (safety #-gcl 3 #+gcl 0)))
3

4
5
6
7
8
#+(and clisp os-windows)
(ext:without-package-lock ()
  (trace uiop:run-program uiop/run-program::%run-program uiop/run-program::%system
         ext:shell ext:run-shell-command ext:run-program))

9
10
11
12
;; On Windows, normalize away CRLF into jut the unixy LF.
(defun dewindowize (x)
  (block ()
    (setf x (remove (code-char 13) x))
13
14
    ;; Some buggy implementations output extra space on Windows;
    ;; Implementations that rely on shell redirection on Windows also do, as a limitation.
15
16
17
    (when (eql #\space (last-char x))
      (return (subseq x 0 (1- (length x)))))
    x))
18

19

20
21
22
(DBG "Testing echo ok 1 via run-program as a list")
(assert-equal "ok 1"
              (dewindowize (run-program '("echo" "ok" "1") :output '(:string :stripped t))))
23

24
(DBG "Testing echo ok 1 via run-program as a string")
25
26
(assert-equal "ok 1"
              (dewindowize (run-program "echo ok 1" :output '(:string :stripped t))))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
27

28
;;; test asdf run-shell-command function
29
(setf *verbose-out* nil)
30
(DBG "Testing true via run-shell-command")
31
(assert-equal 0 (run-shell-command "true"))
32
33
34
(DBG "Testing false via run-shell-command")
(assert-equal 1 (run-shell-command "false"))
(DBG "Testing bad shell command via run-shell-command")
35
36
(unless (< 0 (run-shell-command "./bad-shell-command"))
  (error "Failed to capture exit status indicating shell command failure."))
37

38
#+os-unix
39
40
41
(progn
  (DBG "Testing good shell command in current directory via run-shell-command")
  (unless (equal 0 (run-shell-command "./good-shell-command"))
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
    (error "Failed to capture exit status indicating shell command success."))

  ;; this test checks for a problem there was in allegro -- :output :interactive
  ;; would try to open T as a stream for INPUT.
  (assert-equal '(nil nil 0) (multiple-value-list (run-program "true" :force-shell t :output :interactive)))
  (assert-equal '(nil nil 0) (multiple-value-list (run-program "true" :force-shell nil :output :interactive)))
  (assert-equal '(nil nil 1) (multiple-value-list (run-program "false" :force-shell t :output :interactive :ignore-error-status t)))
  (assert-equal '(nil nil 1) (multiple-value-list (run-program "false" :force-shell nil :output :interactive :ignore-error-status t)))
  (assert-equal
   '("foo" "bar baz" 42)
   (multiple-value-list
    (run-program "cat ; echo bar  baz >&2 ; exit 42"
                 :input '("foo") :output :string :error-output '(:string :stripped t)
                 :ignore-error-status t)))
  (assert-equal
   '(("foo" "bar" "baz" "quux") nil 0)
   (multiple-value-list
    (run-program "echo foo ; echo bar >&2 ; echo baz ; echo quux >& 2"
                 :output :lines :error-output :output))))

62
#-(and sbcl os-windows)
63
(let ((ok1 (format nil "; $ echo ok 1~%ok 1")))
64
  (DBG "Testing awkward legacy output capture via run-shell-command")
65
  (assert-equal
66
67
68
69
70
   (dewindowize
    (stripln
     (with-output-to-string (s)
       (let ((*verbose-out* s))
         (run-shell-command "echo ~A 1" "ok")))))
71
   ok1)
72
  #-ecl
73
  (assert-equal
74
75
76
77
78
79
80
81
   (dewindowize
    (stripln
     (with-output-to-string (s)
       (let ((*verbose-out* t)
             (*standard-output* s))
         (let ((status (run-shell-command "echo ok ~D" 1)))
           (unless (zerop status)
             (error "Didn't get good exit status.")))))))
82
   ok1))
83

84
85
86
;; NB1: run-shell-command is deprecated. Use run-program instead.
;; NB2: we do NOT support stderr capture to *verbose-out* anymore in run-shell-command.
;; If you want 2>&1 redirection, you know where to find it.
87
(assert-equal '(:ok 1) (run-program "echo :ok  1" :output :forms))
88
89
90
(assert-equal "ok" (dewindowize (stripln
                                 (with-output-to-string (*standard-output*)
                                   (run-program "echo ok" :output t :error-output :output)))))
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

;;#+allegro (trace excl:run-shell-command sys:reap-os-subprocess)
;;#+lispworks (trace system:run-shell-command system:pid-exit-status)

#|
Testing run-program
|#

;; We add a newline to the end of a string and return it.
;; We do it in this specific manner so that under unix, windows and macos,
;; format will choose the correct type of newline delimiters
(defun nl (str)
  (format nil "~A~%" str))


;; Convert the input format to a string stream, read it into a string,
;; and see if they match.
(defun slurp-stream-string/check (input-string &key (test #'string=))
  (let ((input-string (format nil input-string)))
    (with-open-stream (s (make-string-input-stream input-string))
      (is (funcall test input-string (slurp-stream-string s))))))

;; Call with a bunch of strings to call the above function upon.
(defun slurp-stream-string/checks (&rest input-string-list)
  (dolist (input-string input-string-list)
    (funcall #'slurp-stream-string/check input-string)))

;; Check to see if the input-string ins converted correctly to the
;; output-form
(defun slurp-stream-lines/check (input-string output-form &key (test #'equal))
  (let ((input-string (format nil input-string)))
    (with-open-stream (s (make-string-input-stream input-string))
      (is (funcall test output-form (slurp-stream-lines s))))))

;; Check to see if the individual input/output lists passed into this
;; function are correct.
(defun slurp-stream-lines/checks (&rest control-forms)
  (dolist (form control-forms)
    (destructuring-bind (input-string output-form) form
      (funcall #'slurp-stream-lines/check input-string output-form))))

(deftest test/slurp-stream-string ()
  ;; Check to make sure the string is exactly what it is when read
  ;; back through a stream. This is a format specifier so we can
  ;; portably test newline processing.
  (slurp-stream-string/checks
   ""
   " "
   "~%"
   "~%~%"
   "~%~%~%"
   "one~%two~%three~%~%four"
   "one two three four"
   "one two~%three four")

  ;; Check some boundary cases on the types passed.
  (signals error (slurp-stream-string nil))
  (signals error (slurp-stream-string 42))
  (signals error (slurp-stream-string "not valid"))
  t)

(deftest test/slurp-stream-lines ()
  (slurp-stream-lines/checks
   ;; input-string first, then expected output-form after its parsing
   '("" nil)
   '(" " (" "))
   '("~%" (""))
   '("~%~%" ("" ""))
   '("~%~%~%" ("" "" ""))
   '("foo" ("foo"))
   '("~%foo" ("" "foo"))
   '("~%foo~%" ("" "foo")) ; consumes last newline!
   '("one~%two~%~%three" ("one" "two" "" "three"))
   '("one~%two~%~%three~%" ("one" "two" "" "three"))
   '("one two three four" ("one two three four"))
   '("one two~%three four~%" ("one two" "three four")))

  ;; Check some boundary cases on the types passed.
  ;; NOTE: NIL is ok since it means read from stdin!
  (signals error (slurp-stream-lines 42))
  (signals error (slurp-stream-lines "not valid"))
  t)

(defun common-test/run-program ()
  ;; Can we echo a simple string?
176
177
  (assert-equal '("abcde") (run-program '("echo" "abcde") :output :lines))
  (assert-equal (nl "fghij") (run-program '("echo" "fghij") :output :string))
178
179

  ;; Are spaces handled properly?
180
181
182
  (assert-equal '("Hello World") (run-program '("echo" "Hello World") :output :lines))
  (assert-equal (nl "Hello World") (run-program '("echo" "Hello World") :output :string))
  (assert-equal (nl "Hello World") (run-program "echo Hello World" :output :string))
183
184
185
186
187
188
189

  ;; Test that run-program fails properly with an
  ;; empty program string
  #+(or clozure (and allegro os-unix) cmu (and lispworks os-unix) sbcl scl)
  (signals error (run-program '("") :output :lines))

  ;; An empty string itself is ok since it is passed to the shell.
190
  (assert-equal "" (run-program "" :output :string))
191
192
193
194
195
196
197
198
199
200
201

  ;; Test that run-program fails properly with a
  ;; nil program list
  #+(or clozure (and allegro os-unix) cmu sbcl scl)
  (signals error (run-program nil :output :lines))

  ;; Test that run-program fails properly when the
  ;; executable doesn't exist.
  (signals error (run-program '("does-not-exist") :output :lines))
  (signals error (run-program "does-not-exist" :output :lines))

202
203
  (assert-equal '(nil nil 0) (multiple-value-list (run-program "echo ok" :output nil)))
  (assert-equal '(nil nil 0) (multiple-value-list (run-program '("echo" "ok") :output nil)))
204
205
206
207
208
  t)


(defun unix-only-test/run-program ()

209
  (assert-equal '("ok 1") (run-program "echo ok  1" :output :lines))
210
211
  (assert-equal '("ok  1") (run-program '("echo" "ok  1") :output :lines))
  (assert-equal "ok  1" (run-program '("echo" "ok  1") :output '(:string :stripped t)))
212

213
  (assert-equal '(nil nil 0) (multiple-value-list (run-program "true")))
214
  (signals subprocess-error (run-program "false"))
215
  (assert-equal '(nil nil 1) (multiple-value-list (run-program "false" :ignore-error-status t)))
216
217
218
219

  (let ((tf (native-namestring (test-source "test-file"))))

    ;; a basic smoke test
220
    (assert-equal '("Single")
221
                  (run-program `("grep" "Single" ,tf) :output :lines))
222
223

    ;; Make sure space is handled correctly
224
    (assert-equal '("double entry")
225
                  (run-program `("grep" "double entry" ,tf) :output :lines))
226
227

    ;; Make sure space is handled correctly
228
    (assert-equal '("triple word entry")
229
                  (run-program `("grep" "triple word entry" ,tf) :output :lines))
230
231
232
233

    ;; Testing special characters
    (loop :for char :across "+-_.,%@:/\\!&*(){}"
      :for str = (string char) :do
234
235
236
237
        (assert-equal (list (format nil "escape ~A" str))
                      (run-program
                       `("grep" ,(format nil "[~A]" str) ,tf)
                       :output :lines)))
238
239
240

    ;; Test that run-program signals an error
    ;; with an executable that doesn't return 0
241
    (signals subprocess-error (run-program '("false") :output :lines))
242
243

    ;; Test that we can suppress the error on run-program
244
    (is (null (run-program '("false")
245
246
247
248
249
250
                            :output :lines :ignore-error-status t))))
  t)

(defun windows-only-test/run-program ()

  ;; a basic smoke test
251
  (assert-equal "ok" (dewindowize (run-program '("cmd" "/c" "echo" "ok") :output :line)))
252
  (assert-equal "ok 1" (dewindowize (run-program "echo ok 1" :output :line)))
253
  ;; clozure: beware http://trac.clozure.com/ccl/ticket/1118
254
255

  t)
256
257
258
259
260
261
262
263
264
265
266

(deftest test/run-program ()
  #+os-unix (common-test/run-program)
  #+os-unix (unix-only-test/run-program)
  #+os-windows (windows-only-test/run-program)
  (terpri)
  t)


(test/run-program)