1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
;;;; -*- Mode: LISP; Base: 10; Syntax: ANSI-Common-lisp; Package: TRIVIAL-GRAY-STREAMS-TEST -*-
(in-package :trivial-gray-streams-test)
;;; assert-invoked - a tool to check that specified method with parameters has
;;; been invoked during execution of a code body
(define-condition invoked ()
((method :type (or symbol cons) ;; cons is for (setf method)
:accessor method
:initarg :method
:initform (error ":method is required"))
(args :type list
:accessor args
:initarg :args
:initform nil)))
(defun assert-invoked-impl (method args body-fn)
(let ((expected-invocation (cons method args))
(actual-invocations nil))
(handler-bind ((invoked (lambda (i)
(let ((invocation (cons (method i) (args i))))
(when (equalp invocation expected-invocation)
(return-from assert-invoked-impl nil))
(push invocation actual-invocations)))))
(funcall body-fn))
(let ((*package* (find-package :keyword))) ; ensures package prefixes are printed
(error "expected invocation: ~(~S~) actual: ~{~(~S~)~^, ~}"
expected-invocation (reverse actual-invocations)))))
(defmacro assert-invoked ((method &rest args) &body body)
"If during execution of the BODY the specified METHOD with ARGS
hasn't been invoked, signals an ERROR."
`(assert-invoked-impl (quote ,method) (list ,@args) (lambda () ,@body)))
(defun invoked (method &rest args)
(signal 'invoked :method method :args args))
;;; The tests.
#|
We will define a gray stream class, specialise
the gray generic function methods on it and test that the methods
are invoked when we call functions from common-lisp package
on that stream.
Some of the gray generic functions are only invoked by default
methods of other generic functions:
cl:format ~t or cl:pprint -> stream-advance-to-column -> stream-line-column
stream-write-char
cl:fresh-line -> stream-fresh-line -> stream-start-line-p -> stream-line-column
stream-terpri
If we define our methods for stream-advance-to-column and stream-fresh-line,
then stream-start-line-p, stream-terpri, stram-line-column are not invoked.
Therefore we define another gray stream class. The first class is used
for all lower level functions (stream-terpri). The second class
is used to test methods for higher level functions (stream-fresh-line).
|#
(defclass test-stream (fundamental-binary-input-stream
fundamental-binary-output-stream
fundamental-character-input-stream
fundamental-character-output-stream)
())
(defclass test-stream2 (test-stream) ())
(defmethod stream-read-char ((stream test-stream))
(invoked 'stream-read-char stream))
(defmethod stream-unread-char ((stream test-stream) char)
(invoked 'stream-unread-char stream char))
(defmethod stream-read-char-no-hang ((stream test-stream))
(invoked 'stream-read-char-no-hang stream))
(defmethod stream-peek-char ((stream test-stream))
(invoked 'stream-peek-char stream))
(defmethod stream-listen ((stream test-stream))
(invoked 'stream-listen stream))
(defmethod stream-read-line ((stream test-stream))
(invoked 'stream-read-line stream))
(defmethod stream-clear-input ((stream test-stream))
(invoked 'stream-clear-input stream))
(defmethod stream-write-char ((stream test-stream) char)
(invoked 'stream-write-char stream char))
(defmethod stream-line-column ((stream test-stream))
(invoked 'stream-line-column stream))
(defmethod stream-start-line-p ((stream test-stream))
(invoked 'stream-start-line-p stream))
(defmethod stream-write-string ((stream test-stream) string &optional start end)
(invoked 'stream-write-string stream string start end))
(defmethod stream-terpri ((stream test-stream))
(invoked 'stream-terpri stream))
(defmethod stream-fresh-line ((stream test-stream2))
(invoked 'stream-fresh-line stream))
(defmethod stream-finish-output ((stream test-stream))
(invoked 'stream-finish-output stream))
(defmethod stream-force-output ((stream test-stream))
(invoked 'stream-force-output stream))
(defmethod stream-clear-output ((stream test-stream))
(invoked 'stream-clear-output stream))
(defmethod stream-advance-to-column ((stream test-stream2) column)
(invoked 'stream-advance-to-column stream column))
(defmethod stream-read-byte ((stream test-stream))
(invoked 'stream-read-byte stream))
(defmethod stream-write-byte ((stream test-stream) byte)
(invoked 'stream-write-byte stream byte))
(defmethod stream-read-sequence ((s test-stream) seq start end &key)
(invoked 'stream-read-sequence s seq :start start :end end))
(defmethod stream-write-sequence ((s test-stream) seq start end &key)
(invoked 'stream-write-sequence s seq :start start :end end))
(defmethod stream-file-position ((s test-stream))
(invoked 'stream-file-position s))
(defmethod (setf stream-file-position) (newval (s test-stream))
(invoked '(setf stream-file-position) newval s))
;; Convinience macro, used when we want to name
;; the test case with the same name as of the gray streams method we test.
(defmacro test-invoked ((method &rest args) &body body)
`(test (,method)
(assert-invoked (,method ,@args)
,@body)))
(defun run-tests ()
(let ((s (make-instance 'test-stream))
(s2 (make-instance 'test-stream2)))
(list
(test-invoked (stream-read-char s)
(read-char s))
(test-invoked (stream-unread-char s #\a)
(unread-char #\a s))
(test-invoked (stream-read-char-no-hang s)
(read-char-no-hang s))
(test-invoked (stream-peek-char s)
(peek-char nil s))
(test-invoked (stream-listen s)
(listen s))
(test-invoked (stream-read-line s)
(read-line s))
(test-invoked (stream-clear-input s)
(clear-input s))
(test-invoked (stream-write-char s #\b)
(write-char #\b s))
(test-invoked (stream-line-column s)
(format s "~10,t"))
(test-invoked (stream-start-line-p s)
(fresh-line s))
(test-invoked (stream-write-string s "hello" 1 4)
(write-string "hello" s :start 1 :end 4))
(test-invoked (stream-terpri s)
(fresh-line s))
(test-invoked (stream-fresh-line s2)
(fresh-line s2))
(test-invoked (stream-finish-output s)
(finish-output s))
(test-invoked (stream-force-output s)
(force-output s))
(test-invoked (stream-clear-output s)
(clear-output s))
(test-invoked (stream-advance-to-column s2 10)
(format s2 "~10,t"))
(test-invoked (stream-read-byte s)
(read-byte s))
(test-invoked (stream-write-byte s 1)
(write-byte 1 s))
;;; extensions
(let ((seq (vector 1 2)))
(test-invoked (stream-read-sequence s seq :start 0 :end 1)
(read-sequence seq s :start 0 :end 1))
(test-invoked (stream-write-sequence s seq :start 0 :end 1)
(write-sequence seq s :start 0 :end 1)))
(test-invoked (stream-file-position s)
(file-position s))
(test (setf-stream-file-position)
(assert-invoked ((setf stream-file-position) 9 s)
(file-position s 9))))))
(defun failed-tests (results)
(remove-if-not #'failed-p results))
(defun failed-test-names (results)
(mapcar (lambda (result)
(string-downcase (name result)))
(failed-tests results)))
#|
(failed-test-names (run-tests))
(setf *allow-debugger* nil))
|#
|
