123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278 |
- <?php
- /**
- * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
- * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
- namespace Test\AppFramework\Middleware;
- use OC\AppFramework\Http\Request;
- use OC\AppFramework\Middleware\MiddlewareDispatcher;
- use OCP\AppFramework\Http\Response;
- use OCP\AppFramework\Middleware;
- use OCP\IConfig;
- use OCP\IRequestId;
- // 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(): void {
- 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->createMock(IRequestId::class),
- $this->createMock(IConfig::class)
- )
- ])->getMock();
- }
- private function getMiddleware($beforeControllerThrowsEx = false) {
- $m1 = new TestMiddleware($beforeControllerThrowsEx);
- $this->dispatcher->registerMiddleware($m1);
- return $m1;
- }
- public function testAfterExceptionShouldReturnResponseOfMiddleware(): void {
- $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')
- ->willReturn($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(): void {
- $m1 = new TestMiddleware(false);
- $m2 = new TestMiddleware(true);
- $this->dispatcher->registerMiddleware($m1);
- $this->dispatcher->registerMiddleware($m2);
- $this->expectException(\Exception::class);
- $this->dispatcher->beforeController($this->controller, $this->method);
- $this->dispatcher->afterException($this->controller, $this->method, $this->exception);
- }
- public function testBeforeControllerCorrectArguments(): void {
- $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(): void {
- $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(): void {
- $m1 = $this->getMiddleware();
- $this->expectException(\Exception::class);
- $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(): void {
- $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(): void {
- $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(): void {
- $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(): void {
- $m1 = $this->getMiddleware();
- $m2 = $this->getMiddleware();
- $this->expectException(\Exception::class);
- $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(): void {
- $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(): void {
- $m1 = $this->getMiddleware();
- $m2 = $this->getMiddleware(true);
- $m3 = $this->createMock(Middleware::class);
- $m3->expects($this->never())
- ->method('afterException');
- $m3->expects($this->never())
- ->method('beforeController');
- $m3->expects($this->never())
- ->method('afterController');
- $m3->method('beforeOutput')
- ->willReturnArgument(2);
- $this->dispatcher->registerMiddleware($m3);
- $this->dispatcher->beforeOutput($this->controller, $this->method, $this->out);
- $this->assertEquals(2, $m1->beforeOutputOrder);
- $this->assertEquals(1, $m2->beforeOutputOrder);
- }
- }
|