test/lisp/subr-tests.el

   1 ;;; subr-tests.el --- Tests for subr.el
   2
   3 ;; Copyright (C) 2015-2017 Free Software Foundation, Inc.
   4
   5 ;; Author: Oleh Krehel <ohwoeowho@gmail.com>,
   6 ;;         Nicolas Petton <nicolas@petton.fr>
   7 ;; Keywords:
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;;
  27
  28 ;;; Code:
  29
  30 (require 'ert)
  31 (eval-when-compile (require 'cl-lib))
  32
  33 (ert-deftest let-when-compile ()
  34   ;; good case
  35   (should (equal (macroexpand '(let-when-compile ((foo (+ 2 3)))
  36                                 (setq bar (eval-when-compile (+ foo foo)))
  37                                 (setq boo (eval-when-compile (* foo foo)))))
  38                  '(progn
  39                    (setq bar (quote 10))
  40                    (setq boo (quote 25)))))
  41   ;; bad case: `eval-when-compile' omitted, byte compiler should catch this
  42   (should (equal (macroexpand
  43                   '(let-when-compile ((foo (+ 2 3)))
  44                     (setq bar (+ foo foo))
  45                     (setq boo (eval-when-compile (* foo foo)))))
  46                  '(progn
  47                    (setq bar (+ foo foo))
  48                    (setq boo (quote 25)))))
  49   ;; something practical
  50   (should (equal (macroexpand
  51                   '(let-when-compile ((keywords '("true" "false")))
  52                     (font-lock-add-keywords
  53                      'c++-mode
  54                      `((,(eval-when-compile
  55                            (format "\\<%s\\>" (regexp-opt keywords)))
  56                          0 font-lock-keyword-face)))))
  57                  '(font-lock-add-keywords
  58                    (quote c++-mode)
  59                    (list
  60                     (cons (quote
  61                            "\\<\\(?:\\(?:fals\\|tru\\)e\\)\\>")
  62                      (quote
  63                       (0 font-lock-keyword-face))))))))
  64
  65 (ert-deftest number-sequence-test ()
  66   (should (= (length
  67               (number-sequence (1- most-positive-fixnum) most-positive-fixnum))
  68              2))
  69   (should (= (length
  70               (number-sequence
  71                (1+ most-negative-fixnum) most-negative-fixnum -1))
  72              2)))
  73
  74 (ert-deftest string-comparison-test ()
  75   (should (string-lessp "abc" "acb"))
  76   (should (string-lessp "aBc" "abc"))
  77   (should (string-lessp "abc" "abcd"))
  78   (should (string-lessp "abc" "abcd"))
  79   (should-not (string-lessp "abc" "abc"))
  80   (should-not (string-lessp "" ""))
  81
  82   (should (string-greaterp "acb" "abc"))
  83   (should (string-greaterp "abc" "aBc"))
  84   (should (string-greaterp "abcd" "abc"))
  85   (should (string-greaterp "abcd" "abc"))
  86   (should-not (string-greaterp "abc" "abc"))
  87   (should-not (string-greaterp "" ""))
  88
  89   ;; Symbols are also accepted
  90   (should (string-lessp 'abc 'acb))
  91   (should (string-lessp "abc" 'acb))
  92   (should (string-greaterp 'acb 'abc))
  93   (should (string-greaterp "acb" 'abc)))
  94
  95 (ert-deftest subr-test-when ()
  96   (should (equal (when t 1) 1))
  97   (should (equal (when t 2) 2))
  98   (should (equal (when nil 1) nil))
  99   (should (equal (when nil 2) nil))
 100   (should (equal (when t 'x 1) 1))
 101   (should (equal (when t 'x 2) 2))
 102   (should (equal (when nil 'x 1) nil))
 103   (should (equal (when nil 'x 2) nil))
 104   (let ((x 1))
 105     (should-not (when nil
 106                   (setq x (1+ x))
 107                   x))
 108     (should (= x 1))
 109     (should (= 2 (when t
 110                    (setq x (1+ x))
 111                    x)))
 112     (should (= x 2)))
 113   (should (equal (macroexpand-all '(when a b c d))
 114                  '(if a (progn b c d)))))
 115
 116 (ert-deftest subr-test-version-parsing ()
 117   (should (equal (version-to-list ".5") '(0 5)))
 118   (should (equal (version-to-list "0.9 alpha1") '(0 9 -3 1)))
 119   (should (equal (version-to-list "0.9 snapshot") '(0  9 -4)))
 120   (should (equal (version-to-list "0.9-alpha1") '(0 9 -3 1)))
 121   (should (equal (version-to-list "0.9-snapshot") '(0  9 -4)))
 122   (should (equal (version-to-list "0.9.snapshot") '(0  9 -4)))
 123   (should (equal (version-to-list "0.9_snapshot") '(0  9 -4)))
 124   (should (equal (version-to-list "0.9alpha1") '(0 9 -3 1)))
 125   (should (equal (version-to-list "0.9snapshot") '(0  9 -4)))
 126   (should (equal (version-to-list "1.0 git") '(1  0 -4)))
 127   (should (equal (version-to-list "1.0 pre2") '(1 0 -1 2)))
 128   (should (equal (version-to-list "1.0-git") '(1  0 -4)))
 129   (should (equal (version-to-list "1.0-pre2") '(1 0 -1 2)))
 130   (should (equal (version-to-list "1.0.1-a") '(1 0 1 1)))
 131   (should (equal (version-to-list "1.0.1-f") '(1 0 1 6)))
 132   (should (equal (version-to-list "1.0.1.a") '(1 0 1 1)))
 133   (should (equal (version-to-list "1.0.1.f") '(1 0 1 6)))
 134   (should (equal (version-to-list "1.0.1_a") '(1 0 1 1)))
 135   (should (equal (version-to-list "1.0.1_f") '(1 0 1 6)))
 136   (should (equal (version-to-list "1.0.1a") '(1 0 1 1)))
 137   (should (equal (version-to-list "1.0.1f") '(1 0 1 6)))
 138   (should (equal (version-to-list "1.0.7.5") '(1 0 7 5)))
 139   (should (equal (version-to-list "1.0.git") '(1  0 -4)))
 140   (should (equal (version-to-list "1.0.pre2") '(1 0 -1 2)))
 141   (should (equal (version-to-list "1.0_git") '(1  0 -4)))
 142   (should (equal (version-to-list "1.0_pre2") '(1 0 -1 2)))
 143   (should (equal (version-to-list "1.0git") '(1  0 -4)))
 144   (should (equal (version-to-list "1.0pre2") '(1 0 -1 2)))
 145   (should (equal (version-to-list "22.8 beta3") '(22 8 -2 3)))
 146   (should (equal (version-to-list "22.8-beta3") '(22 8 -2 3)))
 147   (should (equal (version-to-list "22.8.beta3") '(22 8 -2 3)))
 148   (should (equal (version-to-list "22.8_beta3") '(22 8 -2 3)))
 149   (should (equal (version-to-list "22.8beta3") '(22 8 -2 3)))
 150   (should (equal (version-to-list "6.9.30 Beta") '(6 9 30 -2)))
 151   (should (equal (version-to-list "6.9.30-Beta") '(6 9 30 -2)))
 152   (should (equal (version-to-list "6.9.30.Beta") '(6 9 30 -2)))
 153   (should (equal (version-to-list "6.9.30Beta") '(6 9 30 -2)))
 154   (should (equal (version-to-list "6.9.30_Beta") '(6 9 30 -2)))
 155
 156   (should (equal
 157             (error-message-string (should-error (version-to-list "OTP-18.1.5")))
 158             "Invalid version syntax: `OTP-18.1.5' (must start with a number)"))
 159   (should (equal
 160             (error-message-string (should-error (version-to-list "")))
 161             "Invalid version syntax: `' (must start with a number)"))
 162   (should (equal
 163             (error-message-string (should-error (version-to-list "1.0..7.5")))
 164             "Invalid version syntax: `1.0..7.5'"))
 165   (should (equal
 166             (error-message-string (should-error (version-to-list "1.0prepre2")))
 167             "Invalid version syntax: `1.0prepre2'"))
 168   (should (equal
 169             (error-message-string (should-error (version-to-list "22.8X3")))
 170             "Invalid version syntax: `22.8X3'"))
 171   (should (equal
 172             (error-message-string (should-error (version-to-list "beta22.8alpha3")))
 173             "Invalid version syntax: `beta22.8alpha3' (must start with a number)"))
 174   (should (equal
 175             (error-message-string (should-error (version-to-list "honk")))
 176             "Invalid version syntax: `honk' (must start with a number)"))
 177   (should (equal
 178             (error-message-string (should-error (version-to-list 9)))
 179             "Version must be a string"))
 180
 181   (let ((version-separator "_"))
 182     (should (equal (version-to-list "_5") '(0 5)))
 183     (should (equal (version-to-list "0_9 alpha1") '(0 9 -3 1)))
 184     (should (equal (version-to-list "0_9 snapshot") '(0  9 -4)))
 185     (should (equal (version-to-list "0_9-alpha1") '(0 9 -3 1)))
 186     (should (equal (version-to-list "0_9-snapshot") '(0  9 -4)))
 187     (should (equal (version-to-list "0_9.alpha1") '(0 9 -3 1)))
 188     (should (equal (version-to-list "0_9.snapshot") '(0  9 -4)))
 189     (should (equal (version-to-list "0_9alpha1") '(0 9 -3 1)))
 190     (should (equal (version-to-list "0_9snapshot") '(0  9 -4)))
 191     (should (equal (version-to-list "1_0 git") '(1  0 -4)))
 192     (should (equal (version-to-list "1_0 pre2") '(1 0 -1 2)))
 193     (should (equal (version-to-list "1_0-git") '(1  0 -4)))
 194     (should (equal (version-to-list "1_0.pre2") '(1 0 -1 2)))
 195     (should (equal (version-to-list "1_0_1-a") '(1 0 1 1)))
 196     (should (equal (version-to-list "1_0_1-f") '(1 0 1 6)))
 197     (should (equal (version-to-list "1_0_1.a") '(1 0 1 1)))
 198     (should (equal (version-to-list "1_0_1.f") '(1 0 1 6)))
 199     (should (equal (version-to-list "1_0_1_a") '(1 0 1 1)))
 200     (should (equal (version-to-list "1_0_1_f") '(1 0 1 6)))
 201     (should (equal (version-to-list "1_0_1a") '(1 0 1 1)))
 202     (should (equal (version-to-list "1_0_1f") '(1 0 1 6)))
 203     (should (equal (version-to-list "1_0_7_5") '(1 0 7 5)))
 204     (should (equal (version-to-list "1_0_git") '(1  0 -4)))
 205     (should (equal (version-to-list "1_0pre2") '(1 0 -1 2)))
 206     (should (equal (version-to-list "22_8 beta3") '(22 8 -2 3)))
 207     (should (equal (version-to-list "22_8-beta3") '(22 8 -2 3)))
 208     (should (equal (version-to-list "22_8.beta3") '(22 8 -2 3)))
 209     (should (equal (version-to-list "22_8beta3") '(22 8 -2 3)))
 210     (should (equal (version-to-list "6_9_30 Beta") '(6 9 30 -2)))
 211     (should (equal (version-to-list "6_9_30-Beta") '(6 9 30 -2)))
 212     (should (equal (version-to-list "6_9_30.Beta") '(6 9 30 -2)))
 213     (should (equal (version-to-list "6_9_30Beta") '(6 9 30 -2)))
 214
 215     (should (equal
 216               (error-message-string (should-error (version-to-list "1_0__7_5")))
 217               "Invalid version syntax: `1_0__7_5'"))
 218     (should (equal
 219               (error-message-string (should-error (version-to-list "1_0prepre2")))
 220               "Invalid version syntax: `1_0prepre2'"))
 221     (should (equal
 222               (error-message-string (should-error (version-to-list "22.8X3")))
 223               "Invalid version syntax: `22.8X3'"))
 224     (should (equal
 225               (error-message-string (should-error (version-to-list "beta22_8alpha3")))
 226               "Invalid version syntax: `beta22_8alpha3' (must start with a number)"))))
 227
 228 (defun subr-test--backtrace-frames-with-backtrace-frame (base)
 229   "Reference implementation of `backtrace-frames'."
 230   (let ((idx 0)
 231         (frame nil)
 232         (frames nil))
 233     (while (setq frame (backtrace-frame idx base))
 234       (push frame frames)
 235       (setq idx (1+ idx)))
 236     (nreverse frames)))
 237
 238 (defun subr-test--frames-2 (base)
 239   (let ((_dummy nil))
 240     (progn ;; Add a few frames to top of stack
 241       (unwind-protect
 242           (cons (mapcar (pcase-lambda (`(,evald ,func ,args ,_))
 243                           `(,evald ,func ,@args))
 244                         (backtrace-frames base))
 245                 (subr-test--backtrace-frames-with-backtrace-frame base))))))
 246
 247 (defun subr-test--frames-1 (base)
 248   (subr-test--frames-2 base))
 249
 250 (ert-deftest subr-test-backtrace-simple-tests ()
 251   "Test backtrace-related functions (simple tests).
 252 This exercises `backtrace-frame', and indirectly `mapbacktrace'."
 253   ;; `mapbacktrace' returns nil
 254   (should (equal (mapbacktrace #'ignore) nil))
 255   ;; Unbound BASE is silently ignored
 256   (let ((unbound (make-symbol "ub")))
 257     (should (equal (backtrace-frame 0 unbound) nil))
 258     (should (equal (mapbacktrace #'error unbound) nil)))
 259   ;; First frame is backtrace-related function
 260   (should (equal (backtrace-frame 0) '(t backtrace-frame 0)))
 261   (let ((throw-args (lambda (&rest args) (throw 'ret args))))
 262     (should (equal (catch 'ret (mapbacktrace throw-args))
 263                    `(t mapbacktrace (,throw-args) nil))))
 264   ;; Past-end NFRAMES is silently ignored
 265   (should (equal (backtrace-frame most-positive-fixnum) nil)))
 266
 267 (ert-deftest subr-test-backtrace-integration-test ()
 268   "Test backtrace-related functions (integration test).
 269 This exercises `backtrace-frame', `backtrace-frames', and
 270 indirectly `mapbacktrace'."
 271   ;; Compare two implementations of backtrace-frames
 272   (let ((frame-lists (subr-test--frames-1 'subr-test--frames-2)))
 273     (should (equal (car frame-lists) (cdr frame-lists)))))
 274
 275 (ert-deftest subr-tests--string-match-p--blank ()
 276   "Test that [:blank:] matches horizontal whitespace, cf. Bug#25366."
 277   (should (equal (string-match-p "\\`[[:blank:]]\\'" " ") 0))
 278   (should (equal (string-match-p "\\`[[:blank:]]\\'" "\t") 0))
 279   (should-not (string-match-p "\\`[[:blank:]]\\'" "\n"))
 280   (should-not (string-match-p "\\`[[:blank:]]\\'" "a"))
 281   (should (equal (string-match-p "\\`[[:blank:]]\\'" "\N{HAIR SPACE}") 0))
 282   (should (equal (string-match-p "\\`[[:blank:]]\\'" "\u3000") 0))
 283   (should-not (string-match-p "\\`[[:blank:]]\\'" "\N{LINE SEPARATOR}")))
 284
 285 (ert-deftest subr-tests--dolist--wrong-number-of-args ()
 286   "Test that `dolist' doesn't accept wrong types or length of SPEC,
 287 cf. Bug#25477."
 288   (should-error (eval '(dolist (a)))
 289                 :type 'wrong-number-of-arguments)
 290   (should-error (eval '(dolist (a () 'result 'invalid)) t)
 291                 :type 'wrong-number-of-arguments)
 292   (should-error (eval '(dolist "foo") t)
 293                 :type 'wrong-type-argument))
 294
 295 (ert-deftest subr-tests-bug22027 ()
 296   "Test for https://debbugs.gnu.org/22027 ."
 297   (let ((default "foo") res)
 298     (cl-letf (((symbol-function 'read-string)
 299                (lambda (_prompt _init _hist def) def)))
 300       (setq res (read-passwd "pass: " 'confirm (mapconcat #'string default "")))
 301       (should (string= default res)))))
 302
 303 (ert-deftest subr-tests--gensym ()
 304   "Test `gensym' behavior."
 305   (should (equal (symbol-name (let ((gensym-counter 0)) (gensym)))
 306                  "g0"))
 307   (should (eq (string-to-char (symbol-name (gensym))) ?g))
 308   (should (eq (string-to-char (symbol-name (gensym "X"))) ?X)))
 309
 310 (provide 'subr-tests)
 311 ;;; subr-tests.el ends here