. 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' * @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 add service. * * @throws \ReflectionException * @throws \coding_exception * @throws \dml_exception * @throws \invalid_parameter_exception * @throws \invalid_response_exception * @throws \restricted_context_exception */ public function test_adding() { $this->resetAfterTest(); self::setAdminUser(); $record = self::get_random_record(); $return = local_webhooks_external::add_service((array) $record); $return = external_api::clean_returnvalue(local_webhooks_external::add_service_returns(), $return); self::assertInternalType('integer', $return); self::assertEquals(1, api::get_total_count()); $service = api::get_service($return); self::assertEquals($record->header, $service->header); self::assertEquals($record->name, $service->name); self::assertEquals($record->point, $service->point); self::assertEquals($record->status, $service->status); self::assertEquals($record->token, $service->token); self::assertEquals($return, $service->id); self::assertInternalType('array', $service->events); self::assertCount(count($record->events), $service->events); foreach ($service->events as $event) { self::assertContains($event, $record->events); } } /** * Testing the external delete service. * * @throws \ReflectionException * @throws \coding_exception * @throws \dml_exception * @throws \invalid_parameter_exception * @throws \invalid_response_exception * @throws \restricted_context_exception */ public function test_deleting() { $this->resetAfterTest(); self::setAdminUser(); // Testing correct delete record of the database. $record = self::get_random_record(); $record->id = api::add_service($record); $return = local_webhooks_external::del_service($record->id); $return = external_api::clean_returnvalue(local_webhooks_external::del_service_returns(), $return); self::assertEquals(0, api::get_total_count()); self::assertInternalType('bool', $return); $ids = []; $total = random_int(5, 20); // Testing correct delete record of the record's list. for ($i = 0; $i < $total; $i++) { $record = self::get_random_record(); $ids[] = api::add_service($record); } self::assertEquals(count($ids), api::get_total_count()); $return = local_webhooks_external::del_service($ids[array_rand($ids, 1)]); $return = external_api::clean_returnvalue(local_webhooks_external::del_service_returns(), $return); self::assertEquals(count($ids) - 1, api::get_total_count()); self::assertInternalType('bool', $return); } /** * 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() { $this->resetAfterTest(); self::setAdminUser(); // 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() { $this->resetAfterTest(); self::setAdminUser(); $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() { $this->resetAfterTest(); self::setAdminUser(); $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']); } }