aboutsummaryrefslogtreecommitdiff
path: root/tests/test-coverage-core--backend-registry.el
blob: 2369806fc43e5a4a5958f4cb141c1285e702dd64 (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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
;;; test-coverage-core--backend-registry.el --- Tests for coverage backend registry -*- lexical-binding: t; -*-

;;; Commentary:
;; Unit tests for the backend registry.
;;
;; A backend is a plist with at least :name, :detect, :run, and :report-path
;; keys.  `cj/coverage-register-backend' adds or replaces an entry.
;; `cj/--coverage-backend-for-project' resolves which backend applies to
;; a project root, honoring an optional override (buffer-local
;; `cj/coverage-backend' from .dir-locals.el in real use).

;;; Code:

(require 'ert)

(add-to-list 'load-path (expand-file-name "modules" user-emacs-directory))
(require 'coverage-core)

(defmacro test-coverage-registry-with-empty (&rest body)
  "Run BODY with `cj/coverage-backends' rebound to an empty list."
  (declare (indent 0))
  `(let ((cj/coverage-backends nil))
	 ,@body))

;;; Normal cases

(ert-deftest test-coverage-backend-register-adds-entry ()
  "Normal: registering a backend makes it retrievable by name."
  (test-coverage-registry-with-empty
	(cj/coverage-register-backend
	 '(:name elisp :detect (lambda (_) t) :run ignore :report-path ignore))
	(should (= 1 (length cj/coverage-backends)))
	(should (eq 'elisp (plist-get (car cj/coverage-backends) :name)))))

(ert-deftest test-coverage-backend-register-replaces-in-place ()
  "Normal: re-registering by name replaces the existing entry at the same position."
  (test-coverage-registry-with-empty
	(cj/coverage-register-backend
	 '(:name elisp :detect (lambda (_) nil) :run ignore :report-path ignore))
	(cj/coverage-register-backend
	 '(:name python :detect (lambda (_) nil) :run ignore :report-path ignore))
	(cj/coverage-register-backend
	 '(:name elisp :detect (lambda (_) t) :run ignore :report-path ignore))
	(should (= 2 (length cj/coverage-backends)))
	(should (eq 'elisp (plist-get (nth 0 cj/coverage-backends) :name)))
	(should (eq 'python (plist-get (nth 1 cj/coverage-backends) :name)))
	(should (funcall (plist-get (nth 0 cj/coverage-backends) :detect) "/tmp"))))

(ert-deftest test-coverage-backend-for-project-first-detect-wins ()
  "Normal: resolution returns the first backend whose :detect matches."
  (test-coverage-registry-with-empty
	(cj/coverage-register-backend
	 '(:name a :detect (lambda (_) nil) :run ignore :report-path ignore))
	(cj/coverage-register-backend
	 '(:name b :detect (lambda (_) t)   :run ignore :report-path ignore))
	(cj/coverage-register-backend
	 '(:name c :detect (lambda (_) t)   :run ignore :report-path ignore))
	(let ((backend (cj/--coverage-backend-for-project "/tmp")))
	  (should (eq 'b (plist-get backend :name))))))

;;; Boundary cases

(ert-deftest test-coverage-backend-for-project-empty-registry ()
  "Boundary: empty registry returns nil, not an error."
  (test-coverage-registry-with-empty
	(should (null (cj/--coverage-backend-for-project "/tmp")))))

(ert-deftest test-coverage-backend-for-project-no-match ()
  "Boundary: no backend's :detect matches returns nil."
  (test-coverage-registry-with-empty
	(cj/coverage-register-backend
	 '(:name a :detect (lambda (_) nil) :run ignore :report-path ignore))
	(cj/coverage-register-backend
	 '(:name b :detect (lambda (_) nil) :run ignore :report-path ignore))
	(should (null (cj/--coverage-backend-for-project "/tmp")))))

(ert-deftest test-coverage-backend-for-project-override-bypasses-detect ()
  "Boundary: OVERRIDE returns the named backend without calling :detect."
  (test-coverage-registry-with-empty
	(cj/coverage-register-backend
	 '(:name a :detect (lambda (_) nil) :run ignore :report-path ignore))
	(cj/coverage-register-backend
	 '(:name b :detect (lambda (_) nil) :run ignore :report-path ignore))
	(let ((backend (cj/--coverage-backend-for-project "/tmp" 'b)))
	  (should (eq 'b (plist-get backend :name))))))

(ert-deftest test-coverage-backend-for-project-detect-receives-root ()
  "Boundary: the :detect function is called with the project root."
  (test-coverage-registry-with-empty
	(let ((captured nil))
	  (cj/coverage-register-backend
	   `(:name a
			   :detect ,(lambda (root) (setq captured root) t)
			   :run ignore :report-path ignore))
	  (cj/--coverage-backend-for-project "/my/root")
	  (should (equal "/my/root" captured)))))

;;; Error cases

(ert-deftest test-coverage-backend-for-project-override-unknown-errors ()
  "Error: OVERRIDE that names an unregistered backend signals user-error."
  (test-coverage-registry-with-empty
	(cj/coverage-register-backend
	 '(:name a :detect (lambda (_) t) :run ignore :report-path ignore))
	(should-error (cj/--coverage-backend-for-project "/tmp" 'bogus)
				  :type 'user-error)))

(provide 'test-coverage-core--backend-registry)
;;; test-coverage-core--backend-registry.el ends here