diff options
| -rw-r--r-- | tests/test-init-module-headers.el | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/tests/test-init-module-headers.el b/tests/test-init-module-headers.el new file mode 100644 index 00000000..70bdc428 --- /dev/null +++ b/tests/test-init-module-headers.el @@ -0,0 +1,111 @@ +;;; test-init-module-headers.el --- Validate load-graph header contracts -*- lexical-binding: t; -*- + +;;; Commentary: +;; Enforces the module load-graph header standard from +;; docs/design/init-load-graph.org against every module that has been +;; classified so far. Classification proceeds in batches; a module joins +;; `test-init-header--classified-modules' once its header declares the +;; contract. When that list reaches parity with the modules required by +;; init.el, the project's Phase 1 exit criterion is met. +;; +;; The contract is seven commentary lines after `;;; Commentary:': +;; Layer:, Category:, Load shape:, Eager reason: (only when eager), +;; Top-level side effects:, Runtime requires:, Direct test load:. +;; +;; This test reads module files directly; it does not load them, so it adds +;; no startup or package dependencies of its own. + +;;; Code: + +(require 'ert) +(require 'seq) + +(defconst test-init-header--classified-modules + '("system-lib" + "user-constants" + "host-environment" + "system-defaults" + "keyboard-compat" + "keybindings" + "config-utilities") + "Modules annotated with the load-graph header contract. +Grows one batch at a time. Parity with the init.el require set is the +Phase 1 exit criterion.") + +(defconst test-init-header--required-labels + '("Layer:" + "Category:" + "Load shape:" + "Top-level side effects:" + "Runtime requires:" + "Direct test load:") + "Header labels every classified module must declare. +`Eager reason:' is required additionally, but only when the load shape is +eager; it is checked separately.") + +(defun test-init-header--header-text (module) + "Return MODULE's commentary header text (everything before `;;; Code:')." + (let ((file (expand-file-name (concat module ".el") + (expand-file-name "modules" user-emacs-directory)))) + (with-temp-buffer + (insert-file-contents file) + (buffer-substring-no-properties + (point-min) + (or (save-excursion + (goto-char (point-min)) + (when (re-search-forward "^;;; Code:" nil t) + (match-beginning 0))) + (point-max)))))) + +(defun test-init-header--missing-labels (header) + "Return the list of required labels absent from HEADER. +Includes `Eager reason:' when HEADER declares an eager load shape but +omits the reason." + (let ((missing + (seq-remove (lambda (label) (string-match-p (regexp-quote label) header)) + test-init-header--required-labels))) + (when (and (string-match-p "Load shape:[ \t]*eager" header) + (not (string-match-p "Eager reason:" header))) + (setq missing (append missing '("Eager reason:")))) + missing)) + +(ert-deftest test-init-header-classified-modules-declare-contract () + "Normal: every classified module declares all required header lines." + (let (failures) + (dolist (module test-init-header--classified-modules) + (let ((missing (test-init-header--missing-labels + (test-init-header--header-text module)))) + (when missing + (push (format "%s missing: %s" module (string-join missing ", ")) + failures)))) + (should-not failures))) + +(ert-deftest test-init-header-detects-single-missing-line () + "Boundary: a header missing exactly one line is reported by that line's name." + (let ((header (concat ";; Layer: 1 (Foundation).\n" + ";; Category: F.\n" + ";; Load shape: command.\n" + ";; Top-level side effects: none.\n" + ";; Runtime requires: none.\n"))) + ;; Missing only `Direct test load:'. + (should (equal '("Direct test load:") + (test-init-header--missing-labels header))))) + +(ert-deftest test-init-header-eager-requires-reason () + "Error: an eager load shape with no `Eager reason:' flags the omission." + (let ((header (concat ";; Layer: 1 (Foundation).\n" + ";; Category: F.\n" + ";; Load shape: eager.\n" + ";; Top-level side effects: none.\n" + ";; Runtime requires: none.\n" + ";; Direct test load: yes.\n"))) + (should (member "Eager reason:" (test-init-header--missing-labels header))))) + +(ert-deftest test-init-header-scoping-excludes-unclassified () + "Error: an unclassified module is not enforced (scoping proof)." + ;; games-config is required by init.el but not yet classified; it must be + ;; absent from the allowlist so the suite stays green during migration. + (should-not (member "games-config" test-init-header--classified-modules))) + +(provide 'test-init-module-headers) +;;; test-init-module-headers.el ends here |