procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Expand coverage of unit tests for time-stamp

Browse source 
* test/lisp/time-stamp-tests.el: Remove redundant word "test"
from the names of all the tests.
(time-stamp-custom-time-zone, time-stamp-custom-pattern,
time-stamp-custom-inserts-lines, time-stamp-custom-count,
time-stamp-helper-safe-locals): New tests
This commit is contained in:
Stephen Gildea 2019-11-19 21:26:09 -08:00
parent 0fce8e9391
commit 123c775aa7
1 changed files with 196 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

219
test/lisp/time-stamp-tests.el
View file

@ -20,13 +20,15 @@
;;; Code:
(require 'ert)
(require 'generator)
(eval-when-compile (require 'cl-lib))
(require 'time-stamp)
(defmacro with-time-stamp-test-env (&rest body)
"Evaluate BODY with some standard time-stamp test variables bound."
(declare (indent defun))
`(let ((user-login-name "test-logname")
(user-full-name "Time Stamp Tester")
(user-full-name "100%d Tester") ;verify "%" passed unchanged
(buffer-file-name "/emacs/test/time-stamped-file")
(mail-host-address "test-mail-host-name")
(ref-time1 '(17337 16613)) ;Monday, Jan 2, 2006, 3:04:05 PM
@ -43,7 +45,16 @@
;; suppress the byte compiler's "unused" warning.
(list ref-time1 ref-time2 ref-time3)
,@body)))
(put 'with-time-stamp-test-env 'lisp-indent-hook 'defun)
(defmacro with-time-stamp-test-time (reference-time &rest body)
"Force any contained time-stamp call to use time REFERENCE-TIME."
(declare (indent defun))
`(cl-letf*
((orig-time-stamp-string-fn (symbol-function 'time-stamp-string))
((symbol-function 'time-stamp-string)
(lambda (ts-format)
(apply orig-time-stamp-string-fn ts-format ,reference-time nil))))
,@body))
(defmacro time-stamp-should-warn (form)
"Similar to `should' but verifies that a format warning is generated."
@ -57,9 +68,152 @@
;;; Tests:
;;; Tests of customization variables
(ert-deftest time-stamp-custom-time-zone ()
"Test that setting time-stamp-time-zone affects the format."
(with-time-stamp-test-env
(let ((time-stamp-time-zone "PST8"))
(should (equal (time-stamp-string "%H %Z" ref-time1) "07 PST")))
(let ((time-stamp-time-zone "UTC0"))
(should (equal (time-stamp-string "%H %Z" ref-time1) "15 UTC")))
(let ((time-stamp-time-zone "GMT0"))
(should (equal (time-stamp-string "%H %Z" ref-time1) "15 GMT")))))
(iter-defun time-stamp-test-pattern-sequential ()
"Iterate through each possibility for a part of time-stamp-pattern."
(let ((pattern-value-parts
'(("4/" "10/" "-4/" "0/" "") ;0: line limit
("stamp<" "") ;1: start
("%-d" "%_H" "%^a" "%#Z" "%:A" "%02H" "%%" "") ;2: format part 1
(" " "x" ":" "\n" "") ;3: format part 2
("%-d" "%_H" "%^a" "%#Z" "%:A" "%02H" "%%") ;4: format part 3
(">end" "")))) ;5: end
(dotimes (cur (length pattern-value-parts))
(dotimes (cur-index (length (nth cur pattern-value-parts)))
(cl-flet ((extract-part
(lambda (desired-part)
(let ((part-list (nth desired-part pattern-value-parts)))
(if (= desired-part cur)
(nth cur-index part-list)
(nth 0 part-list))))))
;; Don't repeat the default pattern.
(if (or (= cur 0) (> cur-index 0))
;; The whole format must start with %, so not all
;; generated combinations are valid
(if (or (not (equal (extract-part 2) ""))
(equal (extract-part 3) ""))
(iter-yield (list (extract-part 0)
(extract-part 1)
(apply #'concat
(mapcar #'extract-part '(2 3 4)))
(extract-part 5))))))))))
(iter-defun time-stamp-test-pattern-multiply ()
"Iterate through every combination of parts of time-stamp-pattern."
(let ((line-limit-values '("" "4/"))
(start-values '("" "stamp<"))
(format-values '("%%" "%m"))
(end-values '("" ">end")))
;; yield all combinations of the above
(dolist (line-limit line-limit-values)
(dolist (start start-values)
(dolist (format format-values)
(dolist (end end-values)
(iter-yield (list line-limit start format end))))))))
(iter-defun time-stamp-test-pattern-all ()
(iter-yield-from (time-stamp-test-pattern-sequential))
(iter-yield-from (time-stamp-test-pattern-multiply)))
(ert-deftest time-stamp-custom-pattern ()
"Test that time-stamp-pattern is parsed correctly."
(iter-do (pattern-parts (time-stamp-test-pattern-all))
(cl-destructuring-bind (line-limit1 start1 whole-format end1) pattern-parts
(cl-letf
(((symbol-function 'time-stamp-once)
(lambda (start search-limit ts-start ts-end
ts-format _format-lines _end-lines)
;; Verify that time-stamp parsed time-stamp-pattern and
;; called us with the correct pieces.
(let ((limit-number (string-to-number line-limit1)))
(if (equal line-limit1 "")
(setq limit-number time-stamp-line-limit))
(goto-char (point-min))
(if (> limit-number 0)
(should (= search-limit (line-beginning-position
(1+ limit-number))))
(should (= search-limit (point-max))))
(goto-char (point-max))
(if (< limit-number 0)
(should (= start (line-beginning-position
(1+ limit-number))))
(should (= start (point-min)))))
(if (equal start1 "")
(should (equal ts-start time-stamp-start))
(should (equal ts-start start1)))
(if (equal whole-format "%%")
(should (equal ts-format time-stamp-format))
(should (equal ts-format whole-format)))
(if (equal end1 "")
(should (equal ts-end time-stamp-end))
(should (equal ts-end end1)))
;; return nil to stop time-stamp from calling us again
nil)))
(let ((time-stamp-pattern (concat
line-limit1 start1 whole-format end1)))
(with-temp-buffer
;; prep the buffer with more than the
;; largest line-limit1 number of lines
(insert "\n\n\n\n\n\n\n\n\n\n\n\n")
;; Call time-stamp, which will call time-stamp-once,
;; triggering the tests above.
(time-stamp)))))))
(ert-deftest time-stamp-custom-inserts-lines ()
"Test that time-stamp inserts lines or not, as directed."
(with-time-stamp-test-env
(let ((time-stamp-start "Updated on:")
;; the newline in the format will insert a line if we let it
(time-stamp-format "\n %Y-%m-%d")
(time-stamp-end "$")
(time-stamp-inserts-lines nil) ;changed later in the test
(buffer-expected-1line "Updated on:\n 2006-01-02\n")
(buffer-expected-2line "Updated on:\n 2006-01-02\n 2006-01-02\n"))
(with-time-stamp-test-time ref-time1
(with-temp-buffer
(insert "Updated on:\n\n")
(time-stamp)
(should (equal (buffer-string) buffer-expected-1line))
;; second call should not add a line
(time-stamp)
(should (equal (buffer-string) buffer-expected-1line))
(setq time-stamp-inserts-lines t)
;; with time-stamp-inserts-lines set, should add a line
(time-stamp)
(should (equal (buffer-string) buffer-expected-2line)))))))
(ert-deftest time-stamp-custom-count ()
"Test that time-stamp updates no more than time-stamp-count templates."
(with-time-stamp-test-env
(let ((time-stamp-start "TS: <")
(time-stamp-format "%Y-%m-%d")
(time-stamp-count 1) ;changed later in the test
(buffer-expected-once "TS: <2006-01-02>\nTS: <>")
(buffer-expected-twice "TS: <2006-01-02>\nTS: <2006-01-02>"))
(with-time-stamp-test-time ref-time1
(with-temp-buffer
(insert "TS: <>\nTS: <>")
(time-stamp)
(should (equal (buffer-string) buffer-expected-once))
(setq time-stamp-count 2)
(time-stamp)
(should (equal (buffer-string) buffer-expected-twice)))))))
;;; Tests of time-stamp-string formatting
(ert-deftest time-stamp-test-format-day-of-week ()
(ert-deftest time-stamp-format-day-of-week ()
"Test time-stamp formats for named day of week."
(with-time-stamp-test-env
;; implemented and documented since 1997
@ -78,7 +232,7 @@
(should (equal (time-stamp-string "%^a" ref-time1) "MON"))
(should (equal (time-stamp-string "%A" ref-time1) "Monday"))))
(ert-deftest time-stamp-test-format-month-name ()
(ert-deftest time-stamp-format-month-name ()
"Test time-stamp formats for month name."
(with-time-stamp-test-env
;; implemented and documented since 1997
@ -97,7 +251,7 @@
(should (equal (time-stamp-string "%^b" ref-time1) "JAN"))
(should (equal (time-stamp-string "%B" ref-time1) "January"))))
(ert-deftest time-stamp-test-format-day-of-month ()
(ert-deftest time-stamp-format-day-of-month ()
"Test time-stamp formats for day of month."
(with-time-stamp-test-env
;; implemented and documented since 1995
@ -120,7 +274,7 @@
(should (equal (time-stamp-string "%d" ref-time1) "02"))
(should (equal (time-stamp-string "%d" ref-time2) "18"))))
(ert-deftest time-stamp-test-format-hours-24 ()
(ert-deftest time-stamp-format-hours-24 ()
"Test time-stamp formats for hour on a 24-hour clock."
(with-time-stamp-test-env
;; implemented and documented since 1995
@ -150,7 +304,7 @@
(should (equal (time-stamp-string "%H" ref-time2) "12"))
(should (equal (time-stamp-string "%H" ref-time3) "06"))))
(ert-deftest time-stamp-test-format-hours-12 ()
(ert-deftest time-stamp-format-hours-12 ()
"Test time-stamp formats for hour on a 12-hour clock."
(with-time-stamp-test-env
;; implemented and documented since 1995
@ -180,7 +334,7 @@
(should (equal (time-stamp-string "%I" ref-time2) "12"))
(should (equal (time-stamp-string "%I" ref-time3) "06"))))
(ert-deftest time-stamp-test-format-month-number ()
(ert-deftest time-stamp-format-month-number ()
"Test time-stamp formats for month number."
(with-time-stamp-test-env
;; implemented and documented since 1995
@ -203,7 +357,7 @@
(should (equal (time-stamp-string "%m" ref-time1) "01"))
(should (equal (time-stamp-string "%m" ref-time2) "11"))))
(ert-deftest time-stamp-test-format-minute ()
(ert-deftest time-stamp-format-minute ()
"Test time-stamp formats for minute."
(with-time-stamp-test-env
;; implemented and documented since 1995
@ -226,7 +380,7 @@
(should (equal (time-stamp-string "%M" ref-time1) "04"))
(should (equal (time-stamp-string "%M" ref-time2) "14"))))
(ert-deftest time-stamp-test-format-second ()
(ert-deftest time-stamp-format-second ()
"Test time-stamp formats for second."
(with-time-stamp-test-env
;; implemented and documented since 1995
@ -249,7 +403,7 @@
(should (equal (time-stamp-string "%S" ref-time1) "05"))
(should (equal (time-stamp-string "%S" ref-time2) "15"))))
(ert-deftest time-stamp-test-format-year-2digit ()
(ert-deftest time-stamp-format-year-2digit ()
"Test time-stamp formats for %y."
(with-time-stamp-test-env
;; implemented and documented since 1995
@ -274,13 +428,13 @@
(time-stamp-should-warn
(equal (time-stamp-string "%4y" ref-time1) "2006"))))
(ert-deftest time-stamp-test-format-year-4digit ()
(ert-deftest time-stamp-format-year-4digit ()
"Test time-stamp format %Y."
(with-time-stamp-test-env
;; implemented since 1997, documented since 2019
(should (equal (time-stamp-string "%Y" ref-time1) "2006"))))
(ert-deftest time-stamp-test-format-am-pm ()
(ert-deftest time-stamp-format-am-pm ()
"Test time-stamp formats for AM and PM strings."
(with-time-stamp-test-env
;; implemented and documented since 1997
@ -292,14 +446,14 @@
(should (equal (time-stamp-string "%p" ref-time1) "PM"))
(should (equal (time-stamp-string "%p" ref-time3) "AM"))))
(ert-deftest time-stamp-test-format-day-number-in-week ()
(ert-deftest time-stamp-format-day-number-in-week ()
"Test time-stamp formats for day number in week."
(with-time-stamp-test-env
(should (equal (time-stamp-string "%w" ref-time1) "1"))
(should (equal (time-stamp-string "%w" ref-time2) "5"))
(should (equal (time-stamp-string "%w" ref-time3) "0"))))
(ert-deftest time-stamp-test-format-time-zone-name ()
(ert-deftest time-stamp-format-time-zone-name ()
"Test time-stamp format %Z."
(with-time-stamp-test-env
(let ((UTC-abbr (format-time-string "%Z" ref-time1 t))
@ -309,7 +463,7 @@
;; implemented since 1997, documented since 2019
(should (equal (time-stamp-string "%#Z" ref-time1) utc-abbr)))))
(ert-deftest time-stamp-test-format-time-zone-offset ()
(ert-deftest time-stamp-format-time-zone-offset ()
"Test time-stamp format %z."
(with-time-stamp-test-env
(let ((utc-abbr (format-time-string "%#Z" ref-time1 t)))
@ -331,7 +485,7 @@
(should (equal (time-stamp-string "%::z" ref-time1) "+00:00:00"))
(should (equal (time-stamp-string "%:::z" ref-time1) "+00"))))
(ert-deftest time-stamp-test-format-non-date-conversions ()
(ert-deftest time-stamp-format-non-date-conversions ()
"Test time-stamp formats for non-date items."
(with-time-stamp-test-env
;; implemented and documented since 1995
@ -344,10 +498,10 @@
;; documented 1995-2019
(should (equal
(time-stamp-string "%s" ref-time1) "test-system-name.example.org"))
(should (equal (time-stamp-string "%U" ref-time1) "Time Stamp Tester"))
(should (equal (time-stamp-string "%U" ref-time1) "100%d Tester"))
(should (equal (time-stamp-string "%u" ref-time1) "test-logname"))
;; implemented since 2001, documented since 2019
(should (equal (time-stamp-string "%L" ref-time1) "Time Stamp Tester"))
(should (equal (time-stamp-string "%L" ref-time1) "100%d Tester"))
(should (equal (time-stamp-string "%l" ref-time1) "test-logname"))
;; implemented since 2007, documented since 2019
(should (equal
@ -355,7 +509,7 @@
(should (equal
(time-stamp-string "%q" ref-time1) "test-system-name"))))
(ert-deftest time-stamp-test-format-ignored-modifiers ()
(ert-deftest time-stamp-format-ignored-modifiers ()
"Test additional args allowed (but ignored) to allow for future expansion."
(with-time-stamp-test-env
;; allowed modifiers
@ -363,12 +517,12 @@
;; not all punctuation is allowed
(should-not (equal (time-stamp-string "%&P" ref-time3) "AM"))))
(ert-deftest time-stamp-test-format-non-conversions ()
(ert-deftest time-stamp-format-non-conversions ()
"Test that without a %, the text is copied literally."
(with-time-stamp-test-env
(should (equal (time-stamp-string "No percent" ref-time1) "No percent"))))
(ert-deftest time-stamp-test-format-string-width ()
(ert-deftest time-stamp-format-string-width ()
"Test time-stamp string width modifiers."
(with-time-stamp-test-env
;; strings truncate on the right or are blank-padded on the left
@ -384,7 +538,7 @@
;;; Tests of helper functions
(ert-deftest time-stamp-test-helper-zone-type-p ()
(ert-deftest time-stamp-helper-zone-type-p ()
"Test time-stamp-zone-type-p."
(should (time-stamp-zone-type-p t))
(should (time-stamp-zone-type-p nil))
@ -399,4 +553,23 @@
(should-not (time-stamp-zone-type-p '(0 0)))
(should-not (time-stamp-zone-type-p '("A" "A"))))
(ert-deftest time-stamp-helper-safe-locals ()
"Test that our variables are known to be safe local variables."
(should (safe-local-variable-p 'time-stamp-format "a string"))
(should-not (safe-local-variable-p 'time-stamp-format '(a list)))
(should (safe-local-variable-p 'time-stamp-time-zone "a string"))
(should-not (safe-local-variable-p 'time-stamp-time-zone 0.5))
(should (safe-local-variable-p 'time-stamp-line-limit 8))
(should-not (safe-local-variable-p 'time-stamp-line-limit "a string"))
(should (safe-local-variable-p 'time-stamp-start "a string"))
(should-not (safe-local-variable-p 'time-stamp-start 17))
(should (safe-local-variable-p 'time-stamp-end "a string"))
(should-not (safe-local-variable-p 'time-stamp-end 17))
(should (safe-local-variable-p 'time-stamp-inserts-lines t))
(should-not (safe-local-variable-p 'time-stamp-inserts-lines 17))
(should (safe-local-variable-p 'time-stamp-count 2))
(should-not (safe-local-variable-p 'time-stamp-count t))
(should (safe-local-variable-p 'time-stamp-pattern "a string"))
(should-not (safe-local-variable-p 'time-stamp-pattern 17)))
;;; time-stamp-tests.el ends here