From 4e271a6c36c73cbf3b45ced26493aa6589669815 Mon Sep 17 00:00:00 2001 From: Stephen Gildea Date: Fri, 25 Oct 2019 08:44:15 -0700 Subject: [PATCH] time-stamp-tests: consistently name the time vars * time-stamp-tests.el (with-time-stamp-test-env): rename local variable 'ref-time' to 'ref-time1', for parallelism with ref-time2 and ref-time3. --- test/lisp/time-stamp-tests.el | 192 +++++++++++++++++----------------- 1 file changed, 97 insertions(+), 95 deletions(-) diff --git a/test/lisp/time-stamp-tests.el b/test/lisp/time-stamp-tests.el index 4cc4ea1a5b8..d01d37a6648 100644 --- a/test/lisp/time-stamp-tests.el +++ b/test/lisp/time-stamp-tests.el @@ -29,7 +29,7 @@ (user-full-name "Time Stamp Tester") (buffer-file-name "/emacs/test/time-stamped-file") (mail-host-address "test-mail-host-name") - (ref-time '(17337 16613)) ;Monday, Jan 2, 2006, 3:04:05 PM + (ref-time1 '(17337 16613)) ;Monday, Jan 2, 2006, 3:04:05 PM (ref-time2 '(22574 61591)) ;Friday, Nov 18, 2016, 12:14:15 PM (ref-time3 '(21377 34956)) ;Sunday, May 25, 2014, 06:07:08 AM (time-stamp-time-zone t)) ;use UTC @@ -41,7 +41,7 @@ (lambda () "test-system-name.example.org"))) ;; Not all reference times are used in all tests; ;; suppress the byte compiler's "unused" warning. - (list ref-time ref-time2 ref-time3) + (list ref-time1 ref-time2 ref-time3) ,@body))) (put 'with-time-stamp-test-env 'lisp-indent-hook 'defun) @@ -61,90 +61,90 @@ "Test time-stamp formats for named day of week." (with-time-stamp-test-env ;; implemented and documented since 1997 - (should (equal (time-stamp-string "%3a" ref-time) "Mon")) - (should (equal (time-stamp-string "%#A" ref-time) "MONDAY")) + (should (equal (time-stamp-string "%3a" ref-time1) "Mon")) + (should (equal (time-stamp-string "%#A" ref-time1) "MONDAY")) ;; documented 1997-2019 - (should (equal (time-stamp-string "%3A" ref-time) "MON")) - (should (equal (time-stamp-string "%:a" ref-time) "Monday")) + (should (equal (time-stamp-string "%3A" ref-time1) "MON")) + (should (equal (time-stamp-string "%:a" ref-time1) "Monday")) ;; implemented since 2001, documented since 2019 - (should (equal (time-stamp-string "%#a" ref-time) "MON")) - (should (equal (time-stamp-string "%:A" ref-time) "Monday")) + (should (equal (time-stamp-string "%#a" ref-time1) "MON")) + (should (equal (time-stamp-string "%:A" ref-time1) "Monday")) ;; allowed but undocumented since 2019 (warned 1997-2019) - (should (equal (time-stamp-string "%^A" ref-time) "MONDAY")) + (should (equal (time-stamp-string "%^A" ref-time1) "MONDAY")) ;; warned 1997-2019, changed in 2019 - (should (equal (time-stamp-string "%a" ref-time) "Mon")) - (should (equal (time-stamp-string "%^a" ref-time) "MON")) - (should (equal (time-stamp-string "%A" ref-time) "Monday")))) + (should (equal (time-stamp-string "%a" ref-time1) "Mon")) + (should (equal (time-stamp-string "%^a" ref-time1) "MON")) + (should (equal (time-stamp-string "%A" ref-time1) "Monday")))) (ert-deftest time-stamp-test-month-name () "Test time-stamp formats for month name." (with-time-stamp-test-env ;; implemented and documented since 1997 - (should (equal (time-stamp-string "%3b" ref-time) "Jan")) - (should (equal (time-stamp-string "%#B" ref-time) "JANUARY")) + (should (equal (time-stamp-string "%3b" ref-time1) "Jan")) + (should (equal (time-stamp-string "%#B" ref-time1) "JANUARY")) ;; documented 1997-2019 - (should (equal (time-stamp-string "%3B" ref-time) "JAN")) - (should (equal (time-stamp-string "%:b" ref-time) "January")) + (should (equal (time-stamp-string "%3B" ref-time1) "JAN")) + (should (equal (time-stamp-string "%:b" ref-time1) "January")) ;; implemented since 2001, documented since 2019 - (should (equal (time-stamp-string "%#b" ref-time) "JAN")) - (should (equal (time-stamp-string "%:B" ref-time) "January")) + (should (equal (time-stamp-string "%#b" ref-time1) "JAN")) + (should (equal (time-stamp-string "%:B" ref-time1) "January")) ;; allowed but undocumented since 2019 (warned 1997-2019) - (should (equal (time-stamp-string "%^B" ref-time) "JANUARY")) + (should (equal (time-stamp-string "%^B" ref-time1) "JANUARY")) ;; warned 1997-2019, changed in 2019 - (should (equal (time-stamp-string "%b" ref-time) "Jan")) - (should (equal (time-stamp-string "%^b" ref-time) "JAN")) - (should (equal (time-stamp-string "%B" ref-time) "January")))) + (should (equal (time-stamp-string "%b" ref-time1) "Jan")) + (should (equal (time-stamp-string "%^b" ref-time1) "JAN")) + (should (equal (time-stamp-string "%B" ref-time1) "January")))) (ert-deftest time-stamp-test-day-of-month () "Test time-stamp formats for day of month." (with-time-stamp-test-env ;; implemented and documented since 1995 - (should (equal (time-stamp-string "%2d" ref-time) " 2")) + (should (equal (time-stamp-string "%2d" ref-time1) " 2")) (should (equal (time-stamp-string "%2d" ref-time2) "18")) - (should (equal (time-stamp-string "%02d" ref-time) "02")) + (should (equal (time-stamp-string "%02d" ref-time1) "02")) (should (equal (time-stamp-string "%02d" ref-time2) "18")) ;; documented 1997-2019 - (should (equal (time-stamp-string "%:d" ref-time) "2")) + (should (equal (time-stamp-string "%:d" ref-time1) "2")) (should (equal (time-stamp-string "%:d" ref-time2) "18")) ;; implemented since 1997, documented since 2019 - (should (equal (time-stamp-string "%1d" ref-time) "2")) + (should (equal (time-stamp-string "%1d" ref-time1) "2")) (should (equal (time-stamp-string "%1d" ref-time2) "18")) ;; allowed but undocumented since 2019 (warned 1997-2019) - (should (equal (time-stamp-string "%-d" ref-time) "2")) + (should (equal (time-stamp-string "%-d" ref-time1) "2")) (should (equal (time-stamp-string "%-d" ref-time2) "18")) ;; warned 1997-2019, changed in 2019 - (should (equal (time-stamp-string "%_d" ref-time) " 2")) + (should (equal (time-stamp-string "%_d" ref-time1) " 2")) (should (equal (time-stamp-string "%_d" ref-time2) "18")) - (should (equal (time-stamp-string "%d" ref-time) "02")) + (should (equal (time-stamp-string "%d" ref-time1) "02")) (should (equal (time-stamp-string "%d" ref-time2) "18")))) (ert-deftest time-stamp-test-hours-24 () "Test time-stamp formats for hour on a 24-hour clock." (with-time-stamp-test-env ;; implemented and documented since 1995 - (should (equal (time-stamp-string "%2H" ref-time) "15")) + (should (equal (time-stamp-string "%2H" ref-time1) "15")) (should (equal (time-stamp-string "%2H" ref-time2) "12")) (should (equal (time-stamp-string "%2H" ref-time3) " 6")) - (should (equal (time-stamp-string "%02H" ref-time) "15")) + (should (equal (time-stamp-string "%02H" ref-time1) "15")) (should (equal (time-stamp-string "%02H" ref-time2) "12")) (should (equal (time-stamp-string "%02H" ref-time3) "06")) ;; documented 1997-2019 - (should (equal (time-stamp-string "%:H" ref-time) "15")) + (should (equal (time-stamp-string "%:H" ref-time1) "15")) (should (equal (time-stamp-string "%:H" ref-time2) "12")) (should (equal (time-stamp-string "%:H" ref-time3) "6")) ;; implemented since 1997, documented since 2019 - (should (equal (time-stamp-string "%1H" ref-time) "15")) + (should (equal (time-stamp-string "%1H" ref-time1) "15")) (should (equal (time-stamp-string "%1H" ref-time2) "12")) (should (equal (time-stamp-string "%1H" ref-time3) "6")) ;; allowed but undocumented since 2019 (warned 1997-2019) - (should (equal (time-stamp-string "%-H" ref-time) "15")) + (should (equal (time-stamp-string "%-H" ref-time1) "15")) (should (equal (time-stamp-string "%-H" ref-time2) "12")) (should (equal (time-stamp-string "%-H" ref-time3) "6")) ;; warned 1997-2019, changed in 2019 - (should (equal (time-stamp-string "%_H" ref-time) "15")) + (should (equal (time-stamp-string "%_H" ref-time1) "15")) (should (equal (time-stamp-string "%_H" ref-time2) "12")) (should (equal (time-stamp-string "%_H" ref-time3) " 6")) - (should (equal (time-stamp-string "%H" ref-time) "15")) + (should (equal (time-stamp-string "%H" ref-time1) "15")) (should (equal (time-stamp-string "%H" ref-time2) "12")) (should (equal (time-stamp-string "%H" ref-time3) "06")))) @@ -152,29 +152,29 @@ "Test time-stamp formats for hour on a 12-hour clock." (with-time-stamp-test-env ;; implemented and documented since 1995 - (should (equal (time-stamp-string "%2I" ref-time) " 3")) + (should (equal (time-stamp-string "%2I" ref-time1) " 3")) (should (equal (time-stamp-string "%2I" ref-time2) "12")) (should (equal (time-stamp-string "%2I" ref-time3) " 6")) - (should (equal (time-stamp-string "%02I" ref-time) "03")) + (should (equal (time-stamp-string "%02I" ref-time1) "03")) (should (equal (time-stamp-string "%02I" ref-time2) "12")) (should (equal (time-stamp-string "%02I" ref-time3) "06")) ;; documented 1997-2019 - (should (equal (time-stamp-string "%:I" ref-time) "3")) ;PM + (should (equal (time-stamp-string "%:I" ref-time1) "3")) ;PM (should (equal (time-stamp-string "%:I" ref-time2) "12")) ;PM (should (equal (time-stamp-string "%:I" ref-time3) "6")) ;AM ;; implemented since 1997, documented since 2019 - (should (equal (time-stamp-string "%1I" ref-time) "3")) + (should (equal (time-stamp-string "%1I" ref-time1) "3")) (should (equal (time-stamp-string "%1I" ref-time2) "12")) (should (equal (time-stamp-string "%1I" ref-time3) "6")) ;; allowed but undocumented since 2019 (warned 1997-2019) - (should (equal (time-stamp-string "%-I" ref-time) "3")) + (should (equal (time-stamp-string "%-I" ref-time1) "3")) (should (equal (time-stamp-string "%-I" ref-time2) "12")) (should (equal (time-stamp-string "%-I" ref-time3) "6")) ;; warned 1997-2019, changed in 2019 - (should (equal (time-stamp-string "%_I" ref-time) " 3")) + (should (equal (time-stamp-string "%_I" ref-time1) " 3")) (should (equal (time-stamp-string "%_I" ref-time2) "12")) (should (equal (time-stamp-string "%_I" ref-time3) " 6")) - (should (equal (time-stamp-string "%I" ref-time) "03")) + (should (equal (time-stamp-string "%I" ref-time1) "03")) (should (equal (time-stamp-string "%I" ref-time2) "12")) (should (equal (time-stamp-string "%I" ref-time3) "06")))) @@ -182,154 +182,156 @@ "Test time-stamp formats for month number." (with-time-stamp-test-env ;; implemented and documented since 1995 - (should (equal (time-stamp-string "%2m" ref-time) " 1")) + (should (equal (time-stamp-string "%2m" ref-time1) " 1")) (should (equal (time-stamp-string "%2m" ref-time2) "11")) - (should (equal (time-stamp-string "%02m" ref-time) "01")) + (should (equal (time-stamp-string "%02m" ref-time1) "01")) (should (equal (time-stamp-string "%02m" ref-time2) "11")) ;; documented 1997-2019 - (should (equal (time-stamp-string "%:m" ref-time) "1")) + (should (equal (time-stamp-string "%:m" ref-time1) "1")) (should (equal (time-stamp-string "%:m" ref-time2) "11")) ;; implemented since 1997, documented since 2019 - (should (equal (time-stamp-string "%1m" ref-time) "1")) + (should (equal (time-stamp-string "%1m" ref-time1) "1")) (should (equal (time-stamp-string "%1m" ref-time2) "11")) ;; allowed but undocumented since 2019 (warned 1997-2019) - (should (equal (time-stamp-string "%-m" ref-time) "1")) + (should (equal (time-stamp-string "%-m" ref-time1) "1")) (should (equal (time-stamp-string "%-m" ref-time2) "11")) ;; warned 1997-2019, changed in 2019 - (should (equal (time-stamp-string "%_m" ref-time) " 1")) + (should (equal (time-stamp-string "%_m" ref-time1) " 1")) (should (equal (time-stamp-string "%_m" ref-time2) "11")) - (should (equal (time-stamp-string "%m" ref-time) "01")) + (should (equal (time-stamp-string "%m" ref-time1) "01")) (should (equal (time-stamp-string "%m" ref-time2) "11")))) (ert-deftest time-stamp-test-minute () "Test time-stamp formats for minute." (with-time-stamp-test-env ;; implemented and documented since 1995 - (should (equal (time-stamp-string "%2M" ref-time) " 4")) + (should (equal (time-stamp-string "%2M" ref-time1) " 4")) (should (equal (time-stamp-string "%2M" ref-time2) "14")) - (should (equal (time-stamp-string "%02M" ref-time) "04")) + (should (equal (time-stamp-string "%02M" ref-time1) "04")) (should (equal (time-stamp-string "%02M" ref-time2) "14")) ;; documented 1997-2019 - (should (equal (time-stamp-string "%:M" ref-time) "4")) + (should (equal (time-stamp-string "%:M" ref-time1) "4")) (should (equal (time-stamp-string "%:M" ref-time2) "14")) ;; implemented since 1997, documented since 2019 - (should (equal (time-stamp-string "%1M" ref-time) "4")) + (should (equal (time-stamp-string "%1M" ref-time1) "4")) (should (equal (time-stamp-string "%1M" ref-time2) "14")) ;; allowed but undocumented since 2019 (warned 1997-2019) - (should (equal (time-stamp-string "%-M" ref-time) "4")) + (should (equal (time-stamp-string "%-M" ref-time1) "4")) (should (equal (time-stamp-string "%-M" ref-time2) "14")) ;; warned 1997-2019, changed in 2019 - (should (equal (time-stamp-string "%_M" ref-time) " 4")) + (should (equal (time-stamp-string "%_M" ref-time1) " 4")) (should (equal (time-stamp-string "%_M" ref-time2) "14")) - (should (equal (time-stamp-string "%M" ref-time) "04")) + (should (equal (time-stamp-string "%M" ref-time1) "04")) (should (equal (time-stamp-string "%M" ref-time2) "14")))) (ert-deftest time-stamp-test-second () "Test time-stamp formats for second." (with-time-stamp-test-env ;; implemented and documented since 1995 - (should (equal (time-stamp-string "%2S" ref-time) " 5")) + (should (equal (time-stamp-string "%2S" ref-time1) " 5")) (should (equal (time-stamp-string "%2S" ref-time2) "15")) - (should (equal (time-stamp-string "%02S" ref-time) "05")) + (should (equal (time-stamp-string "%02S" ref-time1) "05")) (should (equal (time-stamp-string "%02S" ref-time2) "15")) ;; documented 1997-2019 - (should (equal (time-stamp-string "%:S" ref-time) "5")) + (should (equal (time-stamp-string "%:S" ref-time1) "5")) (should (equal (time-stamp-string "%:S" ref-time2) "15")) ;; implemented since 1997, documented since 2019 - (should (equal (time-stamp-string "%1S" ref-time) "5")) + (should (equal (time-stamp-string "%1S" ref-time1) "5")) (should (equal (time-stamp-string "%1S" ref-time2) "15")) ;; allowed but undocumented since 2019 (warned 1997-2019) - (should (equal (time-stamp-string "%-S" ref-time) "5")) + (should (equal (time-stamp-string "%-S" ref-time1) "5")) (should (equal (time-stamp-string "%-S" ref-time2) "15")) ;; warned 1997-2019, changed in 2019 - (should (equal (time-stamp-string "%_S" ref-time) " 5")) + (should (equal (time-stamp-string "%_S" ref-time1) " 5")) (should (equal (time-stamp-string "%_S" ref-time2) "15")) - (should (equal (time-stamp-string "%S" ref-time) "05")) + (should (equal (time-stamp-string "%S" ref-time1) "05")) (should (equal (time-stamp-string "%S" ref-time2) "15")))) (ert-deftest time-stamp-test-year-2digit () "Test time-stamp formats for %y." (with-time-stamp-test-env ;; implemented and documented since 1995 - (should (equal (time-stamp-string "%02y" ref-time) "06")) + (should (equal (time-stamp-string "%02y" ref-time1) "06")) (should (equal (time-stamp-string "%02y" ref-time2) "16")) ;; documented 1997-2019 - (should (equal (time-stamp-string "%:y" ref-time) "2006")) + (should (equal (time-stamp-string "%:y" ref-time1) "2006")) (should (equal (time-stamp-string "%:y" ref-time2) "2016")) ;; warned 1997-2019, changed in 2019 ;; (We don't expect the %-y or %_y form to be useful, ;; but we test both so that we can confidently state that ;; `-' and `_' affect all 2-digit conversions identically.) - (should (equal (time-stamp-string "%-y" ref-time) "6")) + (should (equal (time-stamp-string "%-y" ref-time1) "6")) (should (equal (time-stamp-string "%-y" ref-time2) "16")) - (should (equal (time-stamp-string "%_y" ref-time) " 6")) + (should (equal (time-stamp-string "%_y" ref-time1) " 6")) (should (equal (time-stamp-string "%_y" ref-time2) "16")) - (should (equal (time-stamp-string "%y" ref-time) "06")) + (should (equal (time-stamp-string "%y" ref-time1) "06")) (should (equal (time-stamp-string "%y" ref-time2) "16")) ;; implemented since 1995, warned since 2019, will change - (time-stamp-should-warn (equal (time-stamp-string "%04y" ref-time) "2006")) - (time-stamp-should-warn (equal (time-stamp-string "%4y" ref-time) "2006")))) + (time-stamp-should-warn + (equal (time-stamp-string "%04y" ref-time1) "2006")) + (time-stamp-should-warn + (equal (time-stamp-string "%4y" ref-time1) "2006")))) (ert-deftest time-stamp-test-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-time) "2006")))) + (should (equal (time-stamp-string "%Y" ref-time1) "2006")))) (ert-deftest time-stamp-test-am-pm () "Test time-stamp formats for AM and PM strings." (with-time-stamp-test-env ;; implemented and documented since 1997 - (should (equal (time-stamp-string "%#p" ref-time) "pm")) + (should (equal (time-stamp-string "%#p" ref-time1) "pm")) (should (equal (time-stamp-string "%#p" ref-time3) "am")) - (should (equal (time-stamp-string "%P" ref-time) "PM")) + (should (equal (time-stamp-string "%P" ref-time1) "PM")) (should (equal (time-stamp-string "%P" ref-time3) "AM")) ;; warned 1997-2019, changed in 2019 - (should (equal (time-stamp-string "%p" ref-time) "PM")) + (should (equal (time-stamp-string "%p" ref-time1) "PM")) (should (equal (time-stamp-string "%p" ref-time3) "AM")))) (ert-deftest time-stamp-test-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-time) "1")) + (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-time-zone () "Test time-stamp formats for time zone." (with-time-stamp-test-env - (let ((UTC-abbr (format-time-string "%Z" ref-time t)) - (utc-abbr (format-time-string "%#Z" ref-time t))) + (let ((UTC-abbr (format-time-string "%Z" ref-time1 t)) + (utc-abbr (format-time-string "%#Z" ref-time1 t))) ;; implemented and documented since 1995 - (should (equal (time-stamp-string "%Z" ref-time) UTC-abbr)) + (should (equal (time-stamp-string "%Z" ref-time1) UTC-abbr)) ;; documented 1995-2019 - (should (equal (time-stamp-string "%z" ref-time) utc-abbr)) + (should (equal (time-stamp-string "%z" ref-time1) utc-abbr)) ;; implemented since 1997, documented since 2019 - (should (equal (time-stamp-string "%#Z" ref-time) utc-abbr))))) + (should (equal (time-stamp-string "%#Z" ref-time1) utc-abbr))))) (ert-deftest time-stamp-test-non-date-conversions () "Test time-stamp formats for non-date items." (with-time-stamp-test-env ;; implemented and documented since 1995 - (should (equal (time-stamp-string "%%" ref-time) "%")) ;% last char - (should (equal (time-stamp-string "%%P" ref-time) "%P")) ;% not last char - (should (equal (time-stamp-string "%f" ref-time) "time-stamped-file")) - (should (equal - (time-stamp-string "%F" ref-time) "/emacs/test/time-stamped-file")) - (should (equal (time-stamp-string "%h" ref-time) "test-mail-host-name")) + (should (equal (time-stamp-string "%%" ref-time1) "%")) ;% last char + (should (equal (time-stamp-string "%%P" ref-time1) "%P")) ;% not last char + (should (equal (time-stamp-string "%f" ref-time1) "time-stamped-file")) + (should + (equal (time-stamp-string "%F" ref-time1) "/emacs/test/time-stamped-file")) + (should (equal (time-stamp-string "%h" ref-time1) "test-mail-host-name")) ;; documented 1995-2019 (should (equal - (time-stamp-string "%s" ref-time) "test-system-name.example.org")) - (should (equal (time-stamp-string "%U" ref-time) "Time Stamp Tester")) - (should (equal (time-stamp-string "%u" ref-time) "test-logname")) + (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) "test-logname")) ;; implemented since 2001, documented since 2019 - (should (equal (time-stamp-string "%L" ref-time) "Time Stamp Tester")) - (should (equal (time-stamp-string "%l" ref-time) "test-logname")) + (should (equal (time-stamp-string "%L" ref-time1) "Time Stamp Tester")) + (should (equal (time-stamp-string "%l" ref-time1) "test-logname")) ;; implemented since 2007, documented since 2019 (should (equal - (time-stamp-string "%Q" ref-time) "test-system-name.example.org")) + (time-stamp-string "%Q" ref-time1) "test-system-name.example.org")) (should (equal - (time-stamp-string "%q" ref-time) "test-system-name")))) + (time-stamp-string "%q" ref-time1) "test-system-name")))) (ert-deftest time-stamp-test-ignored-modifiers () "Test additional args allowed (but ignored) to allow for future expansion." @@ -342,7 +344,7 @@ (ert-deftest time-stamp-test-non-conversions () "Test that without a %, the text is copied literally." (with-time-stamp-test-env - (should (equal (time-stamp-string "No percent" ref-time) "No percent")))) + (should (equal (time-stamp-string "No percent" ref-time1) "No percent")))) (ert-deftest time-stamp-test-string-width () "Test time-stamp string width modifiers." -- 2.39.2