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