MDL-55528 assignfeedback_editpdf: Add step to check all pages loaded
[moodle.git] / mod / assign / feedback / editpdf / tests / behat / behat_assignfeedback_editpdf.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  * Behat editpdf-related steps definitions.
19  *
20  * @package    assignfeedback_editpdf
21  * @category   test
22  * @copyright  2013 Jerome Mouneyrac
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
28 require_once(__DIR__ . '/../../../../../../lib/behat/behat_base.php');
30 /**
31  * Steps definitions related with the editpdf.
32  *
33  * @package    assignfeedback_editpdf
34  * @category   test
35  * @copyright  2013 Jerome Mouneyrac
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class behat_assignfeedback_editpdf extends behat_base {
40     /**
41      * Checks that Ghostscript is installed.
42      *
43      * @Given /^ghostscript is installed$/
44      */
45     public function ghostscript_is_installed() {
46         $testpath = assignfeedback_editpdf\pdf::test_gs_path();
47         if (!extension_loaded('zlib') or
48             $testpath->status !== assignfeedback_editpdf\pdf::GSPATH_OK) {
49             throw new \Moodle\BehatExtension\Exception\SkippedException;
50         }
51     }
53     /**
54      * Draw on the pdf.
55      *
56      * @When /^I draw on the pdf$/
57      */
58     public function i_draw_on_the_pdf() {
59         $js = ' (function() {
60     var instance = M.assignfeedback_editpdf.instance;
61     var event = { clientX: 100, clientY: 250, preventDefault: function() {} };
62     instance.edit_start(event);
63 }()); ';
64         $this->getSession()->executeScript($js);
65         sleep(1);
66         $js = ' (function() {
67     var instance = M.assignfeedback_editpdf.instance;
68     var event = { clientX: 150, clientY: 275, preventDefault: function() {} };
69     instance.edit_move(event);
70 }()); ';
71         $this->getSession()->executeScript($js);
72         sleep(1);
73         $js = ' (function() {
74     var instance = M.assignfeedback_editpdf.instance;
75     var event = { clientX: 200, clientY: 300, preventDefault: function() {} };
76     instance.edit_end(event);
77 }()); ';
78         $this->getSession()->executeScript($js);
79         sleep(1);
80     }
82     /**
83      * I wait for all pages in the PDF document to be converted to images and loaded.
84      *
85      * @Given /^I wait for the complete PDF to load$/
86      */
87     public function i_wait_for_all_editpdf_pages_to_load() {
88         // No need to wait if not running JS.
89         if (!$this->running_javascript()) {
90             return;
91         }
93         // Ensure that the document is ready, and all pages are loaded.
94         $conditions = [
95             'typeof M !== "undefined"',
96             'typeof M.assignfeedback_editpdf !== "undefined"',
97             'typeof M.assignfeedback_editpdf.instance !== "undefined"',
98             'M.assignfeedback_editpdf.instance.documentstatus === 2',
99             'M.assignfeedback_editpdf.instance.pagecount === M.assignfeedback_editpdf.instance.pages.length',
100         ];
101         $js = implode(' && ', $conditions);
103         $this->getSession()->wait(self::TIMEOUT * 1000, "({$js})");
104     }