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-candidates-length 2)
 186           (company-candidates '("123" "45")))
 187       (company-pseudo-tooltip-show (cdr col-row) (car col-row) 0)
 188       (let ((ov company-pseudo-tooltip-overlay))
 189         (should (eq (overlay-get ov 'company-width) 3))
 190         ;; FIXME: Make it 2?
 191         (should (eq (overlay-get ov 'company-height) 10))
 192         (should (eq (overlay-get ov 'company-column) (car col-row)))
 193         (should (string= (overlay-get ov 'company-before)
 194                          " 123\nc45 c\nddd\n"))))))
 195
 196 (ert-deftest company-pseudo-tooltip-overlay-show ()
 197   :tags '(interactive)
 198   (with-temp-buffer
 199     (company-test-pseudo-tooltip-overlay-show)))
 200
 201 (ert-deftest company-pseudo-tooltip-overlay-show-with-header-line ()
 202   :tags '(interactive)
 203   (with-temp-buffer
 204     (setq header-line-format "foo bar")
 205     (company-test-pseudo-tooltip-overlay-show)))
 206
 207 ;;; Template
 208
 209 (ert-deftest company-template-removed-after-the-last-jump ()
 210   (with-temp-buffer
 211     (insert "{ }")
 212     (goto-char 2)
 213     (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
 214       (save-excursion
 215         (dotimes (i 2)
 216           (insert " ")
 217           (company-template-add-field tpl (point) "foo")))
 218       (company-call 'template-forward-field)
 219       (should (= 3 (point)))
 220       (company-call 'template-forward-field)
 221       (should (= 7 (point)))
 222       (company-call 'template-forward-field)
 223       (should (= 11 (point)))
 224       (should (zerop (length (overlay-get tpl 'company-template-fields))))
 225       (should (null (overlay-buffer tpl))))))
 226
 227 (ert-deftest company-template-removed-after-input-and-jump ()
 228   (with-temp-buffer
 229     (insert "{ }")
 230     (goto-char 2)
 231     (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
 232       (save-excursion
 233         (insert " ")
 234         (company-template-add-field tpl (point) "bar"))
 235       (company-call 'template-move-to-first tpl)
 236       (should (= 3 (point)))
 237       (dolist (c (string-to-list "tee"))
 238         (let ((last-command-event c))
 239           (company-call 'self-insert-command 1)))
 240       (should (string= "{ tee }" (buffer-string)))
 241       (should (overlay-buffer tpl))
 242       (company-call 'template-forward-field)
 243       (should (= 7 (point)))
 244       (should (null (overlay-buffer tpl))))))
 245
 246 (defun company-call (name &rest args)
 247   (let* ((maybe (intern (format "company-%s" name)))
 248          (command (if (fboundp maybe) maybe name)))
 249     (apply command args)
 250     (let ((this-command command))
 251       (run-hooks 'post-command-hook))))
 252
 253 (ert-deftest company-template-c-like-templatify ()
 254   (with-temp-buffer
 255     (let ((text "foo(int a, short b)"))
 256       (insert text)
 257       (company-template-c-like-templatify text)
 258       (should (equal "foo(arg0, arg1)" (buffer-string)))
 259       (should (looking-at "arg0"))
 260       (should (equal "int a"
 261                      (overlay-get (company-template-field-at) 'display))))))
 262
 263 ;;; Elisp
 264
 265 (defmacro company-elisp-with-buffer (contents &rest body)
 266   (declare (indent 0))
 267   `(with-temp-buffer
 268      (insert ,contents)
 269      (setq major-mode 'emacs-lisp-mode)
 270      (re-search-backward "|")
 271      (replace-match "")
 272      (let ((company-elisp-detect-function-context t))
 273        ,@body)))
 274
 275 (ert-deftest company-elisp-candidates-predicate ()
 276   (company-elisp-with-buffer
 277     "(foo ba|)"
 278     (should (eq (company-elisp--candidates-predicate "ba")
 279                 'boundp))
 280     (should (eq (let (company-elisp-detect-function-context)
 281                   (company-elisp--candidates-predicate "ba"))
 282                 'company-elisp--predicate)))
 283   (company-elisp-with-buffer
 284     "(foo| )"
 285     (should (eq (company-elisp--candidates-predicate "foo")
 286                 'fboundp))
 287     (should (eq (let (company-elisp-detect-function-context)
 288                   (company-elisp--candidates-predicate "foo"))
 289                 'company-elisp--predicate)))
 290   (company-elisp-with-buffer
 291     "(foo 'b|)"
 292     (should (eq (company-elisp--candidates-predicate "b")
 293                 'company-elisp--predicate))))
 294
 295 (ert-deftest company-elisp-candidates-predicate-in-docstring ()
 296   (company-elisp-with-buffer
 297    "(def foo () \"Doo be doo `ide|"
 298    (should (eq 'company-elisp--predicate
 299                (company-elisp--candidates-predicate "ide")))))
 300
 301 ;; This one's also an integration test.
 302 (ert-deftest company-elisp-candidates-recognizes-binding-form ()
 303   (let ((company-elisp-detect-function-context t)
 304         (obarray [when what whelp])
 305         (what 1)
 306         (whelp 2)
 307         (wisp 3))
 308     (company-elisp-with-buffer
 309       "(let ((foo 7) (wh| )))"
 310       (should (equal '("what" "whelp")
 311                      (company-elisp-candidates "wh"))))
 312     (company-elisp-with-buffer
 313       "(cond ((null nil) (wh| )))"
 314       (should (equal '("when")
 315                      (company-elisp-candidates "wh"))))))
 316
 317 (ert-deftest company-elisp-candidates-predicate-binding-without-value ()
 318   (loop for (text prefix predicate) in '(("(let (foo|" "foo" boundp)
 319                                          ("(let (foo (bar|" "bar" boundp)
 320                                          ("(let (foo) (bar|" "bar" fboundp))
 321         do
 322         (eval `(company-elisp-with-buffer
 323                  ,text
 324                  (should (eq ',predicate
 325                              (company-elisp--candidates-predicate ,prefix)))))))
 326
 327 (ert-deftest company-elisp-finds-vars ()
 328   (let ((obarray [boo bar baz backquote])
 329         (boo t)
 330         (bar t)
 331         (baz t))
 332     (should (equal '("bar" "baz")
 333                    (company-elisp--globals "ba" 'boundp)))))
 334
 335 (ert-deftest company-elisp-finds-functions ()
 336   (let ((obarray [when what whelp])
 337         (what t)
 338         (whelp t))
 339     (should (equal '("when")
 340                    (company-elisp--globals "wh" 'fboundp)))))
 341
 342 (ert-deftest company-elisp-finds-things ()
 343   (let ((obarray [when what whelp])
 344         (what t)
 345         (whelp t))
 346     (should (equal '("what" "whelp" "when")
 347                    (sort (company-elisp--globals "wh" 'company-elisp--predicate)
 348                          'string<)))))
 349
 350 (ert-deftest company-elisp-locals-vars ()
 351   (company-elisp-with-buffer
 352     "(let ((foo 5) (bar 6))
 353        (cl-labels ((borg ()))
 354          (lambda (boo baz)
 355            b|)))"
 356     (should (equal '("bar" "baz" "boo")
 357                    (company-elisp--locals "b" nil)))))
 358
 359 (ert-deftest company-elisp-locals-single-var ()
 360   (company-elisp-with-buffer
 361     "(dotimes (itk 100)
 362        (dolist (item items)
 363          it|))"
 364     (should (equal '("itk" "item")
 365                    (company-elisp--locals "it" nil)))))
 366
 367 (ert-deftest company-elisp-locals-funs ()
 368   (company-elisp-with-buffer
 369     "(cl-labels ((foo ())
 370                  (fee ()))
 371        (let ((fun 4))
 372          (f| )))"
 373     (should (equal '("fee" "foo")
 374                    (sort (company-elisp--locals "f" t) 'string<)))))
 375
 376 (ert-deftest company-elisp-locals-skips-current-varlist ()
 377   (company-elisp-with-buffer
 378     "(let ((foo 1)
 379            (f| )))"
 380     (should (null (company-elisp--locals "f" nil)))))
 381
 382 (ert-deftest company-elisp-show-locals-first ()
 383   (company-elisp-with-buffer
 384     "(let ((floo 1)
 385            (flop 2)
 386            (flee 3))
 387        fl|)"
 388     (let ((obarray [float-pi]))
 389       (let (company-elisp-show-locals-first)
 390         (should (eq nil (company-elisp 'sorted))))
 391       (let ((company-elisp-show-locals-first t))
 392         (should (eq t (company-elisp 'sorted)))
 393         (should (equal '("flee" "floo" "flop" "float-pi")
 394                        (company-elisp-candidates "fl")))))))
 395
 396 (ert-deftest company-elisp-candidates-no-duplicates ()
 397   (company-elisp-with-buffer
 398     "(let ((float-pi 4))
 399        f|)"
 400     (let ((obarray [float-pi])
 401           (company-elisp-show-locals-first t))
 402       (should (equal '("float-pi") (company-elisp-candidates "f"))))))
 403
 404 (ert-deftest company-elisp-shouldnt-complete-defun-name ()
 405   (company-elisp-with-buffer
 406     "(defun foob|)"
 407     (should (null (company-elisp 'prefix)))))
 408
 409 (ert-deftest company-elisp-should-complete-def-call ()
 410   (company-elisp-with-buffer
 411     "(defu|"
 412     (should (equal "defu" (company-elisp 'prefix)))))
 413
 414 (ert-deftest company-elisp-should-complete-in-defvar ()
 415   ;; It will also complete the var name, at least for now.
 416   (company-elisp-with-buffer
 417     "(defvar abc de|"
 418     (should (equal "de" (company-elisp 'prefix)))))
 419
 420 (ert-deftest company-elisp-shouldnt-complete-in-defun-arglist ()
 421   (company-elisp-with-buffer
 422     "(defsubst foobar (ba|"
 423     (should (null (company-elisp 'prefix)))))
 424
 425 (ert-deftest company-elisp-prefix-in-defun-body ()
 426   (company-elisp-with-buffer
 427     "(defun foob ()|)"
 428     (should (equal "" (company-elisp 'prefix)))))
 429
 430 ;;; Clang
 431
 432 (ert-deftest company-clang-objc-templatify ()
 433   (with-temp-buffer
 434     (let ((text "createBookWithTitle:andAuthor:"))
 435       (insert text)
 436       (company-clang-objc-templatify text)
 437       (should (equal "createBookWithTitle:arg0 andAuthor:arg1" (buffer-string)))
 438       (should (looking-at "arg0"))
 439       (should (null (overlay-get (company-template-field-at) 'display))))))