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
|
;;; relint-test.el --- Tests for relint.el -*- lexical-binding: t -*-
;; Copyright (C) 2019-2020 Free Software Foundation, Inc.
;; Author: Mattias Engdegård <mattiase@acm.org>
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
(require 'relint)
(require 'ert)
;; Required for some of the source in test/
(require 'subr-x)
(defconst relint-test--this-file
(or load-file-name buffer-file-name))
;; A nonsense test value to exercise the location code.
(defconst relint-test--value
'(t1 t2
13 -7 14.0 1.0e+INF "ab\"\\" ?a ?? ?\\ ?\( ?\)
[xy 4 uv]
(t3 (((t4) t5) (t6))
('t7 't8 '(t9 () (()))))
(r . s)
(t10 t11 . t12)
#'zz
'''qqq
`(t13 ,t14 ,(t15 t16) ,@t17 ,@(t18 t19))))
(defun relint-test--enumerate-nodes (form path)
"List of (NODE . PATH-TO-NODE) for each node in FORM, starting at PATH.
A node is either an atom or a list, but not a proper tail of a list."
(if (consp form)
(let ((r (list (cons form path)))
(i 0))
(while (consp form)
(let ((node (car form)))
(setq r (append
(reverse (relint-test--enumerate-nodes node (cons i path)))
r))
(setq i (1+ i))
(setq form (cdr form))))
(reverse r))
(list (cons form path))))
(defun relint-test--find-toplevel-form (pred)
"Find first toplevel form satisfying PRED. Return (FORM . POSITION)."
(catch 'found
(while t
(let* ((pos (point))
(form (read (current-buffer))))
(when (funcall pred form)
(throw 'found (cons form pos)))))))
(ert-deftest relint-find-pos ()
"Test the mechanism that computes a position from a toplevel-position
and a path."
(with-temp-buffer
(emacs-lisp-mode)
(insert-file-contents relint-test--this-file)
(let* ((form-pos (relint-test--find-toplevel-form
(lambda (x) (pcase x
(`(defconst relint-test--value . ,_) t)))))
(toplevel-form (car form-pos))
(toplevel-pos (cdr form-pos)))
;; We have a toplevel form and position. Enumerate its parts.
(dolist (item (relint-test--enumerate-nodes toplevel-form nil))
(let* ((node (car item))
(path (cdr item))
(pos (relint--pos-from-start-pos-path toplevel-pos path)))
;; Skip sugared items; they cannot be read in isolation.
(unless (memq node '(quote function \` \, \,@))
(goto-char pos)
;; The position should not be at whitespace or comment.
(should-not (looking-at (rx (any " \t\n;"))))
;; Read what we find at the position to check.
(let ((thing-here (read (current-buffer))))
(should (equal thing-here node)))))))))
(defun relint-test--insert-file (file)
(insert-file-contents
(expand-file-name file (file-name-directory relint-test--this-file))))
(defun relint-test--scan-file (file)
"Scan FILE and return the results as a string."
(with-temp-buffer
;; The reference files (*.expected) are kept in the `grave' style,
;; to make the test independent of `text-quoting-style'.
(let ((text-quoting-style 'grave))
(relint--buffer (find-file-noselect file t) (current-buffer) t))
(buffer-string)))
(defun relint-test--read-file (file)
(with-temp-buffer
(relint-test--insert-file file)
(buffer-string)))
;; The scan tests are divided more-or-less arbitarily into chunks
;; instead of having one big file, to make it easier to find errors.
(defmacro relint-test--deftest (basename)
(let* ((testfile (concat "test/" basename ".elisp"))
(expected (concat "test/" basename ".expected"))
(name (intern (concat "relint-check-file-" basename))))
`(ert-deftest ,name ()
(should (equal (relint-test--scan-file ,testfile)
(relint-test--read-file ,expected))))))
(dolist (f (directory-files
(concat (file-name-directory relint-test--this-file) "/test")
nil (rx ".elisp" eos)))
(let ((base (string-remove-suffix ".elisp" f)))
(eval `(relint-test--deftest ,base))))
(ert-deftest relint-buffer ()
(let ((buf (get-buffer-create " *relint-test*"))
(text-quoting-style 'grave))
(unwind-protect
(progn
(with-current-buffer buf
(emacs-lisp-mode)
(insert ";hello\n(looking-at \"broken**regexp\")\n")
(insert "(looking-at (make-string 2 ?^))\n")
(insert "(looking-at (concat \"ab\" \"cdef\" \"[gg]\"))\n")
(insert "(string-match \"[xy\" s)\n"))
(should (equal
(relint-buffer buf)
'(("In call to looking-at: Repetition of repetition"
20 28 "broken**regexp" 7 warning)
("In call to looking-at: Unescaped literal `^'"
50 nil "^^" 1 warning)
("In call to looking-at: Duplicated `g' inside character alternative"
82 105 "abcdef[gg]" 8 warning)
("In call to string-match: Unterminated character alternative"
125 nil "[xy" nil error)))))
(kill-buffer buf))))
(ert-deftest relint-buffer-huge ()
;; Regression test for regexp stack overflow in the scan for ineffective
;; backslashes.
(should (equal
(with-temp-buffer
(emacs-lisp-mode)
(insert "(message \"hello\\? anyone?\")\n")
(insert "(defconst my-const '(")
(dotimes (i 200000)
(insert (format "%d " i)))
(insert "))\n")
(insert "(message \"goodbye\\! everyone!\")\n")
(let ((text-quoting-style 'grave))
(relint-buffer (current-buffer))))
'(("Ineffective string escape `\\?'" 16 nil nil nil warning)
("Ineffective string escape `\\!'" 1288960 nil nil nil warning)))))
(provide 'relint-test)
|
