From a8c11451e8d885a243c1ad52012093ba8d121e2c Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Tue, 21 Jul 2020 20:33:33 +0200 Subject: Process login through Slim controller --- tests/front/ShaarliMiddlewareTest.php | 7 +- .../visitor/FrontControllerMockHelper.php | 1 + .../controller/visitor/LoginControllerTest.php | 278 ++++++++++++++++++++- 3 files changed, 281 insertions(+), 5 deletions(-) (limited to 'tests/front') diff --git a/tests/front/ShaarliMiddlewareTest.php b/tests/front/ShaarliMiddlewareTest.php index 20090d8b..09bebd04 100644 --- a/tests/front/ShaarliMiddlewareTest.php +++ b/tests/front/ShaarliMiddlewareTest.php @@ -38,6 +38,8 @@ class ShaarliMiddlewareTest extends TestCase $this->container->loginManager = $this->createMock(LoginManager::class); + $this->container->environment = ['REQUEST_URI' => 'http://shaarli/subfolder/path']; + $this->middleware = new ShaarliMiddleware($this->container); } @@ -127,7 +129,10 @@ class ShaarliMiddlewareTest extends TestCase $result = $this->middleware->__invoke($request, $response, $controller); static::assertSame(302, $result->getStatusCode()); - static::assertSame('/subfolder/login', $result->getHeader('location')[0]); + static::assertSame( + '/subfolder/login?returnurl=' . urlencode('http://shaarli/subfolder/path'), + $result->getHeader('location')[0] + ); } /** diff --git a/tests/front/controller/visitor/FrontControllerMockHelper.php b/tests/front/controller/visitor/FrontControllerMockHelper.php index 7f560662..e0bd4ecf 100644 --- a/tests/front/controller/visitor/FrontControllerMockHelper.php +++ b/tests/front/controller/visitor/FrontControllerMockHelper.php @@ -80,6 +80,7 @@ trait FrontControllerMockHelper 'SERVER_NAME' => 'shaarli', 'SERVER_PORT' => '80', 'REQUEST_URI' => '/daily-rss', + 'REMOTE_ADDR' => '1.2.3.4', ]; $this->container->basePath = '/subfolder'; diff --git a/tests/front/controller/visitor/LoginControllerTest.php b/tests/front/controller/visitor/LoginControllerTest.php index e57f44b9..0a21f938 100644 --- a/tests/front/controller/visitor/LoginControllerTest.php +++ b/tests/front/controller/visitor/LoginControllerTest.php @@ -7,6 +7,10 @@ namespace Shaarli\Front\Controller\Visitor; use PHPUnit\Framework\TestCase; use Shaarli\Config\ConfigManager; use Shaarli\Front\Exception\LoginBannedException; +use Shaarli\Front\Exception\WrongTokenException; +use Shaarli\Render\TemplatePage; +use Shaarli\Security\CookieManager; +use Shaarli\Security\SessionManager; use Slim\Http\Request; use Slim\Http\Response; @@ -21,13 +25,25 @@ class LoginControllerTest extends TestCase { $this->createContainer(); + $this->container->cookieManager = $this->createMock(CookieManager::class); + $this->container->sessionManager->method('checkToken')->willReturn(true); + $this->controller = new LoginController($this->container); } + /** + * Test displaying login form with valid parameters. + */ public function testValidControllerInvoke(): void { $request = $this->createMock(Request::class); - $request->expects(static::once())->method('getServerParam')->willReturn('> referer'); + $request + ->expects(static::atLeastOnce()) + ->method('getParam') + ->willReturnCallback(function (string $key) { + return 'returnurl' === $key ? '> referer' : null; + }) + ; $response = new Response(); $assignedVariables = []; @@ -46,18 +62,32 @@ class LoginControllerTest extends TestCase static::assertInstanceOf(Response::class, $result); static::assertSame(200, $result->getStatusCode()); - static::assertSame('loginform', (string) $result->getBody()); + static::assertSame(TemplatePage::LOGIN, (string) $result->getBody()); static::assertSame('> referer', $assignedVariables['returnurl']); static::assertSame(true, $assignedVariables['remember_user_default']); static::assertSame('Login - Shaarli', $assignedVariables['pagetitle']); } + /** + * Test displaying login form with username defined in the request. + */ public function testValidControllerInvokeWithUserName(): void { + $this->container->environment = ['HTTP_REFERER' => '> referer']; + $request = $this->createMock(Request::class); - $request->expects(static::once())->method('getServerParam')->willReturn('> referer'); - $request->expects(static::exactly(2))->method('getParam')->willReturn('myUser>'); + $request + ->expects(static::atLeastOnce()) + ->method('getParam') + ->willReturnCallback(function (string $key, $default) { + if ('login' === $key) { + return 'myUser>'; + } + + return $default; + }) + ; $response = new Response(); $assignedVariables = []; @@ -84,6 +114,9 @@ class LoginControllerTest extends TestCase static::assertSame('Login - Shaarli', $assignedVariables['pagetitle']); } + /** + * Test displaying login page while being logged in. + */ public function testLoginControllerWhileLoggedIn(): void { $request = $this->createMock(Request::class); @@ -98,6 +131,9 @@ class LoginControllerTest extends TestCase static::assertSame(['/subfolder/'], $result->getHeader('Location')); } + /** + * Test displaying login page with open shaarli configured: redirect to homepage. + */ public function testLoginControllerOpenShaarli(): void { $request = $this->createMock(Request::class); @@ -119,6 +155,9 @@ class LoginControllerTest extends TestCase static::assertSame(['/subfolder/'], $result->getHeader('Location')); } + /** + * Test displaying login page while being banned. + */ public function testLoginControllerWhileBanned(): void { $request = $this->createMock(Request::class); @@ -131,4 +170,235 @@ class LoginControllerTest extends TestCase $this->controller->index($request, $response); } + + /** + * Test processing login with valid parameters. + */ + public function testProcessLoginWithValidParameters(): void + { + $parameters = [ + 'login' => 'bob', + 'password' => 'pass', + ]; + $request = $this->createMock(Request::class); + $request + ->expects(static::atLeastOnce()) + ->method('getParam') + ->willReturnCallback(function (string $key) use ($parameters) { + return $parameters[$key] ?? null; + }) + ; + $response = new Response(); + + $this->container->loginManager->method('canLogin')->willReturn(true); + $this->container->loginManager->expects(static::once())->method('handleSuccessfulLogin'); + $this->container->loginManager + ->expects(static::once()) + ->method('checkCredentials') + ->with('1.2.3.4', '1.2.3.4', 'bob', 'pass') + ->willReturn(true) + ; + $this->container->loginManager->method('getStaySignedInToken')->willReturn(bin2hex(random_bytes(8))); + + $this->container->sessionManager->expects(static::never())->method('extendSession'); + $this->container->sessionManager->expects(static::once())->method('destroy'); + $this->container->sessionManager + ->expects(static::once()) + ->method('cookieParameters') + ->with(0, '/subfolder/', 'shaarli') + ; + $this->container->sessionManager->expects(static::once())->method('start'); + $this->container->sessionManager->expects(static::once())->method('regenerateId')->with(true); + + $result = $this->controller->login($request, $response); + + static::assertSame(302, $result->getStatusCode()); + static::assertSame('/subfolder/', $result->getHeader('location')[0]); + } + + /** + * Test processing login with return URL. + */ + public function testProcessLoginWithReturnUrl(): void + { + $parameters = [ + 'returnurl' => 'http://shaarli/subfolder/admin/shaare', + ]; + $request = $this->createMock(Request::class); + $request + ->expects(static::atLeastOnce()) + ->method('getParam') + ->willReturnCallback(function (string $key) use ($parameters) { + return $parameters[$key] ?? null; + }) + ; + $response = new Response(); + + $this->container->loginManager->method('canLogin')->willReturn(true); + $this->container->loginManager->expects(static::once())->method('handleSuccessfulLogin'); + $this->container->loginManager->expects(static::once())->method('checkCredentials')->willReturn(true); + $this->container->loginManager->method('getStaySignedInToken')->willReturn(bin2hex(random_bytes(8))); + + $result = $this->controller->login($request, $response); + + static::assertSame(302, $result->getStatusCode()); + static::assertSame('/subfolder/admin/shaare', $result->getHeader('location')[0]); + } + + /** + * Test processing login with remember me session enabled. + */ + public function testProcessLoginLongLastingSession(): void + { + $parameters = [ + 'longlastingsession' => true, + ]; + $request = $this->createMock(Request::class); + $request + ->expects(static::atLeastOnce()) + ->method('getParam') + ->willReturnCallback(function (string $key) use ($parameters) { + return $parameters[$key] ?? null; + }) + ; + $response = new Response(); + + $this->container->loginManager->method('canLogin')->willReturn(true); + $this->container->loginManager->expects(static::once())->method('handleSuccessfulLogin'); + $this->container->loginManager->expects(static::once())->method('checkCredentials')->willReturn(true); + $this->container->loginManager->method('getStaySignedInToken')->willReturn(bin2hex(random_bytes(8))); + + $this->container->sessionManager->expects(static::once())->method('destroy'); + $this->container->sessionManager + ->expects(static::once()) + ->method('cookieParameters') + ->with(42, '/subfolder/', 'shaarli') + ; + $this->container->sessionManager->expects(static::once())->method('start'); + $this->container->sessionManager->expects(static::once())->method('regenerateId')->with(true); + $this->container->sessionManager->expects(static::once())->method('extendSession')->willReturn(42); + + $this->container->cookieManager = $this->createMock(CookieManager::class); + $this->container->cookieManager + ->expects(static::once()) + ->method('setCookieParameter') + ->willReturnCallback(function (string $name): CookieManager { + static::assertSame(CookieManager::STAY_SIGNED_IN, $name); + + return $this->container->cookieManager; + }) + ; + + $result = $this->controller->login($request, $response); + + static::assertSame(302, $result->getStatusCode()); + static::assertSame('/subfolder/', $result->getHeader('location')[0]); + } + + /** + * Test processing login with invalid credentials + */ + public function testProcessLoginWrongCredentials(): void + { + $parameters = [ + 'returnurl' => 'http://shaarli/subfolder/admin/shaare', + ]; + $request = $this->createMock(Request::class); + $request + ->expects(static::atLeastOnce()) + ->method('getParam') + ->willReturnCallback(function (string $key) use ($parameters) { + return $parameters[$key] ?? null; + }) + ; + $response = new Response(); + + $this->container->loginManager->method('canLogin')->willReturn(true); + $this->container->loginManager->expects(static::once())->method('handleFailedLogin'); + $this->container->loginManager->expects(static::once())->method('checkCredentials')->willReturn(false); + + $this->container->sessionManager + ->expects(static::once()) + ->method('setSessionParameter') + ->with(SessionManager::KEY_ERROR_MESSAGES, ['Wrong login/password.']) + ; + + $result = $this->controller->login($request, $response); + + static::assertSame(200, $result->getStatusCode()); + static::assertSame(TemplatePage::LOGIN, (string) $result->getBody()); + } + + /** + * Test processing login with wrong token + */ + public function testProcessLoginWrongToken(): void + { + $request = $this->createMock(Request::class); + $response = new Response(); + + $this->container->sessionManager = $this->createMock(SessionManager::class); + $this->container->sessionManager->method('checkToken')->willReturn(false); + + $this->expectException(WrongTokenException::class); + + $this->controller->login($request, $response); + } + + /** + * Test processing login with wrong token + */ + public function testProcessLoginAlreadyLoggedIn(): void + { + $request = $this->createMock(Request::class); + $response = new Response(); + + $this->container->loginManager->method('isLoggedIn')->willReturn(true); + $this->container->loginManager->expects(static::never())->method('handleSuccessfulLogin'); + $this->container->loginManager->expects(static::never())->method('handleFailedLogin'); + + $result = $this->controller->login($request, $response); + + static::assertSame(302, $result->getStatusCode()); + static::assertSame('/subfolder/', $result->getHeader('location')[0]); + } + + /** + * Test processing login with wrong token + */ + public function testProcessLoginInOpenShaarli(): void + { + $request = $this->createMock(Request::class); + $response = new Response(); + + $this->container->conf = $this->createMock(ConfigManager::class); + $this->container->conf->method('get')->willReturnCallback(function (string $key, $value) { + return 'security.open_shaarli' === $key ? true : $value; + }); + + $this->container->loginManager->expects(static::never())->method('handleSuccessfulLogin'); + $this->container->loginManager->expects(static::never())->method('handleFailedLogin'); + + $result = $this->controller->login($request, $response); + + static::assertSame(302, $result->getStatusCode()); + static::assertSame('/subfolder/', $result->getHeader('location')[0]); + } + + /** + * Test processing login while being banned + */ + public function testProcessLoginWhileBanned(): void + { + $request = $this->createMock(Request::class); + $response = new Response(); + + $this->container->loginManager->method('canLogin')->willReturn(false); + $this->container->loginManager->expects(static::never())->method('handleSuccessfulLogin'); + $this->container->loginManager->expects(static::never())->method('handleFailedLogin'); + + $this->expectException(LoginBannedException::class); + + $this->controller->login($request, $response); + } } -- cgit v1.2.3