Commit | Line | Data |
---|---|---|
c0cd1b3e | 1 | ;;; GNU Guix --- Functional package management for GNU |
9562a2eb | 2 | ;;; Copyright © 2012, 2013, 2014, 2015, 2016, 2018, 2019, 2020, 2021 Ludovic Courtès <ludo@gnu.org> |
c0cd1b3e LC |
3 | ;;; |
4 | ;;; This file is part of GNU Guix. | |
5 | ;;; | |
6 | ;;; GNU Guix is free software; you can redistribute it and/or modify it | |
7 | ;;; under the terms of the GNU General Public License as published by | |
8 | ;;; the Free Software Foundation; either version 3 of the License, or (at | |
9 | ;;; your option) any later version. | |
10 | ;;; | |
11 | ;;; GNU Guix is distributed in the hope that it will be useful, but | |
12 | ;;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | ;;; GNU General Public License for more details. | |
15 | ;;; | |
16 | ;;; You should have received a copy of the GNU General Public License | |
17 | ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>. | |
18 | ||
19 | (define-module (test-records) | |
babc2c80 | 20 | #:use-module (srfi srfi-1) |
c0cd1b3e LC |
21 | #:use-module (srfi srfi-64) |
22 | #:use-module (ice-9 match) | |
23e9a680 | 23 | #:use-module (ice-9 regex) |
c0cd1b3e LC |
24 | #:use-module (guix records)) |
25 | ||
23e9a680 LC |
26 | (define (test-module) |
27 | ;; A module in which to evaluate things that are known to fail. | |
28 | (let ((module (make-fresh-user-module))) | |
29 | (module-use! module (resolve-interface '(guix records))) | |
30 | module)) | |
31 | ||
9562a2eb LC |
32 | (define (location-alist loc) |
33 | ;; Return a location alist. In Guile < 3.0.6, LOC is always an alist, but | |
34 | ;; starting with 3.0.6, LOC is a vector (at least when it comes from | |
35 | ;; 'syntax-error' exceptions), hence this conversion. | |
36 | (match loc | |
37 | (#(file line column) | |
38 | `((line . ,line) (column . ,column) | |
39 | (filename . ,file))) | |
40 | (_ loc))) | |
41 | ||
23e9a680 | 42 | \f |
c0cd1b3e LC |
43 | (test-begin "records") |
44 | ||
45 | (test-assert "define-record-type*" | |
46 | (begin | |
47 | (define-record-type* <foo> foo make-foo | |
48 | foo? | |
49 | (bar foo-bar) | |
50 | (baz foo-baz (default (+ 40 2)))) | |
51 | (and (match (foo (bar 1) (baz 2)) | |
52 | (($ <foo> 1 2) #t)) | |
53 | (match (foo (baz 2) (bar 1)) | |
54 | (($ <foo> 1 2) #t)) | |
55 | (match (foo (bar 1)) | |
56 | (($ <foo> 1 42) #t))))) | |
57 | ||
59fbeb8c | 58 | (test-assert "define-record-type* with let* behavior" |
c0cd1b3e | 59 | ;; Make sure field initializers can refer to each other as if they were in |
59fbeb8c | 60 | ;; a 'let*'. |
c0cd1b3e LC |
61 | (begin |
62 | (define-record-type* <bar> bar make-bar | |
63 | foo? | |
64 | (x bar-x) | |
65 | (y bar-y (default (+ 40 2))) | |
66 | (z bar-z)) | |
67 | (and (match (bar (x 1) (y (+ x 1)) (z (* y 2))) | |
68 | (($ <bar> 1 2 4) #t)) | |
69 | (match (bar (x 7) (z (* x 3))) | |
6c356414 | 70 | (($ <bar> 7 42 21) #t)) |
c0cd1b3e | 71 | (match (bar (z 21) (x (/ z 3))) |
a1906758 | 72 | (($ <bar> 7 42 21) #t))))) |
c0cd1b3e LC |
73 | |
74 | (test-assert "define-record-type* & inherit" | |
75 | (begin | |
76 | (define-record-type* <foo> foo make-foo | |
77 | foo? | |
78 | (bar foo-bar) | |
79 | (baz foo-baz (default (+ 40 2)))) | |
80 | (let* ((a (foo (bar 1))) | |
81 | (b (foo (inherit a) (baz 2))) | |
82 | (c (foo (inherit b) (bar -2))) | |
83 | (d (foo (inherit c))) | |
84 | (e (foo (inherit (foo (bar 42))) (baz 77)))) | |
85 | (and (match a (($ <foo> 1 42) #t)) | |
86 | (match b (($ <foo> 1 2) #t)) | |
87 | (match c (($ <foo> -2 2) #t)) | |
88 | (equal? c d) | |
89 | (match e (($ <foo> 42 77) #t)))))) | |
90 | ||
59fbeb8c | 91 | (test-assert "define-record-type* & inherit & let* behavior" |
c0cd1b3e LC |
92 | (begin |
93 | (define-record-type* <foo> foo make-foo | |
94 | foo? | |
95 | (bar foo-bar) | |
96 | (baz foo-baz (default (+ 40 2)))) | |
97 | (let* ((a (foo (bar 77))) | |
98 | (b (foo (inherit a) (bar 1) (baz (+ bar 1)))) | |
99 | (c (foo (inherit b) (baz 2) (bar (- baz 1))))) | |
100 | (and (match a (($ <foo> 77 42) #t)) | |
101 | (match b (($ <foo> 1 2) #t)) | |
102 | (equal? b c))))) | |
103 | ||
8a16d064 LC |
104 | (test-assert "define-record-type* & inherit & innate" |
105 | (begin | |
106 | (define-record-type* <foo> foo make-foo | |
107 | foo? | |
108 | (bar foo-bar (innate) (default 42))) | |
109 | (let* ((a (foo (bar 1))) | |
110 | (b (foo (inherit a))) | |
111 | (c (foo (inherit a) (bar 3))) | |
112 | (d (foo))) | |
113 | (and (match a (($ <foo> 1) #t)) | |
114 | (match b (($ <foo> 42) #t)) | |
115 | (match c (($ <foo> 3) #t)) | |
116 | (match d (($ <foo> 42) #t)))))) | |
117 | ||
c0cd1b3e LC |
118 | (test-assert "define-record-type* & thunked" |
119 | (begin | |
120 | (define-record-type* <foo> foo make-foo | |
121 | foo? | |
122 | (bar foo-bar) | |
123 | (baz foo-baz (thunked))) | |
124 | ||
125 | (let* ((calls 0) | |
126 | (x (foo (bar 2) | |
127 | (baz (begin (set! calls (1+ calls)) 3))))) | |
128 | (and (zero? calls) | |
129 | (equal? (foo-bar x) 2) | |
130 | (equal? (foo-baz x) 3) (= 1 calls) | |
131 | (equal? (foo-baz x) 3) (= 2 calls))))) | |
132 | ||
133 | (test-assert "define-record-type* & thunked & default" | |
134 | (begin | |
135 | (define-record-type* <foo> foo make-foo | |
136 | foo? | |
137 | (bar foo-bar) | |
138 | (baz foo-baz (thunked) (default 42))) | |
139 | ||
140 | (let ((mark (make-parameter #f))) | |
141 | (let ((x (foo (bar 2) (baz (mark)))) | |
142 | (y (foo (bar 2)))) | |
143 | (and (equal? (foo-bar x) 2) | |
144 | (parameterize ((mark (cons 'a 'b))) | |
145 | (eq? (foo-baz x) (mark))) | |
146 | (equal? (foo-bar y) 2) | |
147 | (equal? (foo-baz y) 42)))))) | |
148 | ||
149 | (test-assert "define-record-type* & thunked & inherited" | |
150 | (begin | |
151 | (define-record-type* <foo> foo make-foo | |
152 | foo? | |
153 | (bar foo-bar (thunked)) | |
154 | (baz foo-baz (thunked) (default 42))) | |
155 | ||
156 | (let ((mark (make-parameter #f))) | |
157 | (let* ((x (foo (bar 2) (baz (mark)))) | |
158 | (y (foo (inherit x) (bar (mark))))) | |
159 | (and (equal? (foo-bar x) 2) | |
160 | (parameterize ((mark (cons 'a 'b))) | |
161 | (eq? (foo-baz x) (mark))) | |
162 | (parameterize ((mark (cons 'a 'b))) | |
163 | (eq? (foo-bar y) (mark))) | |
164 | (parameterize ((mark (cons 'a 'b))) | |
165 | (eq? (foo-baz y) (mark)))))))) | |
166 | ||
8a16d064 LC |
167 | (test-assert "define-record-type* & thunked & innate" |
168 | (let ((mark (make-parameter #f))) | |
169 | (define-record-type* <foo> foo make-foo | |
170 | foo? | |
171 | (bar foo-bar (thunked) (innate) (default (mark))) | |
172 | (baz foo-baz (default #f))) | |
173 | ||
174 | (let* ((x (foo (bar 42))) | |
175 | (y (foo (inherit x) (baz 'unused)))) | |
176 | (and (procedure? (struct-ref x 0)) | |
177 | (equal? (foo-bar x) 42) | |
178 | (parameterize ((mark (cons 'a 'b))) | |
179 | (eq? (foo-bar y) (mark))) | |
180 | (parameterize ((mark (cons 'a 'b))) | |
181 | (eq? (foo-bar y) (mark))))))) | |
182 | ||
abd4d6b3 LC |
183 | (test-assert "define-record-type* & thunked & this-record" |
184 | (begin | |
185 | (define-record-type* <foo> foo make-foo | |
186 | foo? | |
187 | (bar foo-bar) | |
188 | (baz foo-baz (thunked))) | |
189 | ||
190 | (let ((x (foo (bar 40) | |
191 | (baz (+ (foo-bar this-record) 2))))) | |
192 | (and (= 40 (foo-bar x)) | |
193 | (= 42 (foo-baz x)))))) | |
194 | ||
195 | (test-assert "define-record-type* & thunked & default & this-record" | |
196 | (begin | |
197 | (define-record-type* <foo> foo make-foo | |
198 | foo? | |
199 | (bar foo-bar) | |
200 | (baz foo-baz (thunked) | |
201 | (default (+ (foo-bar this-record) 2)))) | |
202 | ||
203 | (let ((x (foo (bar 40)))) | |
204 | (and (= 40 (foo-bar x)) | |
205 | (= 42 (foo-baz x)))))) | |
206 | ||
207 | (test-assert "define-record-type* & thunked & inherit & this-record" | |
208 | (begin | |
209 | (define-record-type* <foo> foo make-foo | |
210 | foo? | |
211 | (bar foo-bar) | |
212 | (baz foo-baz (thunked) | |
213 | (default (+ (foo-bar this-record) 2)))) | |
214 | ||
215 | (let* ((x (foo (bar 40))) | |
216 | (y (foo (inherit x) (bar -2))) | |
217 | (z (foo (inherit x) (baz -2)))) | |
218 | (and (= -2 (foo-bar y)) | |
219 | (= 0 (foo-baz y)) | |
220 | (= 40 (foo-bar z)) | |
221 | (= -2 (foo-baz z)))))) | |
222 | ||
d2be7e3c LC |
223 | (test-assert "define-record-type* & thunked & inherit & custom this" |
224 | (let () | |
225 | (define-record-type* <foo> foo make-foo | |
226 | foo? this-foo | |
227 | (thing foo-thing (thunked))) | |
228 | (define-record-type* <bar> bar make-bar | |
229 | bar? this-bar | |
230 | (baz bar-baz (thunked))) | |
231 | ||
232 | ;; Nest records and test the two self references. | |
233 | (let* ((x (foo (thing (bar (baz (list this-bar this-foo)))))) | |
234 | (y (foo-thing x))) | |
235 | (match (bar-baz y) | |
236 | ((first second) | |
237 | (and (eq? second x) | |
238 | (bar? first) | |
239 | (eq? first y))))))) | |
240 | ||
310b32a2 LC |
241 | (test-assert "define-record-type* & delayed" |
242 | (begin | |
243 | (define-record-type* <foo> foo make-foo | |
244 | foo? | |
245 | (bar foo-bar (delayed))) | |
246 | ||
247 | (let* ((calls 0) | |
248 | (x (foo (bar (begin (set! calls (1+ calls)) 3))))) | |
249 | (and (zero? calls) | |
250 | (equal? (foo-bar x) 3) (= 1 calls) | |
251 | (equal? (foo-bar x) 3) (= 1 calls) | |
252 | (equal? (foo-bar x) 3) (= 1 calls))))) | |
253 | ||
254 | (test-assert "define-record-type* & delayed & default" | |
255 | (let ((mark #f)) | |
256 | (define-record-type* <foo> foo make-foo | |
257 | foo? | |
258 | (bar foo-bar (delayed) (default mark))) | |
259 | ||
260 | (let ((x (foo))) | |
261 | (set! mark 42) | |
262 | (and (equal? (foo-bar x) 42) | |
263 | (begin | |
264 | (set! mark 7) | |
265 | (equal? (foo-bar x) 42)))))) | |
266 | ||
267 | (test-assert "define-record-type* & delayed & inherited" | |
268 | (begin | |
269 | (define-record-type* <foo> foo make-foo | |
270 | foo? | |
271 | (bar foo-bar (delayed)) | |
272 | (baz foo-baz (delayed))) | |
273 | ||
274 | (let* ((m 1) | |
275 | (n #f) | |
276 | (x (foo (bar m) (baz n))) | |
277 | (y (foo (inherit x) (baz 'b)))) | |
278 | (set! n 'a) | |
279 | (and (equal? (foo-bar x) 1) | |
280 | (eq? (foo-baz x) 'a) | |
281 | (begin | |
282 | (set! m 777) | |
283 | (equal? (foo-bar y) 1)) ;promise was already forced | |
284 | (eq? (foo-baz y) 'b))))) | |
285 | ||
babc2c80 LC |
286 | (test-assert "define-record-type* & wrong field specifier" |
287 | (let ((exp '(begin | |
288 | (define-record-type* <foo> foo make-foo | |
289 | foo? | |
290 | (bar foo-bar (default 42)) | |
291 | (baz foo-baz)) | |
292 | ||
293 | (foo (baz 1 2 3 4 5)))) ;syntax error | |
294 | (loc (current-source-location))) ;keep this alignment! | |
295 | (catch 'syntax-error | |
296 | (lambda () | |
297 | (eval exp (test-module)) | |
298 | #f) | |
47212fc7 | 299 | (lambda (key proc message location form subform . _) |
babc2c80 LC |
300 | (and (eq? proc 'foo) |
301 | (string-match "invalid field" message) | |
47212fc7 LC |
302 | (equal? subform '(baz 1 2 3 4 5)) |
303 | (equal? form '(foo (baz 1 2 3 4 5))) | |
babc2c80 LC |
304 | |
305 | ;; Make sure the location is that of the field specifier. | |
306 | ;; See <http://bugs.gnu.org/23969>. | |
307 | (lset= equal? | |
308 | (pk 'expected-loc | |
309 | `((line . ,(- (assq-ref loc 'line) 1)) | |
310 | ,@(alist-delete 'line loc))) | |
9562a2eb | 311 | (pk 'actual-loc (location-alist location)))))))) |
babc2c80 | 312 | |
47212fc7 LC |
313 | (test-assert "define-record-type* & wrong field specifier, identifier" |
314 | (let ((exp '(begin | |
315 | (define-record-type* <foo> foo make-foo | |
316 | foo? | |
317 | (bar foo-bar (default 42)) | |
318 | (baz foo-baz)) | |
319 | ||
320 | (foo | |
321 | baz))) ;syntax error | |
322 | (loc (current-source-location))) ;keep this alignment! | |
323 | (catch 'syntax-error | |
324 | (lambda () | |
325 | (eval exp (test-module)) | |
326 | #f) | |
327 | (lambda (key proc message location form subform . _) | |
328 | (and (eq? proc 'foo) | |
329 | (string-match "invalid field" message) | |
330 | (equal? subform 'baz) | |
331 | (equal? form '(foo baz)) | |
332 | ||
333 | ;; Here the location is that of the parent form. | |
334 | (lset= equal? | |
335 | (pk 'expected-loc | |
336 | `((line . ,(- (assq-ref loc 'line) 2)) | |
337 | ,@(alist-delete 'line loc))) | |
9562a2eb | 338 | (pk 'actual-loc (location-alist location)))))))) |
47212fc7 | 339 | |
23e9a680 LC |
340 | (test-assert "define-record-type* & missing initializers" |
341 | (catch 'syntax-error | |
342 | (lambda () | |
343 | (eval '(begin | |
344 | (define-record-type* <foo> foo make-foo | |
345 | foo? | |
346 | (bar foo-bar (default 42)) | |
347 | (baz foo-baz)) | |
348 | ||
349 | (foo)) | |
350 | (test-module)) | |
351 | #f) | |
352 | (lambda (key proc message location form . args) | |
353 | (and (eq? proc 'foo) | |
354 | (string-match "missing .*initialize.*baz" message) | |
355 | (equal? form '(foo)))))) | |
356 | ||
357 | (test-assert "define-record-type* & extra initializers" | |
358 | (catch 'syntax-error | |
359 | (lambda () | |
360 | (eval '(begin | |
361 | (define-record-type* <foo> foo make-foo | |
362 | foo? | |
363 | (bar foo-bar (default 42))) | |
364 | ||
365 | (foo (baz 'what?))) | |
366 | (test-module)) | |
367 | #f) | |
368 | (lambda (key proc message location form . args) | |
369 | (and (string-match "extra.*initializer.*baz" message) | |
370 | (eq? proc 'foo))))) | |
371 | ||
a1906758 LC |
372 | (test-assert "define-record-type* & inherit & extra initializers" |
373 | (catch 'syntax-error | |
374 | (lambda () | |
375 | (eval '(begin | |
376 | (define-record-type* <foo> foo make-foo | |
377 | foo? | |
378 | (bar foo-bar (default 42))) | |
379 | ||
380 | (foo (inherit (foo)) (baz 'what?))) | |
381 | (test-module)) | |
382 | #f) | |
383 | (lambda (key proc message location form . args) | |
384 | (and (string-match "extra.*initializer.*baz" message) | |
385 | (eq? proc 'foo))))) | |
386 | ||
c2dcff41 LC |
387 | (test-assert "define-record-type* & duplicate initializers" |
388 | (let ((exp '(begin | |
389 | (define-record-type* <foo> foo make-foo | |
390 | foo? | |
391 | (bar foo-bar (default 42))) | |
392 | ||
393 | (foo (bar 1) | |
394 | (bar 2)))) | |
395 | (loc (current-source-location))) ;keep this alignment! | |
396 | (catch 'syntax-error | |
397 | (lambda () | |
398 | (eval exp (test-module)) | |
399 | #f) | |
400 | (lambda (key proc message location form . args) | |
401 | (and (string-match "duplicate.*initializer" message) | |
402 | (eq? proc 'foo) | |
403 | ||
404 | ;; Make sure the location is that of the field specifier. | |
405 | (lset= equal? | |
406 | (pk 'expected-loc | |
407 | `((line . ,(- (assq-ref loc 'line) 1)) | |
408 | ,@(alist-delete 'line loc))) | |
9562a2eb | 409 | (pk 'actual-loc (location-alist location)))))))) |
c2dcff41 | 410 | |
7874bbbb LC |
411 | (test-assert "ABI checks" |
412 | (let ((module (test-module))) | |
413 | (eval '(begin | |
414 | (define-record-type* <foo> foo make-foo | |
415 | foo? | |
416 | (bar foo-bar (default 42))) | |
417 | ||
418 | (define (make-me-a-record) (foo))) | |
419 | module) | |
420 | (unless (eval '(foo? (make-me-a-record)) module) | |
421 | (error "what?" (eval '(make-me-a-record) module))) | |
422 | ||
423 | ;; Redefine <foo> with an additional field. | |
424 | (eval '(define-record-type* <foo> foo make-foo | |
425 | foo? | |
426 | (baz foo-baz) | |
427 | (bar foo-bar (default 42))) | |
428 | module) | |
429 | ||
430 | ;; Now 'make-me-a-record' is out of sync because it does an | |
431 | ;; 'allocate-struct' that corresponds to the previous definition of <foo>. | |
432 | (catch 'record-abi-mismatch-error | |
433 | (lambda () | |
434 | (eval '(foo? (make-me-a-record)) module) | |
435 | #f) | |
8e1395be LC |
436 | (match-lambda* |
437 | ((key 'abi-check (? string? message) (rtd) . _) | |
438 | (eq? rtd (eval '<foo> module))))))) | |
7874bbbb | 439 | |
fdc1bf65 LC |
440 | (test-equal "recutils->alist" |
441 | '((("Name" . "foo") | |
442 | ("Version" . "0.1") | |
443 | ("Synopsis" . "foo bar") | |
444 | ("Something_else" . "chbouib")) | |
445 | (("Name" . "bar") | |
446 | ("Version" . "1.5"))) | |
b7b88288 LC |
447 | (let ((p (open-input-string " |
448 | # Comment following an empty line, and | |
449 | # preceding a couple of empty lines, all of | |
450 | # which should be silently consumed. | |
451 | ||
452 | ||
453 | Name: foo | |
fdc1bf65 | 454 | Version: 0.1 |
b7b88288 LC |
455 | # Comment right in the middle, |
456 | # spanning two lines. | |
fdc1bf65 LC |
457 | Synopsis: foo bar |
458 | Something_else: chbouib | |
459 | ||
b7b88288 | 460 | # Comment right before. |
fdc1bf65 | 461 | Name: bar |
b7b88288 LC |
462 | Version: 1.5 |
463 | # Comment at the end."))) | |
fdc1bf65 LC |
464 | (list (recutils->alist p) |
465 | (recutils->alist p)))) | |
466 | ||
836d10f1 LC |
467 | (test-equal "recutils->alist with + lines" |
468 | '(("Name" . "foo") | |
469 | ("Description" . "1st line,\n2nd line,\n 3rd line with extra space,\n4th line without space.")) | |
470 | (recutils->alist (open-input-string " | |
471 | Name: foo | |
472 | Description: 1st line, | |
473 | + 2nd line, | |
474 | + 3rd line with extra space, | |
475 | +4th line without space."))) | |
476 | ||
c8772a7a LC |
477 | (test-equal "alist->record" '((1 2) b c) |
478 | (alist->record '(("a" . 1) ("b" . b) ("c" . c) ("a" . 2)) | |
479 | list | |
480 | '("a" "b" "c") | |
481 | '("a"))) | |
482 | ||
c0cd1b3e | 483 | (test-end) |