aboutsummaryrefslogtreecommitdiff
path: root/tests/testutil-system-defaults.el
blob: d1e669dc4192dd4b9a1827ac9b835890f27d1416 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
;;; testutil-system-defaults.el --- Shared load harness for system-defaults tests -*- lexical-binding: t; -*-

;;; Commentary:

;; system-defaults.el has startup side effects (server start, coding-system
;; setup, recentf, file creation under `user-emacs-directory').  Tests that
;; assert one of its settings load the module fresh in a sandbox with those
;; external interactions stubbed, then inspect the variable they own.  This
;; file holds that harness so each system-defaults test file shares one copy.

;;; Code:

(require 'cl-lib)
(require 'autorevert)
(require 'bookmark)
(require 'server)
(require 'vc-hooks)

(defvar org-dir nil
  "Test binding for system-defaults bookmark path setup.")

(defvar user-home-dir nil
  "Test binding for system-defaults default directory setup.")

(defvar use-package-always-ensure nil
  "Test binding for use-package package installation policy.")

(defconst test-system-defaults--repo-root
  (file-name-directory
   (directory-file-name
    (file-name-directory (or load-file-name buffer-file-name))))
  "Repository root, derived from this file's location under tests/.")

(defmacro test-system-defaults--with-load-environment (&rest body)
  "Run BODY with the side effects of loading system-defaults.el stubbed.
`user-emacs-directory', `user-home-dir', and `org-dir' are redirected to
throwaway temp directories so file creation lands in the sandbox."
  (declare (indent 0))
  `(let ((user-emacs-directory (file-name-as-directory
                                (make-temp-file "system-defaults-emacs-" t)))
         (user-home-dir (file-name-as-directory
                         (make-temp-file "system-defaults-home-" t)))
         (org-dir (file-name-as-directory
                   (make-temp-file "system-defaults-org-" t)))
         (use-package-always-ensure nil))
     (cl-letf (((symbol-function 'server-running-p) (lambda (&rest _) t))
               ((symbol-function 'server-start) #'ignore)
               ((symbol-function 'set-locale-environment) #'ignore)
               ((symbol-function 'prefer-coding-system) #'ignore)
               ((symbol-function 'set-default-coding-systems) #'ignore)
               ((symbol-function 'set-terminal-coding-system) #'ignore)
               ((symbol-function 'set-keyboard-coding-system) #'ignore)
               ((symbol-function 'set-selection-coding-system) #'ignore)
               ((symbol-function 'set-charset-priority) #'ignore)
               ((symbol-function 'global-auto-revert-mode) #'ignore)
               ((symbol-function 'recentf-mode) #'ignore))
       (unless (fboundp 'use-package)
         (defmacro use-package (&rest _args) nil))
       ,@body)))

(defun test-system-defaults--load ()
  "Load system-defaults.el fresh from the repo for a smoke assertion.
Call inside `test-system-defaults--with-load-environment'."
  (load (expand-file-name "modules/system-defaults.el"
                          test-system-defaults--repo-root)
        nil t))

(provide 'testutil-system-defaults)
;;; testutil-system-defaults.el ends here