* * @license GNU AGPL version 3 or any later version * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program 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 program. If not, see . * */ namespace Test\AppFramework\Middleware; use OC\AppFramework\Middleware\OCSMiddleware; use OC\AppFramework\OCS\BaseResponse; use OC\AppFramework\OCS\V1Response; use OC\AppFramework\OCS\V2Response; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; use OCP\AppFramework\OCS\OCSBadRequestException; use OCP\AppFramework\OCS\OCSException; use OCP\AppFramework\OCS\OCSForbiddenException; use OCP\AppFramework\OCS\OCSNotFoundException; use OCP\AppFramework\OCSController; use OCP\IRequest; class OCSMiddlewareTest extends \Test\TestCase { /** * @var IRequest */ private $request; protected function setUp(): void { parent::setUp(); $this->request = $this->getMockBuilder(IRequest::class) ->getMock(); } public function dataAfterException() { $OCSController = $this->getMockBuilder(OCSController::class) ->disableOriginalConstructor() ->getMock(); $controller = $this->getMockBuilder(Controller::class) ->disableOriginalConstructor() ->getMock(); return [ [$OCSController, new \Exception(), true], [$OCSController, new OCSException(), false, '', Http::STATUS_INTERNAL_SERVER_ERROR], [$OCSController, new OCSException('foo'), false, 'foo', Http::STATUS_INTERNAL_SERVER_ERROR], [$OCSController, new OCSException('foo', Http::STATUS_IM_A_TEAPOT), false, 'foo', Http::STATUS_IM_A_TEAPOT], [$OCSController, new OCSBadRequestException(), false, '', Http::STATUS_BAD_REQUEST], [$OCSController, new OCSBadRequestException('foo'), false, 'foo', Http::STATUS_BAD_REQUEST], [$OCSController, new OCSForbiddenException(), false, '', Http::STATUS_FORBIDDEN], [$OCSController, new OCSForbiddenException('foo'), false, 'foo', Http::STATUS_FORBIDDEN], [$OCSController, new OCSNotFoundException(), false, '', Http::STATUS_NOT_FOUND], [$OCSController, new OCSNotFoundException('foo'), false, 'foo', Http::STATUS_NOT_FOUND], [$controller, new \Exception(), true], [$controller, new OCSException(), true], [$controller, new OCSException('foo'), true], [$controller, new OCSException('foo', Http::STATUS_IM_A_TEAPOT), true], [$controller, new OCSBadRequestException(), true], [$controller, new OCSBadRequestException('foo'), true], [$controller, new OCSForbiddenException(), true], [$controller, new OCSForbiddenException('foo'), true], [$controller, new OCSNotFoundException(), true], [$controller, new OCSNotFoundException('foo'), true], ]; } /** * @dataProvider dataAfterException * * @param Controller $controller * @param \Exception $exception * @param bool $forward * @param string $message * @param int $code */ public function testAfterExceptionOCSv1($controller, $exception, $forward, $message = '', $code = 0) { $this->request ->method('getScriptName') ->willReturn('/ocs/v1.php'); $OCSMiddleware = new OCSMiddleware($this->request); $OCSMiddleware->beforeController($controller, 'method'); try { $result = $OCSMiddleware->afterException($controller, 'method', $exception); $this->assertFalse($forward); $this->assertInstanceOf(V1Response::class, $result); $this->assertSame($message, $this->invokePrivate($result, 'statusMessage')); if ($exception->getCode() === 0) { $this->assertSame(\OCP\AppFramework\OCSController::RESPOND_UNKNOWN_ERROR, $result->getOCSStatus()); } else { $this->assertSame($code, $result->getOCSStatus()); } if ($exception instanceof OCSForbiddenException) { $this->assertSame(Http::STATUS_UNAUTHORIZED, $result->getStatus()); } else { $this->assertSame(Http::STATUS_OK, $result->getStatus()); } } catch (\Exception $e) { $this->assertTrue($forward); $this->assertEquals($exception, $e); } } /** * @dataProvider dataAfterException * * @param Controller $controller * @param \Exception $exception * @param bool $forward * @param string $message * @param int $code */ public function testAfterExceptionOCSv2($controller, $exception, $forward, $message = '', $code = 0) { $this->request ->method('getScriptName') ->willReturn('/ocs/v2.php'); $OCSMiddleware = new OCSMiddleware($this->request); $OCSMiddleware->beforeController($controller, 'method'); try { $result = $OCSMiddleware->afterException($controller, 'method', $exception); $this->assertFalse($forward); $this->assertInstanceOf(V2Response::class, $result); $this->assertSame($message, $this->invokePrivate($result, 'statusMessage')); if ($exception->getCode() === 0) { $this->assertSame(\OCP\AppFramework\OCSController::RESPOND_UNKNOWN_ERROR, $result->getOCSStatus()); } else { $this->assertSame($code, $result->getOCSStatus()); } $this->assertSame($code, $result->getStatus()); } catch (\Exception $e) { $this->assertTrue($forward); $this->assertEquals($exception, $e); } } /** * @dataProvider dataAfterException * * @param Controller $controller * @param \Exception $exception * @param bool $forward * @param string $message * @param int $code */ public function testAfterExceptionOCSv2SubFolder($controller, $exception, $forward, $message = '', $code = 0) { $this->request ->method('getScriptName') ->willReturn('/mysubfolder/ocs/v2.php'); $OCSMiddleware = new OCSMiddleware($this->request); $OCSMiddleware->beforeController($controller, 'method'); try { $result = $OCSMiddleware->afterException($controller, 'method', $exception); $this->assertFalse($forward); $this->assertInstanceOf(V2Response::class, $result); $this->assertSame($message, $this->invokePrivate($result, 'statusMessage')); if ($exception->getCode() === 0) { $this->assertSame(\OCP\AppFramework\OCSController::RESPOND_UNKNOWN_ERROR, $result->getOCSStatus()); } else { $this->assertSame($code, $result->getOCSStatus()); } $this->assertSame($code, $result->getStatus()); } catch (\Exception $e) { $this->assertTrue($forward); $this->assertEquals($exception, $e); } } public function dataAfterController() { $OCSController = $this->getMockBuilder(OCSController::class) ->disableOriginalConstructor() ->getMock(); $controller = $this->getMockBuilder(Controller::class) ->disableOriginalConstructor() ->getMock(); return [ [$OCSController, new Http\Response(), false], [$OCSController, new Http\JSONResponse(), false], [$OCSController, new Http\JSONResponse(['message' => 'foo']), false], [$OCSController, new Http\JSONResponse(['message' => 'foo'], Http::STATUS_UNAUTHORIZED), true], [$OCSController, new Http\JSONResponse(['message' => 'foo'], Http::STATUS_FORBIDDEN), true], [$controller, new Http\Response(), false], [$controller, new Http\JSONResponse(), false], [$controller, new Http\JSONResponse(['message' => 'foo']), false], [$controller, new Http\JSONResponse(['message' => 'foo'], Http::STATUS_UNAUTHORIZED), false], [$controller, new Http\JSONResponse(['message' => 'foo'], Http::STATUS_FORBIDDEN), false], ]; } /** * @dataProvider dataAfterController * * @param Controller $controller * @param Http\Response $response * @param bool $converted */ public function testAfterController($controller, $response, $converted) { $OCSMiddleware = new OCSMiddleware($this->request); $newResponse = $OCSMiddleware->afterController($controller, 'foo', $response); if ($converted === false) { $this->assertSame($response, $newResponse); } else { $this->assertInstanceOf(BaseResponse::class, $newResponse); $this->assertSame($response->getData()['message'], $this->invokePrivate($newResponse, 'statusMessage')); $this->assertSame(\OCP\AppFramework\OCSController::RESPOND_UNAUTHORISED, $newResponse->getOCSStatus()); $this->assertSame(Http::STATUS_UNAUTHORIZED, $newResponse->getStatus()); } } }