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

   1 ;;; core-tests.el --- company-mode tests  -*- lexical-binding: t -*-
   2
   3 ;; Copyright (C) 2015  Free Software Foundation, Inc.
   4
   5 ;; Author: Dmitry Gutov
   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 (require 'company-tests)
  23
  24 (ert-deftest company-good-prefix ()
  25   (let ((company-minimum-prefix-length 5)
  26         company-abort-manual-when-too-short
  27         company--manual-action            ;idle begin
  28         (company-selection-changed t))    ;has no effect
  29     (should (eq t (company--good-prefix-p "!@#$%")))
  30     (should (eq nil (company--good-prefix-p "abcd")))
  31     (should (eq nil (company--good-prefix-p 'stop)))
  32     (should (eq t (company--good-prefix-p '("foo" . 5))))
  33     (should (eq nil (company--good-prefix-p '("foo" . 4))))
  34     (should (eq t (company--good-prefix-p '("foo" . t))))))
  35
  36 (ert-deftest company--manual-prefix-set-and-unset ()
  37   (with-temp-buffer
  38     (insert "ab")
  39     (company-mode)
  40     (let (company-frontends
  41           (company-backends
  42            (list (lambda (command &optional _)
  43                    (cl-case command
  44                      (prefix (buffer-substring (point-min) (point)))
  45                      (candidates '("abc" "abd")))))))
  46       (company-manual-begin)
  47       (should (equal "ab" company--manual-prefix))
  48       (company-abort)
  49       (should (null company--manual-prefix)))))
  50
  51 (ert-deftest company-abort-manual-when-too-short ()
  52   (let ((company-minimum-prefix-length 5)
  53         (company-abort-manual-when-too-short t)
  54         (company-selection-changed t))    ;has not effect
  55     (let ((company--manual-action nil))   ;idle begin
  56       (should (eq t (company--good-prefix-p "!@#$%")))
  57       (should (eq t (company--good-prefix-p '("foo" . 5))))
  58       (should (eq t (company--good-prefix-p '("foo" . t)))))
  59     (let ((company--manual-action t)
  60           (company--manual-prefix "abc")) ;manual begin from this prefix
  61       (should (eq t (company--good-prefix-p "!@#$")))
  62       (should (eq nil (company--good-prefix-p "ab")))
  63       (should (eq nil (company--good-prefix-p 'stop)))
  64       (should (eq t (company--good-prefix-p '("foo" . 4))))
  65       (should (eq t (company--good-prefix-p "abcd")))
  66       (should (eq t (company--good-prefix-p "abc")))
  67       (should (eq t (company--good-prefix-p '("bar" . t)))))))
  68
  69 (ert-deftest company-common-with-non-prefix-completion ()
  70   (let ((company-backend #'ignore)
  71         (company-prefix "abc")
  72         company-candidates
  73         company-candidates-length
  74         company-candidates-cache
  75         company-common)
  76     (company-update-candidates '("abc" "def-abc"))
  77     (should (null company-common))
  78     (company-update-candidates '("abc" "abe-c"))
  79     (should (null company-common))
  80     (company-update-candidates '("abcd" "abcde" "abcdf"))
  81     (should (equal "abcd" company-common))))
  82
  83 (ert-deftest company-multi-backend-with-lambdas ()
  84   (let ((company-backend
  85          (list (lambda (command &optional _ &rest _r)
  86                  (cl-case command
  87                    (prefix "z")
  88                    (candidates '("a" "b"))))
  89                (lambda (command &optional _ &rest _r)
  90                  (cl-case command
  91                    (prefix "z")
  92                    (candidates '("c" "d")))))))
  93     (should (equal (company-call-backend 'candidates "z") '("a" "b" "c" "d")))))
  94
  95 (ert-deftest company-multi-backend-filters-backends-by-prefix ()
  96   (let ((company-backend
  97          (list (lambda (command &optional _ &rest _r)
  98                  (cl-case command
  99                    (prefix (cons "z" t))
 100                    (candidates '("a" "b"))))
 101                (lambda (command &optional _ &rest _r)
 102                  (cl-case command
 103                    (prefix "t")
 104                    (candidates '("c" "d"))))
 105                (lambda (command &optional _ &rest _r)
 106                  (cl-case command
 107                    (prefix "z")
 108                    (candidates '("e" "f")))))))
 109     (should (equal (company-call-backend 'candidates "z") '("a" "b" "e" "f")))))
 110
 111 (ert-deftest company-multi-backend-remembers-candidate-backend ()
 112   (let ((company-backend
 113          (list (lambda (command &optional _)
 114                  (cl-case command
 115                    (ignore-case nil)
 116                    (annotation "1")
 117                    (candidates '("a" "c"))
 118                    (post-completion "13")))
 119                (lambda (command &optional _)
 120                  (cl-case command
 121                    (ignore-case t)
 122                    (annotation "2")
 123                    (candidates '("b" "d"))
 124                    (post-completion "42")))
 125                (lambda (command &optional _)
 126                  (cl-case command
 127                    (annotation "3")
 128                    (candidates '("e"))
 129                    (post-completion "74"))))))
 130     (let ((candidates (company-calculate-candidates nil)))
 131       (should (equal candidates '("a" "b" "c" "d" "e")))
 132       (should (equal t (company-call-backend 'ignore-case)))
 133       (should (equal "1" (company-call-backend 'annotation (nth 0 candidates))))
 134       (should (equal "2" (company-call-backend 'annotation (nth 1 candidates))))
 135       (should (equal "13" (company-call-backend 'post-completion (nth 2 candidates))))
 136       (should (equal "42" (company-call-backend 'post-completion (nth 3 candidates))))
 137       (should (equal "3" (company-call-backend 'annotation (nth 4 candidates))))
 138       (should (equal "74" (company-call-backend 'post-completion (nth 4 candidates)))))))
 139
 140 (ert-deftest company-multi-backend-handles-keyword-with ()
 141   (let ((primo (lambda (command &optional _)
 142                  (cl-case command
 143                    (prefix "a")
 144                    (candidates '("abb" "abc" "abd")))))
 145         (secundo (lambda (command &optional _)
 146                    (cl-case command
 147                      (prefix "a")
 148                      (candidates '("acc" "acd"))))))
 149     (let ((company-backend (list 'ignore 'ignore :with secundo)))
 150       (should (null (company-call-backend 'prefix))))
 151     (let ((company-backend (list 'ignore primo :with secundo)))
 152       (should (equal "a" (company-call-backend 'prefix)))
 153       (should (equal '("abb" "abc" "abd" "acc" "acd")
 154                      (company-call-backend 'candidates "a"))))))
 155
 156 (ert-deftest company-begin-backend-failure-doesnt-break-company-backends ()
 157   (with-temp-buffer
 158     (insert "a")
 159     (company-mode)
 160     (should-error
 161      (company-begin-backend #'ignore))
 162     (let (company-frontends
 163           (company-backends
 164            (list (lambda (command &optional _)
 165                    (cl-case command
 166                      (prefix "a")
 167                      (candidates '("a" "ab" "ac")))))))
 168       (let (this-command)
 169         (company-call 'complete))
 170       (should (eq 3 company-candidates-length)))))
 171
 172 (ert-deftest company-require-match-explicit ()
 173   (with-temp-buffer
 174     (insert "ab")
 175     (company-mode)
 176     (let (company-frontends
 177           (company-require-match 'company-explicit-action-p)
 178           (company-backends
 179            (list (lambda (command &optional _)
 180                    (cl-case command
 181                      (prefix (buffer-substring (point-min) (point)))
 182                      (candidates '("abc" "abd")))))))
 183       (let (this-command)
 184         (company-complete))
 185       (let ((last-command-event ?e))
 186         (company-call 'self-insert-command 1))
 187       (should (eq 2 company-candidates-length))
 188       (should (eq 3 (point))))))
 189
 190 (ert-deftest company-dont-require-match-when-idle ()
 191   (with-temp-buffer
 192     (insert "ab")
 193     (company-mode)
 194     (let (company-frontends
 195           (company-minimum-prefix-length 2)
 196           (company-require-match 'company-explicit-action-p)
 197           (company-backends
 198            (list (lambda (command &optional _)
 199                    (cl-case command
 200                      (prefix (buffer-substring (point-min) (point)))
 201                      (candidates '("abc" "abd")))))))
 202       (company-idle-begin (current-buffer) (selected-window)
 203                           (buffer-chars-modified-tick) (point))
 204       (should (eq 2 company-candidates-length))
 205       (let ((last-command-event ?e))
 206         (company-call 'self-insert-command 1))
 207       (should (eq nil company-candidates-length))
 208       (should (eq 4 (point))))))
 209
 210 (ert-deftest company-dont-require-match-if-was-a-match-and-old-prefix-ended ()
 211   (with-temp-buffer
 212     (insert "ab")
 213     (company-mode)
 214     (let (company-frontends
 215           (company-require-match t)
 216           (company-backends
 217            (list (lambda (command &optional _)
 218                    (cl-case command
 219                      (prefix (company-grab-word))
 220                      (candidates '("abc" "ab" "abd"))
 221                      (sorted t))))))
 222       (let (this-command)
 223         (company-complete))
 224       (let ((last-command-event ?e))
 225         (company-call 'self-insert-command 1))
 226       (should (eq 3 company-candidates-length))
 227       (should (eq 3 (point)))
 228       (let ((last-command-event ? ))
 229         (company-call 'self-insert-command 1))
 230       (should (null company-candidates-length))
 231       (should (eq 4 (point))))))
 232
 233 (ert-deftest company-dont-require-match-if-was-a-match-and-new-prefix-is-stop ()
 234   (with-temp-buffer
 235     (company-mode)
 236     (insert "c")
 237     (let (company-frontends
 238           (company-require-match t)
 239           (company-backends
 240            (list (lambda (command &optional _)
 241                    (cl-case command
 242                      (prefix (if (> (point) 2)
 243                                  'stop
 244                                (buffer-substring (point-min) (point))))
 245                      (candidates '("a" "b" "c")))))))
 246       (let (this-command)
 247         (company-complete))
 248       (should (eq 3 company-candidates-length))
 249       (let ((last-command-event ?e))
 250         (company-call 'self-insert-command 1))
 251       (should (not company-candidates)))))
 252
 253 (ert-deftest company-should-complete-whitelist ()
 254   (with-temp-buffer
 255     (insert "ab")
 256     (company-mode)
 257     (let (company-frontends
 258           company-begin-commands
 259           (company-backends
 260            (list (lambda (command &optional _)
 261                    (cl-case command
 262                      (prefix (buffer-substring (point-min) (point)))
 263                      (candidates '("abc" "abd")))))))
 264       (let ((company-continue-commands nil))
 265         (let (this-command)
 266           (company-complete))
 267         (company-call 'backward-delete-char 1)
 268         (should (null company-candidates-length)))
 269       (let ((company-continue-commands '(backward-delete-char)))
 270         (let (this-command)
 271           (company-complete))
 272         (company-call 'backward-delete-char 1)
 273         (should (eq 2 company-candidates-length))))))
 274
 275 (ert-deftest company-should-complete-blacklist ()
 276   (with-temp-buffer
 277     (insert "ab")
 278     (company-mode)
 279     (let (company-frontends
 280           company-begin-commands
 281           (company-backends
 282            (list (lambda (command &optional _)
 283                    (cl-case command
 284                      (prefix (buffer-substring (point-min) (point)))
 285                      (candidates '("abc" "abd")))))))
 286       (let ((company-continue-commands '(not backward-delete-char)))
 287         (let (this-command)
 288           (company-complete))
 289         (company-call 'backward-delete-char 1)
 290         (should (null company-candidates-length)))
 291       (let ((company-continue-commands '(not backward-delete-char-untabify)))
 292         (let (this-command)
 293           (company-complete))
 294         (company-call 'backward-delete-char 1)
 295         (should (eq 2 company-candidates-length))))))
 296
 297 (ert-deftest company-auto-complete-explicit ()
 298   (with-temp-buffer
 299     (insert "ab")
 300     (company-mode)
 301     (let (company-frontends
 302           (company-auto-complete 'company-explicit-action-p)
 303           (company-auto-complete-chars '(? ))
 304           (company-backends
 305            (list (lambda (command &optional _)
 306                    (cl-case command
 307                      (prefix (buffer-substring (point-min) (point)))
 308                      (candidates '("abcd" "abef")))))))
 309       (let (this-command)
 310         (company-complete))
 311       (let ((last-command-event ? ))
 312         (company-call 'self-insert-command 1))
 313       (should (string= "abcd " (buffer-string))))))
 314
 315 (ert-deftest company-no-auto-complete-when-idle ()
 316   (with-temp-buffer
 317     (insert "ab")
 318     (company-mode)
 319     (let (company-frontends
 320           (company-auto-complete 'company-explicit-action-p)
 321           (company-auto-complete-chars '(? ))
 322           (company-minimum-prefix-length 2)
 323           (company-backends
 324            (list (lambda (command &optional _)
 325                    (cl-case command
 326                      (prefix (buffer-substring (point-min) (point)))
 327                      (candidates '("abcd" "abef")))))))
 328       (company-idle-begin (current-buffer) (selected-window)
 329                           (buffer-chars-modified-tick) (point))
 330       (let ((last-command-event ? ))
 331         (company-call 'self-insert-command 1))
 332       (should (string= "ab " (buffer-string))))))
 333
 334 (ert-deftest company-clears-explicit-action-when-no-matches ()
 335   (with-temp-buffer
 336     (company-mode)
 337     (let (company-frontends
 338           company-backends)
 339       (company-call 'manual-begin) ;; fails
 340       (should (null company-candidates))
 341       (should (null (company-explicit-action-p))))))
 342
 343 (ert-deftest company-ignore-case-replaces-prefix ()
 344   (with-temp-buffer
 345     (company-mode)
 346     (let (company-frontends
 347           (company-backends
 348            (list (lambda (command &optional _)
 349                    (cl-case command
 350                      (prefix (buffer-substring (point-min) (point)))
 351                      (candidates '("abcd" "abef"))
 352                      (ignore-case t))))))
 353       (insert "A")
 354       (let (this-command)
 355         (company-complete))
 356       (should (string= "ab" (buffer-string)))
 357       (delete-char -2)
 358       (insert "A") ; hack, to keep it in one test
 359       (company-complete-selection)
 360       (should (string= "abcd" (buffer-string))))))
 361
 362 (ert-deftest company-ignore-case-with-keep-prefix ()
 363   (with-temp-buffer
 364     (insert "AB")
 365     (company-mode)
 366     (let (company-frontends
 367           (company-backends
 368            (list (lambda (command &optional _)
 369                    (cl-case command
 370                      (prefix (buffer-substring (point-min) (point)))
 371                      (candidates '("abcd" "abef"))
 372                      (ignore-case 'keep-prefix))))))
 373       (let (this-command)
 374         (company-complete))
 375       (company-complete-selection)
 376       (should (string= "ABcd" (buffer-string))))))
 377
 378 (ert-deftest company-non-prefix-completion ()
 379   (with-temp-buffer
 380     (insert "tc")
 381     (company-mode)
 382     (let (company-frontends
 383           (company-backends
 384            (list (lambda (command &optional _)
 385                    (cl-case command
 386                      (prefix (buffer-substring (point-min) (point)))
 387                      (candidates '("tea-cup" "teal-color")))))))
 388       (let (this-command)
 389         (company-complete))
 390       (should (string= "tc" (buffer-string)))
 391       (company-complete-selection)
 392       (should (string= "tea-cup" (buffer-string))))))
 393
 394 ;;; Row and column
 395
 396 (ert-deftest company-column-with-composition ()
 397   :tags '(interactive)
 398   (with-temp-buffer
 399     (save-window-excursion
 400       (set-window-buffer nil (current-buffer))
 401       (insert "lambda ()")
 402       (compose-region 1 (1+ (length "lambda")) "\\")
 403       (should (= (company--column) 4)))))
 404
 405 (ert-deftest company-column-with-line-prefix ()
 406   :tags '(interactive)
 407   (with-temp-buffer
 408     (save-window-excursion
 409       (set-window-buffer nil (current-buffer))
 410       (insert "foo")
 411       (put-text-property (point-min) (point) 'line-prefix "  ")
 412       (should (= (company--column) 5)))))
 413
 414 (ert-deftest company-column-with-line-prefix-on-empty-line ()
 415   :tags '(interactive)
 416   (with-temp-buffer
 417     (save-window-excursion
 418       (set-window-buffer nil (current-buffer))
 419       (insert "\n")
 420       (forward-char -1)
 421       (put-text-property (point-min) (point-max) 'line-prefix "  ")
 422       (should (= (company--column) 2)))))
 423
 424 (ert-deftest company-column-with-tabs ()
 425   :tags '(interactive)
 426   (with-temp-buffer
 427     (save-window-excursion
 428       (set-window-buffer nil (current-buffer))
 429       (insert "|\t|\t|\t(")
 430       (let ((tab-width 8))
 431         (should (= (company--column) 25))))))
 432
 433 (ert-deftest company-row-with-header-line-format ()
 434   :tags '(interactive)
 435   (with-temp-buffer
 436     (save-window-excursion
 437       (set-window-buffer nil (current-buffer))
 438       (should (= (company--row) 0))
 439       (setq header-line-format "aaaaaaa")
 440       (should (= (company--row) 0)))))