722f7a9d1e3d120002f9dacf0844aa978b38e966
[moodle.git] / files / converter / unoconv / tests / converter_test.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Test unoconv functionality.
19  *
20  * @package    core
21  * @copyright  2016 Damyon Wiese
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
28 /**
29  * A set of tests for some of the unoconv functionality within Moodle.
30  *
31  * @package    core
32  * @copyright  2016 Damyon Wiese
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class fileconverter_unoconv_converter_testcase extends advanced_testcase {
37     /**
38      * Helper to skip tests which _require_ unoconv.
39      */
40     protected function require_unoconv() {
41         global $CFG;
43         if (empty($CFG->pathtounoconv) || !file_is_executable(trim($CFG->pathtounoconv))) {
44             // No conversions are possible, sorry.
45             $this->markTestSkipped();
46         }
47     }
49     /**
50      * Get a testable mock of the fileconverter_unoconv class.
51      *
52      * @param   array   $mockedmethods A list of methods you intend to override
53      *                  If no methods are specified, only abstract functions are mocked.
54      * @return  \fileconverter_unoconv\converter
55      */
56     protected function get_testable_mock($mockedmethods = null) {
57         $converter = $this->getMockBuilder(\fileconverter_unoconv\converter::class)
58             ->setMethods($mockedmethods)
59             ->getMock();
61         return $converter;
62     }
64     /**
65      * Tests for the start_document_conversion function.
66      */
67     public function test_start_document_conversion() {
68         $this->resetAfterTest();
70         $this->require_unoconv();
72         // Mock the file to be converted.
73         $filerecord = [
74             'contextid' => context_system::instance()->id,
75             'component' => 'test',
76             'filearea'  => 'unittest',
77             'itemid'    => 0,
78             'filepath'  => '/',
79             'filename'  => 'test.docx',
80         ];
81         $fs = get_file_storage();
82         $source = __DIR__ . DIRECTORY_SEPARATOR . 'fixtures' . DIRECTORY_SEPARATOR . 'unoconv-source.docx';
83         $testfile = $fs->create_file_from_pathname($filerecord, $source);
85         $converter = $this->get_testable_mock();
87         // Convert the document.
88         $result = $converter->start_document_conversion($testfile, 'pdf');
89         $this->assertNotFalse($result);
90         $this->assertSame('application/pdf', $result->get_mimetype());
91         $this->assertGreaterThan(0, $result->get_filesize());
93         // Repeat immediately with the file forcing re-generation.
94         $new = $converter->start_document_conversion($testfile, 'pdf', true);
95         $this->assertNotFalse($new);
96         $this->assertSame('application/pdf', $new->get_mimetype());
97         $this->assertGreaterThan(0, $new->get_filesize());
98         $this->assertNotEquals($result->get_id(), $new->get_id());
99         // Note: We cannot compare contenthash for PDF because the PDF has a unique ID, and a creation timestamp
100         // imprinted in the file.
101     }
103     /**
104      * Tests for the test_unoconv_path function.
105      *
106      * @dataProvider provider_test_unoconv_path
107      * @param   string $path The path to test
108      * @param   int $status The expected status
109      */
110     public function test_test_unoconv_path($path, $status) {
111         global $CFG;
113         $this->resetAfterTest();
115         // Set the current path.
116         $CFG->pathtounoconv = $path;
118         // Run the tests.
119         $result = \fileconverter_unoconv\converter::test_unoconv_path();
121         $this->assertEquals($status, $result->status);
122     }
124     /**
125      * Provider for test_unoconv_path.
126      *
127      * @return  array
128      */
129     public function provider_test_unoconv_path() {
130         return [
131             'Empty path' => [
132                 'path' => null,
133                 'status' => \fileconverter_unoconv\converter::UNOCONVPATH_EMPTY,
134             ],
135             'Invalid file' => [
136                 'path' => '/path/to/nonexistent/file',
137                 'status' => \fileconverter_unoconv\converter::UNOCONVPATH_DOESNOTEXIST,
138             ],
139             'Directory' => [
140                 'path' => __DIR__,
141                 'status' => \fileconverter_unoconv\converter::UNOCONVPATH_ISDIR,
142             ],
143         ];
144     }