293 lines
8.7 KiB
PHP
293 lines
8.7 KiB
PHP
<?php
|
|
|
|
/**
|
|
* ownCloud - App Framework
|
|
*
|
|
* @author Bernhard Posselt
|
|
* @copyright 2012 Bernhard Posselt <dev@bernhard-posselt.com>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
|
|
* License as published by the Free Software Foundation; either
|
|
* version 3 of the License, or any later version.
|
|
*
|
|
* This library 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 AFFERO GENERAL PUBLIC LICENSE for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
|
|
namespace Test\AppFramework\Middleware;
|
|
|
|
use OC\AppFramework\Http\Request;
|
|
use OC\AppFramework\Middleware\MiddlewareDispatcher;
|
|
use OCP\AppFramework\Middleware;
|
|
use OCP\AppFramework\Http\Response;
|
|
|
|
|
|
// needed to test ordering
|
|
class TestMiddleware extends Middleware {
|
|
public static $beforeControllerCalled = 0;
|
|
public static $afterControllerCalled = 0;
|
|
public static $afterExceptionCalled = 0;
|
|
public static $beforeOutputCalled = 0;
|
|
|
|
public $beforeControllerOrder = 0;
|
|
public $afterControllerOrder = 0;
|
|
public $afterExceptionOrder = 0;
|
|
public $beforeOutputOrder = 0;
|
|
|
|
public $controller;
|
|
public $methodName;
|
|
public $exception;
|
|
public $response;
|
|
public $output;
|
|
|
|
private $beforeControllerThrowsEx;
|
|
|
|
/**
|
|
* @param boolean $beforeControllerThrowsEx
|
|
*/
|
|
public function __construct($beforeControllerThrowsEx) {
|
|
self::$beforeControllerCalled = 0;
|
|
self::$afterControllerCalled = 0;
|
|
self::$afterExceptionCalled = 0;
|
|
self::$beforeOutputCalled = 0;
|
|
$this->beforeControllerThrowsEx = $beforeControllerThrowsEx;
|
|
}
|
|
|
|
public function beforeController($controller, $methodName){
|
|
self::$beforeControllerCalled++;
|
|
$this->beforeControllerOrder = self::$beforeControllerCalled;
|
|
$this->controller = $controller;
|
|
$this->methodName = $methodName;
|
|
if($this->beforeControllerThrowsEx){
|
|
throw new \Exception();
|
|
}
|
|
}
|
|
|
|
public function afterException($controller, $methodName, \Exception $exception){
|
|
self::$afterExceptionCalled++;
|
|
$this->afterExceptionOrder = self::$afterExceptionCalled;
|
|
$this->controller = $controller;
|
|
$this->methodName = $methodName;
|
|
$this->exception = $exception;
|
|
parent::afterException($controller, $methodName, $exception);
|
|
}
|
|
|
|
public function afterController($controller, $methodName, Response $response){
|
|
self::$afterControllerCalled++;
|
|
$this->afterControllerOrder = self::$afterControllerCalled;
|
|
$this->controller = $controller;
|
|
$this->methodName = $methodName;
|
|
$this->response = $response;
|
|
return parent::afterController($controller, $methodName, $response);
|
|
}
|
|
|
|
public function beforeOutput($controller, $methodName, $output){
|
|
self::$beforeOutputCalled++;
|
|
$this->beforeOutputOrder = self::$beforeOutputCalled;
|
|
$this->controller = $controller;
|
|
$this->methodName = $methodName;
|
|
$this->output = $output;
|
|
return parent::beforeOutput($controller, $methodName, $output);
|
|
}
|
|
}
|
|
|
|
|
|
class MiddlewareDispatcherTest extends \Test\TestCase {
|
|
|
|
public $exception;
|
|
public $response;
|
|
private $out;
|
|
private $method;
|
|
private $controller;
|
|
|
|
/**
|
|
* @var MiddlewareDispatcher
|
|
*/
|
|
private $dispatcher;
|
|
|
|
protected function setUp() {
|
|
parent::setUp();
|
|
|
|
$this->dispatcher = new MiddlewareDispatcher();
|
|
$this->controller = $this->getControllerMock();
|
|
$this->method = 'method';
|
|
$this->response = new Response();
|
|
$this->out = 'hi';
|
|
$this->exception = new \Exception();
|
|
}
|
|
|
|
|
|
private function getControllerMock(){
|
|
return $this->getMockBuilder('OCP\AppFramework\Controller')
|
|
->setMethods(['method'])
|
|
->setConstructorArgs(['app',
|
|
new Request(
|
|
['method' => 'GET'],
|
|
$this->getMockBuilder('\OCP\Security\ISecureRandom')->getMock(),
|
|
$this->getMockBuilder('\OCP\IConfig')->getMock()
|
|
)
|
|
])->getMock();
|
|
}
|
|
|
|
|
|
private function getMiddleware($beforeControllerThrowsEx=false){
|
|
$m1 = new TestMiddleware($beforeControllerThrowsEx);
|
|
$this->dispatcher->registerMiddleware($m1);
|
|
return $m1;
|
|
}
|
|
|
|
|
|
public function testAfterExceptionShouldReturnResponseOfMiddleware(){
|
|
$response = new Response();
|
|
$m1 = $this->getMockBuilder('\OCP\AppFramework\Middleware')
|
|
->setMethods(['afterException', 'beforeController'])
|
|
->getMock();
|
|
$m1->expects($this->never())
|
|
->method('afterException');
|
|
|
|
$m2 = $this->getMockBuilder('OCP\AppFramework\Middleware')
|
|
->setMethods(['afterException', 'beforeController'])
|
|
->getMock();
|
|
$m2->expects($this->once())
|
|
->method('afterException')
|
|
->will($this->returnValue($response));
|
|
|
|
$this->dispatcher->registerMiddleware($m1);
|
|
$this->dispatcher->registerMiddleware($m2);
|
|
|
|
$this->dispatcher->beforeController($this->controller, $this->method);
|
|
$this->assertEquals($response, $this->dispatcher->afterException($this->controller, $this->method, $this->exception));
|
|
}
|
|
|
|
|
|
public function testAfterExceptionShouldThrowAgainWhenNotHandled(){
|
|
$m1 = new TestMiddleware(false);
|
|
$m2 = new TestMiddleware(true);
|
|
|
|
$this->dispatcher->registerMiddleware($m1);
|
|
$this->dispatcher->registerMiddleware($m2);
|
|
|
|
$this->setExpectedException('\Exception');
|
|
$this->dispatcher->beforeController($this->controller, $this->method);
|
|
$this->dispatcher->afterException($this->controller, $this->method, $this->exception);
|
|
}
|
|
|
|
|
|
public function testBeforeControllerCorrectArguments(){
|
|
$m1 = $this->getMiddleware();
|
|
$this->dispatcher->beforeController($this->controller, $this->method);
|
|
|
|
$this->assertEquals($this->controller, $m1->controller);
|
|
$this->assertEquals($this->method, $m1->methodName);
|
|
}
|
|
|
|
|
|
public function testAfterControllerCorrectArguments(){
|
|
$m1 = $this->getMiddleware();
|
|
|
|
$this->dispatcher->afterController($this->controller, $this->method, $this->response);
|
|
|
|
$this->assertEquals($this->controller, $m1->controller);
|
|
$this->assertEquals($this->method, $m1->methodName);
|
|
$this->assertEquals($this->response, $m1->response);
|
|
}
|
|
|
|
|
|
public function testAfterExceptionCorrectArguments(){
|
|
$m1 = $this->getMiddleware();
|
|
|
|
$this->setExpectedException('\Exception');
|
|
|
|
$this->dispatcher->beforeController($this->controller, $this->method);
|
|
$this->dispatcher->afterException($this->controller, $this->method, $this->exception);
|
|
|
|
$this->assertEquals($this->controller, $m1->controller);
|
|
$this->assertEquals($this->method, $m1->methodName);
|
|
$this->assertEquals($this->exception, $m1->exception);
|
|
}
|
|
|
|
|
|
public function testBeforeOutputCorrectArguments(){
|
|
$m1 = $this->getMiddleware();
|
|
|
|
$this->dispatcher->beforeOutput($this->controller, $this->method, $this->out);
|
|
|
|
$this->assertEquals($this->controller, $m1->controller);
|
|
$this->assertEquals($this->method, $m1->methodName);
|
|
$this->assertEquals($this->out, $m1->output);
|
|
}
|
|
|
|
|
|
public function testBeforeControllerOrder(){
|
|
$m1 = $this->getMiddleware();
|
|
$m2 = $this->getMiddleware();
|
|
|
|
$this->dispatcher->beforeController($this->controller, $this->method);
|
|
|
|
$this->assertEquals(1, $m1->beforeControllerOrder);
|
|
$this->assertEquals(2, $m2->beforeControllerOrder);
|
|
}
|
|
|
|
public function testAfterControllerOrder(){
|
|
$m1 = $this->getMiddleware();
|
|
$m2 = $this->getMiddleware();
|
|
|
|
$this->dispatcher->afterController($this->controller, $this->method, $this->response);
|
|
|
|
$this->assertEquals(2, $m1->afterControllerOrder);
|
|
$this->assertEquals(1, $m2->afterControllerOrder);
|
|
}
|
|
|
|
|
|
public function testAfterExceptionOrder(){
|
|
$m1 = $this->getMiddleware();
|
|
$m2 = $this->getMiddleware();
|
|
|
|
$this->setExpectedException('\Exception');
|
|
$this->dispatcher->beforeController($this->controller, $this->method);
|
|
$this->dispatcher->afterException($this->controller, $this->method, $this->exception);
|
|
|
|
$this->assertEquals(1, $m1->afterExceptionOrder);
|
|
$this->assertEquals(1, $m2->afterExceptionOrder);
|
|
}
|
|
|
|
|
|
public function testBeforeOutputOrder(){
|
|
$m1 = $this->getMiddleware();
|
|
$m2 = $this->getMiddleware();
|
|
|
|
$this->dispatcher->beforeOutput($this->controller, $this->method, $this->out);
|
|
|
|
$this->assertEquals(2, $m1->beforeOutputOrder);
|
|
$this->assertEquals(1, $m2->beforeOutputOrder);
|
|
}
|
|
|
|
|
|
public function testExceptionShouldRunAfterExceptionOfOnlyPreviouslyExecutedMiddlewares(){
|
|
$m1 = $this->getMiddleware();
|
|
$m2 = $this->getMiddleware(true);
|
|
$m3 = $this->getMockBuilder('\OCP\AppFramework\Middleware')->getMock();
|
|
$m3->expects($this->never())
|
|
->method('afterException');
|
|
$m3->expects($this->never())
|
|
->method('beforeController');
|
|
$m3->expects($this->never())
|
|
->method('afterController');
|
|
|
|
$this->dispatcher->registerMiddleware($m3);
|
|
|
|
$this->dispatcher->beforeOutput($this->controller, $this->method, $this->out);
|
|
|
|
$this->assertEquals(2, $m1->beforeOutputOrder);
|
|
$this->assertEquals(1, $m2->beforeOutputOrder);
|
|
}
|
|
}
|