aboutsummaryrefslogtreecommitdiff
path: root/tests/test-wttrin--debug-log.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-wttrin--debug-log.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-wttrin--debug-log.el')
-rw-r--r--tests/test-wttrin--debug-log.el82
1 files changed, 82 insertions, 0 deletions
diff --git a/tests/test-wttrin--debug-log.el b/tests/test-wttrin--debug-log.el
new file mode 100644
index 0000000..4f4e2ba
--- /dev/null
+++ b/tests/test-wttrin--debug-log.el
@@ -0,0 +1,82 @@
+;;; test-wttrin--debug-log.el --- Tests for wttrin--debug-log -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2025-2026 Craig Jennings
+
+;;; Commentary:
+
+;; Unit tests for wttrin--debug-log. Verifies that messages are appended
+;; only when `wttrin-debug' is non-nil, that format args are interpolated,
+;; and that entries are timestamped (timestamp . message) cons cells.
+
+;;; Code:
+
+(require 'ert)
+(require 'wttrin)
+(require 'testutil-wttrin)
+
+(require 'wttrin-debug
+ (expand-file-name "wttrin-debug.el"
+ (file-name-directory (locate-library "wttrin"))))
+
+;;; Normal Cases
+
+(ert-deftest test-wttrin--debug-log-normal-appends-entry-when-debug-enabled ()
+ "Calling debug-log with debug enabled appends a single entry."
+ (let ((wttrin-debug t)
+ (wttrin--debug-log nil))
+ (wttrin--debug-log "hello")
+ (should (= 1 (length wttrin--debug-log)))))
+
+(ert-deftest test-wttrin--debug-log-normal-interpolates-format-args ()
+ "Format args are passed through `format' before storage."
+ (let ((wttrin-debug t)
+ (wttrin--debug-log nil))
+ (wttrin--debug-log "value=%d name=%s" 42 "foo")
+ (should (string= "value=42 name=foo" (cdar wttrin--debug-log)))))
+
+(ert-deftest test-wttrin--debug-log-normal-prepends-most-recent-entry ()
+ "Most recent entry is at the head of the log (push semantics)."
+ (let ((wttrin-debug t)
+ (wttrin--debug-log nil))
+ (wttrin--debug-log "first")
+ (wttrin--debug-log "second")
+ (should (string= "second" (cdar wttrin--debug-log)))
+ (should (string= "first" (cdadr wttrin--debug-log)))))
+
+(ert-deftest test-wttrin--debug-log-normal-timestamp-has-millisecond-format ()
+ "Timestamp is a string in HH:MM:SS.mmm format."
+ (let ((wttrin-debug t)
+ (wttrin--debug-log nil))
+ (wttrin--debug-log "anything")
+ (should (string-match-p "^[0-9]\\{2\\}:[0-9]\\{2\\}:[0-9]\\{2\\}\\.[0-9]\\{3\\}$"
+ (caar wttrin--debug-log)))))
+
+;;; Boundary Cases
+
+(ert-deftest test-wttrin--debug-log-boundary-empty-format-string-stores-empty-message ()
+ "An empty format string produces an entry with an empty message."
+ (let ((wttrin-debug t)
+ (wttrin--debug-log nil))
+ (wttrin--debug-log "")
+ (should (= 1 (length wttrin--debug-log)))
+ (should (string= "" (cdar wttrin--debug-log)))))
+
+(ert-deftest test-wttrin--debug-log-boundary-no-format-args-stores-literal-string ()
+ "Calling with only a format string and no args stores it as-is."
+ (let ((wttrin-debug t)
+ (wttrin--debug-log nil))
+ (wttrin--debug-log "literal text with no format directives")
+ (should (string= "literal text with no format directives"
+ (cdar wttrin--debug-log)))))
+
+;;; Error Cases
+
+(ert-deftest test-wttrin--debug-log-error-no-entry-when-debug-disabled ()
+ "When wttrin-debug is nil, debug-log adds nothing."
+ (let ((wttrin-debug nil)
+ (wttrin--debug-log nil))
+ (wttrin--debug-log "should not appear")
+ (should-not wttrin--debug-log)))
+
+(provide 'test-wttrin--debug-log)
+;;; test-wttrin--debug-log.el ends here