code.delx.au - gnu-emacs-elpa/blob - company-tests.el

   1 ;;; company-tests.el --- company-mode tests
   2
   3 ;; Copyright (C) 2011, 2013  Free Software Foundation, Inc.
   4
   5 ;; Author: Nikolaj Schumacher
   6
   7 ;; This file is part of GNU Emacs.
   8
   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.
  13
  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.
  18
  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/>.
  21
  22
  23 ;;; Commentary:
  24 ;;
  25
  26 ;;; Code:
  27
  28 (require 'ert)
  29 (require 'company)
  30 (require 'company-keywords)
  31
  32 ;;; Core
  33
  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))
  42           (setq prev next))))))
  43
  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))))))
  52
  53 (ert-deftest company-multi-backend-with-lambdas ()
  54   (let ((company-backend
  55          (list (lambda (command &optional arg &rest ignore)
  56                  (case command
  57                    (prefix "z")
  58                    (candidates '("a" "b"))))
  59                (lambda (command &optional arg &rest ignore)
  60                  (case command
  61                    (prefix "z")
  62                    (candidates '("c" "d")))))))
  63     (should (equal (company-call-backend 'candidates "z") '("a" "b" "c" "d")))))
  64
  65 (ert-deftest company-begin-backend-failure-doesnt-break-company-backends ()
  66   (with-temp-buffer
  67     (insert "a")
  68     (company-mode)
  69     (should-error
  70      (company-begin-backend (lambda (command &rest ignore))))
  71     (let (company-frontends
  72           (company-backends
  73            (list (lambda (command &optional arg)
  74                    (case command
  75                      (prefix "a")
  76                      (candidates '("a" "ab" "ac")))))))
  77       (let (this-command)
  78         (company-call 'complete))
  79       (should (eq 3 company-candidates-length)))))
  80
  81 (ert-deftest company-require-match-explicit ()
  82   (with-temp-buffer
  83     (insert "ab")
  84     (company-mode)
  85     (let (company-frontends
  86           (company-require-match 'company-explicit-action-p)
  87           (company-backends
  88            (list (lambda (command &optional arg)
  89                    (case command
  90                      (prefix (buffer-substring (point-min) (point)))
  91                      (candidates '("abc" "abd")))))))
  92       (let (this-command)
  93         (company-complete))
  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))))))
  98
  99 (ert-deftest company-dont-require-match-when-idle ()
 100   (with-temp-buffer
 101     (insert "ab")
 102     (company-mode)
 103     (let (company-frontends
 104           (company-require-match 'company-explicit-action-p)
 105           (company-backends
 106            (list (lambda (command &optional arg)
 107                    (case command
 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))))))
 116
 117 (ert-deftest company-auto-complete-explicit ()
 118   (with-temp-buffer
 119     (insert "ab")
 120     (company-mode)
 121     (let (company-frontends
 122           (company-auto-complete 'company-explicit-action-p)
 123           (company-auto-complete-chars '(? ))
 124           (company-backends
 125            (list (lambda (command &optional arg)
 126                    (case command
 127                      (prefix (buffer-substring (point-min) (point)))
 128                      (candidates '("abcd" "abef")))))))
 129       (let (this-command)
 130         (company-complete))
 131       (let ((last-command-event ? ))
 132         (company-call 'self-insert-command 1))
 133       (should (string= "abcd " (buffer-string))))))
 134
 135 (ert-deftest company-no-auto-complete-when-idle ()
 136   (with-temp-buffer
 137     (insert "ab")
 138     (company-mode)
 139     (let (company-frontends
 140           (company-auto-complete 'company-explicit-action-p)
 141           (company-auto-complete-chars '(? ))
 142           (company-backends
 143            (list (lambda (command &optional arg)
 144                    (case command
 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))))))
 152
 153 (ert-deftest company-clears-explicit-action-when-no-matches ()
 154   (with-temp-buffer
 155     (company-mode)
 156     (let (company-frontends
 157           company-backends)
 158       (company-call 'manual-begin) ;; fails
 159       (should (null company-candidates))
 160       (should (null (company-explicit-action-p))))))
 161
 162 (ert-deftest company-pseudo-tooltip-does-not-get-displaced ()
 163   :tags '(interactive)
 164   (with-temp-buffer
 165     (save-window-excursion
 166       (set-window-buffer nil (current-buffer))
 167       (save-excursion (insert " ff"))
 168       (company-mode)
 169       (let ((company-frontends '(company-pseudo-tooltip-frontend))
 170             (company-begin-commands '(self-insert-command))
 171             (company-backends
 172              (list (lambda (c &optional arg)
 173                      (case c (prefix "") (candidates '("a" "b" "c")))))))
 174         (let (this-command)
 175           (company-call 'complete))
 176         (company-call 'open-line 1)
 177         (should (eq 2 (overlay-start company-pseudo-tooltip-overlay)))))))
 178
 179 (defun company-test-pseudo-tooltip-overlay-show ()
 180   (save-window-excursion
 181     (set-window-buffer nil (current-buffer))
 182     (insert "aaaa\n bb\nccccc\nddd")
 183     (search-backward "bb")
 184     (let ((col-row (company--col-row))
 185           (company-tooltip-limit 5)
 186           (company-candidates-length 2)
 187           (company-candidates '("123" "45")))
 188       (company-pseudo-tooltip-show (cdr col-row) (car col-row) 0)
 189       (let ((ov company-pseudo-tooltip-overlay))
 190         (should (eq (overlay-get ov 'company-width) 3))
 191         ;; FIXME: Make it 2?
 192         (should (eq (overlay-get ov 'company-height) 5))
 193         (should (eq (overlay-get ov 'company-column) (car col-row)))
 194         (should (string= (overlay-get ov 'company-before)
 195                          " 123\nc45 c\nddd\n"))))))
 196
 197 (ert-deftest company-pseudo-tooltip-overlay-show ()
 198   :tags '(interactive)
 199   (with-temp-buffer
 200     (company-test-pseudo-tooltip-overlay-show)))
 201
 202 (ert-deftest company-pseudo-tooltip-overlay-show-with-header-line ()
 203   :tags '(interactive)
 204   (with-temp-buffer
 205     (setq header-line-format "foo bar")
 206     (company-test-pseudo-tooltip-overlay-show)))
 207
 208 ;;; Template
 209
 210 (ert-deftest company-template-removed-after-the-last-jump ()
 211   (with-temp-buffer
 212     (insert "{ }")
 213     (goto-char 2)
 214     (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
 215       (save-excursion
 216         (dotimes (i 2)
 217           (insert " ")
 218           (company-template-add-field tpl (point) "foo")))
 219       (company-call 'template-forward-field)
 220       (should (= 3 (point)))
 221       (company-call 'template-forward-field)
 222       (should (= 7 (point)))
 223       (company-call 'template-forward-field)
 224       (should (= 11 (point)))
 225       (should (zerop (length (overlay-get tpl 'company-template-fields))))
 226       (should (null (overlay-buffer tpl))))))
 227
 228 (ert-deftest company-template-removed-after-input-and-jump ()
 229   (with-temp-buffer
 230     (insert "{ }")
 231     (goto-char 2)
 232     (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
 233       (save-excursion
 234         (insert " ")
 235         (company-template-add-field tpl (point) "bar"))
 236       (company-call 'template-move-to-first tpl)
 237       (should (= 3 (point)))
 238       (dolist (c (string-to-list "tee"))
 239         (let ((last-command-event c))
 240           (company-call 'self-insert-command 1)))
 241       (should (string= "{ tee }" (buffer-string)))
 242       (should (overlay-buffer tpl))
 243       (company-call 'template-forward-field)
 244       (should (= 7 (point)))
 245       (should (null (overlay-buffer tpl))))))
 246
 247 (defun company-call (name &rest args)
 248   (let* ((maybe (intern (format "company-%s" name)))
 249          (command (if (fboundp maybe) maybe name)))
 250     (apply command args)
 251     (let ((this-command command))
 252       (run-hooks 'post-command-hook))))
 253
 254 (ert-deftest company-template-c-like-templatify ()
 255   (with-temp-buffer
 256     (let ((text "foo(int a, short b)"))
 257       (insert text)
 258       (company-template-c-like-templatify text)
 259       (should (equal "foo(arg0, arg1)" (buffer-string)))
 260       (should (looking-at "arg0"))
 261       (should (equal "int a"
 262                      (overlay-get (company-template-field-at) 'display))))))
 263
 264 ;;; Elisp
 265
 266 (defmacro company-elisp-with-buffer (contents &rest body)
 267   (declare (indent 0))
 268   `(with-temp-buffer
 269      (insert ,contents)
 270      (setq major-mode 'emacs-lisp-mode)
 271      (re-search-backward "|")
 272      (replace-match "")
 273      (let ((company-elisp-detect-function-context t))
 274        ,@body)))
 275
 276 (ert-deftest company-elisp-candidates-predicate ()
 277   (company-elisp-with-buffer
 278     "(foo ba|)"
 279     (should (eq (company-elisp--candidates-predicate "ba")
 280                 'boundp))
 281     (should (eq (let (company-elisp-detect-function-context)
 282                   (company-elisp--candidates-predicate "ba"))
 283                 'company-elisp--predicate)))
 284   (company-elisp-with-buffer
 285     "(foo| )"
 286     (should (eq (company-elisp--candidates-predicate "foo")
 287                 'fboundp))
 288     (should (eq (let (company-elisp-detect-function-context)
 289                   (company-elisp--candidates-predicate "foo"))
 290                 'company-elisp--predicate)))
 291   (company-elisp-with-buffer
 292     "(foo 'b|)"
 293     (should (eq (company-elisp--candidates-predicate "b")
 294                 'company-elisp--predicate))))
 295
 296 (ert-deftest company-elisp-candidates-predicate-in-docstring ()
 297   (company-elisp-with-buffer
 298    "(def foo () \"Doo be doo `ide|"
 299    (should (eq 'company-elisp--predicate
 300                (company-elisp--candidates-predicate "ide")))))
 301
 302 ;; This one's also an integration test.
 303 (ert-deftest company-elisp-candidates-recognizes-binding-form ()
 304   (let ((company-elisp-detect-function-context t)
 305         (obarray [when what whelp])
 306         (what 1)
 307         (whelp 2)
 308         (wisp 3))
 309     (company-elisp-with-buffer
 310       "(let ((foo 7) (wh| )))"
 311       (should (equal '("what" "whelp")
 312                      (company-elisp-candidates "wh"))))
 313     (company-elisp-with-buffer
 314       "(cond ((null nil) (wh| )))"
 315       (should (equal '("when")
 316                      (company-elisp-candidates "wh"))))))
 317
 318 (ert-deftest company-elisp-candidates-predicate-binding-without-value ()
 319   (loop for (text prefix predicate) in '(("(let (foo|" "foo" boundp)
 320                                          ("(let (foo (bar|" "bar" boundp)
 321                                          ("(let (foo) (bar|" "bar" fboundp))
 322         do
 323         (eval `(company-elisp-with-buffer
 324                  ,text
 325                  (should (eq ',predicate
 326                              (company-elisp--candidates-predicate ,prefix)))))))
 327
 328 (ert-deftest company-elisp-finds-vars ()
 329   (let ((obarray [boo bar baz backquote])
 330         (boo t)
 331         (bar t)
 332         (baz t))
 333     (should (equal '("bar" "baz")
 334                    (company-elisp--globals "ba" 'boundp)))))
 335
 336 (ert-deftest company-elisp-finds-functions ()
 337   (let ((obarray [when what whelp])
 338         (what t)
 339         (whelp t))
 340     (should (equal '("when")
 341                    (company-elisp--globals "wh" 'fboundp)))))
 342
 343 (ert-deftest company-elisp-finds-things ()
 344   (let ((obarray [when what whelp])
 345         (what t)
 346         (whelp t))
 347     (should (equal '("what" "whelp" "when")
 348                    (sort (company-elisp--globals "wh" 'company-elisp--predicate)
 349                          'string<)))))
 350
 351 (ert-deftest company-elisp-locals-vars ()
 352   (company-elisp-with-buffer
 353     "(let ((foo 5) (bar 6))
 354        (cl-labels ((borg ()))
 355          (lambda (boo baz)
 356            b|)))"
 357     (should (equal '("bar" "baz" "boo")
 358                    (company-elisp--locals "b" nil)))))
 359
 360 (ert-deftest company-elisp-locals-single-var ()
 361   (company-elisp-with-buffer
 362     "(dotimes (itk 100)
 363        (dolist (item items)
 364          it|))"
 365     (should (equal '("itk" "item")
 366                    (company-elisp--locals "it" nil)))))
 367
 368 (ert-deftest company-elisp-locals-funs ()
 369   (company-elisp-with-buffer
 370     "(cl-labels ((foo ())
 371                  (fee ()))
 372        (let ((fun 4))
 373          (f| )))"
 374     (should (equal '("fee" "foo")
 375                    (sort (company-elisp--locals "f" t) 'string<)))))
 376
 377 (ert-deftest company-elisp-locals-skips-current-varlist ()
 378   (company-elisp-with-buffer
 379     "(let ((foo 1)
 380            (f| )))"
 381     (should (null (company-elisp--locals "f" nil)))))
 382
 383 (ert-deftest company-elisp-show-locals-first ()
 384   (company-elisp-with-buffer
 385     "(let ((floo 1)
 386            (flop 2)
 387            (flee 3))
 388        fl|)"
 389     (let ((obarray [float-pi]))
 390       (let (company-elisp-show-locals-first)
 391         (should (eq nil (company-elisp 'sorted))))
 392       (let ((company-elisp-show-locals-first t))
 393         (should (eq t (company-elisp 'sorted)))
 394         (should (equal '("flee" "floo" "flop" "float-pi")
 395                        (company-elisp-candidates "fl")))))))
 396
 397 (ert-deftest company-elisp-candidates-no-duplicates ()
 398   (company-elisp-with-buffer
 399     "(let ((float-pi 4))
 400        f|)"
 401     (let ((obarray [float-pi])
 402           (company-elisp-show-locals-first t))
 403       (should (equal '("float-pi") (company-elisp-candidates "f"))))))
 404
 405 (ert-deftest company-elisp-shouldnt-complete-defun-name ()
 406   (company-elisp-with-buffer
 407     "(defun foob|)"
 408     (should (null (company-elisp 'prefix)))))
 409
 410 (ert-deftest company-elisp-should-complete-def-call ()
 411   (company-elisp-with-buffer
 412     "(defu|"
 413     (should (equal "defu" (company-elisp 'prefix)))))
 414
 415 (ert-deftest company-elisp-should-complete-in-defvar ()
 416   ;; It will also complete the var name, at least for now.
 417   (company-elisp-with-buffer
 418     "(defvar abc de|"
 419     (should (equal "de" (company-elisp 'prefix)))))
 420
 421 (ert-deftest company-elisp-shouldnt-complete-in-defun-arglist ()
 422   (company-elisp-with-buffer
 423     "(defsubst foobar (ba|"
 424     (should (null (company-elisp 'prefix)))))
 425
 426 (ert-deftest company-elisp-prefix-in-defun-body ()
 427   (company-elisp-with-buffer
 428     "(defun foob ()|)"
 429     (should (equal "" (company-elisp 'prefix)))))
 430
 431 ;;; Clang
 432
 433 (ert-deftest company-clang-objc-templatify ()
 434   (with-temp-buffer
 435     (let ((text "createBookWithTitle:andAuthor:"))
 436       (insert text)
 437       (company-clang-objc-templatify text)
 438       (should (equal "createBookWithTitle:arg0 andAuthor:arg1" (buffer-string)))
 439       (should (looking-at "arg0"))
 440       (should (null (overlay-get (company-template-field-at) 'display))))))