MDL-30811 output: Add support for session notifications

This commit is contained in:
Andrew Nicols
2016-02-29 09:05:56 +08:00
parent 243468030a
commit 0346323cec
16 changed files with 622 additions and 55 deletions
+122
View File
@@ -0,0 +1,122 @@
<?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/>.
/**
* Unit tests for core\notification.
*
* @package core
* @category phpunit
* @copyright 2016 Andrew Nicols <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* Unit tests for core\notification.
*
* @package core
* @category phpunit
* @category phpunit
* @copyright 2016 Andrew Nicols <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_notification_testcase extends advanced_testcase {
/**
* Setup required for all notification tests.
*
* This includes emptying the list of notifications on the session, resetting any session which exists, and setting
* up a new moodle_page object.
*/
public function setUp() {
global $PAGE, $SESSION;
parent::setUp();
$PAGE = new moodle_page();
\core\session\manager::init_empty_session();
$SESSION->notifications = [];
}
/**
* Tear down required for all notification tests.
*
* This includes emptying the list of notifications on the session, resetting any session which exists, and setting
* up a new moodle_page object.
*/
public function tearDown() {
global $PAGE, $SESSION;
$PAGE = null;
\core\session\manager::init_empty_session();
$SESSION->notifications = [];
parent::tearDown();
}
/**
* Test the way in which notifications are added to the session in different stages of the page load.
*/
public function test_add_during_output_stages() {
global $PAGE, $SESSION;
\core\notification::add('Example before header', \core\notification::INFO);
$this->assertCount(1, $SESSION->notifications);
$PAGE->set_state(\moodle_page::STATE_PRINTING_HEADER);
\core\notification::add('Example during header', \core\notification::INFO);
$this->assertCount(2, $SESSION->notifications);
$PAGE->set_state(\moodle_page::STATE_IN_BODY);
\core\notification::add('Example in body', \core\notification::INFO);
$this->expectOutputRegex('/Example in body/');
$this->assertCount(2, $SESSION->notifications);
$PAGE->set_state(\moodle_page::STATE_DONE);
\core\notification::add('Example after page', \core\notification::INFO);
$this->assertCount(3, $SESSION->notifications);
}
/**
* Test fetching of notifications from the session.
*/
public function test_fetch() {
// Initially there won't be any notifications.
$this->assertCount(0, \core\notification::fetch());
// Adding a notification should make one available to fetch.
\core\notification::success('Notification created');
$this->assertCount(1, \core\notification::fetch());
$this->assertCount(0, \core\notification::fetch());
}
/**
* Test that session notifications are persisted across session clears.
*/
public function test_session_persistance() {
global $PAGE, $SESSION;
// Initially there won't be any notifications.
$this->assertCount(0, $SESSION->notifications);
// Adding a notification should make one available to fetch.
\core\notification::success('Notification created');
$this->assertCount(1, $SESSION->notifications);
// Re-creating the session will not empty the notification bag.
\core\session\manager::init_empty_session();
$this->assertCount(1, $SESSION->notifications);
}
}
+2 -2
View File
@@ -59,7 +59,7 @@ class core_session_manager_testcase extends advanced_testcase {
\core\session\manager::init_empty_session();
$this->assertInstanceOf('stdClass', $SESSION);
$this->assertEmpty((array)$SESSION);
$this->assertCount(1, (array)$SESSION);
$this->assertSame($GLOBALS['SESSION'], $_SESSION['SESSION']);
$this->assertSame($GLOBALS['SESSION'], $SESSION);
@@ -149,7 +149,7 @@ class core_session_manager_testcase extends advanced_testcase {
$this->assertEquals(0, $USER->id);
$this->assertInstanceOf('stdClass', $SESSION);
$this->assertEmpty((array)$SESSION);
$this->assertCount(1, (array)$SESSION);
$this->assertSame($GLOBALS['SESSION'], $_SESSION['SESSION']);
$this->assertSame($GLOBALS['SESSION'], $SESSION);
+3 -3
View File
@@ -76,7 +76,7 @@ class core_sessionlib_testcase extends advanced_testcase {
$this->assertSame($PAGE->context, context_course::instance($SITE->id));
$this->assertNotSame($adminsession, $SESSION);
$this->assertObjectNotHasAttribute('test1', $SESSION);
$this->assertEmpty((array)$SESSION);
$this->assertCount(1, (array)$SESSION);
$usersession1 = $SESSION;
$SESSION->test2 = true;
$this->assertSame($GLOBALS['SESSION'], $_SESSION['SESSION']);
@@ -99,7 +99,7 @@ class core_sessionlib_testcase extends advanced_testcase {
$this->assertSame($PAGE->context, context_course::instance($SITE->id));
$this->assertNotSame($adminsession, $SESSION);
$this->assertNotSame($usersession1, $SESSION);
$this->assertEmpty((array)$SESSION);
$this->assertCount(1, (array)$SESSION);
$usersession2 = $SESSION;
$usersession2->test3 = true;
$this->assertSame($GLOBALS['SESSION'], $_SESSION['SESSION']);
@@ -123,7 +123,7 @@ class core_sessionlib_testcase extends advanced_testcase {
$this->assertSame($PAGE->context, context_course::instance($SITE->id));
$this->assertNotSame($adminsession, $SESSION);
$this->assertNotSame($usersession1, $SESSION);
$this->assertEmpty((array)$SESSION);
$this->assertCount(1, (array)$SESSION);
$this->assertSame($GLOBALS['SESSION'], $_SESSION['SESSION']);
$this->assertSame($GLOBALS['SESSION'], $SESSION);
$this->assertSame($GLOBALS['USER'], $_SESSION['USER']);