test/automated/seq-tests.el

   1 ;;; seq-tests.el --- Tests for sequences.el
   2
   3 ;; Copyright (C) 2014-2015 Free Software Foundation, Inc.
   4
   5 ;; Author: Nicolas Petton <nicolas@petton.fr>
   6 ;; Maintainer: emacs-devel@gnu.org
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;; Tests for sequences.el
  26
  27 ;;; Code:
  28
  29 (require 'ert)
  30 (require 'seq)
  31
  32 (defmacro with-test-sequences (spec &rest body)
  33   "Successively bind VAR to a list, vector, and string built from SEQ.
  34 Evaluate BODY for each created sequence.
  35
  36 \(fn (var seq) body)"
  37   (declare (indent 1) (debug ((symbolp form) body)))
  38   (let ((initial-seq (make-symbol "initial-seq")))
  39     `(let ((,initial-seq ,(cadr spec)))
  40        ,@(mapcar (lambda (s)
  41                    `(let ((,(car spec) (apply (function ,s) ,initial-seq)))
  42                       ,@body))
  43                  '(list vector string)))))
  44
  45 (defun same-contents-p (seq1 seq2)
  46   "Return t if SEQ1 and SEQ2 have the same contents, nil otherwise."
  47   (equal (append seq1 '()) (append seq2 '())))
  48
  49 (defun test-sequences-evenp (integer)
  50   "Return t if INTEGER is even."
  51   (eq (logand integer 1) 0))
  52
  53 (defun test-sequences-oddp (integer)
  54   "Return t if INTEGER is odd."
  55   (not (test-sequences-evenp integer)))
  56
  57 (ert-deftest test-setf-seq-elt ()
  58   (with-test-sequences (seq '(1 2 3))
  59     (setf (seq-elt seq 1) 4)
  60     (should (= 4 (seq-elt seq 1)))))
  61
  62 (ert-deftest test-seq-drop ()
  63   (with-test-sequences (seq '(1 2 3 4))
  64     (should (equal (seq-drop seq 0) seq))
  65     (should (equal (seq-drop seq 1) (seq-subseq seq 1)))
  66     (should (equal (seq-drop seq 2) (seq-subseq seq 2)))
  67     (should (seq-empty-p (seq-drop seq 4)))
  68     (should (seq-empty-p (seq-drop seq 10))))
  69   (with-test-sequences (seq '())
  70     (should (seq-empty-p (seq-drop seq 0)))
  71     (should (seq-empty-p (seq-drop seq 1)))))
  72
  73 (ert-deftest test-seq-take ()
  74   (with-test-sequences (seq '(2 3 4 5))
  75     (should (seq-empty-p (seq-take seq 0)))
  76     (should (= (seq-length (seq-take seq 1)) 1))
  77     (should (= (seq-elt (seq-take seq 1) 0) 2))
  78     (should (same-contents-p (seq-take seq 3) '(2 3 4)))
  79     (should (equal (seq-take seq 10) seq))))
  80
  81 (ert-deftest test-seq-drop-while ()
  82   (with-test-sequences (seq '(1 3 2 4))
  83     (should (equal (seq-drop-while #'test-sequences-oddp seq)
  84                    (seq-drop seq 2)))
  85     (should (equal (seq-drop-while #'test-sequences-evenp seq)
  86                    seq))
  87     (should (seq-empty-p (seq-drop-while #'numberp seq))))
  88   (with-test-sequences (seq '())
  89     (should (seq-empty-p (seq-drop-while #'test-sequences-oddp seq)))))
  90
  91 (ert-deftest test-seq-take-while ()
  92   (with-test-sequences (seq '(1 3 2 4))
  93     (should (equal (seq-take-while #'test-sequences-oddp seq)
  94                    (seq-take seq 2)))
  95     (should (seq-empty-p (seq-take-while #'test-sequences-evenp seq)))
  96     (should (equal (seq-take-while #'numberp seq) seq)))
  97   (with-test-sequences (seq '())
  98     (should (seq-empty-p (seq-take-while #'test-sequences-oddp seq)))))
  99
 100 (ert-deftest test-seq-filter ()
 101   (with-test-sequences (seq '(6 7 8 9 10))
 102     (should (equal (seq-filter #'test-sequences-evenp seq) '(6 8 10)))
 103     (should (equal (seq-filter #'test-sequences-oddp seq) '(7 9)))
 104     (should (equal (seq-filter (lambda (elt) nil) seq) '())))
 105   (with-test-sequences (seq '())
 106     (should (equal (seq-filter #'test-sequences-evenp seq) '()))))
 107
 108 (ert-deftest test-seq-remove ()
 109   (with-test-sequences (seq '(6 7 8 9 10))
 110     (should (equal (seq-remove #'test-sequences-evenp seq) '(7 9)))
 111     (should (equal (seq-remove #'test-sequences-oddp seq) '(6 8 10)))
 112     (should (same-contents-p (seq-remove (lambda (elt) nil) seq) seq)))
 113   (with-test-sequences (seq '())
 114     (should (equal (seq-remove #'test-sequences-evenp seq) '()))))
 115
 116 (ert-deftest test-seq-count ()
 117   (with-test-sequences (seq '(6 7 8 9 10))
 118     (should (equal (seq-count #'test-sequences-evenp seq) 3))
 119     (should (equal (seq-count #'test-sequences-oddp seq) 2))
 120     (should (equal (seq-count (lambda (elt) nil) seq) 0)))
 121   (with-test-sequences (seq '())
 122     (should (equal (seq-count #'test-sequences-evenp seq) 0))))
 123
 124 (ert-deftest test-seq-reduce ()
 125   (with-test-sequences (seq '(1 2 3 4))
 126     (should (= (seq-reduce #'+ seq 0) 10))
 127     (should (= (seq-reduce #'+ seq 5) 15)))
 128   (with-test-sequences (seq '())
 129     (should (eq (seq-reduce #'+ seq 0) 0))
 130     (should (eq (seq-reduce #'+ seq 7) 7))))
 131
 132 (ert-deftest test-seq-some-p ()
 133   (with-test-sequences (seq '(4 3 2 1))
 134     (should (= (seq-some-p #'test-sequences-evenp seq) 4))
 135     (should (= (seq-some-p #'test-sequences-oddp seq) 3))
 136     (should-not (seq-some-p (lambda (elt) (> elt 10)) seq)))
 137   (with-test-sequences (seq '())
 138     (should-not (seq-some-p #'test-sequences-oddp seq))))
 139
 140 (ert-deftest test-seq-contains-p ()
 141   (with-test-sequences (seq '(3 4 5 6))
 142     (should (seq-contains-p seq 3))
 143     (should-not (seq-contains-p seq 7)))
 144   (with-test-sequences (seq '())
 145     (should-not (seq-contains-p seq 3))
 146     (should-not (seq-contains-p seq nil))))
 147
 148 (ert-deftest test-seq-every-p ()
 149   (with-test-sequences (seq '(43 54 22 1))
 150     (should (seq-every-p (lambda (elt) t) seq))
 151     (should-not (seq-every-p #'test-sequences-oddp seq))
 152     (should-not (seq-every-p #'test-sequences-evenp seq)))
 153   (with-test-sequences (seq '(42 54 22 2))
 154     (should (seq-every-p #'test-sequences-evenp seq))
 155     (should-not (seq-every-p #'test-sequences-oddp seq)))
 156   (with-test-sequences (seq '())
 157     (should (seq-every-p #'identity seq))
 158     (should (seq-every-p #'test-sequences-evenp seq))))
 159
 160 (ert-deftest test-seq-empty-p ()
 161   (with-test-sequences (seq '(0))
 162     (should-not (seq-empty-p seq)))
 163   (with-test-sequences (seq '(0 1 2))
 164     (should-not (seq-empty-p seq)))
 165   (with-test-sequences (seq '())
 166     (should (seq-empty-p seq))))
 167
 168 (ert-deftest test-seq-sort ()
 169   (should (equal (seq-sort #'< "cbaf") "abcf"))
 170   (should (equal (seq-sort #'< '(2 1 9 4)) '(1 2 4 9)))
 171   (should (equal (seq-sort #'< [2 1 9 4]) [1 2 4 9]))
 172   (should (equal (seq-sort #'< "") "")))
 173
 174 (ert-deftest test-seq-uniq ()
 175   (with-test-sequences (seq '(2 4 6 8 6 4 3))
 176     (should (equal (seq-uniq seq) '(2 4 6 8 3))))
 177   (with-test-sequences (seq '(3 3 3 3 3))
 178     (should (equal (seq-uniq seq) '(3))))
 179   (with-test-sequences (seq '())
 180     (should (equal (seq-uniq seq) '()))))
 181
 182 (ert-deftest test-seq-subseq ()
 183   (with-test-sequences (seq '(2 3 4 5))
 184     (should (equal (seq-subseq seq 0 4) seq))
 185     (should (same-contents-p (seq-subseq seq 2 4) '(4 5)))
 186     (should (same-contents-p (seq-subseq seq 1 3) '(3 4)))
 187     (should (same-contents-p (seq-subseq seq 1 -1) '(3 4))))
 188   (should (vectorp (seq-subseq [2 3 4 5] 2)))
 189   (should (stringp (seq-subseq "foo" 2 3)))
 190   (should (listp (seq-subseq '(2 3 4 4) 2 3)))
 191   (should-error (seq-subseq '(1 2 3) 4))
 192   (should-not   (seq-subseq '(1 2 3) 3))
 193   (should       (seq-subseq '(1 2 3) -3))
 194   (should-error (seq-subseq '(1 2 3) 1 4))
 195   (should       (seq-subseq '(1 2 3) 1 3))
 196   (should-error (seq-subseq '() -1))
 197   (should-error (seq-subseq [] -1))
 198   (should-error (seq-subseq "" -1))
 199   (should-not (seq-subseq '() 0))
 200   (should-error (seq-subseq '() 0 -1)))
 201
 202 (ert-deftest test-seq-concatenate ()
 203   (with-test-sequences (seq '(2 4 6))
 204     (should (equal (seq-concatenate 'string seq [8]) (string 2 4 6 8)))
 205     (should (equal (seq-concatenate 'list seq '(8 10)) '(2 4 6 8 10)))
 206     (should (equal (seq-concatenate 'vector seq '(8 10)) [2 4 6 8 10]))
 207     (should (equal (seq-concatenate 'vector nil '(8 10)) [8 10]))
 208     (should (equal (seq-concatenate 'vector seq nil) [2 4 6]))))
 209
 210 (ert-deftest test-seq-mapcat ()
 211   (should (equal (seq-mapcat #'seq-reverse '((3 2 1) (6 5 4)))
 212                  '(1 2 3 4 5 6)))
 213   (should (equal (seq-mapcat #'seq-reverse '[(3 2 1) (6 5 4)])
 214                  '(1 2 3 4 5 6)))
 215   (should (equal (seq-mapcat #'seq-reverse '((3 2 1) (6 5 4)) 'vector)
 216                  '[1 2 3 4 5 6])))
 217
 218 (ert-deftest test-seq-partition ()
 219   (should (same-contents-p (seq-partition '(0 1 2 3 4 5 6 7) 3)
 220                            '((0 1 2) (3 4 5) (6 7))))
 221   (should (same-contents-p (seq-partition '[0 1 2 3 4 5 6 7] 3)
 222                            '([0 1 2] [3 4 5] [6 7])))
 223   (should (same-contents-p (seq-partition "Hello world" 2)
 224                            '("He" "ll" "o " "wo" "rl" "d")))
 225   (should (equal (seq-partition '() 2) '()))
 226   (should (equal (seq-partition '(1 2 3) -1) '())))
 227
 228 (ert-deftest test-seq-group-by ()
 229   (with-test-sequences (seq '(1 2 3 4))
 230    (should (equal (seq-group-by #'test-sequences-oddp seq)
 231                   '((t 1 3) (nil 2 4)))))
 232   (should (equal (seq-group-by #'car '((a 1) (b 3) (c 4) (a 2)))
 233                  '((b (b 3)) (c (c 4)) (a (a 1) (a 2))))))
 234
 235 (ert-deftest test-seq-reverse ()
 236   (with-test-sequences (seq '(1 2 3 4))
 237     (should (same-contents-p (seq-reverse seq) '(4 3 2 1)))
 238     (should (equal (type-of (seq-reverse seq))
 239                    (type-of seq)))))
 240
 241 (ert-deftest test-seq-into ()
 242   (let* ((vector [1 2 3])
 243          (list (seq-into vector 'list)))
 244     (should (same-contents-p vector list))
 245     (should (listp list)))
 246   (let* ((list '(hello world))
 247          (vector (seq-into list 'vector)))
 248     (should (same-contents-p vector list))
 249     (should (vectorp vector)))
 250   (let* ((string "hello")
 251          (list (seq-into string 'list)))
 252     (should (same-contents-p string list))
 253     (should (stringp string)))
 254   (let* ((string "hello")
 255          (vector (seq-into string 'vector)))
 256     (should (same-contents-p string vector))
 257     (should (stringp string)))
 258   (let* ((list nil)
 259          (vector (seq-into list 'vector)))
 260     (should (same-contents-p list vector))
 261     (should (vectorp vector))))
 262
 263 (ert-deftest test-seq-intersection ()
 264   (let ((v1 [2 3 4 5])
 265         (v2 [1 3 5 6 7]))
 266     (should (same-contents-p (seq-intersection v1 v2)
 267                              '(3 5))))
 268   (let ((l1 '(2 3 4 5))
 269         (l2 '(1 3 5 6 7)))
 270     (should (same-contents-p (seq-intersection l1 l2)
 271                              '(3 5))))
 272   (let ((v1 [2 4 6])
 273         (v2 [1 3 5]))
 274     (should (seq-empty-p (seq-intersection v1 v2)))))
 275
 276 (ert-deftest test-seq-difference ()
 277   (let ((v1 [2 3 4 5])
 278         (v2 [1 3 5 6 7]))
 279     (should (same-contents-p (seq-difference v1 v2)
 280                              '(2 4))))
 281   (let ((l1 '(2 3 4 5))
 282         (l2 '(1 3 5 6 7)))
 283     (should (same-contents-p (seq-difference l1 l2)
 284                              '(2 4))))
 285   (let ((v1 [2 4 6])
 286         (v2 [2 4 6]))
 287     (should (seq-empty-p (seq-difference v1 v2)))))
 288
 289 (ert-deftest test-seq-let ()
 290   (with-test-sequences (seq '(1 2 3 4))
 291     (seq-let (a b c d e) seq
 292       (should (= a 1))
 293       (should (= b 2))
 294       (should (= c 3))
 295       (should (= d 4))
 296       (should (null e)))
 297     (seq-let (a b &rest others) seq
 298       (should (= a 1))
 299       (should (= b 2))
 300       (should (same-contents-p others (seq-drop seq 2)))))
 301   (let ((seq '(1 (2 (3 (4))))))
 302     (seq-let (_ (_ (_ (a)))) seq
 303       (should (= a 4))))
 304   (let (seq)
 305     (seq-let (a b c) seq
 306       (should (null a))
 307       (should (null b))
 308       (should (null c)))))
 309
 310 (ert-deftest test-seq-min-max ()
 311   (with-test-sequences (seq '(4 5 3 2 0 4))
 312     (should (= (seq-min seq) 0))
 313     (should (= (seq-max seq) 5))))
 314
 315 (ert-deftest test-seq-into-sequence ()
 316   (with-test-sequences (seq '(1 2 3))
 317     (should (eq seq (seq-into-sequence seq)))
 318     (should-error (seq-into-sequence 2))))
 319
 320 (provide 'seq-tests)
 321 ;;; seq-tests.el ends here