Merge branch 'install_310_STABLE' of https://git.in.moodle.com/amosbot/moodle-install...
[moodle.git] / question / engine / tests / questionattemptstepiterator_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  * This file contains tests for the question_attempt_step_iterator class.
19  *
20  * @package    moodlecore
21  * @subpackage questionengine
22  * @copyright  2009 The Open University
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
29 global $CFG;
30 require_once(__DIR__ . '/../lib.php');
31 require_once(__DIR__ . '/helpers.php');
34 /**
35  * Unit tests for the {@link question_attempt_step_iterator} class.
36  *
37  * @copyright  2009 The Open University
38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class question_attempt_step_iterator_test extends advanced_testcase {
41     private $qa;
42     private $iterator;
44     protected function setUp(): void {
45         $question = test_question_maker::make_question('description');
46         $this->qa = new testable_question_attempt($question, 0);
47         for ($i = 0; $i < 3; $i++) {
48             $step = new question_attempt_step(array('i' => $i));
49             $this->qa->add_step($step);
50         }
51         $this->iterator = $this->qa->get_step_iterator();
52     }
54     protected function tearDown(): void {
55         $this->qa = null;
56         $this->iterator = null;
57     }
59     public function test_foreach_loop() {
60         $i = 0;
61         foreach ($this->iterator as $key => $step) {
62             $this->assertEquals($i, $key);
63             $this->assertEquals($i, $step->get_qt_var('i'));
64             $i++;
65         }
66     }
68     public function test_foreach_loop_add_step_during() {
69         $i = 0;
70         foreach ($this->iterator as $key => $step) {
71             $this->assertEquals($i, $key);
72             $this->assertEquals($i, $step->get_qt_var('i'));
73             $i++;
74             if ($i == 2) {
75                 $step = new question_attempt_step(array('i' => 3));
76                 $this->qa->add_step($step);
77             }
78         }
79         $this->assertEquals(4, $i);
80     }
82     public function test_reverse_foreach_loop() {
83         $i = 2;
84         foreach ($this->qa->get_reverse_step_iterator() as $key => $step) {
85             $this->assertEquals($i, $key);
86             $this->assertEquals($i, $step->get_qt_var('i'));
87             $i--;
88         }
89     }
91     public function test_offsetExists_before_start() {
92         $this->assertFalse(isset($this->iterator[-1]));
93     }
95     public function test_offsetExists_at_start() {
96         $this->assertTrue(isset($this->iterator[0]));
97     }
99     public function test_offsetExists_at_endt() {
100         $this->assertTrue(isset($this->iterator[2]));
101     }
103     public function test_offsetExists_past_end() {
104         $this->assertFalse(isset($this->iterator[3]));
105     }
107     public function test_offsetGet_before_start() {
108         $this->expectException(moodle_exception::class);
109         $step = $this->iterator[-1];
110     }
112     public function test_offsetGet_at_start() {
113         $step = $this->iterator[0];
114         $this->assertEquals(0, $step->get_qt_var('i'));
115     }
117     public function test_offsetGet_at_end() {
118         $step = $this->iterator[2];
119         $this->assertEquals(2, $step->get_qt_var('i'));
120     }
122     public function test_offsetGet_past_end() {
123         $this->expectException(moodle_exception::class);
124         $step = $this->iterator[3];
125     }
127     public function test_cannot_set() {
128         $this->expectException(moodle_exception::class);
129         $this->iterator[0] = null;
130     }
132     public function test_cannot_unset() {
133         $this->expectException(moodle_exception::class);
134         unset($this->iterator[2]);
135     }