mirrored from git://git.moodle.org/moodle.git
/
filterlib_test.php
891 lines (787 loc) · 35.9 KB
/
filterlib_test.php
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
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle 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.
//
// Moodle 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 Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Tests for the parts of ../filterlib.php that involve loading the configuration
* from, and saving the configuration to, the database.
*
* @package core_filter
* @category phpunit
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->libdir . '/filterlib.php');
/**
* Test filters.
*/
class core_filterlib_testcase extends advanced_testcase {
private function assert_only_one_filter_globally($filter, $state) {
global $DB;
$recs = $DB->get_records('filter_active');
$this->assertCount(1, $recs);
$rec = reset($recs);
unset($rec->id);
$expectedrec = new stdClass();
$expectedrec->filter = $filter;
$expectedrec->contextid = context_system::instance()->id;
$expectedrec->active = $state;
$expectedrec->sortorder = 1;
$this->assertEquals($expectedrec, $rec);
}
private function assert_global_sort_order($filters) {
global $DB;
$sortedfilters = $DB->get_records_menu('filter_active',
array('contextid' => context_system::instance()->id), 'sortorder', 'sortorder,filter');
$testarray = array();
$index = 1;
foreach ($filters as $filter) {
$testarray[$index++] = $filter;
}
$this->assertEquals($testarray, $sortedfilters);
}
public function test_set_filter_globally_on() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
// Exercise SUT.
filter_set_global_state('name', TEXTFILTER_ON);
// Validate.
$this->assert_only_one_filter_globally('name', TEXTFILTER_ON);
}
public function test_set_filter_globally_off() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
// Exercise SUT.
filter_set_global_state('name', TEXTFILTER_OFF);
// Validate.
$this->assert_only_one_filter_globally('name', TEXTFILTER_OFF);
}
public function test_set_filter_globally_disabled() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
// Exercise SUT.
filter_set_global_state('name', TEXTFILTER_DISABLED);
// Validate.
$this->assert_only_one_filter_globally('name', TEXTFILTER_DISABLED);
}
/**
* @expectedException coding_exception
*/
public function test_global_config_exception_on_invalid_state() {
$this->resetAfterTest();
filter_set_global_state('name', 0);
}
public function test_auto_sort_order() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
// Exercise SUT.
filter_set_global_state('one', TEXTFILTER_DISABLED);
filter_set_global_state('two', TEXTFILTER_DISABLED);
// Validate.
$this->assert_global_sort_order(array('one', 'two'));
}
public function test_auto_sort_order_enabled() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
// Exercise SUT.
filter_set_global_state('one', TEXTFILTER_ON);
filter_set_global_state('two', TEXTFILTER_OFF);
// Validate.
$this->assert_global_sort_order(array('one', 'two'));
}
public function test_update_existing_dont_duplicate() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
// Exercise SUT.
filter_set_global_state('name', TEXTFILTER_ON);
filter_set_global_state('name', TEXTFILTER_OFF);
// Validate.
$this->assert_only_one_filter_globally('name', TEXTFILTER_OFF);
}
public function test_update_reorder_down() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
filter_set_global_state('one', TEXTFILTER_ON);
filter_set_global_state('two', TEXTFILTER_ON);
filter_set_global_state('three', TEXTFILTER_ON);
// Exercise SUT.
filter_set_global_state('two', TEXTFILTER_ON, -1);
// Validate.
$this->assert_global_sort_order(array('two', 'one', 'three'));
}
public function test_update_reorder_up() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
filter_set_global_state('one', TEXTFILTER_ON);
filter_set_global_state('two', TEXTFILTER_ON);
filter_set_global_state('three', TEXTFILTER_ON);
filter_set_global_state('four', TEXTFILTER_ON);
// Exercise SUT.
filter_set_global_state('two', TEXTFILTER_ON, 1);
// Validate.
$this->assert_global_sort_order(array('one', 'three', 'two', 'four'));
}
public function test_auto_sort_order_change_to_enabled() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
filter_set_global_state('one', TEXTFILTER_ON);
filter_set_global_state('two', TEXTFILTER_DISABLED);
filter_set_global_state('three', TEXTFILTER_DISABLED);
// Exercise SUT.
filter_set_global_state('three', TEXTFILTER_ON);
// Validate.
$this->assert_global_sort_order(array('one', 'three', 'two'));
}
public function test_auto_sort_order_change_to_disabled() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
filter_set_global_state('one', TEXTFILTER_ON);
filter_set_global_state('two', TEXTFILTER_ON);
filter_set_global_state('three', TEXTFILTER_DISABLED);
// Exercise SUT.
filter_set_global_state('one', TEXTFILTER_DISABLED);
// Validate.
$this->assert_global_sort_order(array('two', 'one', 'three'));
}
public function test_filter_get_global_states() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
filter_set_global_state('one', TEXTFILTER_ON);
filter_set_global_state('two', TEXTFILTER_OFF);
filter_set_global_state('three', TEXTFILTER_DISABLED);
// Exercise SUT.
$filters = filter_get_global_states();
// Validate.
$this->assertEquals(array(
'one' => (object) array('filter' => 'one', 'active' => TEXTFILTER_ON, 'sortorder' => 1),
'two' => (object) array('filter' => 'two', 'active' => TEXTFILTER_OFF, 'sortorder' => 2),
'three' => (object) array('filter' => 'three', 'active' => TEXTFILTER_DISABLED, 'sortorder' => 3)
), $filters);
}
private function assert_only_one_local_setting($filter, $contextid, $state) {
global $DB;
$recs = $DB->get_records('filter_active');
$this->assertEquals(1, count($recs), 'More than one record returned %s.');
$rec = reset($recs);
unset($rec->id);
unset($rec->sortorder);
$expectedrec = new stdClass();
$expectedrec->filter = $filter;
$expectedrec->contextid = $contextid;
$expectedrec->active = $state;
$this->assertEquals($expectedrec, $rec);
}
private function assert_no_local_setting() {
global $DB;
$this->assertEquals(0, $DB->count_records('filter_active'));
}
public function test_local_on() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Exercise SUT.
filter_set_local_state('name', 123, TEXTFILTER_ON);
// Validate.
$this->assert_only_one_local_setting('name', 123, TEXTFILTER_ON);
}
public function test_local_off() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Exercise SUT.
filter_set_local_state('name', 123, TEXTFILTER_OFF);
// Validate.
$this->assert_only_one_local_setting('name', 123, TEXTFILTER_OFF);
}
public function test_local_inherit() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Exercise SUT.
filter_set_local_state('name', 123, TEXTFILTER_INHERIT);
// Validate.
$this->assert_no_local_setting();
}
/**
* @expectedException coding_exception
*/
public function test_local_invalid_state_throws_exception() {
$this->resetAfterTest();
// Exercise SUT.
filter_set_local_state('name', 123, -9999);
}
/**
* @expectedException coding_exception
*/
public function test_throws_exception_when_setting_global() {
$this->resetAfterTest();
// Exercise SUT.
filter_set_local_state('name', context_system::instance()->id, TEXTFILTER_INHERIT);
}
public function test_local_inherit_deletes_existing() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
filter_set_local_state('name', 123, TEXTFILTER_INHERIT);
// Exercise SUT.
filter_set_local_state('name', 123, TEXTFILTER_INHERIT);
// Validate.
$this->assert_no_local_setting();
}
private function assert_only_one_config($filter, $context, $name, $value) {
global $DB;
$recs = $DB->get_records('filter_config');
$this->assertEquals(1, count($recs), 'More than one record returned %s.');
$rec = reset($recs);
unset($rec->id);
$expectedrec = new stdClass();
$expectedrec->filter = $filter;
$expectedrec->contextid = $context;
$expectedrec->name = $name;
$expectedrec->value = $value;
$this->assertEquals($expectedrec, $rec);
}
public function test_set_new_config() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Exercise SUT.
filter_set_local_config('name', 123, 'settingname', 'An arbitrary value');
// Validate.
$this->assert_only_one_config('name', 123, 'settingname', 'An arbitrary value');
}
public function test_update_existing_config() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
filter_set_local_config('name', 123, 'settingname', 'An arbitrary value');
// Exercise SUT.
filter_set_local_config('name', 123, 'settingname', 'A changed value');
// Validate.
$this->assert_only_one_config('name', 123, 'settingname', 'A changed value');
}
public function test_filter_get_local_config() {
$this->resetAfterTest();
// Setup fixture.
filter_set_local_config('name', 123, 'setting1', 'An arbitrary value');
filter_set_local_config('name', 123, 'setting2', 'Another arbitrary value');
filter_set_local_config('name', 122, 'settingname', 'Value from another context');
filter_set_local_config('other', 123, 'settingname', 'Someone else\'s value');
// Exercise SUT.
$config = filter_get_local_config('name', 123);
// Validate.
$this->assertEquals(array('setting1' => 'An arbitrary value', 'setting2' => 'Another arbitrary value'), $config);
}
protected function setup_available_in_context_tests() {
$course = $this->getDataGenerator()->create_course(array('category'=>1));
$childcontext = context_coursecat::instance(1);
$childcontext2 = context_course::instance($course->id);
$syscontext = context_system::instance();
return [
'syscontext' => $syscontext,
'childcontext' => $childcontext,
'childcontext2' => $childcontext2
];
}
protected function remove_all_filters_from_config() {
global $DB;
$DB->delete_records('filter_active', array());
$DB->delete_records('filter_config', array());
}
private function assert_filter_list($expectedfilters, $filters) {
$this->assertEquals($expectedfilters, array_keys($filters), '', 0, 10, true);
}
public function test_globally_on_is_returned() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
[
'syscontext' => $syscontext
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_ON);
// Exercise SUT.
$filters = filter_get_active_in_context($syscontext);
// Validate.
$this->assert_filter_list(array('name'), $filters);
// Check no config returned correctly.
$this->assertEquals(array(), $filters['name']);
}
public function test_globally_off_not_returned() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
[
'childcontext2' => $childcontext2
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_OFF);
// Exercise SUT.
$filters = filter_get_active_in_context($childcontext2);
// Validate.
$this->assert_filter_list(array(), $filters);
}
public function test_globally_off_overridden() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
[
'childcontext' => $childcontext,
'childcontext2' => $childcontext2
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_OFF);
filter_set_local_state('name', $childcontext->id, TEXTFILTER_ON);
// Exercise SUT.
$filters = filter_get_active_in_context($childcontext2);
// Validate.
$this->assert_filter_list(array('name'), $filters);
}
public function test_globally_on_overridden() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
[
'childcontext' => $childcontext,
'childcontext2' => $childcontext2
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_ON);
filter_set_local_state('name', $childcontext->id, TEXTFILTER_OFF);
// Exercise SUT.
$filters = filter_get_active_in_context($childcontext2);
// Validate.
$this->assert_filter_list(array(), $filters);
}
public function test_globally_disabled_not_overridden() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
[
'syscontext' => $syscontext,
'childcontext' => $childcontext
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_DISABLED);
filter_set_local_state('name', $childcontext->id, TEXTFILTER_ON);
// Exercise SUT.
$filters = filter_get_active_in_context($syscontext);
// Validate.
$this->assert_filter_list(array(), $filters);
}
public function test_single_config_returned() {
$this->resetAfterTest();
[
'childcontext' => $childcontext
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_ON);
filter_set_local_config('name', $childcontext->id, 'settingname', 'A value');
// Exercise SUT.
$filters = filter_get_active_in_context($childcontext);
// Validate.
$this->assertEquals(array('settingname' => 'A value'), $filters['name']);
}
public function test_multi_config_returned() {
$this->resetAfterTest();
[
'childcontext' => $childcontext
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_ON);
filter_set_local_config('name', $childcontext->id, 'settingname', 'A value');
filter_set_local_config('name', $childcontext->id, 'anothersettingname', 'Another value');
// Exercise SUT.
$filters = filter_get_active_in_context($childcontext);
// Validate.
$this->assertEquals(array('settingname' => 'A value', 'anothersettingname' => 'Another value'), $filters['name']);
}
public function test_config_from_other_context_not_returned() {
$this->resetAfterTest();
[
'childcontext' => $childcontext,
'childcontext2' => $childcontext2
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_ON);
filter_set_local_config('name', $childcontext->id, 'settingname', 'A value');
filter_set_local_config('name', $childcontext2->id, 'anothersettingname', 'Another value');
// Exercise SUT.
$filters = filter_get_active_in_context($childcontext2);
// Validate.
$this->assertEquals(array('anothersettingname' => 'Another value'), $filters['name']);
}
public function test_config_from_other_filter_not_returned() {
$this->resetAfterTest();
[
'childcontext' => $childcontext
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_ON);
filter_set_local_config('name', $childcontext->id, 'settingname', 'A value');
filter_set_local_config('other', $childcontext->id, 'anothersettingname', 'Another value');
// Exercise SUT.
$filters = filter_get_active_in_context($childcontext);
// Validate.
$this->assertEquals(array('settingname' => 'A value'), $filters['name']);
}
protected function assert_one_available_filter($filter, $localstate, $inheritedstate, $filters) {
$this->assertEquals(1, count($filters), 'More than one record returned %s.');
$rec = $filters[$filter];
unset($rec->id);
$expectedrec = new stdClass();
$expectedrec->filter = $filter;
$expectedrec->localstate = $localstate;
$expectedrec->inheritedstate = $inheritedstate;
$this->assertEquals($expectedrec, $rec);
}
public function test_available_in_context_localoverride() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
[
'childcontext' => $childcontext
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_ON);
filter_set_local_state('name', $childcontext->id, TEXTFILTER_OFF);
// Exercise SUT.
$filters = filter_get_available_in_context($childcontext);
// Validate.
$this->assert_one_available_filter('name', TEXTFILTER_OFF, TEXTFILTER_ON, $filters);
}
public function test_available_in_context_nolocaloverride() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
[
'childcontext' => $childcontext,
'childcontext2' => $childcontext2
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_ON);
filter_set_local_state('name', $childcontext->id, TEXTFILTER_OFF);
// Exercise SUT.
$filters = filter_get_available_in_context($childcontext2);
// Validate.
$this->assert_one_available_filter('name', TEXTFILTER_INHERIT, TEXTFILTER_OFF, $filters);
}
public function test_available_in_context_disabled_not_returned() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
[
'childcontext' => $childcontext
] = $this->setup_available_in_context_tests();
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_DISABLED);
filter_set_local_state('name', $childcontext->id, TEXTFILTER_ON);
// Exercise SUT.
$filters = filter_get_available_in_context($childcontext);
// Validate.
$this->assertEquals(array(), $filters);
}
/**
* @expectedException coding_exception
*/
public function test_available_in_context_exception_with_syscontext() {
$this->resetAfterTest();
[
'syscontext' => $syscontext
] = $this->setup_available_in_context_tests();
// Exercise SUT.
filter_get_available_in_context($syscontext);
}
protected function setup_preload_activities_test() {
$syscontext = context_system::instance();
$catcontext = context_coursecat::instance(1);
$course = $this->getDataGenerator()->create_course(array('category' => 1));
$coursecontext = context_course::instance($course->id);
$page1 = $this->getDataGenerator()->create_module('page', array('course' => $course->id));
$activity1context = context_module::instance($page1->cmid);
$page2 = $this->getDataGenerator()->create_module('page', array('course' => $course->id));
$activity2context = context_module::instance($page2->cmid);
return [
'syscontext' => $syscontext,
'catcontext' => $catcontext,
'course' => $course,
'coursecontext' => $coursecontext,
'activity1context' => $activity1context,
'activity2context' => $activity2context
];
}
private function assert_matches($modinfo, $activity1context, $activity2context) {
global $FILTERLIB_PRIVATE, $DB;
// Use preload cache...
$FILTERLIB_PRIVATE = new stdClass();
filter_preload_activities($modinfo);
// Get data and check no queries are made.
$before = $DB->perf_get_reads();
$plfilters1 = filter_get_active_in_context($activity1context);
$plfilters2 = filter_get_active_in_context($activity2context);
$after = $DB->perf_get_reads();
$this->assertEquals($before, $after);
// Repeat without cache and check it makes queries now.
$FILTERLIB_PRIVATE = new stdClass;
$before = $DB->perf_get_reads();
$filters1 = filter_get_active_in_context($activity1context);
$filters2 = filter_get_active_in_context($activity2context);
$after = $DB->perf_get_reads();
$this->assertTrue($after > $before);
// Check they match.
$this->assertEquals($plfilters1, $filters1);
$this->assertEquals($plfilters2, $filters2);
}
public function test_preload() {
$this->resetAfterTest();
[
'catcontext' => $catcontext,
'course' => $course,
'coursecontext' => $coursecontext,
'activity1context' => $activity1context,
'activity2context' => $activity2context
] = $this->setup_preload_activities_test();
// Get course and modinfo.
$modinfo = new course_modinfo($course, 2);
// Note: All the tests in this function check that the result from the
// preloaded cache is the same as the result from calling the standard
// function without preloading.
// Initially, check with no filters enabled.
$this->assert_matches($modinfo, $activity1context, $activity2context);
// Enable filter globally, check.
filter_set_global_state('name', TEXTFILTER_ON);
$this->assert_matches($modinfo, $activity1context, $activity2context);
// Disable for activity 2.
filter_set_local_state('name', $activity2context->id, TEXTFILTER_OFF);
$this->assert_matches($modinfo, $activity1context, $activity2context);
// Disable at category.
filter_set_local_state('name', $catcontext->id, TEXTFILTER_OFF);
$this->assert_matches($modinfo, $activity1context, $activity2context);
// Enable for activity 1.
filter_set_local_state('name', $activity1context->id, TEXTFILTER_ON);
$this->assert_matches($modinfo, $activity1context, $activity2context);
// Disable globally.
filter_set_global_state('name', TEXTFILTER_DISABLED);
$this->assert_matches($modinfo, $activity1context, $activity2context);
// Add another 2 filters.
filter_set_global_state('frog', TEXTFILTER_ON);
filter_set_global_state('zombie', TEXTFILTER_ON);
$this->assert_matches($modinfo, $activity1context, $activity2context);
// Disable random one of these in each context.
filter_set_local_state('zombie', $activity1context->id, TEXTFILTER_OFF);
filter_set_local_state('frog', $activity2context->id, TEXTFILTER_OFF);
$this->assert_matches($modinfo, $activity1context, $activity2context);
// Now do some filter options.
filter_set_local_config('name', $activity1context->id, 'a', 'x');
filter_set_local_config('zombie', $activity1context->id, 'a', 'y');
filter_set_local_config('frog', $activity1context->id, 'a', 'z');
// These last two don't do anything as they are not at final level but I
// thought it would be good to have that verified in test.
filter_set_local_config('frog', $coursecontext->id, 'q', 'x');
filter_set_local_config('frog', $catcontext->id, 'q', 'z');
$this->assert_matches($modinfo, $activity1context, $activity2context);
}
public function test_filter_delete_all_for_filter() {
global $DB;
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_ON);
filter_set_global_state('other', TEXTFILTER_ON);
filter_set_local_config('name', context_system::instance()->id, 'settingname', 'A value');
filter_set_local_config('other', context_system::instance()->id, 'settingname', 'Other value');
set_config('configname', 'A config value', 'filter_name');
set_config('configname', 'Other config value', 'filter_other');
// Exercise SUT.
filter_delete_all_for_filter('name');
// Validate.
$this->assertEquals(1, $DB->count_records('filter_active'));
$this->assertTrue($DB->record_exists('filter_active', array('filter' => 'other')));
$this->assertEquals(1, $DB->count_records('filter_config'));
$this->assertTrue($DB->record_exists('filter_config', array('filter' => 'other')));
$expectedconfig = new stdClass;
$expectedconfig->configname = 'Other config value';
$this->assertEquals($expectedconfig, get_config('filter_other'));
$this->assertEquals(get_config('filter_name'), new stdClass());
}
public function test_filter_delete_all_for_context() {
global $DB;
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
// Setup fixture.
filter_set_global_state('name', TEXTFILTER_ON);
filter_set_local_state('name', 123, TEXTFILTER_OFF);
filter_set_local_config('name', 123, 'settingname', 'A value');
filter_set_local_config('other', 123, 'settingname', 'Other value');
filter_set_local_config('other', 122, 'settingname', 'Other value');
// Exercise SUT.
filter_delete_all_for_context(123);
// Validate.
$this->assertEquals(1, $DB->count_records('filter_active'));
$this->assertTrue($DB->record_exists('filter_active', array('contextid' => context_system::instance()->id)));
$this->assertEquals(1, $DB->count_records('filter_config'));
$this->assertTrue($DB->record_exists('filter_config', array('filter' => 'other')));
}
public function test_set() {
global $CFG;
$this->resetAfterTest();
$this->assertFileExists("$CFG->dirroot/filter/emailprotect"); // Any standard filter.
$this->assertFileExists("$CFG->dirroot/filter/tidy"); // Any standard filter.
$this->assertFileNotExists("$CFG->dirroot/filter/grgrggr"); // Any non-existent filter
// Setup fixture.
set_config('filterall', 0);
set_config('stringfilters', '');
// Exercise SUT.
filter_set_applies_to_strings('tidy', true);
// Validate.
$this->assertEquals('tidy', $CFG->stringfilters);
$this->assertEquals(1, $CFG->filterall);
filter_set_applies_to_strings('grgrggr', true);
$this->assertEquals('tidy', $CFG->stringfilters);
$this->assertEquals(1, $CFG->filterall);
filter_set_applies_to_strings('emailprotect', true);
$this->assertEquals('tidy,emailprotect', $CFG->stringfilters);
$this->assertEquals(1, $CFG->filterall);
}
public function test_unset_to_empty() {
global $CFG;
$this->resetAfterTest();
$this->assertFileExists("$CFG->dirroot/filter/tidy"); // Any standard filter.
// Setup fixture.
set_config('filterall', 1);
set_config('stringfilters', 'tidy');
// Exercise SUT.
filter_set_applies_to_strings('tidy', false);
// Validate.
$this->assertEquals('', $CFG->stringfilters);
$this->assertEquals('', $CFG->filterall);
}
public function test_unset_multi() {
global $CFG;
$this->resetAfterTest();
$this->assertFileExists("$CFG->dirroot/filter/emailprotect"); // Any standard filter.
$this->assertFileExists("$CFG->dirroot/filter/tidy"); // Any standard filter.
$this->assertFileExists("$CFG->dirroot/filter/multilang"); // Any standard filter.
// Setup fixture.
set_config('filterall', 1);
set_config('stringfilters', 'emailprotect,tidy,multilang');
// Exercise SUT.
filter_set_applies_to_strings('tidy', false);
// Validate.
$this->assertEquals('emailprotect,multilang', $CFG->stringfilters);
$this->assertEquals(1, $CFG->filterall);
}
public function test_filter_manager_instance() {
$this->resetAfterTest();
set_config('perfdebug', 7);
filter_manager::reset_caches();
$filterman = filter_manager::instance();
$this->assertInstanceOf('filter_manager', $filterman);
$this->assertNotInstanceOf('performance_measuring_filter_manager', $filterman);
set_config('perfdebug', 15);
filter_manager::reset_caches();
$filterman = filter_manager::instance();
$this->assertInstanceOf('filter_manager', $filterman);
$this->assertInstanceOf('performance_measuring_filter_manager', $filterman);
}
public function test_filter_get_active_state_contextid_parameter() {
$this->resetAfterTest();
filter_set_global_state('glossary', TEXTFILTER_ON);
// Using system context by default.
$active = filter_get_active_state('glossary');
$this->assertEquals($active, TEXTFILTER_ON);
$systemcontext = context_system::instance();
// Passing $systemcontext object.
$active = filter_get_active_state('glossary', $systemcontext);
$this->assertEquals($active, TEXTFILTER_ON);
// Passing $systemcontext id.
$active = filter_get_active_state('glossary', $systemcontext->id);
$this->assertEquals($active, TEXTFILTER_ON);
// Not system context.
filter_set_local_state('glossary', '123', TEXTFILTER_ON);
$active = filter_get_active_state('glossary', '123');
$this->assertEquals($active, TEXTFILTER_ON);
}
public function test_filter_get_active_state_filtername_parameter() {
$this->resetAfterTest();
filter_set_global_state('glossary', TEXTFILTER_ON);
// Using full filtername.
$active = filter_get_active_state('filter/glossary');
$this->assertEquals($active, TEXTFILTER_ON);
// Wrong filtername.
$this->expectException('coding_exception');
$active = filter_get_active_state('mod/glossary');
}
public function test_filter_get_active_state_after_change() {
$this->resetAfterTest();
filter_set_global_state('glossary', TEXTFILTER_ON);
$systemcontextid = context_system::instance()->id;
$active = filter_get_active_state('glossary', $systemcontextid);
$this->assertEquals($active, TEXTFILTER_ON);
filter_set_global_state('glossary', TEXTFILTER_OFF);
$systemcontextid = context_system::instance()->id;
$active = filter_get_active_state('glossary', $systemcontextid);
$this->assertEquals($active, TEXTFILTER_OFF);
filter_set_global_state('glossary', TEXTFILTER_DISABLED);
$systemcontextid = context_system::instance()->id;
$active = filter_get_active_state('glossary', $systemcontextid);
$this->assertEquals($active, TEXTFILTER_DISABLED);
}
public function test_filter_get_globally_enabled_default() {
$this->resetAfterTest();
$enabledfilters = filter_get_globally_enabled();
$this->assertArrayNotHasKey('glossary', $enabledfilters);
}
public function test_filter_get_globally_enabled_after_change() {
$this->resetAfterTest();
filter_set_global_state('glossary', TEXTFILTER_ON);
$enabledfilters = filter_get_globally_enabled();
$this->assertArrayHasKey('glossary', $enabledfilters);
}
public function test_filter_get_globally_enabled_filters_with_config() {
$this->resetAfterTest();
$this->remove_all_filters_from_config(); // Remove all filters.
[
'syscontext' => $syscontext,
'childcontext' => $childcontext
] = $this->setup_available_in_context_tests();
$this->remove_all_filters_from_config(); // Remove all filters.
// Set few filters.
filter_set_global_state('one', TEXTFILTER_ON);
filter_set_global_state('three', TEXTFILTER_OFF, -1);
filter_set_global_state('two', TEXTFILTER_DISABLED);
// Set global config.
filter_set_local_config('one', $syscontext->id, 'test1a', 'In root');
filter_set_local_config('one', $syscontext->id, 'test1b', 'In root');
filter_set_local_config('two', $syscontext->id, 'test2a', 'In root');
filter_set_local_config('two', $syscontext->id, 'test2b', 'In root');
// Set child config.
filter_set_local_config('one', $childcontext->id, 'test1a', 'In child');
filter_set_local_config('one', $childcontext->id, 'test1b', 'In child');
filter_set_local_config('two', $childcontext->id, 'test2a', 'In child');
filter_set_local_config('two', $childcontext->id, 'test2b', 'In child');
filter_set_local_config('three', $childcontext->id, 'test3a', 'In child');
filter_set_local_config('three', $childcontext->id, 'test3b', 'In child');
// Check.
$actual = filter_get_globally_enabled_filters_with_config();
$this->assertCount(2, $actual);
$this->assertEquals(['three', 'one'], array_keys($actual)); // Checks sortorder.
$this->assertArrayHasKey('one', $actual);
$this->assertArrayNotHasKey('two', $actual);
$this->assertArrayHasKey('three', $actual);
$this->assertEquals(['test1a' => 'In root', 'test1b' => 'In root'], $actual['one']);
$this->assertEquals([], $actual['three']);
}
}