Proyectos de Subversion Moodle

Rev

Rev 11 | Mostrar el archivo completo | | | Autoría | Ultima modificación | Ver Log |

Rev 11 Rev 1441
Línea 25... Línea 25...
25
 */
25
 */
Línea 26... Línea 26...
26
 
26
 
Línea 27... Línea 27...
27
namespace core_badges\external;
27
namespace core_badges\external;
-
 
28
 
28
 
29
use core_badges_external;
29
use core_badges_external;
30
use core_badges\tests\external_helper;
30
use core_external\external_api;
31
use core_external\external_api;
Línea 31... Línea 32...
31
use core_external\external_settings;
32
use core_external\external_settings;
Línea 45... Línea 46...
45
 * @category   external
46
 * @category   external
46
 * @copyright  2016 Juan Leyva <juan@moodle.com>
47
 * @copyright  2016 Juan Leyva <juan@moodle.com>
47
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
48
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
48
 * @since      Moodle 3.1
49
 * @since      Moodle 3.1
49
 */
50
 */
50
class external_test extends externallib_advanced_testcase {
51
final class external_test extends externallib_advanced_testcase {
51
 
-
 
52
    /** @var stdClass $course */
-
 
53
    private $course;
-
 
54
 
-
 
55
    /** @var stdClass $student */
-
 
56
    private $student;
-
 
57
 
-
 
58
    /** @var stdClass $teacher */
-
 
59
    private $teacher;
52
    use external_helper;
60
 
-
 
61
    /**
-
 
62
     * Set up for every test
-
 
63
     */
-
 
64
    public function setUp(): void {
-
 
65
        global $DB;
-
 
66
        $this->resetAfterTest();
-
 
67
        $this->setAdminUser();
-
 
68
 
-
 
69
        // Setup test data.
-
 
70
        $this->course = $this->getDataGenerator()->create_course();
-
 
71
 
-
 
72
        // Create users and enrolments.
-
 
73
        $this->student = $this->getDataGenerator()->create_and_enrol($this->course, 'student');
-
 
74
        $this->teacher = $this->getDataGenerator()->create_and_enrol($this->course, 'editingteacher');
-
 
75
 
-
 
76
        // Mock up a site badge.
-
 
77
        $now = time();
-
 
78
        $badge = new \stdClass();
-
 
79
        $badge->id = null;
-
 
80
        $badge->name = "Test badge site";
-
 
81
        $badge->description = "Testing badges site";
-
 
82
        $badge->timecreated = $now - 12;
-
 
83
        $badge->timemodified = $now - 12;
-
 
84
        $badge->usercreated = $this->teacher->id;
-
 
85
        $badge->usermodified = $this->teacher->id;
-
 
86
        $badge->issuername = "Test issuer";
-
 
87
        $badge->issuerurl = "http://issuer-url.domain.co.nz";
-
 
88
        $badge->issuercontact = "issuer@example.com";
-
 
89
        $badge->expiredate = null;
-
 
90
        $badge->expireperiod = null;
-
 
91
        $badge->type = BADGE_TYPE_SITE;
-
 
92
        $badge->courseid = null;
-
 
93
        $badge->messagesubject = "Test message subject for badge";
-
 
94
        $badge->message = "Test message body for badge";
-
 
95
        $badge->attachment = 1;
-
 
96
        $badge->notification = 0;
-
 
97
        $badge->status = BADGE_STATUS_ACTIVE;
-
 
98
        $badge->version = '1';
-
 
99
        $badge->language = 'en';
-
 
100
        $badge->imageauthorname = 'Image author';
-
 
101
        $badge->imageauthoremail = 'imageauthor@example.com';
-
 
102
        $badge->imageauthorurl = 'http://image-author-url.domain.co.nz';
-
 
103
        $badge->imagecaption = 'Caption';
-
 
104
 
-
 
105
        $badgeid = $DB->insert_record('badge', $badge, true);
-
 
106
        $badge = new \badge($badgeid);
-
 
107
        $badge->issue($this->student->id, true);
-
 
108
 
-
 
109
        // Hack the database to adjust the time each badge was issued.
-
 
110
        $DB->set_field('badge_issued', 'dateissued', $now - 11, array('userid' => $this->student->id, 'badgeid' => $badgeid));
-
 
111
 
-
 
112
        // Add an endorsement for the badge.
-
 
113
        $endorsement = new \stdClass();
-
 
114
        $endorsement->badgeid = $badgeid;
-
 
115
        $endorsement->issuername = 'Issuer name';
-
 
116
        $endorsement->issuerurl = 'http://endorsement-issuer-url.domain.co.nz';
-
 
117
        $endorsement->issueremail = 'endorsementissuer@example.com';
-
 
118
        $endorsement->claimid = 'http://claim-url.domain.co.nz';
-
 
119
        $endorsement->claimcomment = 'Claim comment';
-
 
120
        $endorsement->dateissued = $now;
-
 
121
        $badge->save_endorsement($endorsement);
-
 
122
 
-
 
123
        // Add 2 alignments.
-
 
124
        $alignment = new \stdClass();
-
 
125
        $alignment->badgeid = $badgeid;
-
 
126
        $alignment->targetname = 'Alignment 1';
-
 
127
        $alignment->targeturl = 'http://a1-target-url.domain.co.nz';
-
 
128
        $alignment->targetdescription = 'A1 target description';
-
 
129
        $alignment->targetframework = 'A1 framework';
-
 
130
        $alignment->targetcode = 'A1 code';
-
 
131
        $badge->save_alignment($alignment);
-
 
132
 
-
 
133
        $alignment->targetname = 'Alignment 2';
-
 
134
        $alignment->targeturl = 'http://a2-target-url.domain.co.nz';
-
 
135
        $alignment->targetdescription = 'A2 target description';
-
 
136
        $alignment->targetframework = 'A2 framework';
-
 
137
        $alignment->targetcode = 'A2 code';
-
 
138
        $badge->save_alignment($alignment);
-
 
139
 
-
 
140
        // Now a course badge.
-
 
141
        $badge->id = null;
-
 
142
        $badge->name = "Test badge course";
-
 
143
        $badge->description = "Testing badges course";
-
 
144
        $badge->type = BADGE_TYPE_COURSE;
-
 
145
        $badge->courseid = $this->course->id;
-
 
146
 
-
 
147
        $coursebadgeid = $DB->insert_record('badge', $badge, true);
-
 
148
        $badge = new \badge($coursebadgeid);
-
 
149
        $badge->issue($this->student->id, true);
-
 
150
 
-
 
151
        // Hack the database to adjust the time each badge was issued.
-
 
152
        $DB->set_field('badge_issued', 'dateissued', $now - 10, array('userid' => $this->student->id, 'badgeid' => $coursebadgeid));
-
 
153
 
-
 
154
        // Make the site badge a related badge.
-
 
155
        $badge->add_related_badges(array($badgeid));
-
 
156
    }
-
 
Línea 157... Línea 53...
157
 
53
 
158
    /**
54
    /**
159
     * Test get user badges.
55
     * Test get user badges.
-
 
56
     * These is a basic test since the badges_get_my_user_badges used by the external function already has unit tests.
-
 
57
     *
160
     * These is a basic test since the badges_get_my_user_badges used by the external function already has unit tests.
58
     * @covers \core_badges_external::get_user_badges
161
     */
59
     */
-
 
60
    public function test_get_my_user_badges(): void {
Línea 162... Línea 61...
162
    public function test_get_my_user_badges(): void {
61
        $data = $this->prepare_test_data();
163
 
-
 
164
        $this->setUser($this->student);
-
 
165
 
-
 
166
        $badges = (array) badges_get_user_badges($this->student->id);
-
 
167
        $expectedbadges = array();
-
 
168
        $coursebadge = null;
-
 
169
 
-
 
170
        foreach ($badges as $badge) {
-
 
171
            $context = ($badge->type == BADGE_TYPE_SITE) ? \context_system::instance() : \context_course::instance($badge->courseid);
-
 
172
            $badge->badgeurl = \moodle_url::make_webservice_pluginfile_url($context->id, 'badges', 'badgeimage', $badge->id, '/',
-
 
173
                                                                            'f3')->out(false);
-
 
174
 
-
 
175
            // Get the endorsement, alignments and related badges.
-
 
176
            $badgeinstance = new \badge($badge->id);
-
 
177
            $endorsement = $badgeinstance->get_endorsement();
-
 
178
            $alignments = $badgeinstance->get_alignments();
-
 
179
            $relatedbadges = $badgeinstance->get_related_badges();
-
 
180
            $badge->alignment = array();
-
 
181
            $badge->relatedbadges = array();
-
 
182
 
-
 
183
            if ($endorsement) {
-
 
184
                $badge->endorsement = (array) $endorsement;
-
 
185
            }
-
 
186
 
-
 
187
            if (!empty($alignments)) {
-
 
188
                foreach ($alignments as $alignment) {
-
 
189
                    // Students cannot see some fields of the alignments.
-
 
190
                    unset($alignment->targetname);
-
 
191
                    unset($alignment->targeturl);
-
 
192
                    unset($alignment->targetdescription);
-
 
193
                    unset($alignment->targetframework);
-
 
194
                    unset($alignment->targetcode);
-
 
195
 
-
 
196
                    $badge->alignment[] = (array) $alignment;
-
 
197
                }
-
 
198
            }
-
 
199
 
-
 
200
            if (!empty($relatedbadges)) {
-
 
201
                foreach ($relatedbadges as $relatedbadge) {
-
 
202
                    // Students cannot see some fields of the related badges.
-
 
203
                    unset($relatedbadge->version);
-
 
204
                    unset($relatedbadge->language);
-
 
205
                    unset($relatedbadge->type);
-
 
206
 
-
 
207
                    $badge->relatedbadges[] = (array) $relatedbadge;
-
 
208
                }
-
 
209
            }
-
 
210
 
-
 
211
            $expectedbadges[] = (array) $badge;
-
 
212
            if (isset($badge->courseid)) {
-
 
213
                // Save the course badge to be able to compare it in our tests.
-
 
214
                $coursebadge = (array) $badge;
-
 
215
            }
-
 
216
        }
62
 
217
 
63
        $this->setUser($data['student']);
218
        $result = core_badges_external::get_user_badges();
64
        $result = core_badges_external::get_user_badges();
-
 
65
        $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);
-
 
66
        $this->assertCount(2, $result['badges']);
Línea 219... Línea 67...
219
        $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);
67
        $this->assert_issued_badge($data['coursebadge'], $result['badges'][0], true, false);
220
        $this->assertEquals($expectedbadges, $result['badges']);
68
        $this->assert_issued_badge($data['sitebadge'], $result['badges'][1], true, false);
221
 
69
 
222
        // Pagination and filtering.
70
        // Pagination and filtering.
223
        $result = core_badges_external::get_user_badges(0, $this->course->id, 0, 1, '', true);
71
        $result = core_badges_external::get_user_badges(0, 0, 0, 1, '', true);
224
        $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);
72
        $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);
Línea 225... Línea 73...
225
        $this->assertCount(1, $result['badges']);
73
        $this->assertCount(1, $result['badges']);
226
        $this->assertEquals($coursebadge, $result['badges'][0]);
74
        $this->assert_issued_badge($data['coursebadge'], $result['badges'][0], true, false);
-
 
75
    }
-
 
76
 
227
    }
77
    /**
228
 
78
     * Test get user badges.
-
 
79
     *
Línea -... Línea 80...
-
 
80
     * @covers \core_badges_external::get_user_badges
229
    /**
81
     */
230
     * Test get user badges.
-
 
231
     */
82
    public function test_get_other_user_badges(): void {
232
    public function test_get_other_user_badges(): void {
83
        $data = $this->prepare_test_data();
233
 
-
 
234
        $this->setUser($this->teacher);
84
 
-
 
85
        // User with "moodle/badges:configuredetails" capability.
-
 
86
        $this->setAdminUser();
Línea 235... Línea 87...
235
 
87
        $result = core_badges_external::get_user_badges($data['student']->id);
236
        $result = core_badges_external::get_user_badges($this->student->id);
88
        $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);
237
        $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);
-
 
238
 
89
        $this->assertCount(2, $result['badges']);
239
        $this->assertCount(2, $result['badges']);
-
 
240
 
90
        $this->assert_issued_badge($data['coursebadge'], $result['badges'][0], false, true);
241
        // Check that we don't have permissions for view the complete information for site badges.
-
 
242
        foreach ($result['badges'] as $badge) {
91
        $this->assert_issued_badge($data['sitebadge'], $result['badges'][1], false, true);
243
            if (isset($badge['type']) and $badge['type'] == BADGE_TYPE_COURSE) {
-
 
244
                $this->assertTrue(isset($badge['message']));
-
 
245
 
92
 
246
                // Check that we have permissions to see all the data in alignments and related badges.
-
 
247
                foreach ($badge['alignment'] as $alignment) {
-
 
248
                    $this->assertTrue(isset($alignment['targetdescription']));
-
 
249
                }
93
        // User without "moodle/badges:configuredetails" capability.
250
 
-
 
251
                foreach ($badge['relatedbadges'] as $relatedbadge) {
-
 
252
                    $this->assertTrue(isset($relatedbadge['type']));
94
        $this->setUser($this->getDataGenerator()->create_user());
Línea 253... Línea 95...
253
                }
95
        $result = core_badges_external::get_user_badges($data['student']->id);
254
            } else {
96
        $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);
-
 
97
        $this->assertCount(2, $result['badges']);
-
 
98
        $this->assert_issued_badge($data['coursebadge'], $result['badges'][0], false, false);
255
                $this->assertFalse(isset($badge['message']));
99
        $this->assert_issued_badge($data['sitebadge'], $result['badges'][1], false, false);
256
            }
100
    }
257
        }
101
 
Línea -... Línea 102...
-
 
102
    /**
-
 
103
     * Test get_user_badges where issuername contains text to be filtered
258
    }
104
     *
259
 
105
     * @covers \core_badges_external::get_user_badges
Línea 260... Línea 106...
260
    /**
106
     */
Línea 261... Línea 107...
261
     * Test get_user_badges where issuername contains text to be filtered
107
    public function test_get_user_badges_filter_issuername(): void {
262
     */
108
        global $DB;
263
    public function test_get_user_badges_filter_issuername(): void {
109
 
Línea 264... Línea 110...
264
        global $DB;
110
        $data = $this->prepare_test_data();
265
 
111
 
266
        filter_set_global_state('multilang', TEXTFILTER_ON);
112
        filter_set_global_state('multilang', TEXTFILTER_ON);
Línea 267... Línea 113...
267
        filter_set_applies_to_strings('multilang', true);
113
        filter_set_applies_to_strings('multilang', true);
268
 
114
 
269
        external_settings::get_instance()->set_filter(true);
115
        external_settings::get_instance()->set_filter(true);