summaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2025-11-08 11:33:31 -0600
committerCraig Jennings <c@cjennings.net>2025-11-08 11:33:31 -0600
commit19e88c1ed7ecde966372adefeb3d468374ef1dd7 (patch)
tree43515c57ad96fcc60f9be57bce7e2938e5e954b1 /tests
parent47130cec2000f741bdcf61827c03226fd0301bc0 (diff)
refactor: config: replace magic numbers with named constants
Replace two magic numbers with self-documenting constants: 1. Cache cleanup percentage (line 395): - Before: (dotimes (_ (/ (length entries) 5)) - After: (dotimes (_ (floor (* (length entries) wttrin--cache-cleanup-percentage))) - Added: wttrin--cache-cleanup-percentage constant (0.20 = 20%) - Explains WHY 20%: provides buffer before next cleanup cycle 2. Mode-line startup delay (line 508): - Before: (run-at-time 3 nil #'wttrin--mode-line-fetch-weather) - After: (run-at-time wttrin-mode-line-startup-delay nil ...) - Added: wttrin-mode-line-startup-delay defcustom (default 3 seconds) - Now user-customizable, range 1-5 seconds recommended Added comprehensive tests (8 tests, all passing): - 5 tests verify cache cleanup behavior (removes ~20% of oldest entries) - 3 tests verify startup delay defcustom exists and has reasonable value Benefits: - Self-documenting code (explains WHY these values exist) - Startup delay is now user-customizable - Easier for future maintainers to understand rationale 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'tests')
-rw-r--r--tests/test-wttrin--cleanup-cache-constants.el143
1 files changed, 143 insertions, 0 deletions
diff --git a/tests/test-wttrin--cleanup-cache-constants.el b/tests/test-wttrin--cleanup-cache-constants.el
new file mode 100644
index 0000000..60d784b
--- /dev/null
+++ b/tests/test-wttrin--cleanup-cache-constants.el
@@ -0,0 +1,143 @@
+;;; test-wttrin--cleanup-cache-constants.el --- Tests for cache cleanup constants -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2024 Craig Jennings
+
+;;; Commentary:
+;; Unit tests verifying cache cleanup behavior with named constants.
+;; These tests verify the behavior before and after refactoring magic numbers.
+
+;;; Code:
+
+(require 'ert)
+(require 'wttrin)
+
+;;; Normal Cases - Cache Cleanup Behavior
+
+(ert-deftest test-wttrin--cleanup-cache-removes-oldest-entries ()
+ "Test that cleanup removes oldest entries when cache exceeds max."
+ (let ((wttrin--cache (make-hash-table :test 'equal))
+ (wttrin-cache-max-entries 5)
+ (now (float-time)))
+ ;; Add 10 entries with sequential timestamps
+ (dotimes (i 10)
+ (puthash (format "location-%d" i)
+ (cons (+ now i) (format "data-%d" i))
+ wttrin--cache))
+ ;; Cache should have 10 entries
+ (should (= 10 (hash-table-count wttrin--cache)))
+
+ ;; Trigger cleanup
+ (wttrin--cleanup-cache-if-needed)
+
+ ;; After cleanup, cache should have fewer entries
+ ;; With 10 entries and max of 5, should remove 20% = 2 entries
+ ;; Leaving 8 entries
+ (should (= 8 (hash-table-count wttrin--cache)))
+
+ ;; Oldest entries (location-0, location-1) should be removed
+ (should-not (gethash "location-0" wttrin--cache))
+ (should-not (gethash "location-1" wttrin--cache))
+
+ ;; Newer entries should remain
+ (should (gethash "location-9" wttrin--cache))
+ (should (gethash "location-8" wttrin--cache))))
+
+(ert-deftest test-wttrin--cleanup-cache-removes-approximately-20-percent ()
+ "Test that cleanup removes approximately 20% of entries."
+ (let ((wttrin--cache (make-hash-table :test 'equal))
+ (wttrin-cache-max-entries 10)
+ (now (float-time)))
+ ;; Add 20 entries (twice the max)
+ (dotimes (i 20)
+ (puthash (format "loc-%d" i)
+ (cons (+ now i) (format "data-%d" i))
+ wttrin--cache))
+
+ (should (= 20 (hash-table-count wttrin--cache)))
+
+ ;; Trigger cleanup - should remove 20% of 20 = 4 entries
+ (wttrin--cleanup-cache-if-needed)
+
+ ;; Should have 16 entries remaining (20 - 4)
+ (should (= 16 (hash-table-count wttrin--cache)))))
+
+(ert-deftest test-wttrin--cleanup-cache-no-action-when-under-max ()
+ "Test that cleanup does nothing when cache is under max."
+ (let ((wttrin--cache (make-hash-table :test 'equal))
+ (wttrin-cache-max-entries 10)
+ (now (float-time)))
+ ;; Add 5 entries (under max of 10)
+ (dotimes (i 5)
+ (puthash (format "location-%d" i)
+ (cons (+ now i) (format "data-%d" i))
+ wttrin--cache))
+
+ (should (= 5 (hash-table-count wttrin--cache)))
+
+ ;; Trigger cleanup
+ (wttrin--cleanup-cache-if-needed)
+
+ ;; Should still have 5 entries (no cleanup needed)
+ (should (= 5 (hash-table-count wttrin--cache)))))
+
+;;; Boundary Cases
+
+(ert-deftest test-wttrin--cleanup-cache-exactly-at-max ()
+ "Test that cleanup does nothing when cache is exactly at max."
+ (let ((wttrin--cache (make-hash-table :test 'equal))
+ (wttrin-cache-max-entries 5)
+ (now (float-time)))
+ ;; Add exactly 5 entries (at max)
+ (dotimes (i 5)
+ (puthash (format "location-%d" i)
+ (cons (+ now i) (format "data-%d" i))
+ wttrin--cache))
+
+ (should (= 5 (hash-table-count wttrin--cache)))
+
+ ;; Trigger cleanup - should do nothing since not > max
+ (wttrin--cleanup-cache-if-needed)
+
+ ;; Should still have 5 entries
+ (should (= 5 (hash-table-count wttrin--cache)))))
+
+(ert-deftest test-wttrin--cleanup-cache-one-over-max ()
+ "Test cleanup when cache has just one entry over max."
+ (let ((wttrin--cache (make-hash-table :test 'equal))
+ (wttrin-cache-max-entries 5)
+ (now (float-time)))
+ ;; Add 6 entries (1 over max)
+ (dotimes (i 6)
+ (puthash (format "location-%d" i)
+ (cons (+ now i) (format "data-%d" i))
+ wttrin--cache))
+
+ (should (= 6 (hash-table-count wttrin--cache)))
+
+ ;; Trigger cleanup - should remove 20% of 6 = 1.2 = 1 entry (floor)
+ (wttrin--cleanup-cache-if-needed)
+
+ ;; Should have 5 entries remaining
+ (should (= 5 (hash-table-count wttrin--cache)))
+
+ ;; Oldest entry (location-0) should be removed
+ (should-not (gethash "location-0" wttrin--cache))))
+
+;;; Tests for Mode-Line Startup Delay (after refactoring)
+
+(ert-deftest test-wttrin-mode-line-startup-delay-exists ()
+ "Test that wttrin-mode-line-startup-delay defcustom exists after refactoring."
+ ;; This test will fail initially, then pass after refactoring
+ (should (boundp 'wttrin-mode-line-startup-delay)))
+
+(ert-deftest test-wttrin-mode-line-startup-delay-is-number ()
+ "Test that startup delay is a number."
+ (should (numberp wttrin-mode-line-startup-delay)))
+
+(ert-deftest test-wttrin-mode-line-startup-delay-reasonable-range ()
+ "Test that startup delay is in reasonable range (1-10 seconds)."
+ (should (>= wttrin-mode-line-startup-delay 1))
+ (should (<= wttrin-mode-line-startup-delay 10)))
+
+(provide 'test-wttrin--cleanup-cache-constants)
+;;; test-wttrin--cleanup-cache-constants.el ends here