forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
converter_test.php
917 lines (758 loc) · 30.8 KB
/
converter_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
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
<?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/>.
/**
* PHPUnit tests for fileconverter API.
*
* @package core_files
* @copyright 2017 Andrew nicols <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
use core_files\conversion;
use core_files\converter;
/**
* PHPUnit tests for fileconverter API.
*
* @package core_files
* @copyright 2017 Andrew nicols <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class converter_test extends advanced_testcase {
/**
* Get a testable mock of the abstract files_converter class.
*
* @param array $mockedmethods A list of methods you intend to override
* If no methods are specified, only abstract functions are mocked.
* @return \core_files\converter
*/
protected function get_testable_mock($mockedmethods = []) {
$converter = $this->getMockBuilder(\core_files\converter::class)
->onlyMethods($mockedmethods)
->getMockForAbstractClass();
return $converter;
}
/**
* Get a testable mock of the conversion.
*
* @param array $mockedmethods A list of methods you intend to override
* @return \core_files\conversion
*/
protected function get_testable_conversion($mockedmethods = []) {
$conversion = $this->getMockBuilder(\core_files\conversion::class)
->onlyMethods($mockedmethods)
->setConstructorArgs([0, (object) []])
->getMock();
return $conversion;
}
/**
* Get a testable mock of the abstract files_converter class.
*
* @param array $mockedmethods A list of methods you intend to override
* If no methods are specified, only abstract functions are mocked.
* @return \core_files\converter_interface
*/
protected function get_mocked_converter($mockedmethods = []) {
$converter = $this->getMockBuilder(\core_files\converter_interface::class)
->onlyMethods($mockedmethods)
->getMockForAbstractClass();
return $converter;
}
/**
* Helper to create a stored file objectw with the given supplied content.
*
* @param string $filecontent The content of the mocked file
* @param string $filename The file name to use in the stored_file
* @param array $mockedmethods A list of methods you intend to override
* If no methods are specified, only abstract functions are mocked.
* @return stored_file
*/
protected function get_stored_file($filecontent = 'content', $filename = null, $filerecord = [], $mockedmethods = []) {
global $CFG;
$contenthash = sha1($filecontent);
if (empty($filename)) {
$filename = $contenthash;
}
$filerecord['contenthash'] = $contenthash;
$filerecord['filesize'] = strlen($filecontent);
$filerecord['filename'] = $filename;
$filerecord['id'] = 42;
$file = $this->getMockBuilder(stored_file::class)
->onlyMethods($mockedmethods)
->setConstructorArgs([get_file_storage(), (object) $filerecord])
->getMock();
return $file;
}
/**
* Helper to create a stored file object with the given supplied content.
*
* @param string $filecontent The content of the mocked file
* @param string $filename The file name to use in the stored_file
* @param string $filerecord Any overrides to the filerecord
* @return stored_file
*/
protected function create_stored_file($filecontent = 'content', $filename = 'testfile.txt', $filerecord = []) {
$filerecord = array_merge([
'contextid' => context_system::instance()->id,
'component' => 'core',
'filearea' => 'unittest',
'itemid' => 0,
'filepath' => '/',
'filename' => $filename,
], $filerecord);
$fs = get_file_storage();
$file = $fs->create_file_from_string($filerecord, $filecontent);
return $file;
}
/**
* Get a mock of the file_storage API.
*
* @param array $mockedmethods A list of methods you intend to override
* @return file_storage
*/
protected function get_file_storage_mock($mockedmethods = []) {
$fs = $this->getMockBuilder(\file_storage::class)
->onlyMethods($mockedmethods)
->disableOriginalConstructor()
->getMock();
return $fs;
}
/**
* Test the start_conversion function.
*/
public function test_start_conversion_existing_single(): void {
$this->resetAfterTest();
$sourcefile = $this->create_stored_file();
$first = new conversion(0, (object) [
'sourcefileid' => $sourcefile->get_id(),
'targetformat' => 'pdf',
]);
$first->create();
$converter = $this->get_testable_mock(['poll_conversion']);
$conversion = $converter->start_conversion($sourcefile, 'pdf', false);
// The old conversions should still be present and match the one returned.
$this->assertEquals($first->get('id'), $conversion->get('id'));
}
/**
* Test the start_conversion function.
*/
public function test_start_conversion_existing_multiple(): void {
$this->resetAfterTest();
$sourcefile = $this->create_stored_file();
$first = new conversion(0, (object) [
'sourcefileid' => $sourcefile->get_id(),
'targetformat' => 'pdf',
]);
$first->create();
$second = new conversion(0, (object) [
'sourcefileid' => $sourcefile->get_id(),
'targetformat' => 'pdf',
]);
$second->create();
$converter = $this->get_testable_mock(['poll_conversion']);
$conversion = $converter->start_conversion($sourcefile, 'pdf', false);
// The old conversions should have been removed.
$this->assertFalse(conversion::get_record(['id' => $first->get('id')]));
$this->assertFalse(conversion::get_record(['id' => $second->get('id')]));
}
/**
* Test the start_conversion function.
*/
public function test_start_conversion_no_existing(): void {
$this->resetAfterTest();
$sourcefile = $this->create_stored_file();
$converter = $this->get_testable_mock(['poll_conversion']);
$conversion = $converter->start_conversion($sourcefile, 'pdf', false);
$this->assertInstanceOf(\core_files\conversion::class, $conversion);
}
/**
* Test the get_document_converter_classes function with no enabled plugins.
*/
public function test_get_document_converter_classes_no_plugins(): void {
$converter = $this->get_testable_mock(['get_enabled_plugins']);
$converter->method('get_enabled_plugins')->willReturn([]);
$method = new ReflectionMethod(\core_files\converter::class, 'get_document_converter_classes');
$result = $method->invokeArgs($converter, ['docx', 'pdf']);
$this->assertEmpty($result);
}
/**
* Test the get_document_converter_classes function when no class was found.
*/
public function test_get_document_converter_classes_plugin_class_not_found(): void {
$converter = $this->get_testable_mock(['get_enabled_plugins']);
$converter->method('get_enabled_plugins')->willReturn([
'noplugin' => '\not\a\real\plugin',
]);
$method = new ReflectionMethod(\core_files\converter::class, 'get_document_converter_classes');
$result = $method->invokeArgs($converter, ['docx', 'pdf']);
$this->assertEmpty($result);
}
/**
* Test the get_document_converter_classes function when the returned classes do not meet requirements.
*/
public function test_get_document_converter_classes_plugin_class_requirements_not_met(): void {
$plugin = $this->getMockBuilder(\core_file_converter_requirements_not_met::class)
->onlyMethods([])
->getMock();
$converter = $this->get_testable_mock(['get_enabled_plugins']);
$converter->method('get_enabled_plugins')->willReturn([
'test_plugin' => get_class($plugin),
]);
$method = new ReflectionMethod(\core_files\converter::class, 'get_document_converter_classes');
$result = $method->invokeArgs($converter, ['docx', 'pdf']);
$this->assertEmpty($result);
}
/**
* Test the get_document_converter_classes function when the returned classes do not meet requirements.
*/
public function test_get_document_converter_classes_plugin_class_met_not_supported(): void {
$plugin = $this->getMockBuilder(\core_file_converter_type_not_supported::class)
->onlyMethods([])
->getMock();
$converter = $this->get_testable_mock(['get_enabled_plugins']);
$converter->method('get_enabled_plugins')->willReturn([
'test_plugin' => get_class($plugin),
]);
$method = new ReflectionMethod(\core_files\converter::class, 'get_document_converter_classes');
$result = $method->invokeArgs($converter, ['docx', 'pdf']);
$this->assertEmpty($result);
}
/**
* Test the get_document_converter_classes function when the returned classes do not meet requirements.
*/
public function test_get_document_converter_classes_plugin_class_met_and_supported(): void {
$plugin = $this->getMockBuilder(\core_file_converter_type_supported::class)
->onlyMethods([])
->getMock();
$classname = get_class($plugin);
$converter = $this->get_testable_mock(['get_enabled_plugins']);
$converter->method('get_enabled_plugins')->willReturn([
'test_plugin' => $classname,
]);
$method = new ReflectionMethod(\core_files\converter::class, 'get_document_converter_classes');
$result = $method->invokeArgs($converter, ['docx', 'pdf']);
$this->assertCount(1, $result);
$this->assertNotFalse(array_search($classname, $result));
}
/**
* Test the can_convert_storedfile_to function with a directory.
*/
public function test_can_convert_storedfile_to_directory(): void {
$converter = $this->get_testable_mock();
// A file with filename '.' is a directory.
$file = $this->get_stored_file('', '.');
$this->assertFalse($converter->can_convert_storedfile_to($file, 'target'));
}
/**
* Test the can_convert_storedfile_to function with an empty file.
*/
public function test_can_convert_storedfile_to_emptyfile(): void {
$converter = $this->get_testable_mock();
// A file with filename '.' is a directory.
$file = $this->get_stored_file('');
$this->assertFalse($converter->can_convert_storedfile_to($file, 'target'));
}
/**
* Test the can_convert_storedfile_to function with a file with indistinguished mimetype.
*/
public function test_can_convert_storedfile_to_no_mimetype(): void {
$converter = $this->get_testable_mock();
// A file with filename '.' is a directory.
$file = $this->get_stored_file('example content', 'example', [
'mimetype' => null,
]);
$this->assertFalse($converter->can_convert_storedfile_to($file, 'target'));
}
/**
* Test the can_convert_storedfile_to function with a file with a known mimetype and extension.
*/
public function test_can_convert_storedfile_to_docx(): void {
$returnvalue = (object) [];
$converter = $this->get_testable_mock([
'can_convert_format_to'
]);
$types = \core_filetypes::get_types();
$file = $this->get_stored_file('example content', 'example.docx', [
'mimetype' => $types['docx']['type'],
]);
$converter->expects($this->once())
->method('can_convert_format_to')
->willReturn($returnvalue);
$result = $converter->can_convert_storedfile_to($file, 'target');
$this->assertEquals($returnvalue, $result);
}
/**
* Test the can_convert_format_to function.
*/
public function test_can_convert_format_to_found(): void {
$converter = $this->get_testable_mock(['get_document_converter_classes']);
$mock = $this->get_mocked_converter();
$converter->method('get_document_converter_classes')
->willReturn([$mock]);
$result = $converter->can_convert_format_to('from', 'to');
$this->assertTrue($result);
}
/**
* Test the can_convert_format_to function.
*/
public function test_can_convert_format_to_not_found(): void {
$converter = $this->get_testable_mock(['get_document_converter_classes']);
$converter->method('get_document_converter_classes')
->willReturn([]);
$result = $converter->can_convert_format_to('from', 'to');
$this->assertFalse($result);
}
/**
* Test the can_convert_storedfile_to function with an empty file.
*/
public function test_poll_conversion_in_progress(): void {
$this->resetAfterTest();
$converter = $this->get_testable_mock([
'get_document_converter_classes',
'get_next_converter',
]);
$converter->method('get_document_converter_classes')->willReturn([]);
$converter->method('get_next_converter')->willReturn(false);
$file = $this->create_stored_file('example content', 'example', [
'mimetype' => null,
]);
$conversion = $this->get_testable_conversion([
'get_converter_instance',
]);
$conversion->set_sourcefile($file);
$conversion->set('targetformat', 'target');
$conversion->set('status', conversion::STATUS_IN_PROGRESS);
$conversion->create();
$converterinstance = $this->get_mocked_converter([
'poll_conversion_status',
]);
$converterinstance->expects($this->once())
->method('poll_conversion_status');
$conversion->method('get_converter_instance')->willReturn($converterinstance);
$converter->poll_conversion($conversion);
$this->assertEquals(conversion::STATUS_IN_PROGRESS, $conversion->get('status'));
}
/**
* Test poll_conversion with an in-progress conversion where we are
* unable to instantiate the converter instance.
*/
public function test_poll_conversion_in_progress_fail(): void {
$this->resetAfterTest();
$converter = $this->get_testable_mock([
'get_document_converter_classes',
'get_next_converter',
]);
$converter->method('get_document_converter_classes')->willReturn([]);
$converter->method('get_next_converter')->willReturn(false);
$file = $this->create_stored_file('example content', 'example', [
'mimetype' => null,
]);
$conversion = $this->get_testable_conversion([
'get_converter_instance',
]);
$conversion->set_sourcefile($file);
$conversion->set('targetformat', 'target');
$conversion->set('status', conversion::STATUS_IN_PROGRESS);
$conversion->create();
$conversion->method('get_converter_instance')->willReturn(false);
$converter->poll_conversion($conversion);
$this->assertEquals(conversion::STATUS_FAILED, $conversion->get('status'));
}
/**
* Test the can_convert_storedfile_to function with an empty file.
*/
public function test_poll_conversion_none_supported(): void {
$this->resetAfterTest();
$converter = $this->get_testable_mock([
'get_document_converter_classes',
'get_next_converter',
]);
$converter->method('get_document_converter_classes')->willReturn([]);
$converter->method('get_next_converter')->willReturn(false);
$file = $this->create_stored_file('example content', 'example', [
'mimetype' => null,
]);
$conversion = new conversion(0, (object) [
'sourcefileid' => $file->get_id(),
'targetformat' => 'target',
]);
$conversion->create();
$converter->poll_conversion($conversion);
$this->assertEquals(conversion::STATUS_FAILED, $conversion->get('status'));
}
/**
* Test the can_convert_storedfile_to function with an empty file.
*/
public function test_poll_conversion_pick_first(): void {
$this->resetAfterTest();
$converterinstance = $this->get_mocked_converter([
'start_document_conversion',
'poll_conversion_status',
]);
$converter = $this->get_testable_mock([
'get_document_converter_classes',
'get_next_converter',
]);
$converter->method('get_document_converter_classes')->willReturn([]);
$converter->method('get_next_converter')->willReturn(get_class($converterinstance));
$file = $this->create_stored_file('example content', 'example', [
'mimetype' => null,
]);
$conversion = $this->get_testable_conversion([
'get_converter_instance',
]);
$conversion->set_sourcefile($file);
$conversion->set('targetformat', 'target');
$conversion->set('status', conversion::STATUS_PENDING);
$conversion->create();
$conversion->method('get_converter_instance')->willReturn($converterinstance);
$converterinstance->expects($this->once())
->method('start_document_conversion');
$converterinstance->expects($this->never())
->method('poll_conversion_status');
$converter->poll_conversion($conversion);
$this->assertEquals(conversion::STATUS_IN_PROGRESS, $conversion->get('status'));
}
/**
* Test the can_convert_storedfile_to function with an empty file.
*/
public function test_poll_conversion_pick_subsequent(): void {
$this->resetAfterTest();
$converterinstance = $this->get_mocked_converter([
'start_document_conversion',
'poll_conversion_status',
]);
$converterinstance2 = $this->get_mocked_converter([
'start_document_conversion',
'poll_conversion_status',
]);
$converter = $this->get_testable_mock([
'get_document_converter_classes',
'get_next_converter',
]);
$converter->method('get_document_converter_classes')->willReturn([]);
$converter->method('get_next_converter')
->will($this->onConsecutiveCalls(
get_class($converterinstance),
get_class($converterinstance2)
));
$file = $this->create_stored_file('example content', 'example', [
'mimetype' => null,
]);
$conversion = $this->get_testable_conversion([
'get_converter_instance',
'get_status',
]);
$conversion->set_sourcefile($file);
$conversion->set('targetformat', 'target');
$conversion->set('status', conversion::STATUS_PENDING);
$conversion->create();
$conversion->method('get_status')
->will($this->onConsecutiveCalls(
// Initial status check.
conversion::STATUS_PENDING,
// Second check to make sure it's still pending after polling.
conversion::STATUS_PENDING,
// First one fails.
conversion::STATUS_FAILED,
// Second one succeeds.
conversion::STATUS_COMPLETE,
// And the final result checked in this unit test.
conversion::STATUS_COMPLETE
));
$conversion->method('get_converter_instance')
->will($this->onConsecutiveCalls(
$converterinstance,
$converterinstance2
));
$converterinstance->expects($this->once())
->method('start_document_conversion');
$converterinstance->expects($this->never())
->method('poll_conversion_status');
$converterinstance2->expects($this->once())
->method('start_document_conversion');
$converterinstance2->expects($this->never())
->method('poll_conversion_status');
$converter->poll_conversion($conversion);
$this->assertEquals(conversion::STATUS_COMPLETE, $conversion->get('status'));
}
/**
* Test the start_conversion with a single converter which succeeds.
*/
public function test_start_conversion_one_supported_success(): void {
$this->resetAfterTest();
$converter = $this->get_testable_mock([
'get_document_converter_classes',
]);
$converter->method('get_document_converter_classes')
->willReturn([\core_file_converter_type_successful::class]);
$file = $this->create_stored_file('example content', 'example', [
'mimetype' => null,
]);
$conversion = $converter->start_conversion($file, 'target');
$this->assertEquals(conversion::STATUS_COMPLETE, $conversion->get('status'));
}
/**
* Test the start_conversion with a single converter which failes.
*/
public function test_start_conversion_one_supported_failure(): void {
$this->resetAfterTest();
$converter = $this->get_testable_mock([
'get_document_converter_classes',
]);
$mock = $this->get_mocked_converter(['start_document_conversion']);
$converter->method('get_document_converter_classes')
->willReturn([\core_file_converter_type_failed::class]);
$file = $this->create_stored_file('example content', 'example', [
'mimetype' => null,
]);
$conversion = $converter->start_conversion($file, 'target');
$this->assertEquals(conversion::STATUS_FAILED, $conversion->get('status'));
}
/**
* Test the start_conversion with two converters - fail, then succeed.
*/
public function test_start_conversion_two_supported(): void {
$this->resetAfterTest();
$converter = $this->get_testable_mock([
'get_document_converter_classes',
]);
$mock = $this->get_mocked_converter(['start_document_conversion']);
$converter->method('get_document_converter_classes')
->willReturn([
\core_file_converter_type_failed::class,
\core_file_converter_type_successful::class,
]);
$file = $this->create_stored_file('example content', 'example', [
'mimetype' => null,
]);
$conversion = $converter->start_conversion($file, 'target');
$this->assertEquals(conversion::STATUS_COMPLETE, $conversion->get('status'));
}
/**
* Ensure that get_next_converter returns false when no converters are available.
*/
public function test_get_next_converter_no_converters(): void {
$rcm = new \ReflectionMethod(converter::class, 'get_next_converter');
$converter = new \core_files\converter();
$result = $rcm->invoke($converter, [], null);
$this->assertFalse($result);
}
/**
* Ensure that get_next_converter returns false when already on the
* only converter.
*/
public function test_get_next_converter_only_converters(): void {
$rcm = new \ReflectionMethod(converter::class, 'get_next_converter');
$converter = new converter();
$result = $rcm->invoke($converter, ['example'], 'example');
$this->assertFalse($result);
}
/**
* Ensure that get_next_converter returns false when already on the
* last converter.
*/
public function test_get_next_converter_last_converters(): void {
$rcm = new \ReflectionMethod(converter::class, 'get_next_converter');
$converter = new converter();
$result = $rcm->invoke($converter, ['foo', 'example'], 'example');
$this->assertFalse($result);
}
/**
* Ensure that get_next_converter returns the next vlaue when in a
* current converter.
*/
public function test_get_next_converter_middle_converters(): void {
$rcm = new \ReflectionMethod(converter::class, 'get_next_converter');
$converter = new converter();
$result = $rcm->invoke($converter, ['foo', 'bar', 'baz', 'example'], 'bar');
$this->assertEquals('baz', $result);
}
/**
*
* Ensure that get_next_converter returns the next vlaue when in a
* current converter.
*/
public function test_get_next_converter_first(): void {
$rcm = new \ReflectionMethod(converter::class, 'get_next_converter');
$converter = new converter();
$result = $rcm->invoke($converter, ['foo', 'bar', 'baz', 'example']);
$this->assertEquals('foo', $result);
}
}
class core_file_converter_requirements_base implements \core_files\converter_interface {
/**
* Whether the plugin is configured and requirements are met.
*
* @return bool
*/
public static function are_requirements_met() {
return false;
}
/**
* Convert a document to a new format and return a conversion object relating to the conversion in progress.
*
* @param conversion $conversion The file to be converted
* @return conversion
*/
public function start_document_conversion(conversion $conversion) {
}
/**
* Poll an existing conversion for status update.
*
* @param conversion $conversion The file to be converted
* @return conversion
*/
public function poll_conversion_status(conversion $conversion) {
}
/**
* Whether a file conversion can be completed using this converter.
*
* @param string $from The source type
* @param string $to The destination type
* @return bool
*/
public static function supports($from, $to) {
return false;
}
/**
* A list of the supported conversions.
*
* @return string
*/
public function get_supported_conversions() {
return [];
}
}
/**
* Test class for converter support with requirements are not met.
*
* @package core_files
* @copyright 2017 Andrew nicols <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_file_converter_requirements_not_met extends core_file_converter_requirements_base {
}
/**
* Test class for converter support with requirements met and conversion not supported.
*
* @package core_files
* @copyright 2017 Andrew nicols <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_file_converter_type_not_supported extends core_file_converter_requirements_base {
/**
* Whether the plugin is configured and requirements are met.
*
* @return bool
*/
public static function are_requirements_met() {
return true;
}
}
/**
* Test class for converter support with requirements met and conversion supported.
*
* @package core_files
* @copyright 2017 Andrew nicols <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_file_converter_type_supported extends core_file_converter_requirements_base {
/**
* Whether the plugin is configured and requirements are met.
*
* @return bool
*/
public static function are_requirements_met() {
return true;
}
/**
* Whether a file conversion can be completed using this converter.
*
* @param string $from The source type
* @param string $to The destination type
* @return bool
*/
public static function supports($from, $to) {
return true;
}
}
/**
* Test class for converter support with requirements met and successful conversion.
*
* @package core_files
* @copyright 2017 Andrew nicols <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_file_converter_type_successful extends core_file_converter_requirements_base {
/**
* Convert a document to a new format and return a conversion object relating to the conversion in progress.
*
* @param conversion $conversion The file to be converted
* @return conversion
*/
public function start_document_conversion(conversion $conversion) {
$conversion->set('status', conversion::STATUS_COMPLETE);
return $conversion;
}
/**
* Whether a file conversion can be completed using this converter.
*
* @param string $from The source type
* @param string $to The destination type
* @return bool
*/
public static function supports($from, $to) {
return true;
}
}
/**
* Test class for converter support with requirements met and failed conversion.
*
* @package core_files
* @copyright 2017 Andrew nicols <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_file_converter_type_failed extends core_file_converter_requirements_base {
/**
* Whether the plugin is configured and requirements are met.
*
* @return bool
*/
public static function are_requirements_met() {
return true;
}
/**
* Convert a document to a new format and return a conversion object relating to the conversion in progress.
*
* @param conversion $conversion The file to be converted
* @return conversion
*/
public function start_document_conversion(conversion $conversion) {
$conversion->set('status', conversion::STATUS_FAILED);
return $conversion;
}
/**
* Whether a file conversion can be completed using this converter.
*
* @param string $from The source type
* @param string $to The destination type
* @return bool
*/
public static function supports($from, $to) {
return true;
}
}