File: test-automatic-checking.el

package info (click to toggle)
flycheck 36.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,600 kB
  • sloc: lisp: 16,210; python: 718; makefile: 219; cpp: 24; ruby: 23; perl: 21; ada: 17; f90: 16; haskell: 15; javascript: 15; sh: 14; erlang: 14; xml: 14; ansic: 12; php: 9; tcl: 8; fortran: 3; vhdl: 2; awk: 1; sql: 1
file content (323 lines) | stat: -rw-r--r-- 13,990 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
;;; test-automatic-checking.el --- Flycheck Specs: Automatic Checking -*- lexical-binding: t; -*-

;;; Code:

(require 'flycheck-buttercup)
(require 'test-helpers)

(describe "Automatic syntax checking"

  (describe "flycheck-may-check-automatically"

    (it "not in ephemeral buffers"
      (flycheck-buttercup-with-temp-buffer
        (expect (seq-find #'flycheck-may-check-automatically
                          '(save idle-change new-line mode-enabled))
                :not :to-be-truthy)
        (expect (flycheck-may-check-automatically) :not :to-be-truthy)))

    (it "in normal buffers"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (expect (seq-every-p #'flycheck-may-check-automatically
                             '(save idle-change new-line mode-enabled))
                :to-be-truthy)
        (expect (flycheck-may-check-automatically) :to-be-truthy)))

    (it "automatic checking disabled"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (let ((flycheck-check-syntax-automatically nil))
          (expect (seq-find #'flycheck-may-check-automatically
                            '(save idle-change new-line mode-enabled))
                  :not :to-be-truthy)
          (expect (flycheck-may-check-automatically) :to-be-truthy))))

    (it "specific event disabled"
      (dolist (event '(save idle-change new-line mode-enabled))
        (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
          ;; Disable just a specific event
          (let ((flycheck-check-syntax-automatically
                 (remq event flycheck-check-syntax-automatically)))
            (expect flycheck-check-syntax-automatically :to-be-truthy)
            (expect (flycheck-may-check-automatically event) :not :to-be-truthy)
            (expect (seq-every-p #'flycheck-may-check-automatically
                                 flycheck-check-syntax-automatically)
                    :to-be-truthy)
            (expect (flycheck-may-check-automatically) :to-be-truthy))))))

  (describe "flycheck-check-syntax-automatically"

    (it "mode-enabled is disabled"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (emacs-lisp-mode)
        (expect (flycheck-deferred-check-p) :not :to-be-truthy)
        (let ((flycheck-check-syntax-automatically
               (remq 'mode-enabled flycheck-check-syntax-automatically)))
          (flycheck-mode)
          (expect (flycheck-deferred-check-p) :not :to-be-truthy))))

    (it "mode-enabled checks syntax after flycheck-mode"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (emacs-lisp-mode)
        (expect (flycheck-deferred-check-p) :not :to-be-truthy)
        (let ((flycheck-check-syntax-automatically '(mode-enabled)))
          (flycheck-mode)
          (expect (flycheck-deferred-check-p) :to-be-truthy))))

    (it "idle-change is disabled"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (emacs-lisp-mode)
        (let ((flycheck-check-syntax-automatically nil))
          (flycheck-mode))
        (let ((flycheck-check-syntax-automatically
               (remq 'idle-change flycheck-check-syntax-automatically)))
          (insert "Hello world")
          (sleep-for 0.55)
          (expect (flycheck-deferred-check-p) :not :to-be-truthy))))

    (it "idle-change checks syntax after change"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (emacs-lisp-mode)
        (let ((flycheck-check-syntax-automatically '(idle-change)))
          (flycheck-mode)
          (insert "Hello world")
          (expect (flycheck-deferred-check-p) :not :to-be-truthy)
          (sleep-for 1)
          (expect (flycheck-deferred-check-p) :to-be-truthy))))

    (it "idle-change does not check before delay"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (emacs-lisp-mode)
        (let ((flycheck-check-syntax-automatically '(idle-change))
              (flycheck-idle-change-delay 1.5))
          (flycheck-mode)
          (insert "Hello world")
          (sleep-for 0.55)
          (expect (flycheck-deferred-check-p) :not :to-be-truthy)
          (sleep-for 1.1)
          (expect (flycheck-deferred-check-p) :to-be-truthy))))

    (it "idle-change checks changed buffer"
      (let ((flycheck-check-syntax-automatically '(idle-change))
            (flycheck-idle-change-delay 0.1))
        (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
          (let ((changed-buffer (current-buffer)))
            (emacs-lisp-mode)
            (flycheck-mode)
            (insert "Hello world")
            (switch-to-buffer "other-dummy2.el")
            (emacs-lisp-mode)
            (flycheck-mode)
            (sleep-for 0.2)
            (expect (flycheck-deferred-check-p) :not :to-be-truthy)
            (set-buffer changed-buffer)
            (sleep-for 1)
            (expect (flycheck-deferred-check-p) :to-be-truthy)))))

    (it "does not check after buffer switch by default"
      (let ((flycheck-check-syntax-automatically '())
            (flycheck-idle-buffer-switch-delay 0)
            (checks 0))
        (find-file (flycheck-buttercup-resource-filename "automatic-check-dummy.el"))
        (emacs-lisp-mode)
        (flycheck-mode)
        (add-hook 'flycheck-before-syntax-check-hook (lambda () (cl-incf checks)) nil 'local)

        (switch-to-buffer "*scratch*")
        (switch-to-buffer "automatic-check-dummy.el")
        (sleep-for 0.1)
        (expect checks :to-equal 0)
        (kill-buffer "automatic-check-dummy.el")))

    (it "idle-buffer-switch checks after buffer switch"
      (let ((flycheck-check-syntax-automatically '(idle-buffer-switch))
            (flycheck-idle-buffer-switch-delay 0)
            (checks 0))
        (find-file (flycheck-buttercup-resource-filename "automatic-check-dummy.el"))
        (emacs-lisp-mode)
        (flycheck-mode)
        (add-hook 'flycheck-before-syntax-check-hook (lambda () (cl-incf checks)) nil 'local)

        (switch-to-buffer "*scratch*")
        (switch-to-buffer "automatic-check-dummy.el")
        (sleep-for 0.1)
        (expect checks :to-equal 1)
        (kill-buffer "automatic-check-dummy.el")))

    (it "idle-change cancels idle-buffer-switch"
      (let ((flycheck-check-syntax-automatically '(idle-change idle-buffer-switch))
            (flycheck-idle-change-delay 0.02)
            (flycheck-idle-buffer-switch-delay 0.01)
            (checks 0))
        (find-file (flycheck-buttercup-resource-filename "automatic-check-dummy.el"))
        (emacs-lisp-mode)
        (flycheck-mode)
        (add-hook 'flycheck-before-syntax-check-hook (lambda () (cl-incf checks)) nil 'local)

        (switch-to-buffer "*scratch*")
        (switch-to-buffer "automatic-check-dummy.el")
        (insert "Hello")
        (sleep-for 0.015)
        (expect checks :to-equal 0)
        (sleep-for 1)
        (expect checks :to-equal 1)
        (kill-buffer "automatic-check-dummy.el")))

    (it "idle-buffer-switch cancels idle-change"
      (let ((flycheck-check-syntax-automatically '(idle-change idle-buffer-switch))
            (flycheck-idle-change-delay 0.01)
            (flycheck-idle-buffer-switch-delay 0.05)
            (checks 0))
        (find-file (flycheck-buttercup-resource-filename "automatic-check-dummy.el"))
        (emacs-lisp-mode)
        (flycheck-mode)
        (add-hook 'flycheck-before-syntax-check-hook (lambda () (cl-incf checks)) nil 'local)

        (insert "Hello")
        (switch-to-buffer "*scratch*")
        (switch-to-buffer "automatic-check-dummy.el")
        (sleep-for 0.02)
        (expect checks :to-equal 0)
        (sleep-for 1)
        (expect checks :to-equal 1)
        (kill-buffer "automatic-check-dummy.el")))

    (it "idle-buffer-switch does not check intermediate buffers by default"
      (let ((flycheck-check-syntax-automatically '(idle-buffer-switch))
            (flycheck-idle-buffer-switch-delay 0.01)
            (checks 0))
        (find-file (flycheck-buttercup-resource-filename "automatic-check-dummy.el"))
        (emacs-lisp-mode)
        (flycheck-mode)
        (find-file (flycheck-buttercup-resource-filename "global-mode-dummy.el"))
        (emacs-lisp-mode)
        (flycheck-mode)
        (add-hook 'flycheck-before-syntax-check-hook (lambda () (cl-incf checks)) nil 'local)

        (switch-to-buffer "*scratch*")
        (switch-to-buffer "automatic-check-dummy.el")
        (switch-to-buffer "global-mode-dummy.el")
        (sleep-for 1)
        (expect checks :to-equal 1)
        ;; Since the buffer is not visible, the check would be automatically deferred
        (set-buffer "automatic-check-dummy.el")
        (expect (flycheck-deferred-check-p) :not :to-be-truthy)
        (kill-buffer "automatic-check-dummy.el")
        (kill-buffer "global-mode-dummy.el")))

    (it "idle-buffer-switch checks intermediate buffers with option"
      (let ((flycheck-check-syntax-automatically '(idle-buffer-switch))
            (flycheck-idle-buffer-switch-delay 0.01)
            (flycheck-buffer-switch-check-intermediate-buffers t)
            (checks 0))
        (find-file (flycheck-buttercup-resource-filename "automatic-check-dummy.el"))
        (emacs-lisp-mode)
        (flycheck-mode)
        (find-file (flycheck-buttercup-resource-filename "global-mode-dummy.el"))
        (emacs-lisp-mode)
        (flycheck-mode)
        (add-hook 'flycheck-before-syntax-check-hook (lambda () (cl-incf checks)) nil 'local)

        (switch-to-buffer "*scratch*")
        (switch-to-buffer "automatic-check-dummy.el")
        (switch-to-buffer "global-mode-dummy.el")
        (sleep-for 0.1)
        (expect checks :to-equal 1)
        ;; Since the buffer is not visible, the check will be automatically deferred
        (set-buffer "automatic-check-dummy.el")
        (expect (flycheck-deferred-check-p) :to-be-truthy)
        (kill-buffer "automatic-check-dummy.el")
        (kill-buffer "global-mode-dummy.el")))

    (it "buffer-switch-check-intermediate-buffers does not cancel idle-change"
      (let ((flycheck-check-syntax-automatically '(idle-change idle-buffer-switch))
            (flycheck-buffer-switch-check-intermediate-buffers t)
            (flycheck-idle-change-delay 0.01)
            (flycheck-idle-buffer-switch-delay 0))
        (find-file (flycheck-buttercup-resource-filename "automatic-check-dummy.el"))
        (emacs-lisp-mode)
        (flycheck-mode)

        (insert "Hello")
        (switch-to-buffer "*scratch*")
        (sleep-for 0.1)
        ;; Since the buffer is not visible, the check will be automatically deferred
        (set-buffer "automatic-check-dummy.el")
        (expect (flycheck-deferred-check-p) :to-be-truthy)
        (kill-buffer "automatic-check-dummy.el")))

    (it "new-line is disabled"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (let ((flycheck-check-syntax-automatically nil))
          (flycheck-mode))
        (let ((flycheck-check-syntax-automatically
               (remq 'new-line flycheck-check-syntax-automatically)))
          (insert "\n")
          (expect (flycheck-deferred-check-p) :not :to-be-truthy))))

    (it "new-line checks syntax after new line"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (let ((flycheck-check-syntax-automatically '(new-line)))
          (flycheck-mode)
          (insert "\n")
          (expect (flycheck-deferred-check-p) :to-be-truthy))))

    (it "save disabled"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (let ((flycheck-check-syntax-automatically nil))
          (flycheck-mode))
        (set-buffer-modified-p t)
        (let ((flycheck-check-syntax-automatically
               (remq 'save flycheck-check-syntax-automatically)))
          (save-buffer 0)
          (expect (flycheck-deferred-check-p) :not :to-be-truthy))))

    (it "save checks syntax after save"
      (flycheck-buttercup-with-resource-buffer "automatic-check-dummy.el"
        (let ((flycheck-check-syntax-automatically '(save)))
          (flycheck-mode)
          (set-buffer-modified-p t)
          (save-buffer 0)
          (expect (flycheck-deferred-check-p) :to-be-truthy)))))

  (describe "flycheck-buffer-automatically"

    (it "does not check with disabled mode"
      (flycheck-buttercup-with-temp-buffer
        (rename-buffer "foo")
        (expect flycheck-mode :not :to-be-truthy)
        (expect (flycheck-deferred-check-p) :not :to-be-truthy)
        (flycheck-buffer-automatically)
        (expect (flycheck-deferred-check-p) :not :to-be-truthy)))

    (it "defers the test"
      (flycheck-buttercup-with-temp-buffer
        (flycheck-mode)
        ;; Flycheck won't check ephemeral buffers
        (rename-buffer "foo")
        (expect (flycheck-deferred-check-p) :not :to-be-truthy)
        (flycheck-buffer-automatically)
        (expect (flycheck-deferred-check-p) :to-be-truthy))))

  (describe "Deferred syntax checking"

    (it "flycheck-deferred-check-p returns nil"
      (let ((flycheck-deferred-syntax-check nil))
        (expect (flycheck-deferred-check-p) :not :to-be-truthy)))

    (it "flycheck-deferred-check-p returns truthy"
      (let ((flycheck-deferred-syntax-check t))
        (expect (flycheck-deferred-check-p) :to-be-truthy)))

    (it "flycheck-buffer-deferred schedules a deferred syntax check"
      (flycheck-buttercup-with-temp-buffer
        (expect (flycheck-deferred-check-p) :not :to-be-truthy)
        (flycheck-buffer-deferred)
        (expect (flycheck-deferred-check-p) :to-be-truthy)))

    (it "flycheck-clean-deferred-check removes a deferred syntax check"
      (flycheck-buttercup-with-temp-buffer
        (flycheck-buffer-deferred)
        (flycheck-clean-deferred-check)
        (expect (flycheck-deferred-check-p) :not :to-be-truthy)))))

;;; test-automatic-checking.el ends here