aboutsummaryrefslogtreecommitdiff
path: root/tests/external_test.php
blob: ea2b362517f6171033860d1ed687b6ebb09f41ab (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

defined('MOODLE_INTERNAL') || die();

global $CFG;

require_once($CFG->dirroot . '/local/webhooks/externallib.php');
require_once($CFG->dirroot . '/webservice/tests/helpers.php');

use local_webhooks\local\api;
use local_webhooks\local\record;

/**
 * Testing external functions.
 *
 * @copyright 2019 'Valentin Popov' <info@valentineus.link>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
final class local_webhooks_external_testcase extends externallib_advanced_testcase {
    /**
     * Generate random an event's list.
     *
     * @return array
     *
     * @throws \ReflectionException
     */
    private static function get_random_events(): array {
        $result = array_rand(api::get_events(), random_int(2, 10));

        return is_array($result) ? $result : [];
    }

    /**
     * Generate a random record.
     *
     * @return \local_webhooks\local\record
     *
     * @throws \ReflectionException
     */
    private static function get_random_record(): record {
        $record = new record();

        $record->events = self::get_random_events();
        $record->header = 'application/json';
        $record->name = uniqid('', false);
        $record->point = 'http://example.org/' . urlencode($record->name);
        $record->status = true;
        $record->token = generate_uuid();

        return $record;
    }

    /**
     * Testing external get record's data.
     *
     * @throws \ReflectionException
     * @throws \coding_exception
     * @throws \dml_exception
     * @throws \invalid_parameter_exception
     * @throws \invalid_response_exception
     * @throws \restricted_context_exception
     */
    public function test_get_service() {
        self::setAdminUser();

        $this->resetAfterTest();

        // Creating a new record.
        $record = self::get_random_record();
        $record->id = api::add_service($record);

        $return = local_webhooks_external::get_service($record->id);
        $return = external_api::clean_returnvalue(local_webhooks_external::get_service_returns(), $return);
        self::assertInternalType('array', $return);

        // Testing the main fields.
        self::assertEquals($record->header, $return['header']);
        self::assertEquals($record->id, $return['id']);
        self::assertEquals($record->name, $return['name']);
        self::assertEquals($record->point, $return['point']);
        self::assertEquals($record->status, (int) $return['status']);
        self::assertEquals($record->token, $return['token']);

        // Testing an event's list.
        self::assertInternalType('array', $return['events']);
        self::assertNotCount(0, $return['events']);
        foreach ($return['events'] as $event) {
            self::assertContains($event, $record->events);
        }
    }

    /**
     * Testing external get the record's list.
     *
     * @throws \ReflectionException
     * @throws \coding_exception
     * @throws \dml_exception
     * @throws \invalid_parameter_exception
     * @throws \invalid_response_exception
     * @throws \restricted_context_exception
     */
    public function test_get_services() {
        self::setAdminUser();

        $this->resetAfterTest();

        $records = [];
        $total = random_int(5, 10);

        // Creating some records.
        for ($i = 0; $i < $total; $i++) {
            $record = self::get_random_record();
            $record->id = api::add_service($record);
            $records[$record->id] = $record;
        }

        self::assertEquals(count($records), api::get_total_count());

        $return = local_webhooks_external::get_services();
        $return = external_api::clean_returnvalue(local_webhooks_external::get_services_returns(), $return);

        // Testing received item's list.
        self::assertInternalType('array', $return);
        self::assertCount(count($records), $return);

        foreach ($return as $item) {
            self::assertInternalType('array', $item);

            $record = $records[$item['id']];

            self::assertEquals($record->header, $item['header']);
            self::assertEquals($record->id, $item['id']);
            self::assertEquals($record->name, $item['name']);
            self::assertEquals($record->point, $item['point']);
            self::assertEquals($record->status, (int) $item['status']);
            self::assertEquals($record->token, $item['token']);

            self::assertInternalType('array', $item['events']);
            self::assertNotCount(0, $item['events']);
            foreach ($item['events'] as $event) {
                self::assertContains($event, $record->events);
            }
        }
    }

    /**
     * Testing external get to the list services with conditions.
     *
     * @throws \ReflectionException
     * @throws \coding_exception
     * @throws \dml_exception
     * @throws \invalid_parameter_exception
     * @throws \invalid_response_exception
     * @throws \restricted_context_exception
     */
    public function test_get_services_with_conditions() {
        self::setAdminUser();

        $this->resetAfterTest();

        $records = [];
        $total = random_int(5, 10);
        $limit = intdiv($total, 2);

        // Creating some records.
        for ($i = 0; $i < $total; $i++) {
            $record = self::get_random_record();
            $record->id = api::add_service($record);
            $records[$record->id] = $record;
        }

        self::assertEquals(count($records), api::get_total_count());

        // Testing condition fields.
        $record = $records[array_rand($records, 1)];
        $return = local_webhooks_external::get_services(['point' => $record->point]);
        $return = external_api::clean_returnvalue(local_webhooks_external::get_services_returns(), $return);

        self::assertCount(1, $return);
        self::assertEquals($return[0]['id'], $record->id);

        // Testing limit fields.
        $return = local_webhooks_external::get_services(null, null, 1, $limit);
        $return = external_api::clean_returnvalue(local_webhooks_external::get_services_returns(), $return);
        self::assertCount($limit, $return);

        // Testing sort fields.
        $return = local_webhooks_external::get_services(null, 'id asc');
        $return = external_api::clean_returnvalue(local_webhooks_external::get_services_returns(), $return);
        $service1 = array_shift($return);

        $return = local_webhooks_external::get_services(null, 'id desc');
        $return = external_api::clean_returnvalue(local_webhooks_external::get_services_returns(), $return);
        $service2 = array_shift($return);

        self::assertNotEquals($service1['id'], $service2['id']);
    }
}