1 ;;; company-tests.el --- company-mode tests
3 ;; Copyright (C) 2011, 2013 Free Software Foundation, Inc.
5 ;; Author: Nikolaj Schumacher
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30 (require 'company-keywords)
32 (ert-deftest company-sorted-keywords ()
33 "Test that keywords in `company-keywords-alist' are in alphabetical order."
34 (dolist (pair company-keywords-alist)
35 (when (consp (cdr pair))
36 (let ((prev (cadr pair)))
37 (dolist (next (cddr pair))
38 (should (not (equal prev next)))
39 (should (string< prev next))
42 (ert-deftest company-good-prefix ()
43 (let ((company-minimum-prefix-length 5)
44 company--explicit-action)
45 (should (eq t (company--good-prefix-p "!@#$%")))
46 (should (eq nil (company--good-prefix-p "abcd")))
47 (should (eq nil (company--good-prefix-p 'stop)))
48 (should (eq t (company--good-prefix-p '("foo" . 5))))
49 (should (eq nil (company--good-prefix-p '("foo" . 4))))))
51 (ert-deftest company-multi-backend-with-lambdas ()
52 (let ((company-backend
53 (list (lambda (command &optional arg &rest ignore)
56 (candidates '("a" "b"))))
57 (lambda (command &optional arg &rest ignore)
60 (candidates '("c" "d")))))))
61 (should (equal (company-call-backend 'candidates "z") '("a" "b" "c" "d")))))
63 (ert-deftest company-begin-backend-failure-doesnt-break-company-backends ()
68 (company-begin-backend (lambda (command &rest ignore))))
69 (let (company-frontends
71 (list (lambda (command &optional arg)
74 (candidates '("a" "ab" "ac")))))))
76 (company-call 'complete))
77 (should (eq 3 company-candidates-length)))))
79 (ert-deftest company-require-match-explicit ()
83 (let (company-frontends
84 (company-require-match 'company-explicit-action-p)
86 (list (lambda (command &optional arg)
88 (prefix (buffer-substring (point-min) (point)))
89 (candidates '("abc" "abd")))))))
92 (let ((last-command-event ?e))
93 (company-call 'self-insert-command 1))
94 (should (eq 2 company-candidates-length))
95 (should (eq 3 (point))))))
97 (ert-deftest company-dont-require-match-when-idle ()
101 (let (company-frontends
102 (company-require-match 'company-explicit-action-p)
104 (list (lambda (command &optional arg)
106 (prefix (buffer-substring (point-min) (point)))
107 (candidates '("abc" "abd")))))))
108 (company-idle-begin (current-buffer) (selected-window)
109 (buffer-chars-modified-tick) (point))
110 (let ((last-command-event ?e))
111 (company-call 'self-insert-command 1))
112 (should (eq nil company-candidates-length))
113 (should (eq 4 (point))))))
115 (ert-deftest company-auto-complete-explicit ()
119 (let (company-frontends
120 (company-auto-complete 'company-explicit-action-p)
121 (company-auto-complete-chars '(? ))
123 (list (lambda (command &optional arg)
125 (prefix (buffer-substring (point-min) (point)))
126 (candidates '("abcd" "abef")))))))
129 (let ((last-command-event ? ))
130 (company-call 'self-insert-command 1))
131 (should (string= "abcd " (buffer-string))))))
133 (ert-deftest company-no-auto-complete-when-idle ()
137 (let (company-frontends
138 (company-auto-complete 'company-explicit-action-p)
139 (company-auto-complete-chars '(? ))
141 (list (lambda (command &optional arg)
143 (prefix (buffer-substring (point-min) (point)))
144 (candidates '("abcd" "abef")))))))
145 (company-idle-begin (current-buffer) (selected-window)
146 (buffer-chars-modified-tick) (point))
147 (let ((last-command-event ? ))
148 (company-call 'self-insert-command 1))
149 (should (string= "ab " (buffer-string))))))
151 (ert-deftest company-clears-explicit-action-when-no-matches ()
154 (let (company-frontends
156 (company-call 'manual-begin) ;; fails
157 (should (null company-candidates))
158 (should (null (company-explicit-action-p))))))
160 (ert-deftest company-pseudo-tooltip-does-not-get-displaced ()
162 (save-window-excursion
163 (set-window-buffer nil (current-buffer))
164 (save-excursion (insert " ff"))
166 (let ((company-frontends '(company-pseudo-tooltip-frontend))
167 (company-begin-commands '(self-insert-command))
169 (list (lambda (c &optional arg)
170 (case c (prefix "") (candidates '("a" "b" "c")))))))
172 (company-call 'complete))
173 (company-call 'open-line 1)
174 (should (eq 2 (overlay-start company-pseudo-tooltip-overlay)))))))
176 (ert-deftest company-template-removed-after-the-last-jump ()
180 (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
184 (company-template-add-field tpl (point) "foo")
186 (company-call 'template-forward-field)
187 (should (= 3 (point)))
188 (company-call 'template-forward-field)
189 (should (= 7 (point)))
190 (company-call 'template-forward-field)
191 (should (= 11 (point)))
192 (should (zerop (length (overlay-get tpl 'company-template-fields))))
193 (should (null (overlay-buffer tpl))))))
195 (ert-deftest company-template-removed-after-input-and-jump ()
199 (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
202 (company-template-add-field tpl (point) "bar"))
203 (company-call 'template-move-to-first tpl)
204 (should (= 3 (point)))
205 (dolist (c (string-to-list "tee"))
206 (let ((last-command-event c))
207 (company-call 'self-insert-command 1)))
208 (should (string= "{ tee }" (buffer-string)))
209 (should (overlay-buffer tpl))
210 (company-call 'template-forward-field)
211 (should (= 7 (point)))
212 (should (null (overlay-buffer tpl))))))
214 (defun company-call (name &rest args)
215 (let* ((maybe (intern (format "company-%s" name)))
216 (command (if (fboundp maybe) maybe name)))
218 (let ((this-command command))
219 (run-hooks 'post-command-hook))))
221 (defmacro company-elisp-with-buffer (contents &rest body)
225 (setq major-mode 'emacs-lisp-mode)
226 (re-search-backward "|")
228 (let ((company-elisp-detect-function-context t))
231 (ert-deftest company-elisp-candidates-predicate ()
232 (company-elisp-with-buffer
234 (should (eq (company-elisp--candidates-predicate "ba")
236 (should (eq (let (company-elisp-detect-function-context)
237 (company-elisp--candidates-predicate "ba"))
238 'company-elisp--predicate)))
239 (company-elisp-with-buffer
241 (should (eq (company-elisp--candidates-predicate "foo")
243 (should (eq (let (company-elisp-detect-function-context)
244 (company-elisp--candidates-predicate "foo"))
245 'company-elisp--predicate)))
246 (company-elisp-with-buffer
248 (should (eq (company-elisp--candidates-predicate "b")
249 'company-elisp--predicate))))
251 (ert-deftest company-elisp-candidates-predicate-in-docstring ()
252 (company-elisp-with-buffer
253 "(def foo () \"Doo be doo `ide|"
254 (should (eq 'company-elisp--predicate
255 (company-elisp--candidates-predicate "ide")))))
257 ;; This one's also an integration test.
258 (ert-deftest company-elisp-candidates-recognizes-binding-form ()
259 (let ((company-elisp-detect-function-context t)
260 (obarray [when what whelp])
264 (company-elisp-with-buffer
265 "(let ((foo 7) (wh| )))"
266 (should (equal '("what" "whelp")
267 (company-elisp-candidates "wh"))))
268 (company-elisp-with-buffer
269 "(cond ((null nil) (wh| )))"
270 (should (equal '("when")
271 (company-elisp-candidates "wh"))))))
273 (ert-deftest company-elisp-candidates-predicate-binding-without-value ()
274 (loop for (text prefix predicate) in '(("(let (foo|" "foo" boundp)
275 ("(let (foo (bar|" "bar" boundp)
276 ("(let (foo) (bar|" "bar" fboundp))
278 (eval `(company-elisp-with-buffer
280 (should (eq ',predicate
281 (company-elisp--candidates-predicate ,prefix)))))))
283 (ert-deftest company-elisp-finds-vars ()
284 (let ((obarray [boo bar baz backquote])
288 (should (equal '("bar" "baz")
289 (company-elisp--globals "ba" 'boundp)))))
291 (ert-deftest company-elisp-finds-functions ()
292 (let ((obarray [when what whelp])
295 (should (equal '("when")
296 (company-elisp--globals "wh" 'fboundp)))))
298 (ert-deftest company-elisp-finds-things ()
299 (let ((obarray [when what whelp])
302 (should (equal '("what" "whelp" "when")
303 (sort (company-elisp--globals "wh" 'company-elisp--predicate)
306 (ert-deftest company-elisp-locals-vars ()
307 (company-elisp-with-buffer
308 "(let ((foo 5) (bar 6))
309 (cl-labels ((borg ()))
312 (should (equal '("bar" "baz" "boo")
313 (company-elisp--locals "b" nil)))))
315 (ert-deftest company-elisp-locals-single-var ()
316 (company-elisp-with-buffer
320 (should (equal '("itk" "item")
321 (company-elisp--locals "it" nil)))))
323 (ert-deftest company-elisp-locals-funs ()
324 (company-elisp-with-buffer
325 "(cl-labels ((foo ())
329 (should (equal '("fee" "foo")
330 (sort (company-elisp--locals "f" t) 'string<)))))
332 (ert-deftest company-elisp-locals-skips-current-varlist ()
333 (company-elisp-with-buffer
336 (should (null (company-elisp--locals "f" nil)))))
338 (ert-deftest company-elisp-show-locals-first ()
339 (company-elisp-with-buffer
344 (let ((obarray [float-pi]))
345 (let (company-elisp-show-locals-first)
346 (should (eq nil (company-elisp 'sorted))))
347 (let ((company-elisp-show-locals-first t))
348 (should (eq t (company-elisp 'sorted)))
349 (should (equal '("flee" "floo" "flop" "float-pi")
350 (company-elisp-candidates "fl")))))))
352 (ert-deftest company-elisp-candidates-no-duplicates ()
353 (company-elisp-with-buffer
356 (let ((obarray [float-pi])
357 (company-elisp-show-locals-first t))
358 (should (equal '("float-pi") (company-elisp-candidates "f"))))))
360 (ert-deftest company-elisp-shouldnt-complete-defun-name ()
361 (company-elisp-with-buffer
363 (should (null (company-elisp 'prefix)))))
365 (ert-deftest company-elisp-should-complete-def-call ()
366 (company-elisp-with-buffer
368 (should (equal "defu" (company-elisp 'prefix)))))
370 (ert-deftest company-elisp-should-complete-in-defvar ()
371 ;; It will also complete the var name, at least for now.
372 (company-elisp-with-buffer
374 (should (equal "de" (company-elisp 'prefix)))))
376 (ert-deftest company-elisp-shouldnt-complete-in-defun-arglist ()
377 (company-elisp-with-buffer
378 "(defsubst foobar (ba|"
379 (should (null (company-elisp 'prefix)))))
381 (ert-deftest company-elisp-prefix-in-defun-body ()
382 (company-elisp-with-buffer
384 (should (equal "" (company-elisp 'prefix)))))