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)
34 (ert-deftest company-sorted-keywords ()
35 "Test that keywords in `company-keywords-alist' are in alphabetical order."
36 (dolist (pair company-keywords-alist)
37 (when (consp (cdr pair))
38 (let ((prev (cadr pair)))
39 (dolist (next (cddr pair))
40 (should (not (equal prev next)))
41 (should (string< prev next))
44 (ert-deftest company-good-prefix ()
45 (let ((company-minimum-prefix-length 5)
46 company--explicit-action)
47 (should (eq t (company--good-prefix-p "!@#$%")))
48 (should (eq nil (company--good-prefix-p "abcd")))
49 (should (eq nil (company--good-prefix-p 'stop)))
50 (should (eq t (company--good-prefix-p '("foo" . 5))))
51 (should (eq nil (company--good-prefix-p '("foo" . 4))))))
53 (ert-deftest company-multi-backend-with-lambdas ()
54 (let ((company-backend
55 (list (lambda (command &optional arg &rest ignore)
58 (candidates '("a" "b"))))
59 (lambda (command &optional arg &rest ignore)
62 (candidates '("c" "d")))))))
63 (should (equal (company-call-backend 'candidates "z") '("a" "b" "c" "d")))))
65 (ert-deftest company-begin-backend-failure-doesnt-break-company-backends ()
70 (company-begin-backend (lambda (command &rest ignore))))
71 (let (company-frontends
73 (list (lambda (command &optional arg)
76 (candidates '("a" "ab" "ac")))))))
78 (company-call 'complete))
79 (should (eq 3 company-candidates-length)))))
81 (ert-deftest company-require-match-explicit ()
85 (let (company-frontends
86 (company-require-match 'company-explicit-action-p)
88 (list (lambda (command &optional arg)
90 (prefix (buffer-substring (point-min) (point)))
91 (candidates '("abc" "abd")))))))
94 (let ((last-command-event ?e))
95 (company-call 'self-insert-command 1))
96 (should (eq 2 company-candidates-length))
97 (should (eq 3 (point))))))
99 (ert-deftest company-dont-require-match-when-idle ()
103 (let (company-frontends
104 (company-require-match 'company-explicit-action-p)
106 (list (lambda (command &optional arg)
108 (prefix (buffer-substring (point-min) (point)))
109 (candidates '("abc" "abd")))))))
110 (company-idle-begin (current-buffer) (selected-window)
111 (buffer-chars-modified-tick) (point))
112 (let ((last-command-event ?e))
113 (company-call 'self-insert-command 1))
114 (should (eq nil company-candidates-length))
115 (should (eq 4 (point))))))
117 (ert-deftest company-auto-complete-explicit ()
121 (let (company-frontends
122 (company-auto-complete 'company-explicit-action-p)
123 (company-auto-complete-chars '(? ))
125 (list (lambda (command &optional arg)
127 (prefix (buffer-substring (point-min) (point)))
128 (candidates '("abcd" "abef")))))))
131 (let ((last-command-event ? ))
132 (company-call 'self-insert-command 1))
133 (should (string= "abcd " (buffer-string))))))
135 (ert-deftest company-no-auto-complete-when-idle ()
139 (let (company-frontends
140 (company-auto-complete 'company-explicit-action-p)
141 (company-auto-complete-chars '(? ))
143 (list (lambda (command &optional arg)
145 (prefix (buffer-substring (point-min) (point)))
146 (candidates '("abcd" "abef")))))))
147 (company-idle-begin (current-buffer) (selected-window)
148 (buffer-chars-modified-tick) (point))
149 (let ((last-command-event ? ))
150 (company-call 'self-insert-command 1))
151 (should (string= "ab " (buffer-string))))))
153 (ert-deftest company-clears-explicit-action-when-no-matches ()
156 (let (company-frontends
158 (company-call 'manual-begin) ;; fails
159 (should (null company-candidates))
160 (should (null (company-explicit-action-p))))))
162 (ert-deftest company-pseudo-tooltip-does-not-get-displaced ()
164 (save-window-excursion
165 (set-window-buffer nil (current-buffer))
166 (save-excursion (insert " ff"))
168 (let ((company-frontends '(company-pseudo-tooltip-frontend))
169 (company-begin-commands '(self-insert-command))
171 (list (lambda (c &optional arg)
172 (case c (prefix "") (candidates '("a" "b" "c")))))))
174 (company-call 'complete))
175 (company-call 'open-line 1)
176 (should (eq 2 (overlay-start company-pseudo-tooltip-overlay)))))))
180 (ert-deftest company-template-removed-after-the-last-jump ()
184 (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
188 (company-template-add-field tpl (point) "foo")))
189 (company-call 'template-forward-field)
190 (should (= 3 (point)))
191 (company-call 'template-forward-field)
192 (should (= 7 (point)))
193 (company-call 'template-forward-field)
194 (should (= 11 (point)))
195 (should (zerop (length (overlay-get tpl 'company-template-fields))))
196 (should (null (overlay-buffer tpl))))))
198 (ert-deftest company-template-removed-after-input-and-jump ()
202 (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
205 (company-template-add-field tpl (point) "bar"))
206 (company-call 'template-move-to-first tpl)
207 (should (= 3 (point)))
208 (dolist (c (string-to-list "tee"))
209 (let ((last-command-event c))
210 (company-call 'self-insert-command 1)))
211 (should (string= "{ tee }" (buffer-string)))
212 (should (overlay-buffer tpl))
213 (company-call 'template-forward-field)
214 (should (= 7 (point)))
215 (should (null (overlay-buffer tpl))))))
217 (defun company-call (name &rest args)
218 (let* ((maybe (intern (format "company-%s" name)))
219 (command (if (fboundp maybe) maybe name)))
221 (let ((this-command command))
222 (run-hooks 'post-command-hook))))
224 (ert-deftest company-template-c-like-templatify ()
226 (let ((text "foo(int a, short b)"))
228 (company-template-c-like-templatify text)
229 (should (equal "foo(arg0, arg1)" (buffer-string)))
230 (should (looking-at "arg0"))
231 (should (equal "int a"
232 (overlay-get (company-template-field-at) 'display))))))
236 (defmacro company-elisp-with-buffer (contents &rest body)
240 (setq major-mode 'emacs-lisp-mode)
241 (re-search-backward "|")
243 (let ((company-elisp-detect-function-context t))
246 (ert-deftest company-elisp-candidates-predicate ()
247 (company-elisp-with-buffer
249 (should (eq (company-elisp--candidates-predicate "ba")
251 (should (eq (let (company-elisp-detect-function-context)
252 (company-elisp--candidates-predicate "ba"))
253 'company-elisp--predicate)))
254 (company-elisp-with-buffer
256 (should (eq (company-elisp--candidates-predicate "foo")
258 (should (eq (let (company-elisp-detect-function-context)
259 (company-elisp--candidates-predicate "foo"))
260 'company-elisp--predicate)))
261 (company-elisp-with-buffer
263 (should (eq (company-elisp--candidates-predicate "b")
264 'company-elisp--predicate))))
266 (ert-deftest company-elisp-candidates-predicate-in-docstring ()
267 (company-elisp-with-buffer
268 "(def foo () \"Doo be doo `ide|"
269 (should (eq 'company-elisp--predicate
270 (company-elisp--candidates-predicate "ide")))))
272 ;; This one's also an integration test.
273 (ert-deftest company-elisp-candidates-recognizes-binding-form ()
274 (let ((company-elisp-detect-function-context t)
275 (obarray [when what whelp])
279 (company-elisp-with-buffer
280 "(let ((foo 7) (wh| )))"
281 (should (equal '("what" "whelp")
282 (company-elisp-candidates "wh"))))
283 (company-elisp-with-buffer
284 "(cond ((null nil) (wh| )))"
285 (should (equal '("when")
286 (company-elisp-candidates "wh"))))))
288 (ert-deftest company-elisp-candidates-predicate-binding-without-value ()
289 (loop for (text prefix predicate) in '(("(let (foo|" "foo" boundp)
290 ("(let (foo (bar|" "bar" boundp)
291 ("(let (foo) (bar|" "bar" fboundp))
293 (eval `(company-elisp-with-buffer
295 (should (eq ',predicate
296 (company-elisp--candidates-predicate ,prefix)))))))
298 (ert-deftest company-elisp-finds-vars ()
299 (let ((obarray [boo bar baz backquote])
303 (should (equal '("bar" "baz")
304 (company-elisp--globals "ba" 'boundp)))))
306 (ert-deftest company-elisp-finds-functions ()
307 (let ((obarray [when what whelp])
310 (should (equal '("when")
311 (company-elisp--globals "wh" 'fboundp)))))
313 (ert-deftest company-elisp-finds-things ()
314 (let ((obarray [when what whelp])
317 (should (equal '("what" "whelp" "when")
318 (sort (company-elisp--globals "wh" 'company-elisp--predicate)
321 (ert-deftest company-elisp-locals-vars ()
322 (company-elisp-with-buffer
323 "(let ((foo 5) (bar 6))
324 (cl-labels ((borg ()))
327 (should (equal '("bar" "baz" "boo")
328 (company-elisp--locals "b" nil)))))
330 (ert-deftest company-elisp-locals-single-var ()
331 (company-elisp-with-buffer
335 (should (equal '("itk" "item")
336 (company-elisp--locals "it" nil)))))
338 (ert-deftest company-elisp-locals-funs ()
339 (company-elisp-with-buffer
340 "(cl-labels ((foo ())
344 (should (equal '("fee" "foo")
345 (sort (company-elisp--locals "f" t) 'string<)))))
347 (ert-deftest company-elisp-locals-skips-current-varlist ()
348 (company-elisp-with-buffer
351 (should (null (company-elisp--locals "f" nil)))))
353 (ert-deftest company-elisp-show-locals-first ()
354 (company-elisp-with-buffer
359 (let ((obarray [float-pi]))
360 (let (company-elisp-show-locals-first)
361 (should (eq nil (company-elisp 'sorted))))
362 (let ((company-elisp-show-locals-first t))
363 (should (eq t (company-elisp 'sorted)))
364 (should (equal '("flee" "floo" "flop" "float-pi")
365 (company-elisp-candidates "fl")))))))
367 (ert-deftest company-elisp-candidates-no-duplicates ()
368 (company-elisp-with-buffer
371 (let ((obarray [float-pi])
372 (company-elisp-show-locals-first t))
373 (should (equal '("float-pi") (company-elisp-candidates "f"))))))
375 (ert-deftest company-elisp-shouldnt-complete-defun-name ()
376 (company-elisp-with-buffer
378 (should (null (company-elisp 'prefix)))))
380 (ert-deftest company-elisp-should-complete-def-call ()
381 (company-elisp-with-buffer
383 (should (equal "defu" (company-elisp 'prefix)))))
385 (ert-deftest company-elisp-should-complete-in-defvar ()
386 ;; It will also complete the var name, at least for now.
387 (company-elisp-with-buffer
389 (should (equal "de" (company-elisp 'prefix)))))
391 (ert-deftest company-elisp-shouldnt-complete-in-defun-arglist ()
392 (company-elisp-with-buffer
393 "(defsubst foobar (ba|"
394 (should (null (company-elisp 'prefix)))))
396 (ert-deftest company-elisp-prefix-in-defun-body ()
397 (company-elisp-with-buffer
399 (should (equal "" (company-elisp 'prefix)))))
403 (ert-deftest company-clang-objc-templatify ()
405 (let ((text "createBookWithTitle:andAuthor:"))
407 (company-clang-objc-templatify text)
408 (should (equal "createBookWithTitle:arg0 andAuthor:arg1" (buffer-string)))
409 (should (looking-at "arg0"))
410 (should (null (overlay-get (company-template-field-at) 'display))))))