moodle/local_webhooks
0
Fork 0
Code Issues Releases Activity

Added description record's class

Browse Source 
Signed-off-by: Valentin Popov <info@valentineus.link>
This commit is contained in:
Valentin Popov
2019-05-05 23:27:48 +04:00
parent 3f50d21a7f
commit 654eade42b
2 changed files with 220 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
classes/record.php Normal file
View File

@@ -0,0 +1,80 @@
<?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/>.
namespace local_webhooks\local;
defined('MOODLE_INTERNAL') || die();
use stdClass;
use function defined;
/**
* It's a class description record.
*
* @copyright 2019 'Valentin Popov' <info@valentineus.link>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package local_webhooks\local\local_webhooks_record
*/
final class local_webhooks_record extends stdClass {
/**
* List of some events.
*
* @var array|null
*/
public $events;
/**
* Type of the package.
*
* @var string
*/
public $header;
/**
* A unique identifier of the service.
*
* @var int|null
*/
public $id;
/**
* Name of the service.
*
* @var string
*/
public $name;
/**
* Url's an endpoint to send notifications.
*
* @var string
*/
public $point;
/**
* Status activity of the service.
*
* @var bool
*/
public $status;
/**
* Secret key of the service.
*
* @var string
*/
public $token;
}

232
tests/lib_test.php
View File

@@ -20,12 +20,13 @@ global $CFG;
require_once($CFG->dirroot . '/local/webhooks/lib.php'); require_once($CFG->dirroot . '/local/webhooks/lib.php');
use local_webhooks\local\local_webhooks_record as stdRecord;
/** /**
* Class local_webhooks_lib_testcase * Class local_webhooks_lib_testcase
* *
* @copyright 2019 'Valentin Popov' <info@valentineus.link> * @copyright 2019 'Valentin Popov' <info@valentineus.link>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package local_webhooks
*/ */
final class local_webhooks_lib_testcase extends advanced_testcase { final class local_webhooks_lib_testcase extends advanced_testcase {
/** /**
@@ -41,21 +42,20 @@ final class local_webhooks_lib_testcase extends advanced_testcase {
$this->resetAfterTest(); $this->resetAfterTest();
$data = [ $record = new stdRecord();
'events' => [ $record->header = 'application/json';
$record->name = 'Example name';
$record->point = 'http://example.org/';
$record->status = true;
$record->token = '967b2286-0874-4938-b088-efdbcf8a79bc';
$record->events = [
'\core\event\course_created', '\core\event\course_created',
'\core\event\course_deleted', '\core\event\course_deleted',
'\core\event\course_updated', '\core\event\course_updated',
'\core\event\course_viewed', '\core\event\course_viewed',
],
'header' => 'application/json',
'name' => 'Example name',
'point' => 'http://example.org/',
'status' => 1,
'token' => '967b2286-0874-4938-b088-efdbcf8a79bc',
]; ];
$serviceid = local_webhooks_api::create_service($data); $record->id = local_webhooks_api::create_service($record);
$events = $DB->get_records(LW_TABLE_EVENTS); $events = $DB->get_records(LW_TABLE_EVENTS);
$services = $DB->get_records(LW_TABLE_SERVICES); $services = $DB->get_records(LW_TABLE_SERVICES);
@@ -63,17 +63,17 @@ final class local_webhooks_lib_testcase extends advanced_testcase {
self::assertCount(1, $services); self::assertCount(1, $services);
$service = array_shift($services); $service = array_shift($services);
self::assertEquals($data['header'], $service->header); self::assertEquals($record->header, $service->header);
self::assertEquals($data['name'], $service->name); self::assertEquals($record->id, $service->id);
self::assertEquals($data['point'], $service->point); self::assertEquals($record->name, $service->name);
self::assertEquals($data['status'], (int) $service->status); self::assertEquals($record->point, $service->point);
self::assertEquals($data['token'], $service->token); self::assertEquals($record->status, (bool) $service->status);
self::assertEquals($serviceid, $service->id); self::assertEquals($record->token, $service->token);
self::assertCount(count($data['events']), $events); self::assertCount(count($record->events), $events);
foreach ($events as $event) { foreach ($events as $event) {
self::assertEquals($serviceid, $event->serviceid); self::assertContains($event->name, $record->events);
self::assertContains($event->name, $data['events']); self::assertEquals($record->id, $event->serviceid);
} }
} }
@@ -90,22 +90,21 @@ final class local_webhooks_lib_testcase extends advanced_testcase {
$this->resetAfterTest(); $this->resetAfterTest();
$data = [ $record = new stdRecord();
'events' => [ $record->header = 'application/json';
$record->name = 'Example name';
$record->point = 'http://example.org/';
$record->status = true;
$record->token = '967b2286-0874-4938-b088-efdbcf8a79bc';
$record->events = [
'\core\event\course_created', '\core\event\course_created',
'\core\event\course_deleted', '\core\event\course_deleted',
'\core\event\course_updated', '\core\event\course_updated',
'\core\event\course_viewed', '\core\event\course_viewed',
],
'header' => 'application/json',
'name' => 'Example name',
'point' => 'http://example.org/',
'status' => 1,
'token' => '967b2286-0874-4938-b088-efdbcf8a79bc',
]; ];
$serviceid = local_webhooks_api::create_service($data); $record->id = local_webhooks_api::create_service($record);
self::assertTrue(local_webhooks_api::delete_service($serviceid)); self::assertTrue(local_webhooks_api::delete_service($record->id));
self::assertCount(0, $DB->get_records(LW_TABLE_EVENTS)); self::assertCount(0, $DB->get_records(LW_TABLE_EVENTS));
self::assertCount(0, $DB->get_records(LW_TABLE_SERVICES)); self::assertCount(0, $DB->get_records(LW_TABLE_SERVICES));
} }
@@ -119,34 +118,33 @@ final class local_webhooks_lib_testcase extends advanced_testcase {
public function test_get_service() { public function test_get_service() {
$this->resetAfterTest(); $this->resetAfterTest();
$data = [ $record = new stdRecord();
'events' => [ $record->header = 'application/json';
$record->name = 'Example name';
$record->point = 'http://example.org/';
$record->status = true;
$record->token = '967b2286-0874-4938-b088-efdbcf8a79bc';
$record->events = [
'\core\event\course_created', '\core\event\course_created',
'\core\event\course_deleted', '\core\event\course_deleted',
'\core\event\course_updated', '\core\event\course_updated',
'\core\event\course_viewed', '\core\event\course_viewed',
],
'header' => 'application/json',
'name' => 'Example name',
'point' => 'http://example.org/',
'status' => 1,
'token' => '967b2286-0874-4938-b088-efdbcf8a79bc',
]; ];
$serviceid = local_webhooks_api::create_service($data); $record->id = local_webhooks_api::create_service($record);
$service = local_webhooks_api::get_service($serviceid); $service = local_webhooks_api::get_service($record->id);
self::assertEquals($data['header'], $service->header); self::assertEquals($record->header, $service->header);
self::assertEquals($data['name'], $service->name); self::assertEquals($record->id, $service->id);
self::assertEquals($data['point'], $service->point); self::assertEquals($record->name, $service->name);
self::assertEquals($data['status'], (int) $service->status); self::assertEquals($record->point, $service->point);
self::assertEquals($data['token'], $service->token); self::assertEquals($record->status, (bool) $service->status);
self::assertEquals($serviceid, $service->id); self::assertEquals($record->token, $service->token);
self::assertInternalType('array', $service->events); self::assertInternalType('array', $service->events);
self::assertCount(count($data['events']), $service->events); self::assertCount(count($record->events), $service->events);
foreach ($service->events as $event) { foreach ($service->events as $event) {
self::assertContains($event, $data['events']); self::assertContains($event, $record->events);
} }
} }
@@ -159,24 +157,23 @@ final class local_webhooks_lib_testcase extends advanced_testcase {
public function test_get_services() { public function test_get_services() {
$this->resetAfterTest(); $this->resetAfterTest();
$data = [ $record = new stdRecord();
'events' => [ $record->header = 'application/json';
$record->name = 'Example name';
$record->point = 'http://example.org/';
$record->status = true;
$record->token = '967b2286-0874-4938-b088-efdbcf8a79bc';
$record->events = [
'\core\event\course_created', '\core\event\course_created',
'\core\event\course_deleted', '\core\event\course_deleted',
'\core\event\course_updated', '\core\event\course_updated',
'\core\event\course_viewed', '\core\event\course_viewed',
],
'header' => 'application/json',
'name' => 'Example name',
'point' => 'http://example.org/',
'status' => 1,
'token' => '967b2286-0874-4938-b088-efdbcf8a79bc',
]; ];
$ids = []; $ids = [];
$total = random_int(5, 20); $total = random_int(5, 20);
for ($i = 0; $i < $total; $i++) { for ($i = 0; $i < $total; $i++) {
$ids[] = local_webhooks_api::create_service($data); $ids[] = local_webhooks_api::create_service($record);
} }
$services = local_webhooks_api::get_services(); $services = local_webhooks_api::get_services();
@@ -184,16 +181,16 @@ final class local_webhooks_lib_testcase extends advanced_testcase {
foreach ($services as $service) { foreach ($services as $service) {
self::assertContains($service->id, $ids); self::assertContains($service->id, $ids);
self::assertEquals($data['header'], $service->header); self::assertEquals($record->header, $service->header);
self::assertEquals($data['name'], $service->name); self::assertEquals($record->name, $service->name);
self::assertEquals($data['point'], $service->point); self::assertEquals($record->point, $service->point);
self::assertEquals($data['status'], $service->status); self::assertEquals($record->status, $service->status);
self::assertEquals($data['token'], $service->token); self::assertEquals($record->token, $service->token);
self::assertInternalType('array', $service->events); self::assertInternalType('array', $service->events);
self::assertCount(count($data['events']), $service->events); self::assertCount(count($record->events), $service->events);
foreach ($service->events as $event) { foreach ($service->events as $event) {
self::assertContains($event, $data['events']); self::assertContains($event, $record->events);
} }
} }
} }
@@ -207,42 +204,41 @@ final class local_webhooks_lib_testcase extends advanced_testcase {
public function test_get_services_by_event() { public function test_get_services_by_event() {
$this->resetAfterTest(); $this->resetAfterTest();
$data = [ $record = new stdRecord();
'events' => [ $record->header = 'application/json';
$record->name = 'Example name';
$record->point = 'http://example.org/';
$record->status = true;
$record->token = '967b2286-0874-4938-b088-efdbcf8a79bc';
$record->events = [
'\core\event\course_created', '\core\event\course_created',
'\core\event\course_deleted', '\core\event\course_deleted',
'\core\event\course_updated', '\core\event\course_updated',
'\core\event\course_viewed', '\core\event\course_viewed',
],
'header' => 'application/json',
'name' => 'Example name',
'point' => 'http://example.org/',
'status' => 1,
'token' => '967b2286-0874-4938-b088-efdbcf8a79bc',
]; ];
$ids = []; $ids = [];
$total = random_int(5, 20); $total = random_int(5, 20);
for ($i = 0; $i < $total; $i++) { for ($i = 0; $i < $total; $i++) {
$ids[] = local_webhooks_api::create_service($data); $ids[] = local_webhooks_api::create_service($record);
} }
$eventname = $data['events'][random_int(1, count($data['events']) - 1)]; $eventname = $record->events[random_int(1, count($record->events) - 1)];
$services = local_webhooks_api::get_services_by_event($eventname); $services = local_webhooks_api::get_services_by_event($eventname);
self::assertCount(count($ids), $services); self::assertCount(count($ids), $services);
foreach ($services as $service) { foreach ($services as $service) {
self::assertContains($service->id, $ids); self::assertContains($service->id, $ids);
self::assertEquals($data['header'], $service->header); self::assertEquals($record->header, $service->header);
self::assertEquals($data['name'], $service->name); self::assertEquals($record->name, $service->name);
self::assertEquals($data['point'], $service->point); self::assertEquals($record->point, $service->point);
self::assertEquals($data['status'], $service->status); self::assertEquals($record->status, $service->status);
self::assertEquals($data['token'], $service->token); self::assertEquals($record->token, $service->token);
self::assertInternalType('array', $service->events); self::assertInternalType('array', $service->events);
self::assertCount(count($data['events']), $service->events); self::assertCount(count($record->events), $service->events);
foreach ($service->events as $event) { foreach ($service->events as $event) {
self::assertContains($event, $data['events']); self::assertContains($event, $record->events);
} }
} }
} }
@@ -256,24 +252,22 @@ final class local_webhooks_lib_testcase extends advanced_testcase {
public function test_get_services_with_conditions() { public function test_get_services_with_conditions() {
$this->resetAfterTest(); $this->resetAfterTest();
$data = [ $record = new stdRecord();
'events' => [ $record->header = 'application/json';
$record->status = true;
$record->token = '967b2286-0874-4938-b088-efdbcf8a79bc';
$record->events = [
'\core\event\course_created', '\core\event\course_created',
'\core\event\course_deleted', '\core\event\course_deleted',
'\core\event\course_updated', '\core\event\course_updated',
'\core\event\course_viewed', '\core\event\course_viewed',
],
'header' => 'application/json',
'status' => 1,
'token' => '967b2286-0874-4938-b088-efdbcf8a79bc',
]; ];
$total = random_int(5, 20); $total = random_int(5, 20);
for ($i = 0; $i < $total; $i++) { for ($i = 0; $i < $total; $i++) {
local_webhooks_api::create_service(array_merge($data, [ $record->name = 'Example name #' . $i;
'name' => 'Example name #' . $i, $record->point = 'http://example.org/test_' . $i;
'point' => 'http://example.org/test_' . $i, local_webhooks_api::create_service($record);
]));
} }
self::assertCount(1, local_webhooks_api::get_services([ self::assertCount(1, local_webhooks_api::get_services([
@@ -297,35 +291,33 @@ final class local_webhooks_lib_testcase extends advanced_testcase {
$this->resetAfterTest(); $this->resetAfterTest();
$data1 = [ $record1 = new stdRecord();
'events' => [ $record1->header = 'application/json';
$record1->name = 'Example name';
$record1->point = 'http://example.org/';
$record1->status = true;
$record1->token = '967b2286-0874-4938-b088-efdbcf8a79bc';
$record1->events = [
'\core\event\course_created', '\core\event\course_created',
'\core\event\course_deleted', '\core\event\course_deleted',
'\core\event\course_updated', '\core\event\course_updated',
'\core\event\course_viewed', '\core\event\course_viewed',
],
'header' => 'application/json',
'name' => 'Example name',
'point' => 'http://example.org/',
'status' => 1,
'token' => '967b2286-0874-4938-b088-efdbcf8a79bc',
]; ];
$data2 = [ $record2 = new stdRecord();
'events' => [ $record2->header = 'application/x-www-form-urlencoded';
'\core\event\calendar_event_created' => '1', $record2->name = 'New name';
'\core\event\calendar_event_deleted' => '1', $record2->point = 'http://domain.local/example';
'\core\event\calendar_event_updated' => '1', $record2->status = false;
], $record2->token = 'add62250-2f03-49a9-97c4-6cd73a79e83b';
'header' => 'application/x-www-form-urlencoded', $record2->events = [
'name' => 'New name', '\core\event\calendar_event_created',
'point' => 'http://domain.local/example', '\core\event\calendar_event_deleted',
'status' => 0, '\core\event\calendar_event_updated',
'token' => 'add62250-2f03-49a9-97c4-6cd73a79e83b',
]; ];
$serviceid = local_webhooks_api::create_service($data1); $record2->id = local_webhooks_api::create_service($record1);
self::assertTrue(local_webhooks_api::update_service(array_merge($data2, ['id' => $serviceid]))); self::assertTrue(local_webhooks_api::update_service($record2));
$events = $DB->get_records(LW_TABLE_EVENTS); $events = $DB->get_records(LW_TABLE_EVENTS);
$services = $DB->get_records(LW_TABLE_SERVICES); $services = $DB->get_records(LW_TABLE_SERVICES);
@@ -333,17 +325,17 @@ final class local_webhooks_lib_testcase extends advanced_testcase {
self::assertCount(1, $services); self::assertCount(1, $services);
$service = array_shift($services); $service = array_shift($services);
self::assertEquals($data2['header'], $service->header); self::assertEquals($record2->header, $service->header);
self::assertEquals($data2['name'], $service->name); self::assertEquals($record2->id, $service->id);
self::assertEquals($data2['point'], $service->point); self::assertEquals($record2->name, $service->name);
self::assertEquals($data2['status'], (int) $service->status); self::assertEquals($record2->point, $service->point);
self::assertEquals($data2['token'], $service->token); self::assertEquals($record2->status, (bool) $service->status);
self::assertEquals($serviceid, $service->id); self::assertEquals($record2->token, $service->token);
self::assertCount(count($data2['events']), $events); self::assertCount(count($record2->events), $events);
foreach ($events as $event) { foreach ($events as $event) {
self::assertEquals($serviceid, $event->serviceid); self::assertContains($event->name, $record2->events);
self::assertContains($event->name, $data2['events']); self::assertEquals($record2->id, $event->serviceid);
} }
} }
} }