emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
blob a06d0206473298ac25c6d80b8557a1bfba78ebd3 36846 bytes (raw)
name: testing/lisp/test-org-agenda.el 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
 
;;; test-org-agenda.el --- Tests for org-agenda.el -*- lexical-binding: t ; -*-

;; Copyright (C) 2017, 2019 Marco Wahl

;; Author: Marco Wahl <marcowahlsoft@gmail.com>

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
\f
;;; Commentary:

;; Unit tests for Org Agenda.
\f
;;; Code:

(require 'org-test "../testing/org-test")
(require 'org-agenda)
(eval-and-compile (require 'cl-lib))

\f
;; General auxiliaries

(defun org-test-agenda--agenda-buffers ()
  "Return agenda buffers in a list."
  (cl-remove-if-not (lambda (x)
		      (with-current-buffer x
			(eq major-mode 'org-agenda-mode)))
		    (buffer-list)))

(defun org-test-agenda--kill-all-agendas ()
  "Kill all agenda buffers."
  (mapc #'kill-buffer
	(org-test-agenda--agenda-buffers)))

(defmacro org-test-agenda-with-agenda (text &rest body)
  (declare (indent 1))
  `(org-test-with-temp-text-in-file ,text
     (let ((org-agenda-files `(,buffer-file-name)))
       ,@body
       (org-test-agenda--kill-all-agendas))))

\f
;; Test the Agenda

(ert-deftest test-org-agenda/empty ()
  "Empty agenda."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  (let ((org-agenda-span 'day)
        org-agenda-files)
    (org-agenda-list)
    (set-buffer org-agenda-buffer-name)
    (should (= 2 (count-lines (point-min) (point-max)))))
  (org-test-agenda--kill-all-agendas))

(ert-deftest test-org-agenda/one-line ()
  "One informative line in the agenda."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  (let ((org-agenda-span 'day)
	(org-agenda-files `(,(expand-file-name "examples/agenda-file.org"
					       org-test-dir))))
    ;; NOTE: Be aware that `org-agenda-list' may or may not display
    ;; past scheduled items depending whether the date is today
    ;; `org-today' or not.
    (org-agenda-list nil  "<2017-03-10 Fri>")
    (set-buffer org-agenda-buffer-name)
    (should (= 3 (count-lines (point-min) (point-max)))))
  (org-test-agenda--kill-all-agendas))

(ert-deftest test-org-agenda/time-grid ()
  "Test time grid settings."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  ;; Default time grid.
  (org-test-at-time "2024-01-17 8:00"
    (let ((org-agenda-span 'day)
	  (org-agenda-files `(,(expand-file-name "examples/agenda-file2.org"
					         org-test-dir))))
      ;; NOTE: Be aware that `org-agenda-list' may or may not display
      ;; past scheduled items depending whether the date is today
      ;; `org-today' or not.
      (org-agenda-list nil  "<2024-01-17 Fri>")
      (set-buffer org-agenda-buffer-name)
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "8:00...... now - - - - - - - - - - - - - - - - - - - - - - - - -")))
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "agenda-file2: 9:30-10:00 Scheduled:  TODO one")))
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "agenda-file2:10:00-12:30 Scheduled:  TODO two")))
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "10:00...... ----------------")))
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "agenda-file2:13:00-15:00 Scheduled:  TODO three")))
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "agenda-file2:19:00...... Scheduled:  TODO four"))))
    (org-test-agenda--kill-all-agendas))
  ;; Custom time grid strings
  (org-test-at-time "2024-01-17 8:00"
    (let ((org-agenda-span 'day)
	  (org-agenda-files `(,(expand-file-name "examples/agenda-file2.org"
					         org-test-dir)))
          (org-agenda-time-grid '((daily today require-timed)
                                  (800 1000 1200 1400 1600 1800 2000)
			          "..." "^^^^^^^^^^^^^^" )))
      ;; NOTE: Be aware that `org-agenda-list' may or may not display
      ;; past scheduled items depending whether the date is today
      ;; `org-today' or not.
      (org-agenda-list nil  "<2024-01-17 Fri>")
      (set-buffer org-agenda-buffer-name)
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "10:00...    ^^^^^^^^^^^^^^"))))
    (org-test-agenda--kill-all-agendas))
  ;; Time grid remove-match
  (org-test-at-time "2024-01-17 8:00"
    (let ((org-agenda-span 'day)
	  (org-agenda-files `(,(expand-file-name "examples/agenda-file2.org"
					         org-test-dir)))
          (org-agenda-time-grid '((today remove-match)
			          (800 1000 1200 1400 1600 1800 2000)
			          "......" "----------------" )))
      ;; NOTE: Be aware that `org-agenda-list' may or may not display
      ;; past scheduled items depending whether the date is today
      ;; `org-today' or not.
      (org-agenda-list nil  "<2024-01-17 Fri>")
      (set-buffer org-agenda-buffer-name)
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "agenda-file2: 9:30-10:00 Scheduled:  TODO one")))
      (save-excursion
        (goto-char (point-min))
        (should-not (search-forward "10:00...... ----------------" nil t))))
    (org-test-agenda--kill-all-agendas))
  ;; Time grid with `org-agenda-default-appointment-duration'
  (org-test-at-time "2024-01-17 8:00"
    (let ((org-agenda-span 'day)
	  (org-agenda-files `(,(expand-file-name "examples/agenda-file2.org"
					         org-test-dir)))
          (org-agenda-time-grid '((today remove-match)
			          (800 1000 1200 1400 1600 1800 2000)
			          "......" "----------------" ))
          (org-agenda-default-appointment-duration 60))
      ;; NOTE: Be aware that `org-agenda-list' may or may not display
      ;; past scheduled items depending whether the date is today
      ;; `org-today' or not.
      (org-agenda-list nil  "<2024-01-17 Fri>")
      (set-buffer org-agenda-buffer-name)
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "agenda-file2:19:00-20:00 Scheduled:  TODO four")))
      ;; `org-agenda-default-appointment-duration'
      ;; should not affect date range in timestamps.
      (save-excursion
        (goto-char (point-min))
        (should-not (re-search-forward "agenda-file2:19:00-20:00.+TODO five" nil t)))
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "agenda-file2:19:00...... (1/2):  TODO five")))
      ;; Bug https://list.orgmode.org/orgmode/20211119135325.7f3f85a9@hsu-hh.de/
      (save-excursion
        (goto-char (point-min))
        (should (search-forward "14:00...... ----------------"))))
    (org-test-agenda--kill-all-agendas)))

(ert-deftest test-org-agenda/todo-selector ()
  "Test selecting keywords in `org-todo-list'."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  (let ((org-todo-keywords
         '((sequence "[ ]" "[X]")
           (sequence "TODO" "NEXT" "|" "DONE"))))
    (org-test-agenda-with-agenda
     "
* [ ] Unchecked and will appear in agenda
* NEXT NEXT will appear in agenda
* [X] Checked and will not appear in agenda
* TODO Todo and will appear in agenda
* DONE Done and will not appear in agenda
"
     ;; All todo keywords.
     (org-todo-list)
     (set-buffer org-agenda-buffer-name)
     (should
      (progn
        "all todo"
        (goto-char (point-min))
        (search-forward "[ ] Unchecked and will appear in agenda" nil t)))
     (should
      (progn
        "all todo"
        (goto-char (point-min))
        (search-forward "NEXT NEXT will appear in agenda" nil t)))
     (should
      (progn
        "all todo"
        (goto-char (point-min))
        (search-forward "TODO Todo and will appear in agenda" nil t)))
     
     ;; All todo keywords, including not done.
     (org-todo-list "*")
     (should
      (progn
        "all keywords"
        (goto-char (point-min))
        (search-forward "[ ] Unchecked and will appear in agenda" nil t)))
     (should
      (progn
        "all keywords"
        (goto-char (point-min))
        (search-forward "[X] Checked and will not appear in agenda" nil t)))
     (should
      (progn
        "all keywords"
        (goto-char (point-min))
        (search-forward "DONE Done and will not appear in agenda" nil t)))
     (should
      (progn
        "all keywords"
        (goto-char (point-min))
        (search-forward "NEXT NEXT will appear in agenda" nil t)))
     (should
      (progn
        "all keywords"
        (goto-char (point-min))
        (search-forward "TODO Todo and will appear in agenda" nil t)))
     ;; Just [ ] regexp-like entry.
     (org-todo-list "[ ]")
     (should
      (progn
        "[ ] keyword"
        (goto-char (point-min))
        (search-forward "[ ] Unchecked and will appear in agenda" nil t)))
     (should-not
      (progn
        "[ ] keyword"
        (goto-char (point-min))
        (search-forward "NEXT NEXT will appear in agenda" nil t)))
     (should-not
      (progn
        "[ ] keyword"
        (goto-char (point-min))
        (search-forward "TODO Todo and will appear in agenda" nil t)))
     ;; Two keywords.
     (org-todo-list "NEXT|TODO")
     (should-not
      (progn
        "NEXT|TODO"
        (goto-char (point-min))
        (search-forward "[ ] Unchecked and will appear in agenda" nil t)))
     (should
      (progn
        "NEXT|TODO"
        (goto-char (point-min))
        (search-forward "NEXT NEXT will appear in agenda" nil t)))
     (should
      (progn
        "NEXT|TODO"
        (goto-char (point-min))
        (search-forward "TODO Todo and will appear in agenda" nil t))))))

(ert-deftest test-org-agenda/scheduled-non-todo ()
  "One informative line in the agenda from scheduled non-todo-keyword-item."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  (dolist (org-element-use-cache '(t nil))
    (let ((org-agenda-span 'day)
	  (org-agenda-files `(,(expand-file-name "examples/agenda-file.org"
					         org-test-dir))))
      ;; NOTE: Be aware that `org-agenda-list' may or may not display
      ;; past scheduled items depending whether the date is today
      ;; `org-today' or not.
      (org-agenda-list nil "<2017-07-19 Wed>")
      (set-buffer org-agenda-buffer-name)
      (should
       (progn (goto-line 3)
	      (looking-at " *agenda-file:Scheduled: *test agenda"))))
    (org-test-agenda--kill-all-agendas)))

(ert-deftest test-org-agenda/non-scheduled-re-matches ()
  "Make sure that scheduled-looking elements do not appear in agenda.
See https://list.orgmode.org/20220101200103.GB29829@itccanarias.org/T/#t."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  (let ((org-agenda-span 'day)
	(org-agenda-files `(,(expand-file-name "examples/agenda-file.org"
					       org-test-dir))))
    ;; NOTE: Be aware that `org-agenda-list' may or may not display
    ;; past scheduled items depending whether the date is today
    ;; `org-today' or not.
    (org-agenda-list nil "<2022-01-03 Mon>")
    (set-buffer org-agenda-buffer-name)
    (should (= 2 (count-lines (point-min) (point-max)))))
  (org-test-agenda--kill-all-agendas))

(ert-deftest test-org-agenda/org-search-view ()
  "Test `org-search-view' specifications."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  ;; Search a string.
  (let ((org-agenda-files `(,(expand-file-name "examples/agenda-search.org"
					       org-test-dir))))
    (org-search-view nil "foo")
    (set-buffer org-agenda-buffer-name)
    (should (= 4 (count-lines (point-min) (point-max)))))
  ;; Search past inlinetask.
  (let ((org-agenda-files `(,(expand-file-name "examples/agenda-search.org"
					       org-test-dir))))
    (org-search-view nil "bar")
    (set-buffer org-agenda-buffer-name)
    (should (= 3 (count-lines (point-min) (point-max)))))
  ;; Search inside inlinetask.
  (let ((org-agenda-files `(,(expand-file-name "examples/agenda-search.org"
					       org-test-dir))))
    (org-search-view nil "text inside inlinetask")
    (set-buffer org-agenda-buffer-name)
    (should (= 3 (count-lines (point-min) (point-max)))))
  (org-test-agenda--kill-all-agendas))

(ert-deftest test-org-agenda/property-timestamp ()
  "Match timestamps inside property drawer.
See https://list.orgmode.org/06d301d83d9e$f8b44340$ea1cc9c0$@tomdavey.com"
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  (let ((org-agenda-span 'day)
	(org-agenda-files `(,(expand-file-name "examples/agenda-file.org"
					       org-test-dir))))
    ;; NOTE: Be aware that `org-agenda-list' may or may not display
    ;; past scheduled items depending whether the date is today
    ;; `org-today' or not.
    (org-agenda-list nil "<2022-03-22 Tue>")
    (set-buffer org-agenda-buffer-name)
    (should (= 3 (count-lines (point-min) (point-max))))
    ;; NOTE: Be aware that `org-agenda-list' may or may not display
    ;; past scheduled items depending whether the date is today
    ;; `org-today' or not.
    (org-agenda-list nil "<2022-03-25 Fri>")
    (set-buffer org-agenda-buffer-name)
    (should (= 3 (count-lines (point-min) (point-max)))))
  (org-test-agenda--kill-all-agendas))

(ert-deftest test-org-agenda/set-priority ()
  "One informative line in the agenda. Check that org-agenda-priority updates the agenda."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  (let ((org-agenda-span 'day)
	(org-agenda-files `(,(expand-file-name "examples/agenda-file.org"
					       org-test-dir))))
    ;; NOTE: Be aware that `org-agenda-list' may or may not display
    ;; past scheduled items depending whether the date is today
    ;; `org-today' or not.
    (org-agenda-list nil "<2017-07-19 Wed>")
    (set-buffer org-agenda-buffer-name)
    (should
     (progn (goto-line 3)
	    (org-agenda-priority ?B)
	    (looking-at-p " *agenda-file:Scheduled: *\\[#B\\] test agenda"))))
  (org-test-agenda--kill-all-agendas))

(ert-deftest test-org-agenda/sticky-agenda-name ()
  "Agenda buffer name after having created one sticky agenda buffer."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  (let ((org-agenda-span 'day)
	(buf (get-buffer org-agenda-buffer-name))
        org-agenda-files)
    (when buf (kill-buffer buf))
    (dolist (fn '(org-agenda-list org-todo-list))
      (org-test-with-temp-text "<2017-03-17 Fri>"
			       (org-follow-timestamp-link)) ;creates a sticky agenda
      (org-test-agenda--kill-all-agendas)
      (funcall fn)
      (should (= 1 (length (org-test-agenda--agenda-buffers))))
      (should (string= "*Org Agenda*"
		       (buffer-name (car (org-test-agenda--agenda-buffers)))))))
  (org-test-agenda--kill-all-agendas))

(ert-deftest test-org-agenda/sticky-agenda-name-after-reload ()
  "Agenda buffer name of sticky agenda after reload."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  (org-toggle-sticky-agenda)
  (let (org-agenda-files)
    (org-agenda-list)
    (let* ((agenda-buffer-name
	    (progn
	      (cl-assert (= 1 (length (org-test-agenda--agenda-buffers))))
	      (buffer-name (car (org-test-agenda--agenda-buffers))))))
      (set-buffer agenda-buffer-name)
      (org-agenda-redo)
      (should (= 1 (length (org-test-agenda--agenda-buffers))))
      (should (string= agenda-buffer-name
                       (buffer-name (car (org-test-agenda--agenda-buffers)))))))
  (org-toggle-sticky-agenda)
  (org-test-agenda--kill-all-agendas))

(ert-deftest test-org-agenda/sticky-agenda-filter-preset ()
  "Update sticky agenda buffers properly with preset of filters."
  (unless org-agenda-sticky
    (org-toggle-sticky-agenda))
  (org-test-agenda-with-agenda "* TODO Foo"
    (org-set-property "CATEGORY" "foo")
    (let ((org-agenda-custom-commands
           '(("f" "foo: multi-command"
	      ((tags-todo "+CATEGORY=\"foo\"")
               (alltodo ""))
              ((org-agenda-category-filter-preset '("+foo"))))
             ("b" "bar: multi-command"
	      ((tags-todo "+CATEGORY=\"bar\"")
               (alltodo ""))
              ((org-agenda-category-filter-preset '("+bar"))))
             ("f1" "foo: single-command"
	      tags-todo "+CATEGORY=\"foo\""
              ((org-agenda-category-filter-preset '("+foo"))))
             ("b1" "bar: single-command"
	      tags-todo "+CATEGORY=\"bar\""
              ((org-agenda-category-filter-preset '("+bar"))))
             ("f2" "foo: single-command"
	      alltodo "" ((org-agenda-category-filter-preset '("+foo"))))
             ("b2" "bar: single-command"
	      alltodo "" ((org-agenda-category-filter-preset '("+bar")))))))
      (org-agenda nil "f")
      (org-agenda nil "b")
      (set-buffer "*Org Agenda(f)*")
      (org-agenda-redo)
      (goto-char (point-min))
      (should (not (invisible-p (1- (search-forward "TODO Foo")))))
      (org-test-agenda--kill-all-agendas)
      (org-agenda nil "f1")
      (org-agenda nil "b1")
      (set-buffer "*Org Agenda(f1:+CATEGORY=\"foo\")*")
      (org-agenda-redo)
      (goto-char (point-min))
      (should (not (invisible-p (1- (search-forward "TODO Foo")))))
      (org-test-agenda--kill-all-agendas)
      (org-agenda nil "f2")
      (org-agenda nil "b2")
      (set-buffer "*Org Agenda(f2)*")
      (org-agenda-redo)
      (goto-char (point-min))
      (should (not (invisible-p (1- (search-forward "TODO Foo")))))))
  (org-toggle-sticky-agenda))

(ert-deftest test-org-agenda/skip-if ()
  "Test `org-agenda-skip-if'."
  (dolist (options '((scheduled) (notscheduled)
                     (deadline) (notdeadline)
                     (timestamp) (nottimestamp)
                     (regexp "hello") (notregexp "hello")
                     ;; TODO: Test for specific TODO keywords
                     (todo ("*")) (nottodo ("*"))))
    (should
     (equal
      (if (memq (car options) '(notscheduled notdeadline nottimestamp regexp nottodo))
          8
        nil)
      (org-test-with-temp-text
          "* hello"
        (org-agenda-skip-if nil options))))
    (should
     (equal
      (if (memq (car options) '(scheduled notdeadline timestamp regexp nottodo))
          36
        nil)
      (org-test-with-temp-text
          "* hello
SCHEDULED: <2023-07-15 Sat>"
        (org-agenda-skip-if nil options))))
    (should
     (equal
      (if (memq (car options) '(notscheduled deadline timestamp regexp nottodo))
          35
        nil)
      (org-test-with-temp-text
          "* hello
DEADLINE: <2023-07-15 Sat>"
        (org-agenda-skip-if nil options))))
    (should
     (equal
      (if (memq (car options) '(notscheduled notdeadline timestamp regexp nottodo))
          25
        nil)
      (org-test-with-temp-text
          "* hello
<2023-07-15 Sat>"
        (org-agenda-skip-if nil options))))
    (should
     (equal
      (if (memq (car options) '(notscheduled notdeadline nottimestamp notregexp nottodo))
          10
        nil)
      (org-test-with-temp-text
          "* goodbye"
        (org-agenda-skip-if nil options))))
    (should
     (equal
      (if (memq (car options) '(notscheduled notdeadline nottimestamp notregexp todo))
          26
        nil)
      (org-test-with-temp-text
          "* TODO write better tests"
        (org-agenda-skip-if nil options))))))

(ert-deftest test-org-agenda/timestamp-ignore-todo-item ()
  "Test if `org-agenda' ignores a todo item with a timestamp.

Based on the following variables:
`org-agenda-todo-ignore-deadlines',
`org-agenda-todo-ignore-scheduled', and
`org-agenda-todo-ignore-timestamp'."
  ;; TODO: test `org-agenda-todo-ignore-with-date'.
  ;; Maybe test having multiple variables set.
  (let ((org-agenda-custom-commands
         '(("f" "no fluff" todo ""
            ((org-agenda-todo-keyword-format "")
             (org-agenda-overriding-header "")
             (org-agenda-prefix-format "")))))
        (org-deadline-warning-days 1)
        (expected-return
         (lambda (timestamp value)
           (cl-case timestamp
             (past            (memq value '(all near past -1 -2 -3)))
             (yesteryesterday (memq value '(all near past -1 -2)))
             (yesterday       (memq value '(all near past -1)))
             (today           (memq value '(all near past 0)))
             (tomorrow        (memq value '(all near future 0 1)))
             (tomorroworrow   (memq value '(all far  future 0 1 2)))
             (future          (memq value '(all far  future 0 1 2 3))))))
        ;; Lexically bind the variables we're changing
        org-agenda-todo-ignore-deadlines
        org-agenda-todo-ignore-scheduled
        org-agenda-todo-ignore-timestamp)
    (org-test-at-time "2023-01-15"
      (dolist (variable '(org-agenda-todo-ignore-deadlines
                          org-agenda-todo-ignore-scheduled
                          org-agenda-todo-ignore-timestamp))
        (dolist (type '(timestamp scheduled deadline))
          ;; nil is last so it resets the variable for the next one
          (dolist (value `(past future all 3 2 1 0 -1 -2 -3
                                ,@(when (eq type 'deadline) '(near far nil))))
            (dolist (timestamp '((past .            "<2023-01-01>")
                                 (yesteryesterday . "<2023-01-13>")
                                 (yesterday .       "<2023-01-14>")
                                 (today .           "<2023-01-15>")
                                 (tomorrow .        "<2023-01-16>")
                                 (tomorroworrow .   "<2023-01-17>")
                                 (future .          "<2023-01-31>")))
              ;; Uncomment to debug failure
              ;; (message "Type: %S, Variable: %S, Value: %S, Time: %S" type variable value (car timestamp))
              (set variable value)
              (org-test-agenda-with-agenda
                  (cl-case type
                    (timestamp (concat "* TODO hello\n" (cdr timestamp)))
                    (scheduled (concat "* TODO hello
SCHEDULED: " (cdr timestamp)))
                    (deadline (concat "* TODO hello
DEADLINE: " (cdr timestamp))))
                (should
                 (string-equal
                  (or (and (funcall expected-return (car timestamp) value)
                           (cl-case variable
                             (org-agenda-todo-ignore-deadlines
                              (eq type 'deadline))
                             (org-agenda-todo-ignore-scheduled
                              (eq type 'scheduled))
                             (org-agenda-todo-ignore-timestamp
                              (eq type 'timestamp)))
                           "")
                      "hello\n")
                  (progn
                    (org-agenda nil "f")
                    (buffer-string))))))))))))

(ert-deftest test-org-agenda/skip-scheduled-repeats-after-deadline ()
  "Test `org-agenda-skip-scheduled-repeats-after-deadline'."
  (cl-assert (not org-agenda-sticky) nil "precondition violation")
  (cl-assert (not (org-test-agenda--agenda-buffers))
	     nil "precondition violation")
  (dolist (org-agenda-skip-scheduled-repeats-after-deadline '(nil t))
    (org-test-at-time "2024-01-01 8:00"
      (org-test-with-temp-text-in-file "
* TODO Do me every day until Jan, 5th (inclusive)
SCHEDULED: <2024-01-03 Wed +1d> DEADLINE: <2024-01-05 Fri>
"
        (let ((org-agenda-span 'week)
	      (org-agenda-files `(,(buffer-file-name))))
          ;; NOTE: Be aware that `org-agenda-list' may or may not display
          ;; past scheduled items depending whether the date is today
          ;; `org-today' or not.
          (org-agenda-list nil  "<2024-01-01 Mon>")
          (set-buffer org-agenda-buffer-name)
          (if org-agenda-skip-scheduled-repeats-after-deadline
              (should
               ;; Not displayed after deadline.
               (string-match-p
                "Week-agenda (W01):
Monday      1 January 2024 W01
  [^:]+:In   4 d.:  TODO Do me every day until Jan, 5th (inclusive)
Tuesday     2 January 2024
Wednesday   3 January 2024
  [^:]+:Scheduled:  TODO Do me every day until Jan, 5th (inclusive)
Thursday    4 January 2024
  [^:]+:Scheduled:  TODO Do me every day until Jan, 5th (inclusive)
Friday      5 January 2024
  [^:]+:Scheduled:  TODO Do me every day until Jan, 5th (inclusive)
  [^:]+:Deadline:   TODO Do me every day until Jan, 5th (inclusive)
Saturday    6 January 2024
Sunday      7 January 2024"
                (buffer-string)))
            (should
             ;; Displayed after deadline.
             (string-match-p
              "Week-agenda (W01):
Monday      1 January 2024 W01
  [^:]+:In   4 d.:  TODO Do me every day until Jan, 5th (inclusive)
Tuesday     2 January 2024
Wednesday   3 January 2024
  [^:]+:Scheduled:  TODO Do me every day until Jan, 5th (inclusive)
Thursday    4 January 2024
  [^:]+:Scheduled:  TODO Do me every day until Jan, 5th (inclusive)
Friday      5 January 2024
  [^:]+:Scheduled:  TODO Do me every day until Jan, 5th (inclusive)
  [^:]+:Deadline:   TODO Do me every day until Jan, 5th (inclusive)
Saturday    6 January 2024
  [^:]+:Scheduled:  TODO Do me every day until Jan, 5th (inclusive)
Sunday      7 January 2024
  [^:]+:Scheduled:  TODO Do me every day until Jan, 5th (inclusive)"
              (buffer-string))))))
      (org-test-agenda--kill-all-agendas))))

(ert-deftest test-org-agenda/tags-sorting ()
  "Test if `org-agenda' sorts tags according to `org-tags-sort-function'."
  (let ((org-agenda-custom-commands
         '(("f" "no fluff" todo ""
            ((org-agenda-todo-keyword-format "")
             (org-agenda-overriding-header "")
             (org-agenda-prefix-format "")
             (org-agenda-remove-tags t)
             (org-agenda-sorting-strategy '(tag-up)))))))
    (org-test-agenda-with-agenda
     (string-join
      '("* TODO group_a :group_a:"
        "* TODO tag_a_1 :tag_a_1:"
        "* TODO tag_a_2 :tag_a_2:"
        "* TODO tag_b_1 :tag_b_1:"
        "* TODO tag_b_2 :tag_b_2:"
        "* TODO groupless :groupless:"
        "* TODO lonely :lonely:")
      "\n")
     (dolist (org-tags-sort-function '(nil org-string< org-string> ignore))
       (should
        (string-equal
         (string-trim
          (progn
            (org-agenda nil "f")
            (substring-no-properties (buffer-string))))
         (pcase org-tags-sort-function
           ;; Not sorted
           ('ignore
            (string-join
             '("group_a" "tag_a_1" "tag_a_2" "tag_b_1" "tag_b_2" "groupless" "lonely")
             "\n"))
           ;; TODO: a value of `nil' sorts it!  That's not what the
           ;; customize menu of `org-tags-sort-function' says!  It
           ;; says "No sorting".
           ((or 'nil 'org-string< 'always)
            (string-join
             '("group_a" "groupless" "lonely" "tag_a_1" "tag_a_2" "tag_b_1" "tag_b_2")
             "\n"))
           ('org-string>
            (string-join
             '("tag_b_2" "tag_b_1" "tag_a_2" "tag_a_1" "lonely" "groupless" "group_a")
             "\n")))))))))

(ert-deftest test-org-agenda/goto-date ()
  "Test `org-agenda-goto-date'."
  (unwind-protect
      (should
       (equal
        (time-to-days (org-time-string-to-time "2019-12-30"))
        (let ((org-agenda-files nil))
          (org-agenda-list nil nil 'day)
          (org-agenda-goto-date "2019-12-30")
          (get-text-property (point) 'day))))
    (org-test-agenda--kill-all-agendas)))

(ert-deftest test-org-agenda/file-restriction ()
  "Test file restriction for org agenda."
  (org-test-with-temp-text-in-file "* TODO Foo"
    (org-agenda-set-restriction-lock t)
    (org-agenda nil "t")
    (should (search-forward "Foo"))
    (should (org-agenda-files))
    (should-not (org-agenda-files t))
    (org-agenda-remove-restriction-lock)
    (goto-char (point-min))
    (should-not (search-forward "Foo" nil t))
    (should-not (org-agenda-files)))
  (org-test-with-temp-text-in-file "* TODO Bar"
    (org-agenda nil "t" 'buffer)
    (should (search-forward "Bar"))
    (should (org-agenda-files))
    (should-not (org-agenda-files t))
    (org-agenda-remove-restriction-lock)
    (goto-char (point-min))
    (should-not (search-forward "Bar" nil t))
    (should-not (org-agenda-files)))
  (org-test-with-temp-text-in-file "* TODO Bar"
    (org-agenda nil "t" 'buffer)
    (org-agenda nil "t")
    (should-not (search-forward "Bar" nil t))
    (should-not (org-agenda-files)))
  (org-test-agenda--kill-all-agendas))

(ert-deftest test-org-agenda/skip-deadline-prewarning-if-scheduled ()
  "Test `org-agenda-skip-deadline-prewarning-if-scheduled'."
  (org-test-at-time
      "2024-01-15"
    (let ((org-agenda-skip-deadline-prewarning-if-scheduled t))
      (org-test-agenda-with-agenda
       "* TODO foo\nDEADLINE: <2024-01-20 Sat> SCHEDULED: <2024-01-19 Fri>"
       (org-agenda-list nil nil 1)
       (should-not (search-forward "In " nil t))))
    (let ((org-agenda-skip-deadline-prewarning-if-scheduled 10))
      (org-test-agenda-with-agenda
       "* TODO foo\nDEADLINE: <2024-01-20 Sat> SCHEDULED: <2024-01-19 Fri>"
       (org-agenda-list nil nil 1)
       (should (search-forward "In " nil t))))
    ;; Custom prewarning cookie "-3d", so there should be no warning anyway.
    (let ((org-agenda-skip-deadline-prewarning-if-scheduled 10))
      (org-test-agenda-with-agenda
       "* TODO foo\nDEADLINE: <2024-01-20 Sat -3d> SCHEDULED: <2024-01-19 Fri>"
       (org-agenda-list nil nil 1)
       (should-not (search-forward "In " nil t))))
    (let ((org-agenda-skip-deadline-prewarning-if-scheduled 3))
      (org-test-agenda-with-agenda
       "* TODO foo\nDEADLINE: <2024-01-20 Sat> SCHEDULED: <2024-01-19 Fri>"
       (org-agenda-list nil nil 1)
       (should-not (search-forward "In " nil t))))
    (let ((org-agenda-skip-deadline-prewarning-if-scheduled nil))
      (org-test-agenda-with-agenda
       "* TODO foo\nDEADLINE: <2024-01-20 Sat> SCHEDULED: <2024-01-19 Fri>"
       (org-agenda-list nil nil 1)
       (should (search-forward "In " nil t))))
    (let ((org-agenda-skip-deadline-prewarning-if-scheduled 'pre-scheduled))
      (org-test-agenda-with-agenda
       "* TODO foo\nDEADLINE: <2024-01-20 Sat> SCHEDULED: <2024-01-16 Tue>"
       (org-agenda-list nil nil 1)
       (should-not (search-forward "In " nil t))))
    (let ((org-agenda-skip-deadline-prewarning-if-scheduled 'pre-scheduled))
      (org-test-agenda-with-agenda
       "* TODO foo\nDEADLINE: <2024-01-20 Sat> SCHEDULED: <2024-01-15 Mon>"
       (org-agenda-list nil nil 1)
       (should (search-forward "In " nil t))))))

(ert-deftest test-org-agenda/diary-timestamp ()
  "Test diary timestamp handling."
  (org-test-at-time
      "2024-01-15"
    (org-test-agenda-with-agenda
        "* TODO foo\n<%%(diary-date 01 15 2024)>"
      (org-agenda-list nil nil 1)
      (should (search-forward "foo" nil t)))
    (org-test-agenda-with-agenda
        "* TODO foo\n<%%(diary-date 02 15 2024)>"
      (org-agenda-list nil nil 1)
      (should-not (search-forward "foo" nil t)))
    ;; Test time and time ranges in diary timestamps.
    (org-test-agenda-with-agenda
        "* TODO foo\n<%%(diary-date 01 15 2024) 12:00>"
      (org-agenda-list nil nil 1)
      (should (search-forward "12:00" nil t)))
    (org-test-agenda-with-agenda
        "* TODO foo\n<%%(diary-date 01 15 2024) 12:00-14:00>"
      (org-agenda-list nil nil 1)
      (should (search-forward "12:00-14:00" nil t)))))

\f
;; agenda redo

(require 'face-remap)

(ert-deftest test-org-agenda/rescale ()
  "Text scale survives `org-agenda-redo'."
  (org-test-agenda--kill-all-agendas)
  (unwind-protect
      (let ((org-agenda-span 'day)
         org-agenda-files)
     (org-agenda-list)
     (set-buffer org-agenda-buffer-name)
     (text-scale-mode)
     (text-scale-set 11)
     (cl-assert (and (boundp text-scale-mode) text-scale-mode))
     (org-agenda-redo)
     (should text-scale-mode)
     (should (= 11 text-scale-mode-amount)))
   (org-test-agenda--kill-all-agendas)))

(ert-deftest test-org-agenda/redo-setting ()
  "Command settings survives `org-agenda-redo'."
  (org-test-agenda--kill-all-agendas)
  (let ((org-agenda-custom-commands
         '(("t" "TODOs" alltodo ""
            ((org-agenda-overriding-header "Test"))))))
    (org-agenda nil "t")
    (org-agenda-redo)
    (org-agenda-redo)
    (goto-char (point-min))
    (should (looking-at-p "Test")))
  (org-test-agenda--kill-all-agendas))

\f
(ert-deftest test-org-agenda/diary-inclusion ()
  "Diary inclusion happens."
  (org-test-agenda--kill-all-agendas)
  (let ((diary-file (expand-file-name "examples/diary-file" org-test-dir))
	(org-agenda-files `(,(expand-file-name "examples/agenda-file.org"
					       org-test-dir)))
	(diary-date-forms '((month "[-/]" day "[^-/0-9]")
			    (year "[-/]" month "[-/]" day "[^0-9]")
			    (monthname " *" day "[^-0-9]")
			    (year " *" monthname " *" day "[^0-9]")
			    (dayname "\\W")))
	(org-agenda-span 'day)
	(org-agenda-include-diary t))
    ;; NOTE: Be aware that `org-agenda-list' may or may not display
    ;; past scheduled items depending whether the date is today
    ;; `org-today' or not.
    (org-agenda-list nil "<2019-01-08>")
    (should (search-forward "f0bcf0cd8bad93c1451bb6e1b2aaedef5cce7cbb" nil t))
    (org-test-agenda--kill-all-agendas)))

;; agenda bulk actions

(ert-deftest test-org-agenda/bulk ()
  "Bulk actions are applied to marked items."
  (org-test-agenda-with-agenda "* TODO a\n* TODO b"
    (org-todo-list)
    (org-agenda-bulk-mark-all)
    (cl-letf (((symbol-function 'read-char-exclusive)
               (lambda () ?t))
              ((symbol-function 'completing-read)
               (lambda (&rest _rest) "DONE")))
      (org-agenda-bulk-action))
    (org-agenda-previous-item 99)
    (should (looking-at ".*DONE a"))
    (org-agenda-next-item 1)
    (should (looking-at ".*DONE b"))))

(ert-deftest test-org-agenda/bulk-custom ()
  "Custom bulk actions are applied to all marked items."
  (org-test-agenda-with-agenda "* TODO a\n* TODO b"
    (org-todo-list)
    (org-agenda-bulk-mark-all)

    ;; Mock read functions
    (let* ((f-call-cnt 0)
           (org-agenda-bulk-custom-functions
           `((?P ,(lambda () (setq f-call-cnt (1+ f-call-cnt)))))))
      (cl-letf* (((symbol-function 'read-char-exclusive)
                  (lambda () ?P)))
        (org-agenda-bulk-action)
        (should (= f-call-cnt 2))))))

(ert-deftest test-org-agenda/bulk-custom-arg-func ()
  "Argument collection functions can be specified for custom bulk
functions."
  (org-test-agenda-with-agenda "* TODO a\n* TODO b"
    (org-todo-list)
    (org-agenda-bulk-mark-all)
    (let* ((f-called-cnt 0)
           (arg-f-call-cnt 0)
           (f-called-args nil)
           (org-agenda-bulk-custom-functions
            `((?P
               ;; Custom bulk function
               ,(lambda (&rest args)
                  (message "test")
                  (setq f-called-cnt (1+ f-called-cnt)

                        f-called-args args))
               ;; Argument collection function
               ,(lambda ()
                  (setq arg-f-call-cnt (1+ arg-f-call-cnt))
                  '(1 2 3))))))
      (cl-letf (((symbol-function 'read-char-exclusive)
                 (lambda () ?P)))
        (org-agenda-bulk-action))
      (should (= f-called-cnt 2))
      (should (= arg-f-call-cnt 1))
      (should (equal f-called-args '(1 2 3))))))


\f
(provide 'test-org-agenda)
\f
;;; test-org-agenda.el ends here

debug log:

solving a06d02064 ...
found a06d02064 in https://list.orgmode.org/orgmode/CH3PR84MB3424AED085108BEA72EE32E4C5922@CH3PR84MB3424.NAMPRD84.PROD.OUTLOOK.COM/
found 778f91e8e in https://git.savannah.gnu.org/cgit/emacs/org-mode.git
preparing index
index prepared:
100644 778f91e8ec0255815ea45f40daf9146df28f6ffb	testing/lisp/test-org-agenda.el

applying [1/1] https://list.orgmode.org/orgmode/CH3PR84MB3424AED085108BEA72EE32E4C5922@CH3PR84MB3424.NAMPRD84.PROD.OUTLOOK.COM/
diff --git a/testing/lisp/test-org-agenda.el b/testing/lisp/test-org-agenda.el
index 778f91e8e..a06d02064 100644

Checking patch testing/lisp/test-org-agenda.el...
Applied patch testing/lisp/test-org-agenda.el cleanly.

index at:
100644 a06d0206473298ac25c6d80b8557a1bfba78ebd3	testing/lisp/test-org-agenda.el

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).