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/>.
28 (eval-when-compile (require 'cl))
31 (require 'company-keywords)
32 (require 'company-elisp)
33 (require 'company-clang)
37 (ert-deftest company-sorted-keywords ()
38 "Test that keywords in `company-keywords-alist' are in alphabetical order."
39 (dolist (pair company-keywords-alist)
40 (when (consp (cdr pair))
41 (let ((prev (cadr pair)))
42 (dolist (next (cddr pair))
43 (should (not (equal prev next)))
44 (should (string< prev next))
47 (ert-deftest company-good-prefix ()
48 (let ((company-minimum-prefix-length 5)
49 company--explicit-action)
50 (should (eq t (company--good-prefix-p "!@#$%")))
51 (should (eq nil (company--good-prefix-p "abcd")))
52 (should (eq nil (company--good-prefix-p 'stop)))
53 (should (eq t (company--good-prefix-p '("foo" . 5))))
54 (should (eq nil (company--good-prefix-p '("foo" . 4))))))
56 (ert-deftest company-multi-backend-with-lambdas ()
57 (let ((company-backend
58 (list (lambda (command &optional arg &rest ignore)
61 (candidates '("a" "b"))))
62 (lambda (command &optional arg &rest ignore)
65 (candidates '("c" "d")))))))
66 (should (equal (company-call-backend 'candidates "z") '("a" "b" "c" "d")))))
68 (ert-deftest company-begin-backend-failure-doesnt-break-company-backends ()
73 (company-begin-backend (lambda (command &rest ignore))))
74 (let (company-frontends
76 (list (lambda (command &optional arg)
79 (candidates '("a" "ab" "ac")))))))
81 (company-call 'complete))
82 (should (eq 3 company-candidates-length)))))
84 (ert-deftest company-require-match-explicit ()
88 (let (company-frontends
89 (company-require-match 'company-explicit-action-p)
91 (list (lambda (command &optional arg)
93 (prefix (buffer-substring (point-min) (point)))
94 (candidates '("abc" "abd")))))))
97 (let ((last-command-event ?e))
98 (company-call 'self-insert-command 1))
99 (should (eq 2 company-candidates-length))
100 (should (eq 3 (point))))))
102 (ert-deftest company-dont-require-match-when-idle ()
106 (let (company-frontends
107 (company-require-match 'company-explicit-action-p)
109 (list (lambda (command &optional arg)
111 (prefix (buffer-substring (point-min) (point)))
112 (candidates '("abc" "abd")))))))
113 (company-idle-begin (current-buffer) (selected-window)
114 (buffer-chars-modified-tick) (point))
115 (let ((last-command-event ?e))
116 (company-call 'self-insert-command 1))
117 (should (eq nil company-candidates-length))
118 (should (eq 4 (point))))))
120 (ert-deftest company-auto-complete-explicit ()
124 (let (company-frontends
125 (company-auto-complete 'company-explicit-action-p)
126 (company-auto-complete-chars '(? ))
128 (list (lambda (command &optional arg)
130 (prefix (buffer-substring (point-min) (point)))
131 (candidates '("abcd" "abef")))))))
134 (let ((last-command-event ? ))
135 (company-call 'self-insert-command 1))
136 (should (string= "abcd " (buffer-string))))))
138 (ert-deftest company-no-auto-complete-when-idle ()
142 (let (company-frontends
143 (company-auto-complete 'company-explicit-action-p)
144 (company-auto-complete-chars '(? ))
146 (list (lambda (command &optional arg)
148 (prefix (buffer-substring (point-min) (point)))
149 (candidates '("abcd" "abef")))))))
150 (company-idle-begin (current-buffer) (selected-window)
151 (buffer-chars-modified-tick) (point))
152 (let ((last-command-event ? ))
153 (company-call 'self-insert-command 1))
154 (should (string= "ab " (buffer-string))))))
156 (ert-deftest company-clears-explicit-action-when-no-matches ()
159 (let (company-frontends
161 (company-call 'manual-begin) ;; fails
162 (should (null company-candidates))
163 (should (null (company-explicit-action-p))))))
165 (ert-deftest company-pseudo-tooltip-does-not-get-displaced ()
168 (save-window-excursion
169 (set-window-buffer nil (current-buffer))
170 (save-excursion (insert " ff"))
172 (let ((company-frontends '(company-pseudo-tooltip-frontend))
173 (company-begin-commands '(self-insert-command))
175 (list (lambda (c &optional arg)
176 (case c (prefix "") (candidates '("a" "b" "c")))))))
178 (company-call 'complete))
179 (company-call 'open-line 1)
180 (should (eq 2 (overlay-start company-pseudo-tooltip-overlay)))))))
182 (ert-deftest company-pseudo-tooltip-overlay-show ()
184 (save-window-excursion
185 (set-window-buffer nil (current-buffer))
186 (insert "aaaa\n bb\nccccc\nddd")
187 (search-backward "bb")
188 (let ((col (company--column))
189 (company-candidates-length 2)
190 (company-candidates '("123" "45")))
191 (company-pseudo-tooltip-show (company--row) col 0)
192 (let ((ov company-pseudo-tooltip-overlay))
193 (should (eq (overlay-get ov 'company-width) 3))
195 (should (eq (overlay-get ov 'company-height) company-tooltip-limit))
196 (should (eq (overlay-get ov 'company-column) col))
197 (should (string= (overlay-get ov 'company-before)
198 " 123\nc45 c\nddd\n")))))))
202 (ert-deftest company-template-removed-after-the-last-jump ()
206 (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
210 (company-template-add-field tpl (point) "foo")))
211 (company-call 'template-forward-field)
212 (should (= 3 (point)))
213 (company-call 'template-forward-field)
214 (should (= 7 (point)))
215 (company-call 'template-forward-field)
216 (should (= 11 (point)))
217 (should (zerop (length (overlay-get tpl 'company-template-fields))))
218 (should (null (overlay-buffer tpl))))))
220 (ert-deftest company-template-removed-after-input-and-jump ()
224 (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
227 (company-template-add-field tpl (point) "bar"))
228 (company-call 'template-move-to-first tpl)
229 (should (= 3 (point)))
230 (dolist (c (string-to-list "tee"))
231 (let ((last-command-event c))
232 (company-call 'self-insert-command 1)))
233 (should (string= "{ tee }" (buffer-string)))
234 (should (overlay-buffer tpl))
235 (company-call 'template-forward-field)
236 (should (= 7 (point)))
237 (should (null (overlay-buffer tpl))))))
239 (defun company-call (name &rest args)
240 (let* ((maybe (intern (format "company-%s" name)))
241 (command (if (fboundp maybe) maybe name)))
243 (let ((this-command command))
244 (run-hooks 'post-command-hook))))
246 (ert-deftest company-template-c-like-templatify ()
248 (let ((text "foo(int a, short b)"))
250 (company-template-c-like-templatify text)
251 (should (equal "foo(arg0, arg1)" (buffer-string)))
252 (should (looking-at "arg0"))
253 (should (equal "int a"
254 (overlay-get (company-template-field-at) 'display))))))
258 (defmacro company-elisp-with-buffer (contents &rest body)
262 (setq major-mode 'emacs-lisp-mode)
263 (re-search-backward "|")
265 (let ((company-elisp-detect-function-context t))
268 (ert-deftest company-elisp-candidates-predicate ()
269 (company-elisp-with-buffer
271 (should (eq (company-elisp--candidates-predicate "ba")
273 (should (eq (let (company-elisp-detect-function-context)
274 (company-elisp--candidates-predicate "ba"))
275 'company-elisp--predicate)))
276 (company-elisp-with-buffer
278 (should (eq (company-elisp--candidates-predicate "foo")
280 (should (eq (let (company-elisp-detect-function-context)
281 (company-elisp--candidates-predicate "foo"))
282 'company-elisp--predicate)))
283 (company-elisp-with-buffer
285 (should (eq (company-elisp--candidates-predicate "b")
286 'company-elisp--predicate))))
288 (ert-deftest company-elisp-candidates-predicate-in-docstring ()
289 (company-elisp-with-buffer
290 "(def foo () \"Doo be doo `ide|"
291 (should (eq 'company-elisp--predicate
292 (company-elisp--candidates-predicate "ide")))))
294 ;; This one's also an integration test.
295 (ert-deftest company-elisp-candidates-recognizes-binding-form ()
296 (let ((company-elisp-detect-function-context t)
297 (obarray [when what whelp])
301 (company-elisp-with-buffer
302 "(let ((foo 7) (wh| )))"
303 (should (equal '("what" "whelp")
304 (company-elisp-candidates "wh"))))
305 (company-elisp-with-buffer
306 "(cond ((null nil) (wh| )))"
307 (should (equal '("when")
308 (company-elisp-candidates "wh"))))))
310 (ert-deftest company-elisp-candidates-predicate-binding-without-value ()
311 (loop for (text prefix predicate) in '(("(let (foo|" "foo" boundp)
312 ("(let (foo (bar|" "bar" boundp)
313 ("(let (foo) (bar|" "bar" fboundp))
315 (eval `(company-elisp-with-buffer
317 (should (eq ',predicate
318 (company-elisp--candidates-predicate ,prefix)))))))
320 (ert-deftest company-elisp-finds-vars ()
321 (let ((obarray [boo bar baz backquote])
325 (should (equal '("bar" "baz")
326 (company-elisp--globals "ba" 'boundp)))))
328 (ert-deftest company-elisp-finds-functions ()
329 (let ((obarray [when what whelp])
332 (should (equal '("when")
333 (company-elisp--globals "wh" 'fboundp)))))
335 (ert-deftest company-elisp-finds-things ()
336 (let ((obarray [when what whelp])
339 (should (equal '("what" "whelp" "when")
340 (sort (company-elisp--globals "wh" 'company-elisp--predicate)
343 (ert-deftest company-elisp-locals-vars ()
344 (company-elisp-with-buffer
345 "(let ((foo 5) (bar 6))
346 (cl-labels ((borg ()))
349 (should (equal '("bar" "baz" "boo")
350 (company-elisp--locals "b" nil)))))
352 (ert-deftest company-elisp-locals-single-var ()
353 (company-elisp-with-buffer
357 (should (equal '("itk" "item")
358 (company-elisp--locals "it" nil)))))
360 (ert-deftest company-elisp-locals-funs ()
361 (company-elisp-with-buffer
362 "(cl-labels ((foo ())
366 (should (equal '("fee" "foo")
367 (sort (company-elisp--locals "f" t) 'string<)))))
369 (ert-deftest company-elisp-locals-skips-current-varlist ()
370 (company-elisp-with-buffer
373 (should (null (company-elisp--locals "f" nil)))))
375 (ert-deftest company-elisp-show-locals-first ()
376 (company-elisp-with-buffer
381 (let ((obarray [float-pi]))
382 (let (company-elisp-show-locals-first)
383 (should (eq nil (company-elisp 'sorted))))
384 (let ((company-elisp-show-locals-first t))
385 (should (eq t (company-elisp 'sorted)))
386 (should (equal '("flee" "floo" "flop" "float-pi")
387 (company-elisp-candidates "fl")))))))
389 (ert-deftest company-elisp-candidates-no-duplicates ()
390 (company-elisp-with-buffer
393 (let ((obarray [float-pi])
394 (company-elisp-show-locals-first t))
395 (should (equal '("float-pi") (company-elisp-candidates "f"))))))
397 (ert-deftest company-elisp-shouldnt-complete-defun-name ()
398 (company-elisp-with-buffer
400 (should (null (company-elisp 'prefix)))))
402 (ert-deftest company-elisp-should-complete-def-call ()
403 (company-elisp-with-buffer
405 (should (equal "defu" (company-elisp 'prefix)))))
407 (ert-deftest company-elisp-should-complete-in-defvar ()
408 ;; It will also complete the var name, at least for now.
409 (company-elisp-with-buffer
411 (should (equal "de" (company-elisp 'prefix)))))
413 (ert-deftest company-elisp-shouldnt-complete-in-defun-arglist ()
414 (company-elisp-with-buffer
415 "(defsubst foobar (ba|"
416 (should (null (company-elisp 'prefix)))))
418 (ert-deftest company-elisp-prefix-in-defun-body ()
419 (company-elisp-with-buffer
421 (should (equal "" (company-elisp 'prefix)))))
425 (ert-deftest company-clang-objc-templatify ()
427 (let ((text "createBookWithTitle:andAuthor:"))
429 (company-clang-objc-templatify text)
430 (should (equal "createBookWithTitle:arg0 andAuthor:arg1" (buffer-string)))
431 (should (looking-at "arg0"))
432 (should (null (overlay-get (company-template-field-at) 'display))))))