test/automated/package-test.el

   1 ;;; package-test.el --- Tests for the Emacs package system
   2
   3 ;; Copyright (C) 2013-2015 Free Software Foundation, Inc.
   4
   5 ;; Author: Daniel Hackney <dan@haxney.org>
   6 ;; Version: 1.0
   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 ;; You may want to run this from a separate Emacs instance from your
  26 ;; main one, because a bug in the code below could mess with your
  27 ;; installed packages.
  28
  29 ;; Run this in a clean Emacs session using:
  30 ;;
  31 ;;     $ emacs -Q --batch -L . -l package-test.el -l ert -f ert-run-tests-batch-and-exit
  32
  33 ;;; Code:
  34
  35 (require 'package)
  36 (require 'ert)
  37 (require 'cl-lib)
  38
  39 (defvar package-test-user-dir nil
  40   "Directory to use for installing packages during testing.")
  41
  42 (defvar package-test-file-dir (file-name-directory (or load-file-name
  43                                                        buffer-file-name))
  44   "Directory of the actual \"package-test.el\" file.")
  45
  46 (defvar simple-single-desc
  47   (package-desc-create :name 'simple-single
  48                        :version '(1 3)
  49                        :summary "A single-file package with no dependencies"
  50                        :kind 'single
  51                        :extras '((:url . "http://doodles.au")))
  52   "Expected `package-desc' parsed from simple-single-1.3.el.")
  53
  54 (defvar simple-depend-desc
  55   (package-desc-create :name 'simple-depend
  56                        :version '(1 0)
  57                        :summary "A single-file package with a dependency."
  58                        :kind 'single
  59                        :reqs '((simple-single (1 3))))
  60   "Expected `package-desc' parsed from simple-depend-1.0.el.")
  61
  62 (defvar multi-file-desc
  63   (package-desc-create :name 'multi-file
  64                        :version '(0 2 3)
  65                        :summary "Example of a multi-file tar package"
  66                        :kind 'tar
  67                        :extras '((:url . "http://puddles.li")))
  68   "Expected `package-desc' from \"multi-file-0.2.3.tar\".")
  69
  70 (defvar new-pkg-desc
  71   (package-desc-create :name 'new-pkg
  72                        :version '(1 0)
  73                        :kind 'single)
  74   "Expected `package-desc' parsed from new-pkg-1.0.el.")
  75
  76 (defvar simple-depend-desc-1
  77   (package-desc-create :name 'simple-depend-1
  78                        :version '(1 0)
  79                        :summary "A single-file package with a dependency."
  80                        :kind 'single
  81                        :reqs '((simple-depend (1 0))
  82                                (multi-file (0 1))))
  83   "`package-desc' used for testing dependencies.")
  84
  85 (defvar simple-depend-desc-2
  86   (package-desc-create :name 'simple-depend-2
  87                        :version '(1 0)
  88                        :summary "A single-file package with a dependency."
  89                        :kind 'single
  90                        :reqs '((simple-depend-1 (1 0))
  91                                (multi-file (0 1))))
  92   "`package-desc' used for testing dependencies.")
  93
  94 (defvar package-test-data-dir (expand-file-name "data/package" package-test-file-dir)
  95   "Base directory of package test files.")
  96
  97 (defvar package-test-fake-contents-file
  98   (expand-file-name "archive-contents" package-test-data-dir)
  99   "Path to a static copy of \"archive-contents\".")
 100
 101 (cl-defmacro with-package-test ((&optional &key file
 102                                            basedir
 103                                            install
 104                                            update-news
 105                                            upload-base)
 106                                 &rest body)
 107   "Set up temporary locations and variables for testing."
 108   (declare (indent 1))
 109   `(let* ((package-test-user-dir (make-temp-file "pkg-test-user-dir-" t))
 110           (process-environment (cons (format "HOME=%s" package-test-user-dir)
 111                                      process-environment))
 112           (package-user-dir package-test-user-dir)
 113           (package-archives `(("gnu" . ,package-test-data-dir)))
 114           (old-yes-no-defn (symbol-function 'yes-or-no-p))
 115           (default-directory package-test-file-dir)
 116           abbreviated-home-dir
 117           package--initialized
 118           package-alist
 119           ,@(if update-news
 120                 '(package-update-news-on-upload t)
 121               (list (cl-gensym)))
 122           ,@(if upload-base
 123                 '((package-test-archive-upload-base (make-temp-file "pkg-archive-base-" t))
 124                   (package-archive-upload-base package-test-archive-upload-base))
 125               (list (cl-gensym)))) ;; Dummy value so `let' doesn't try to bind `nil'
 126      (unwind-protect
 127          (progn
 128            ,(if basedir `(cd ,basedir))
 129            (setf (symbol-function 'yes-or-no-p) #'(lambda (&rest r) t))
 130            (unless (file-directory-p package-user-dir)
 131              (mkdir package-user-dir))
 132            ,@(when install
 133                `((package-initialize)
 134                  (package-refresh-contents)
 135                  (mapc 'package-install ,install)))
 136            (with-temp-buffer
 137              ,(if file
 138                   `(insert-file-contents ,file))
 139              ,@body))
 140
 141        (when (file-directory-p package-test-user-dir)
 142          (delete-directory package-test-user-dir t))
 143
 144        (when (and (boundp 'package-test-archive-upload-base)
 145                   (file-directory-p package-test-archive-upload-base))
 146          (delete-directory package-test-archive-upload-base t))
 147        (setf (symbol-function 'yes-or-no-p) old-yes-no-defn))))
 148
 149 (defmacro with-fake-help-buffer (&rest body)
 150   "Execute BODY in a temp buffer which is treated as the \"*Help*\" buffer."
 151   `(with-temp-buffer
 152     (help-mode)
 153     ;; Trick `help-buffer' into using the temp buffer.
 154     (let ((help-xref-following t))
 155       ,@body)))
 156
 157 (defun package-test-strip-version (dir)
 158   (replace-regexp-in-string "-pkg\\.el\\'" "" (package--description-file dir)))
 159
 160 (defun package-test-suffix-matches (base suffix-list)
 161   "Return file names matching BASE concatenated with each item in SUFFIX-LIST"
 162   (cl-mapcan
 163    '(lambda (item) (file-expand-wildcards (concat base item)))
 164    suffix-list))
 165
 166 (defvar tar-parse-info)
 167 (declare-function tar-header-name "tar-mode" (cl-x) t) ; defstruct
 168
 169 (defun package-test-search-tar-file (filename)
 170   "Search the current buffer's `tar-parse-info' variable for FILENAME.
 171
 172 Must called from within a `tar-mode' buffer."
 173   (cl-dolist (header tar-parse-info)
 174     (let ((tar-name (tar-header-name header)))
 175       (when (string= tar-name filename)
 176         (cl-return t)))))
 177
 178 (defun package-test-desc-version-string (desc)
 179   "Return the package version as a string."
 180   (package-version-join (package-desc-version desc)))
 181
 182 (ert-deftest package-test-desc-from-buffer ()
 183   "Parse an elisp buffer to get a `package-desc' object."
 184   (with-package-test (:basedir "data/package" :file "simple-single-1.3.el")
 185     (should (equal (package-buffer-info) simple-single-desc)))
 186   (with-package-test (:basedir "data/package" :file "simple-depend-1.0.el")
 187     (should (equal (package-buffer-info) simple-depend-desc)))
 188   (with-package-test (:basedir "data/package"
 189                                :file "multi-file-0.2.3.tar")
 190     (tar-mode)
 191     (should (equal (package-tar-file-info) multi-file-desc))))
 192
 193 (ert-deftest package-test-install-single ()
 194   "Install a single file without using an archive."
 195   (with-package-test (:basedir "data/package" :file "simple-single-1.3.el")
 196     (should (package-install-from-buffer))
 197     (package-initialize)
 198     (should (package-installed-p 'simple-single))
 199     (let* ((simple-pkg-dir (file-name-as-directory
 200                             (expand-file-name
 201                              "simple-single-1.3"
 202                              package-test-user-dir)))
 203            (autoloads-file (expand-file-name "simple-single-autoloads.el"
 204                                              simple-pkg-dir)))
 205       (should (file-directory-p simple-pkg-dir))
 206       (with-temp-buffer
 207         (insert-file-contents (expand-file-name "simple-single-pkg.el"
 208                                                 simple-pkg-dir))
 209         (should (string= (buffer-string)
 210                          (concat ";;; -*- no-byte-compile: t -*-\n"
 211                                  "(define-package \"simple-single\" \"1.3\" "
 212                                  "\"A single-file package "
 213                                  "with no dependencies\" 'nil "
 214                                  ":url \"http://doodles.au\""
 215                                  ")\n"))))
 216       (should (file-exists-p autoloads-file))
 217       (should-not (get-file-buffer autoloads-file)))))
 218
 219 (ert-deftest package-test-install-dependency ()
 220   "Install a package which includes a dependency."
 221   (with-package-test ()
 222     (package-initialize)
 223     (package-refresh-contents)
 224     (package-install 'simple-depend)
 225     (should (package-installed-p 'simple-single))
 226     (should (package-installed-p 'simple-depend))))
 227
 228 (ert-deftest package-test-install-two-dependencies ()
 229   "Install a package which includes a dependency."
 230   (with-package-test ()
 231     (package-initialize)
 232     (package-refresh-contents)
 233     (package-install 'simple-two-depend)
 234     (should (package-installed-p 'simple-single))
 235     (should (package-installed-p 'simple-depend))
 236     (should (package-installed-p 'simple-two-depend))))
 237
 238 (ert-deftest package-test-refresh-contents ()
 239   "Parse an \"archive-contents\" file."
 240   (with-package-test ()
 241     (package-initialize)
 242     (package-refresh-contents)
 243     (should (eq 4 (length package-archive-contents)))))
 244
 245 (ert-deftest package-test-install-single-from-archive ()
 246   "Install a single package from a package archive."
 247   (with-package-test ()
 248     (package-initialize)
 249     (package-refresh-contents)
 250     (package-install 'simple-single)))
 251
 252 (ert-deftest package-test-install-prioritized ()
 253   "Install a lower version from a higher-prioritized archive."
 254   (with-package-test ()
 255     (let* ((newer-version (expand-file-name "data/package/newer-versions"
 256                                             package-test-file-dir))
 257            (package-archives `(("older" . ,package-test-data-dir)
 258                                ("newer" . ,newer-version)))
 259            (package-archive-priorities '(("older" . 100))))
 260
 261       (package-initialize)
 262       (package-refresh-contents)
 263       (package-install 'simple-single)
 264
 265       (let ((installed (cadr (assq 'simple-single package-alist))))
 266         (should (version-list-= '(1 3)
 267                                 (package-desc-version installed)))))))
 268
 269 (ert-deftest package-test-install-multifile ()
 270   "Check properties of the installed multi-file package."
 271   (with-package-test (:basedir "data/package" :install '(multi-file))
 272     (let ((autoload-file
 273            (expand-file-name "multi-file-autoloads.el"
 274                              (expand-file-name
 275                               "multi-file-0.2.3"
 276                               package-test-user-dir)))
 277           (installed-files '("dir" "multi-file.info" "multi-file-sub.elc"
 278                              "multi-file-autoloads.el" "multi-file.elc"))
 279           (autoload-forms '("^(defvar multi-file-custom-var"
 280                             "^(custom-autoload 'multi-file-custom-var"
 281                             "^(autoload 'multi-file-mode"))
 282           (pkg-dir (file-name-as-directory
 283                     (expand-file-name
 284                      "multi-file-0.2.3"
 285                      package-test-user-dir))))
 286       (package-refresh-contents)
 287       (should (package-installed-p 'multi-file))
 288       (with-temp-buffer
 289         (insert-file-contents-literally autoload-file)
 290         (dolist (fn installed-files)
 291           (should (file-exists-p (expand-file-name fn pkg-dir))))
 292         (dolist (re autoload-forms)
 293           (goto-char (point-min))
 294           (should (re-search-forward re nil t)))))))
 295
 296 (ert-deftest package-test-update-listing ()
 297   "Ensure installed package status is updated."
 298   (with-package-test ()
 299     (let ((buf (package-list-packages)))
 300       (search-forward-regexp "^ +simple-single")
 301       (package-menu-mark-install)
 302       (package-menu-execute)
 303       (should (package-installed-p 'simple-single))
 304       (switch-to-buffer "*Packages*")
 305       (goto-char (point-min))
 306       (should (re-search-forward "^\\s-+simple-single\\s-+1.3\\s-+installed" nil t))
 307       (goto-char (point-min))
 308       (should-not (re-search-forward "^\\s-+simple-single\\s-+1.3\\s-+\\(available\\|new\\)" nil t))
 309       (kill-buffer buf))))
 310
 311 (ert-deftest package-test-update-archives ()
 312   "Test updating package archives."
 313   (with-package-test ()
 314     (let ((buf (package-list-packages)))
 315       (package-menu-refresh)
 316       (search-forward-regexp "^ +simple-single")
 317       (package-menu-mark-install)
 318       (package-menu-execute)
 319       (should (package-installed-p 'simple-single))
 320       (let ((package-test-data-dir
 321              (expand-file-name "data/package/newer-versions" package-test-file-dir)))
 322         (setq package-archives `(("gnu" . ,package-test-data-dir)))
 323         (package-menu-refresh)
 324
 325         ;; New version should be available and old version should be installed
 326         (goto-char (point-min))
 327         (should (re-search-forward "^\\s-+simple-single\\s-+1.4\\s-+new" nil t))
 328         (should (re-search-forward "^\\s-+simple-single\\s-+1.3\\s-+installed" nil t))
 329
 330         (goto-char (point-min))
 331         (should (re-search-forward "^\\s-+new-pkg\\s-+1.0\\s-+\\(available\\|new\\)" nil t))
 332
 333         (package-menu-mark-upgrades)
 334         (package-menu-execute)
 335         (package-menu-refresh)
 336         (should (package-installed-p 'simple-single '(1 4)))))))
 337
 338 (ert-deftest package-test-describe-package ()
 339   "Test displaying help for a package."
 340
 341   (require 'finder-inf)
 342   ;; Built-in
 343   (with-fake-help-buffer
 344    (describe-package '5x5)
 345    (goto-char (point-min))
 346    (should (search-forward "5x5 is a built-in package." nil t))
 347    (should (search-forward "Status: Built-in." nil t))
 348    (should (search-forward "Summary: simple little puzzle game" nil t))
 349    (should (search-forward "The aim of 5x5" nil t)))
 350
 351   ;; Installed
 352   (with-package-test ()
 353     (package-initialize)
 354     (package-refresh-contents)
 355     (package-install 'simple-single)
 356     (with-fake-help-buffer
 357      (describe-package 'simple-single)
 358      (goto-char (point-min))
 359      (should (search-forward "simple-single is an installed package." nil t))
 360      (should (search-forward
 361               "Status: Installed in `~/simple-single-1.3/' (unsigned)."
 362               nil t))
 363      (should (search-forward "Version: 1.3" nil t))
 364      (should (search-forward "Summary: A single-file package with no dependencies"
 365                              nil t))
 366      (should (search-forward "Homepage: http://doodles.au" nil t))
 367      (should (re-search-forward "Keywords: \\[?frobnicate\\]?" nil t))
 368      ;; No description, though. Because at this point we don't know
 369      ;; what archive the package originated from, and we don't have
 370      ;; its readme file saved.
 371      )))
 372
 373 (ert-deftest package-test-describe-non-installed-package ()
 374   "Test displaying of the readme for non-installed package."
 375
 376   (with-package-test ()
 377     (package-initialize)
 378     (package-refresh-contents)
 379     (with-fake-help-buffer
 380      (describe-package 'simple-single)
 381      (goto-char (point-min))
 382      (should (search-forward "Homepage: http://doodles.au" nil t))
 383      (should (search-forward "This package provides a minor mode to frobnicate"
 384                              nil t)))))
 385
 386 (ert-deftest package-test-describe-non-installed-multi-file-package ()
 387   "Test displaying of the readme for non-installed multi-file package."
 388
 389   (with-package-test ()
 390     (package-initialize)
 391     (package-refresh-contents)
 392     (with-fake-help-buffer
 393      (describe-package 'multi-file)
 394      (goto-char (point-min))
 395      (should (search-forward "Homepage: http://puddles.li" nil t))
 396      (should (search-forward "This is a bare-bones readme file for the multi-file"
 397                              nil t)))))
 398
 399 (ert-deftest package-test-signed ()
 400   "Test verifying package signature."
 401   (skip-unless (ignore-errors
 402                  (let ((homedir (make-temp-file "package-test" t)))
 403                    (unwind-protect
 404                        (let ((process-environment
 405                               (cons (format "HOME=%s" homedir)
 406                                     process-environment)))
 407                          (epg-check-configuration (epg-configuration))
 408                          t)
 409                      (delete-directory homedir t)))))
 410   (let* ((keyring (expand-file-name "key.pub" package-test-data-dir))
 411          (package-test-data-dir
 412            (expand-file-name "data/package/signed" package-test-file-dir)))
 413     (with-package-test ()
 414       (package-initialize)
 415       (package-import-keyring keyring)
 416       (package-refresh-contents)
 417       (should (package-install 'signed-good))
 418       (should-error (package-install 'signed-bad))
 419       ;; Check if the installed package status is updated.
 420       (let ((buf (package-list-packages)))
 421         (package-menu-refresh)
 422         (should (re-search-forward "^\\s-+signed-good\\s-+1\\.0\\s-+installed"
 423                                    nil t)))
 424       ;; Check if the package description is updated.
 425       (with-fake-help-buffer
 426        (describe-package 'signed-good)
 427        (goto-char (point-min))
 428        (should (search-forward "signed-good is an installed package." nil t))
 429        (should (search-forward
 430                 "Status: Installed in `~/signed-good-1.0/'."
 431                 nil t))))))
 432
 433
 434 \f
 435 ;;; Tests for package-x features.
 436
 437 (require 'package-x)
 438
 439 (defvar package-x-test--single-archive-entry-1-3
 440   (cons 'simple-single
 441         (package-make-ac-desc '(1 3) nil
 442                               "A single-file package with no dependencies"
 443                               'single
 444                               '((:url . "http://doodles.au"))))
 445   "Expected contents of the archive entry from the \"simple-single\" package.")
 446
 447 (defvar package-x-test--single-archive-entry-1-4
 448   (cons 'simple-single
 449         (package-make-ac-desc '(1 4) nil
 450                               "A single-file package with no dependencies"
 451                               'single
 452                               nil))
 453   "Expected contents of the archive entry from the updated \"simple-single\" package.")
 454
 455 (ert-deftest package-x-test-upload-buffer ()
 456   "Test creating an \"archive-contents\" file"
 457   (with-package-test (:basedir "data/package"
 458                                :file "simple-single-1.3.el"
 459                                :upload-base t)
 460     (package-upload-buffer)
 461     (should (file-exists-p (expand-file-name "archive-contents"
 462                                              package-archive-upload-base)))
 463     (should (file-exists-p (expand-file-name "simple-single-1.3.el"
 464                                              package-archive-upload-base)))
 465     (should (file-exists-p (expand-file-name "simple-single-readme.txt"
 466                                              package-archive-upload-base)))
 467
 468     (let (archive-contents)
 469       (with-temp-buffer
 470         (insert-file-contents
 471          (expand-file-name "archive-contents"
 472                            package-archive-upload-base))
 473         (setq archive-contents
 474               (package-read-from-string
 475                (buffer-substring (point-min) (point-max)))))
 476       (should (equal archive-contents
 477                      (list 1 package-x-test--single-archive-entry-1-3))))))
 478
 479 (ert-deftest package-x-test-upload-new-version ()
 480   "Test uploading a new version of a package"
 481   (with-package-test (:basedir "data/package"
 482                                :file "simple-single-1.3.el"
 483                                :upload-base t)
 484     (package-upload-buffer)
 485     (with-temp-buffer
 486       (insert-file-contents "newer-versions/simple-single-1.4.el")
 487       (package-upload-buffer))
 488
 489     (let (archive-contents)
 490       (with-temp-buffer
 491         (insert-file-contents
 492          (expand-file-name "archive-contents"
 493                            package-archive-upload-base))
 494         (setq archive-contents
 495               (package-read-from-string
 496                (buffer-substring (point-min) (point-max)))))
 497       (should (equal archive-contents
 498                      (list 1 package-x-test--single-archive-entry-1-4))))))
 499
 500 (ert-deftest package-test-get-deps ()
 501   "Test `package--get-deps' with complex structures."
 502   (let ((package-alist
 503          (mapcar (lambda (p) (list (package-desc-name p) p))
 504            (list simple-single-desc
 505                  simple-depend-desc
 506                  multi-file-desc
 507                  new-pkg-desc
 508                  simple-depend-desc-1
 509                  simple-depend-desc-2))))
 510     (should
 511      (equal (package--get-deps 'simple-depend)
 512             '(simple-single)))
 513     (should
 514      (equal (package--get-deps 'simple-depend 'indirect)
 515             nil))
 516     (should
 517      (equal (package--get-deps 'simple-depend 'direct)
 518             '(simple-single)))
 519     (should
 520      (equal (package--get-deps 'simple-depend-2)
 521             '(simple-depend-1 multi-file simple-depend simple-single)))
 522     (should
 523      (equal (package--get-deps 'simple-depend-2 'indirect)
 524             '(simple-depend multi-file simple-single)))
 525     (should
 526      (equal (package--get-deps 'simple-depend-2 'direct)
 527             '(simple-depend-1 multi-file)))))
 528
 529 (ert-deftest package-test-sort-by-dependence ()
 530   "Test `package--sort-by-dependence' with complex structures."
 531   (let ((package-alist
 532          (mapcar (lambda (p) (list (package-desc-name p) p))
 533            (list simple-single-desc
 534                  simple-depend-desc
 535                  multi-file-desc
 536                  new-pkg-desc
 537                  simple-depend-desc-1
 538                  simple-depend-desc-2)))
 539         (delete-list
 540          (list simple-single-desc
 541                simple-depend-desc
 542                multi-file-desc
 543                new-pkg-desc
 544                simple-depend-desc-1
 545                simple-depend-desc-2)))
 546     (should
 547      (equal (package--sort-by-dependence delete-list)
 548             (list simple-depend-desc-2 simple-depend-desc-1 new-pkg-desc
 549                   multi-file-desc simple-depend-desc simple-single-desc)))
 550     (should
 551      (equal (package--sort-by-dependence (reverse delete-list))
 552             (list new-pkg-desc simple-depend-desc-2 simple-depend-desc-1
 553                   multi-file-desc simple-depend-desc simple-single-desc)))))
 554
 555 (provide 'package-test)
 556
 557 ;;; package-test.el ends here