File: racket-tests.el

package info (click to toggle)
racket-mode 20250711~git.8a80578-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,024 kB
  • sloc: lisp: 17,215; makefile: 106
file content (768 lines) | stat: -rw-r--r-- 30,184 bytes parent folder | download
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
;;; racket-tests.el -*- lexical-binding: t; -*-

;; Copyright (c) 2013-2025 by Greg Hendershott.

;; SPDX-License-Identifier: GPL-3.0-or-later

(require 'ert)
(require 'compile)
(require 'cl-macs)
(require 'edmacro)
(require 'faceup)
(require 'paredit)
(require 'racket-mode)
(require 'racket-hash-lang)
(require 'racket-xp)
(require 'racket-cmd)
(require 'racket-repl)
(require 'racket-edit)
(require 'racket-debug)
(require 'racket-xp)
(require 'racket-common)
(require 'racket-custom)
(require 'racket-repl)
(require 'racket-smart-open)
(require 'racket-stepper)

(defconst racket-tests/here-dir (faceup-this-file-directory)
  "The directory this file is located in.")

;;; Utility functions for "integration" testing

(defconst buildd-env-p (getenv "DEBIAN_BUILDD")
  "Is there an environment variable saying we're running on Debian buildd?")

(defconst ci-env-p (getenv "CI")
  "Is there an environment variable saying we're running on CI?

By convention, most CI systems like Travis CI or GitHub Actions
set this, as well as perhaps setting their own env var.")

(defconst racket-tests/timeout
  (cond (buildd-env-p 1800)
        (ci-env-p       60)
        (t              10))
  "Because some of these integration tests await the result of
asynchronous command responses from the back end, it is possible
they might wait indefinitely. So we impose a timeout, used
primarily in `racket-tests/call-until-true'. By default, when
running tests locally, we prefer a shorter timeout. We use a
longer timeout in CI environments, which are likely to be slower.")

(defconst ci-p (or buildd-env-p ci-env-p)
  "Running under conditions for which we might want to disable some tests?")

(defun racket-tests/type (typing)
  (let ((blink-matching-paren nil)) ;suppress "Matches " messages
    (execute-kbd-macro (string-to-vector typing))
    (redisplay)))

(defun racket-tests/press (binding)
  (racket-tests/type (edmacro-parse-keys binding)))

(defun racket-tests/type&press (typing binding)
  (racket-tests/type typing)
  (racket-tests/press binding))

(defun racket-tests/call-until-true (thunk)
  (with-timeout (racket-tests/timeout nil)
    (while (not (funcall thunk))
      (accept-process-output)
      (sit-for 0.25))
    t))

(defmacro racket-tests/should-eventually (expr)
  `(progn
     (racket-tests/call-until-true (lambda () ,expr))
     (should ,expr)))

(defun racket-tests/see-back-rx (rx)
  (racket-tests/call-until-true
   (lambda () (looking-back rx (point-min)))))

(defun racket-tests/see-forward-rx (rx)
  (racket-tests/call-until-true
   (lambda () (looking-at-p rx))))

(defun racket-tests/see-back (str)
  (racket-tests/see-back-rx (regexp-quote str)))

(defun racket-tests/see-forward (str)
  (racket-tests/see-forward-rx (regexp-quote str)))

(defun racket-tests/see-char-property (pos name val)
  (racket-tests/call-until-true
   (lambda () (equal (get-char-property pos name) val))))

(defun racket-tests/explain-see (_str &optional _dir)
  `(actual . ,(buffer-substring-no-properties
               (point-min)
               (point))))

(dolist (sym '(racket-tests/see-back-rx
               racket-tests/see-forward-rx
               racket-tests/see-back
               racket-tests/see-forward))
  (put sym 'ert-explainer #'racket-tests/explain-see))

(defun racket-tests/call-with-back-end-settings (thunk)
  (let ((racket-command-timeout racket-tests/timeout))
    (unwind-protect
        (funcall thunk)
      (racket-stop-back-end))))

(defmacro racket-tests/with-back-end-settings (&rest body)
  (declare (indent 0) (debug t))
  `(racket-tests/call-with-back-end-settings (lambda () ,@body)))

;;; REPL

(ert-deftest racket-tests/repl ()
  "Exercise `racket-repl' command."
  (message "racket-tests/repl")
  (racket-tests/with-back-end-settings
   (racket-repl)
   (should (get-buffer (find-file-noselect racket-repl-command-file)))
   (with-current-buffer (find-file-noselect racket-repl-command-file)
     (with-racket-repl-buffer
       (should
        (racket-tests/see-back-rx
         (rx "Starting back end...\n"
             "Welcome to Racket v" (+ (any hex ".-")) (? " [" (or "bc" "cs") "]") ".\n"
             (? "Warning: GUI programs might not work correctly because\n"
                "your version of Racket lacks `current-get-interaction-evt`,\n"
                "which was added in Racket 8.4.\n")
             "————— run repl.rkt —————\n"
             "repl.rkt> ")))

       ;; Completion
       (racket-tests/should-eventually (member "current-output-port"
                                               racket--repl-namespace-symbols))
       (racket-tests/type "current-out")
       (completion-at-point)
       (should (racket-tests/see-back "current-output-port"))
       (racket-tests/press "RET")
       (should (racket-tests/see-back "#<procedure:current-output-port>\nrepl.rkt> "))

       ;; Multiline expression indent
       (racket-tests/type&press "(if 1" "C-j")
       (should (racket-tests/see-back "(if 1\n              "))
       (racket-tests/type&press "2" "C-j")
       (should (racket-tests/see-back "2\n              "))
       (racket-tests/type&press "3)" "RET")
       (should (racket-tests/see-back "3)\n2\nrepl.rkt> "))

       ;; Multiple expressions at one prompt should produce multiple
       ;; values, one per line.
       (racket-tests/type&press "1 2 3" "RET")
       (should (racket-tests/see-back "1\n2\n3\nrepl.rkt> "))
       (racket-tests/type&press "(+ 1) (+ 2) (+ 3)" "RET")
       (should (racket-tests/see-back "1\n2\n3\nrepl.rkt> "))
       (racket-tests/type&press "\"1\" '2 #(3)" "RET")
       (should (racket-tests/see-back "\"1\"\n2\n'#(3)\nrepl.rkt> "))

       ;; A trailing space should not cause a hang until another
       ;; expression is entered.
       (racket-tests/type&press "1 " "RET")
       (should (racket-tests/see-back "1\nrepl.rkt> "))

       ;; `racket-smart-open-bracket-mode'.
       ;;
       ;; For `paredit-mode' we test using the configuration we
       ;; document in doc/racket-mode.org; see #647.
       (dolist (k '("RET" "C-m" "C-j"))
         (define-key paredit-mode-map (kbd k) nil))
       (let ((typing   "[cond [[values 1] #t] [else #f]]")
             (expected "(cond [(values 1) #t] [else #f])\n#t\nrepl.rkt> "))
         (mapc (lambda (modes)
                 (racket-smart-open-bracket-mode -1)
                 (electric-pair-mode (if (car modes) 1 -1))
                 (if (cdr modes) (enable-paredit-mode) (disable-paredit-mode))
                 ;; Enable /after/ enabling other mode, as our doc
                 ;; string tells users to do.
                 (racket-smart-open-bracket-mode 1)
                 (racket-tests/type&press typing "RET")
                 (should (racket-tests/see-back expected)))
               (list (cons t   nil)       ;just `electric-pair-mode'
                     (cons nil t)         ;just `paredit-mode'
                     (cons nil nil))))    ;neither/plain

       ;; Exit
       (racket-tests/type&press "(exit)" "RET")
       (should (racket-tests/see-back
                "REPL session ended\n"))
       (kill-buffer)))))

;;; Multi REPLs

(ert-deftest racket-test/unique-repls ()
  "Exercise one unique REPL per racket-mode buffer.
Create file a.rkt with (define a \"a\") -- and so on for b.rkt,
c.rkt. Visit each file, racket-run, and check as expected."
  (message "racket-test/unique-repls")
  (racket-tests/with-back-end-settings
    (let* ((racket-repl-buffer-name-function #'racket-repl-buffer-name-unique)
           (names '("a" "b" "c"))
           (rkt-buffers (dolist (name names)
                          (let ((file (make-temp-file name nil ".rkt"))
                                (code (format "#lang racket/base\n(define %s \"%s\")\n"
                                              name name)))
                            (write-region code nil file nil 'no-wrote-file-message)
                            (find-file file)
                            (current-buffer)))))
      (dolist (rkt-buffer rkt-buffers)
        (let* ((var (with-current-buffer rkt-buffer
                      (goto-char 27)
                      (buffer-substring-no-properties (point) (1+ (point)))))
               (val (concat ?\" var ?\")))
          (with-current-buffer rkt-buffer
            (should (equal racket-repl-buffer-name
                           (racket-repl-buffer-name-unique)))
            (racket-run))
          (with-racket-repl-buffer
            (should (equal (buffer-name)
                           (with-current-buffer rkt-buffer
                             (racket-repl-buffer-name-unique))))
            (racket-tests/type&press var "RET")
            (should (racket-tests/see-back (concat val
                                                   ?\n
                                                   var ".rkt> ")))
            (kill-buffer)))
        (delete-file (buffer-file-name))
        (kill-buffer)))))

;;; Run

(ert-deftest racket-tests/run ()
  "Start the REPL via a racket-run command."
  (message "racket-tests/run")
  (dolist (edit-mode (list #'racket-mode #'racket-hash-lang-mode))
    (racket-tests/with-back-end-settings
     (let* ((path (make-temp-file "test" nil ".rkt"))
            (name (file-name-nondirectory path))
            (code "#lang racket/base\n(define foobar 42)\nfoobar\n"))
       (write-region code nil path nil 'no-wrote-file-message)
       (find-file path)
       (funcall edit-mode)
       ;; On older Rackets racket-hash-lang-mode may fail gracefully
       ;; down to prog-mode, but only eventually, after back end
       ;; responds.
       (racket-tests/should-eventually
        (cl-case major-mode
          ((racket-hash-lang-mode) (not buffer-read-only)) ;keep waiting
          ((racket-mode prog-mode) t)))
       (unless (eq major-mode 'prog-mode)
         (racket-run)
         (racket-tests/should-eventually (racket--repl-session-id))
         (with-racket-repl-buffer
           (should (racket-tests/see-back (concat "\n" name "> ")))
           (racket-repl-exit)
           (should (racket-tests/see-back
                    "REPL session ended\n"))
           (kill-buffer)))
       (kill-buffer)
       (delete-file path)))))

;;; Profile

(ert-deftest racket-tests/profile ()
  "Exercise `racket-profile'."
  (skip-unless (not ci-p))
  (message "racket-tests/profile")
  (racket-tests/with-back-end-settings
    (let* ((path (make-temp-file "test" nil ".rkt"))
           (name (file-name-nondirectory path))
           (code "#lang racket/base\n(define foobar 42)\nfoobar\n"))
      (write-region code nil path nil 'no-wrote-file-message)
      (find-file path)
      (racket-tests/should-eventually (equal buffer-file-name path))
      (racket-tests/should-eventually (equal major-mode 'racket-mode))
      ;; Capture racket-repl-buffer-name from the `racket-mode' buffer,
      ;; before `racket-profile' protentially creates/displays/selects
      ;; the `racket-profile-mode' buffer.
      (let ((repl-name racket-repl-buffer-name))
        (racket-profile)
        (racket-tests/should-eventually (get-buffer repl-name))
        (with-current-buffer repl-name
          (racket-tests/should-eventually
           (racket-tests/see-back (concat "\n" name "> "))))

        (racket-tests/should-eventually (get-buffer "*Racket Profile </>*"))
        (with-current-buffer (get-buffer "*Racket Profile </>*")
          (racket-tests/should-eventually (eq major-mode 'racket-profile-mode))
          (kill-buffer))

        (with-current-buffer repl-name
          (racket-repl-exit)
          (should (racket-tests/see-back
                   "REPL session ended\n"))
          (kill-buffer))
        (kill-buffer)
        (delete-file path)))))

;;; racket-xp-mode

(ert-deftest racket-tests/xp ()
  (message "racket-tests/xp")
  (racket-tests/with-back-end-settings
    (let* ((path (make-temp-file "test" nil ".rkt"))
           (code "#lang racket/base\n(define foobar 42)\nfoobar\n"))
      (write-region code nil path nil 'no-wrote-file-message)
      (find-file path)
      ;; In case running test interactively in Emacs where the config
      ;; loads `racket-xp-mode' automatically, disable it first.
      (racket-xp-mode 0)
      (racket-xp-mode 1)
      (should racket-xp-mode)
      (racket-tests/should-eventually
       (progn (goto-char (point-min))
              (racket-xp-next-definition)
              (looking-at-p (regexp-quote "racket/base"))))
      (racket-xp-next-definition)
      (should (racket-tests/see-forward "foobar"))
      (should (equal (get-text-property (point) 'help-echo) "1 bound occurrence"))
      (racket-xp-next-use)
      (should (racket-tests/see-forward "foobar"))
      (should (equal (get-text-property (point) 'help-echo) "defined locally"))
      (goto-char (point-max))
      (insert "foo")
      (completion-at-point)
      (should (racket-tests/see-back "foobar"))
      (racket-xp-mode 0)
      (kill-buffer)
      (delete-file path))))

;;; Debugger

(ert-deftest racket-tests/debugger ()
  (message "racket-tests/debugger")
  (dolist (edit-mode (list #'racket-mode #'racket-hash-lang-mode))
    (racket-tests/with-back-end-settings
     (let* ((path (make-temp-file "test" nil ".rkt"))
            (name (file-name-nondirectory path))
            (code "#lang racket/base\n(define (f x) (+ 1 x))\n(f 41)\n"))
       (write-region code nil path nil 'no-wrote-file-message)
       (find-file path)
       (funcall edit-mode)
       ;; On older Rackets racket-hash-lang-mode may fail gracefully
       ;; down to prog-mode, but only eventually, after back end
       ;; responds.
       (racket-tests/should-eventually
        (cl-case major-mode
          ((racket-hash-lang-mode) (not buffer-read-only)) ;keep waiting
          ((racket-mode prog-mode) t)))
       (unless (eq major-mode 'prog-mode)
         (racket-run `(16))
         (racket-tests/should-eventually (get-buffer racket-repl-buffer-name))
         (racket-tests/should-eventually (racket--repl-session-id))
         (racket-tests/should-eventually racket-debug-mode)

         (with-racket-repl-buffer
           (should (racket-tests/see-back (concat "\n[" name ":42]> ")))) ;debugger prompt
         (should (racket-tests/see-char-property (point) 'face
                                                 racket-debug-break-face))

         (racket-debug-step)
         (with-racket-repl-buffer
           (should (racket-tests/see-back (concat "\n[" name ":33]> "))))
         (should (racket-tests/see-char-property (point) 'face
                                                 racket-debug-break-face))
         (should (racket-tests/see-char-property  (- (point) 3) 'after-string
                                                  (propertize "41" 'face racket-debug-locals-face)))

         (racket-debug-step)
         (with-racket-repl-buffer
           (should (racket-tests/see-back (concat "\n[" name ":47]> "))))
         (should (racket-tests/see-char-property  (point) 'after-string
                                                  (propertize "⇒ (values 42)" 'face racket-debug-result-face)))

         (racket-debug-step)              ;no more debug breaks left
         (with-racket-repl-buffer
           (should (racket-tests/see-back (concat "\n" name "> "))))
         (should (racket-tests/see-char-property (point) 'after-string
                                                 nil))
         (should-not racket-debug-mode)
         (with-racket-repl-buffer
           (racket-repl-exit)
           (should (racket-tests/see-back
                    "REPL session ended\n"))
           (kill-buffer)))
       (kill-buffer)
       (delete-file path)))))

;;; For both "shallow" and "deep" macro stepper tests

;;; Macro stepper: File "shallow"

(defconst racket-tests/expand-mod-name "foo")

(defconst racket-tests/expand-shallow-0
  "«:button:racket-expand-hiding»: standard

«f:Original»
(module foo racket/base (#%module-begin (define x 42) x))

")

(defconst racket-tests/expand-shallow-1
  "«:button:racket-expand-hiding»: standard

«f:Original»
(module foo racket/base (#%module-begin (define x 42) x))

«f:Final»
(module foo racket/base (#%module-begin (define x 42) x))
")

(ert-deftest racket-tests/expand-file-shallow ()
  (message "racket-tests/expand-file-shallow")
  (racket-tests/with-back-end-settings
    (let* ((dir  (make-temp-file "test" t))
           (path (concat dir "/" racket-tests/expand-mod-name ".rkt"))
           (code "#lang racket/base\n(define x 42)\nx"))
      (write-region code nil path nil 'no-wrote-file-message)
      (find-file path)
      (let ((racket-expand-hiding 'standard))
        (racket-expand-file))
      (set-buffer "*Racket Stepper </>*")
      (should (eq major-mode 'racket-stepper-mode))
      (should (equal header-line-format "Press RET to step. C-u RET to step all. C-h m to see help."))
      (racket-tests/should-eventually
       (faceup-test-font-lock-buffer nil racket-tests/expand-shallow-0))
      (racket-tests/press "RET")
      (racket-tests/should-eventually
       (faceup-test-font-lock-buffer nil racket-tests/expand-shallow-1))
      (kill-buffer)
      (delete-file path))))

;;; Macro stepper: File "deep"

(defconst racket-tests/expand-deep-0
  "«f:macro hiding disabled by command prefix»

«f:Original»
(module foo racket/base (#%module-begin (define x 42) x))

")

(defconst racket-tests/expand-deep-1
  "«f:macro hiding disabled by command prefix»

«f:Original»
(module foo racket/base (#%module-begin (define x 42) x))

«f:1: Macro transformation»
«x:@@ -1 +1,9 @@»
«:diff-removed:-(module foo racket/base (#%module-begin (define x 42) x))»
«:diff-added:+(module foo racket/base»
«:diff-added:+  (printing:module-begin:1»
«:diff-added:+   (module:1»
«:diff-added:+    configure-runtime:1»
«:diff-added:+    '#%kernel:1»
«:diff-added:+    (#%require:1 racket/runtime-config:1)»
«:diff-added:+    (configure:1 #f))»
«:diff-added:+   (define x 42)»
«:diff-added:+   x))»

")

(defconst racket-tests/expand-deep-2
  "«f:macro hiding disabled by command prefix»

«f:Original»
(module foo racket/base (#%module-begin (define x 42) x))

«f:1: Macro transformation»
«x:@@ -1 +1,9 @@»
«:diff-removed:-(module foo racket/base (#%module-begin (define x 42) x))»
«:diff-added:+(module foo racket/base»
«:diff-added:+  (printing:module-begin:1»
«:diff-added:+   (module:1»
«:diff-added:+    configure-runtime:1»
«:diff-added:+    '#%kernel:1»
«:diff-added:+    (#%require:1 racket/runtime-config:1)»
«:diff-added:+    (configure:1 #f))»
«:diff-added:+   (define x 42)»
«:diff-added:+   x))»

«f:2: Macro transformation»
«x:@@ -1,9 +1,11 @@»
 (module foo racket/base
«:diff-removed:-  (printing:module-begin:1»
«:diff-removed:-   (module:1»
«:diff-removed:-    configure-runtime:1»
«:diff-removed:-    '#%kernel:1»
«:diff-removed:-    (#%require:1 racket/runtime-config:1)»
«:diff-removed:-    (configure:1 #f))»
«:diff-removed:-   (define x 42)»
«:diff-removed:-   x))»
«:diff-added:+  (#%module-begin:2»
«:diff-added:+   (do-wrapping-module-begin:2»
«:diff-added:+    print-result:2»
«:diff-added:+    (module:1»
«:diff-added:+     configure-runtime:1»
«:diff-added:+     '#%kernel:1»
«:diff-added:+     (#%require:1 racket/runtime-config:1)»
«:diff-added:+     (configure:1 #f)))»
«:diff-added:+   (do-wrapping-module-begin:2 print-result:2 (define x 42))»
«:diff-added:+   (do-wrapping-module-begin:2 print-result:2 x)))»

")

(unless (eq system-type 'windows-nt)    ;requires `diff` program
  (ert-deftest racket-tests/expand-file-deep ()
    (message "racket-tests/expand-file-deep")
    (racket-tests/with-back-end-settings
      (let* ((dir  (make-temp-file "test" t))
             (path (concat dir "/" racket-tests/expand-mod-name ".rkt"))
             (code "#lang racket/base\n(define x 42)\nx"))
        (write-region code nil path nil 'no-wrote-file-message)
        (find-file path)
        (racket-expand-file 4) ;; i.e. C-u prefix
        (set-buffer "*Racket Stepper </>*")
        (should (eq major-mode 'racket-stepper-mode))
        (should (equal header-line-format "Press RET to step. C-u RET to step all. C-h m to see help."))
        (racket-tests/should-eventually
         (faceup-test-font-lock-buffer nil racket-tests/expand-deep-0))
        (racket-tests/press "RET")
        (racket-tests/should-eventually
         (faceup-test-font-lock-buffer nil racket-tests/expand-deep-1))
        (racket-tests/press "RET")
        (racket-tests/should-eventually
         (faceup-test-font-lock-buffer nil racket-tests/expand-deep-2))
        (kill-buffer)
        (delete-file path)))))

;;; Macro stepper: Expression

(defconst racket-tests/expand-expression-original
  "«f:macro hiding disabled by command prefix»

«f:Original»
(cond ((< 1 2) #t) (else #f))

")

(defconst racket-tests/expand-expression-final
  "«f:macro hiding disabled by command prefix»

«f:Original»
(cond ((< 1 2) #t) (else #f))

«f:1: Macro transformation»
«x:@@ -1 +1 @@»
«:diff-removed:-(cond ((< 1 2) #t) (else #f))»
«:diff-added:+(if:1 (< 1 2) (let-values:1 () #t) (let-values:1 () #f))»

«f:2: Add explicit #%app»
«x:@@ -1 +1 @@»
«:diff-removed:-(if:1 (< 1 2) (let-values:1 () #t) (let-values:1 () #f))»
«:diff-added:+(if:1 (#%app < 1 2) (let-values:1 () #t) (let-values:1 () #f))»

«f:3: Macro transformation»
«x:@@ -1 +1 @@»
«:diff-removed:-(if:1 (#%app < 1 2) (let-values:1 () #t) (let-values:1 () #f))»
«:diff-added:+(if:1 (#%app:2 < 1 2) (let-values:1 () #t) (let-values:1 () #f))»

«f:4: Add explicit #%datum»
«x:@@ -1 +1 @@»
«:diff-removed:-(if:1 (#%app:2 < 1 2) (let-values:1 () #t) (let-values:1 () #f))»
«:diff-added:+(if:1 (#%app:2 < (#%datum . 1) 2) (let-values:1 () #t) (let-values:1 () #f))»

«f:5: Macro transformation»
«x:@@ -1 +1 @@»
«:diff-removed:-(if:1 (#%app:2 < (#%datum . 1) 2) (let-values:1 () #t) (let-values:1 () #f))»
«:diff-added:+(if:1 (#%app:2 < '1 2) (let-values:1 () #t) (let-values:1 () #f))»

«f:6: Add explicit #%datum»
«x:@@ -1 +1 @@»
«:diff-removed:-(if:1 (#%app:2 < '1 2) (let-values:1 () #t) (let-values:1 () #f))»
«:diff-added:+(if:1 (#%app:2 < '1 (#%datum . 2)) (let-values:1 () #t) (let-values:1 () #f))»

«f:7: Macro transformation»
«x:@@ -1 +1 @@»
«:diff-removed:-(if:1 (#%app:2 < '1 (#%datum . 2)) (let-values:1 () #t) (let-values:1 () #f))»
«:diff-added:+(if:1 (#%app:2 < '1 '2) (let-values:1 () #t) (let-values:1 () #f))»

«f:8: Add explicit #%datum»
«x:@@ -1 +1 @@»
«:diff-removed:-(if:1 (#%app:2 < '1 '2) (let-values:1 () #t) (let-values:1 () #f))»
«:diff-added:+(if:1 (#%app:2 < '1 '2) (let-values:1 () (#%datum . #t)) (let-values:1 () #f))»

«f:9: Macro transformation»
«x:@@ -1 +1 @@»
«:diff-removed:-(if:1 (#%app:2 < '1 '2) (let-values:1 () (#%datum . #t)) (let-values:1 () #f))»
«:diff-added:+(if:1 (#%app:2 < '1 '2) (let-values:1 () '#t) (let-values:1 () #f))»

«f:10: Add explicit #%datum»
«x:@@ -1 +1 @@»
«:diff-removed:-(if:1 (#%app:2 < '1 '2) (let-values:1 () '#t) (let-values:1 () #f))»
«:diff-added:+(if:1 (#%app:2 < '1 '2) (let-values:1 () '#t) (let-values:1 () (#%datum . #f)))»

«f:11: Macro transformation»
«x:@@ -1 +1 @@»
«:diff-removed:-(if:1 (#%app:2 < '1 '2) (let-values:1 () '#t) (let-values:1 () (#%datum . #f)))»
«:diff-added:+(if:1 (#%app:2 < '1 '2) (let-values:1 () '#t) (let-values:1 () '#f))»

«f:Final»
(if:1 (#%app:2 < '1 '2) (let-values:1 () '#t) (let-values:1 () '#f))
")

(unless (eq system-type 'windows-nt)    ;requires `diff` program
  (ert-deftest racket-tests/expand-expression ()
    (message "racket-tests/expand-expression")
    (racket-tests/with-back-end-settings
      (let* ((path (make-temp-file "test" nil ".rkt"))
             (name (file-name-nondirectory path))
             (code "#lang racket/base\n(cond [(< 1 2) #t] [else #f])\n"))
        (write-region code nil path nil 'no-wrote-file-message)
        (find-file path)

        (racket-run)
        (racket-tests/should-eventually (get-buffer racket-repl-buffer-name))
        (racket-tests/should-eventually (racket--repl-session-id))
        (with-racket-repl-buffer
          (should (racket-tests/see-back (concat "\n" name "> "))))

        (goto-char (point-max))         ;after the cond expression
        (racket-expand-last-sexp 4) ;; i.e. C-u prefix
        (set-buffer "*Racket Stepper </>*")
        (should (eq major-mode 'racket-stepper-mode))
        (should (equal header-line-format "Press RET to step. C-u RET to step all. C-h m to see help."))

        (racket-tests/should-eventually
         (faceup-test-font-lock-buffer nil racket-tests/expand-expression-original))

        (racket-tests/press "C-u RET")
        (racket-tests/should-eventually
         (faceup-test-font-lock-buffer nil racket-tests/expand-expression-final))

        (quit-window)
        (with-racket-repl-buffer
          (racket-repl-exit)
          (should (racket-tests/see-back
                   "REPL session ended\n"))
          (kill-buffer))

        (kill-buffer)
        (delete-file path)))))

;;; Indentation correctness

(defun racket-tests/indent-region ()
  "Indent entire current buffer, suppressing progress-reporter messages."
  (cl-letf (((symbol-function #'make-progress-reporter)   #'ignore)
            ((symbol-function #'progress-reporter-update) #'ignore)
            ((symbol-function #'progress-reporter-done)   #'ignore))
    (indent-region (point-min) (point-max))))

(defun racket-tests/same-indent (file)
  (with-current-buffer (find-file (expand-file-name file racket-tests/here-dir))
    (racket-tests/indent-region)
    (let ((ok (not (buffer-modified-p))))
      (revert-buffer t t t)  ;revert in case running ERT interactively
      ok)))

(ert-deftest racket-tests/indent-same ()
  "Indentation of example/*.rkt shouldn't change."
  (should (racket-tests/same-indent "example/example.rkt"))
  (should (racket-tests/same-indent "example/indent.rkt")))

;;; Indentation speed

;; To measure the performance of `racket-indent-line', these tests
;; call `indent-region' on some examples of unusually large files.
;; Re-indenting huge files isn't a priority use case for Racket Mode.
;; We don't even bother to supply an `indent-region-function'. Indeed
;; these tests rely on the fact that `indent-region' will therefore
;; call `racket-indent-line' for every one of the thousands of lines
;; in these files. The huge example files are just a convenient way to
;; get a large, varied amount of test data.

(defun racket-tests/indent-time (file)
  (with-current-buffer (find-file (expand-file-name file racket-tests/here-dir))
    (racket-mode)
    (let* ((start (float-time (get-internal-run-time)))
           (_ (racket-tests/indent-region))
           (finish (float-time (get-internal-run-time)))
           (dur (- finish start)))
      (message "indent %s %f seconds cpu"
               file dur)
      (revert-buffer t t t)
      dur)))

(ert-deftest racket-tests/indent-speed-1 ()
  (skip-unless (not ci-p))
  (should (< (racket-tests/indent-time "example/class-internal.rkt") 10)))

(ert-deftest racket-tests/indent-speed-2 ()
  (skip-unless (not ci-p))
  (should (< (racket-tests/indent-time "example/core.scm") 10)))

;;; Font-lock

(defun racket-tests/same-faceup (file)
  "Test that FILE is fontified as the .faceup file describes.
FILE is interpreted as relative to this source directory."
  (let ((font-lock-maximum-decoration t)
        (faceup-properties '(face syntax-table)))
    (faceup-test-font-lock-file 'racket-mode
                                (expand-file-name file racket-tests/here-dir))))

(faceup-defexplainer racket-tests/same-faceup)

(ert-deftest racket-tests/font-lock ()
  "Font-lock of example/*.rkt shouldn't change."
  (should (racket-tests/same-faceup "example/indent.rkt"))
  (should (racket-tests/same-faceup "example/example.rkt")))

;;; fill-paragraph comment issue 437

(ert-deftest racket-tests/fill-paragraph-comment ()
  (with-current-buffer (get-buffer-create "issue-437.rkt")
    (racket-mode)
    (insert ";; blah blah blah\n")
    (insert ";; blah blah blah\n")
    (forward-line -1)
    (fill-paragraph)
    (goto-char (point-max))
    (should (racket-tests/see-back
             ";; blah blah blah blah blah blah\n"))
    (kill-buffer (current-buffer))))

(ert-deftest racket-tests/cmd-read ()
  "Exercise `racket--cmd-read' with randomly generated and chunked sexprs."
  (dotimes (_ 10)
    (with-temp-buffer
      (let* ((num-top-level-sexprs 3000)
             (orig (mapcar (lambda (_)
                             (mapcar (lambda (_)
                                       (if (zerop (random 2))
                                           (random 1000)
                                         (make-string (+ 5 (random 10))
                                                      (+ ?a (random 26)))))
                                     (make-list (+ 10 (random 90)) nil)))
                           (make-list num-top-level-sexprs nil)))
             (orig-as-str (apply #'concat
                                 (mapcar (lambda (s) (concat s "\n"))
                                         (mapcar #'prin1-to-string
                                                 orig))))
             (results nil))
        ;; Simulate the process filter getting the text in arbitrary
        ;; chunks, inserting into the buffer, and calling
        ;; `racket--cmd-read' to read any available complete top-level
        ;; sexprs.
        (cl-flet ((add/read (str)
                            (goto-char (point-max))
                            (insert str)
                            (racket--cmd-read (lambda (v) (push v results)))))
          (while (< 0 (length orig-as-str))
            (let ((len (max 1 (random (length orig-as-str)))))
              (add/read (substring orig-as-str 0 len))
              (setq orig-as-str (substring orig-as-str len))))
          (setq results (reverse results))
          (should (equal orig results)))))))

(provide 'racket-tests)

;;; racket-tests.el ends here