272b55ee76e1ff742bb2465ef0d746ae905384bc
[moodle.git] / admin / tool / lp / tests / exporter_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  * Exporter class tests.
19  *
20  * @package    tool_lp
21  * @copyright  2015 Damyon Wiese
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
26 global $CFG;
28 /**
29  * Exporter testcase.
30  *
31  * @package    tool_lp
32  * @copyright  2015 Damyon Wiese
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class tool_lp_exporter_testcase extends advanced_testcase {
37     protected $validrelated = null;
38     protected $invalidrelated = null;
39     protected $validdata = null;
40     protected $invaliddata = null;
42     public function setUp() {
43         $s = new stdClass();
44         $this->validrelated = array('simplestdClass' => $s, 'arrayofstdClass' => array($s, $s));
45         $this->invalidrelated = array('simplestdClass' => 'a string', 'arrayofstdClass' => 5);
47         $this->validdata = array('stringA' => 'A string', 'stringAformat' => FORMAT_HTML, 'intB' => 4);
49         $this->invaliddata = array('stringA' => 'A string');
50     }
52     public function test_get_read_structure() {
53         $structure = tool_lp_testable_exporter::get_read_structure();
55         $this->assertInstanceOf('external_single_structure', $structure);
56         $this->assertInstanceOf('external_value', $structure->keys['stringA']);
57         $this->assertInstanceOf('external_format_value', $structure->keys['stringAformat']);
58         $this->assertInstanceOf('external_value', $structure->keys['intB']);
59         $this->assertInstanceOf('external_value', $structure->keys['otherstring']);
60         $this->assertInstanceOf('external_multiple_structure', $structure->keys['otherstrings']);
61     }
63     public function test_get_create_structure() {
64         $structure = tool_lp_testable_exporter::get_create_structure();
66         $this->assertInstanceOf('external_single_structure', $structure);
67         $this->assertInstanceOf('external_value', $structure->keys['stringA']);
68         $this->assertInstanceOf('external_format_value', $structure->keys['stringAformat']);
69         $this->assertInstanceOf('external_value', $structure->keys['intB']);
70         $this->assertArrayNotHasKey('otherstring', $structure->keys);
71         $this->assertArrayNotHasKey('otherstrings', $structure->keys);
72     }
74     public function test_get_update_structure() {
75         $structure = tool_lp_testable_exporter::get_update_structure();
77         $this->assertInstanceOf('external_single_structure', $structure);
78         $this->assertInstanceOf('external_value', $structure->keys['stringA']);
79         $this->assertInstanceOf('external_format_value', $structure->keys['stringAformat']);
80         $this->assertInstanceOf('external_value', $structure->keys['intB']);
81         $this->assertArrayNotHasKey('otherstring', $structure->keys);
82         $this->assertArrayNotHasKey('otherstrings', $structure->keys);
83     }
85     public function test_invalid_data() {
86         global $PAGE;
87         $this->setExpectedException('coding_exception');
88         $exporter = new tool_lp_testable_exporter($this->invaliddata, $this->validrelated);
89         $output = $PAGE->get_renderer('tool_lp');
91         $result = $exporter->export($output);
92     }
94     public function test_invalid_related() {
95         global $PAGE;
96         $this->setExpectedException('coding_exception');
97         $exporter = new tool_lp_testable_exporter($this->validdata, $this->invalidrelated);
98         $output = $PAGE->get_renderer('tool_lp');
100         $result = $exporter->export($output);
101     }
103     public function test_valid_data_and_related() {
104         global $PAGE;
105         $exporter = new tool_lp_testable_exporter($this->validdata, $this->validrelated);
107         $output = $PAGE->get_renderer('tool_lp');
109         $result = $exporter->export($output);
110     }
113 /**
114  * Example persistent class.
115  *
116  * @package    tool_lp
117  * @copyright  2015 Frédéric Massart - FMCorz.net
118  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
119  */
120 class tool_lp_testable_exporter extends \core_competency\external\exporter {
122     protected static function define_related() {
123         // We cache the context so it does not need to be retrieved from the course.
124         return array('simplestdClass' => 'stdClass', 'arrayofstdClass' => 'stdClass[]');
125     }
127     protected function get_other_values(renderer_base $output) {
128         return array(
129             'otherstring' => 'An other string',
130             'otherstrings' => array('String a', 'String b')
131         );
132     }
134     public static function define_properties() {
135         return array(
136             'stringA' => array(
137                 'type' => PARAM_RAW,
138             ),
139             'stringAformat' => array(
140                 'type' => PARAM_INT,
141             ),
142             'intB' => array(
143                 'type' => PARAM_INT,
144             )
145         );
146     }
148     public static function define_other_properties() {
149         return array(
150             'otherstring' => array(
151                 'type' => PARAM_TEXT,
152             ),
153             'otherstrings' => array(
154                 'type' => PARAM_TEXT,
155                 'multiple' => true
156             )
157         );
158     }