aboutsummaryrefslogtreecommitdiff
path: root/tests/test-debug-wttrin-mode-line.el
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-05 05:11:55 -0500
committerCraig Jennings <c@cjennings.net>2026-05-05 05:11:55 -0500
commitba22e0cc3c81d85b3ee8aaa337d6a388627c3af2 (patch)
tree87edb50acc44464d2887d73f2e0eb46cdac7b91e /tests/test-debug-wttrin-mode-line.el
parent6554cb8000a8f471f7c9e050e284f3fc364d5dad (diff)
downloademacs-wttrin-ba22e0cc3c81d85b3ee8aaa337d6a388627c3af2.tar.gz
emacs-wttrin-ba22e0cc3c81d85b3ee8aaa337d6a388627c3af2.zip
test: cover wttrin-debug.el and expand lint to all source files
I added 24 unit tests across six new files for wttrin-debug.el. They cover enable/disable, the debug-log writer, clear-log, show-log, and the mode-line diagnostic dump. That lifts wttrin-debug.el coverage from 27% to 95%, and overall coverage from 84% to 94%. Each function gets Normal / Boundary / Error categories where applicable. Globals like `wttrin-debug` and `wttrin--debug-log` are isolated per test with let-bindings. The dynamic-scope rebinding restores state cleanly at exit. I expanded the `lint` target to run on all three source files instead of just `wttrin.el`. Checkdoc and elisp-lint run on every file. Package-lint stays scoped to `wttrin.el` because the others aren't standalone packages. The tricky bit: `elisp-lint-file` re-runs package-lint internally as one of its validators. So the explicit guard alone wasn't enough. The fix binds `elisp-lint-ignored-validators` to include "package-lint" for the secondaries, which suppresses the re-run at the validator level. I also added `*-autoloads.el` to .gitignore. Eask generates `emacs-wttrin-autoloads.el` during install, and it shouldn't be tracked. I skipped one function: `wttrin--debug-mode-line-info` is a one-line dispatcher to `debug-wttrin-mode-line`. Testing it would assert the dispatch happened, which only tests Emacs.
Diffstat (limited to 'tests/test-debug-wttrin-mode-line.el')
-rw-r--r--tests/test-debug-wttrin-mode-line.el79
1 files changed, 79 insertions, 0 deletions
diff --git a/tests/test-debug-wttrin-mode-line.el b/tests/test-debug-wttrin-mode-line.el
new file mode 100644
index 0000000..437185a
--- /dev/null
+++ b/tests/test-debug-wttrin-mode-line.el
@@ -0,0 +1,79 @@
+;;; test-debug-wttrin-mode-line.el --- Tests for debug-wttrin-mode-line -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2025-2026 Craig Jennings
+
+;;; Commentary:
+
+;; Unit tests for debug-wttrin-mode-line. This function is a UI-heavy
+;; diagnostic dump, so testing focuses on the two top-level branches:
+;; - When *wttr.in* is missing, no diagnostic buffer is produced.
+;; - When *wttr.in* exists, the diagnostic buffer is created and contains
+;; the expected section labels.
+
+;;; Code:
+
+(require 'ert)
+(require 'wttrin)
+(require 'testutil-wttrin)
+
+(require 'wttrin-debug
+ (expand-file-name "wttrin-debug.el"
+ (file-name-directory (locate-library "wttrin"))))
+
+;;; Setup and Teardown
+
+(defun test-debug-wttrin-mode-line-setup ()
+ "Setup for debug-wttrin-mode-line tests."
+ (when (get-buffer "*wttr.in*")
+ (kill-buffer "*wttr.in*"))
+ (when (get-buffer "*wttrin-mode-debug*")
+ (kill-buffer "*wttrin-mode-debug*")))
+
+(defun test-debug-wttrin-mode-line-teardown ()
+ "Teardown for debug-wttrin-mode-line tests."
+ (when (get-buffer "*wttr.in*")
+ (kill-buffer "*wttr.in*"))
+ (when (get-buffer "*wttrin-mode-debug*")
+ (kill-buffer "*wttrin-mode-debug*")))
+
+;;; Normal Cases
+
+(ert-deftest test-debug-wttrin-mode-line-normal-no-buffer-skips-diagnostic-buffer ()
+ "When the *wttr.in* buffer is absent, no diagnostic buffer is created."
+ (test-debug-wttrin-mode-line-setup)
+ (unwind-protect
+ (progn
+ (debug-wttrin-mode-line)
+ (should-not (get-buffer "*wttrin-mode-debug*")))
+ (test-debug-wttrin-mode-line-teardown)))
+
+(ert-deftest test-debug-wttrin-mode-line-normal-buffer-exists-creates-diagnostic-buffer ()
+ "When the *wttr.in* buffer exists, the diagnostic buffer is created."
+ (test-debug-wttrin-mode-line-setup)
+ (unwind-protect
+ (progn
+ (with-current-buffer (get-buffer-create "*wttr.in*")
+ (wttrin-mode))
+ (debug-wttrin-mode-line)
+ (should (get-buffer "*wttrin-mode-debug*")))
+ (test-debug-wttrin-mode-line-teardown)))
+
+(ert-deftest test-debug-wttrin-mode-line-normal-diagnostic-buffer-contains-section-labels ()
+ "Diagnostic buffer contains the expected section labels."
+ (test-debug-wttrin-mode-line-setup)
+ (unwind-protect
+ (progn
+ (with-current-buffer (get-buffer-create "*wttr.in*")
+ (wttrin-mode))
+ (debug-wttrin-mode-line)
+ (with-current-buffer "*wttrin-mode-debug*"
+ (let ((contents (buffer-string)))
+ (should (string-match-p "Wttrin Mode-Line Debug Info" contents))
+ (should (string-match-p "Buffer:" contents))
+ (should (string-match-p "Major mode:" contents))
+ (should (string-match-p "mode-name variable:" contents))
+ (should (string-match-p "mode-line-format first 5 elements:" contents)))))
+ (test-debug-wttrin-mode-line-teardown)))
+
+(provide 'test-debug-wttrin-mode-line)
+;;; test-debug-wttrin-mode-line.el ends here