MyShaarli/tests/front/controller/visitor/LoginControllerTest.php

405 lines
15 KiB
PHP
Raw Normal View History

<?php
declare(strict_types=1);
namespace Shaarli\Front\Controller\Visitor;
use Shaarli\Config\ConfigManager;
use Shaarli\Front\Exception\LoginBannedException;
2020-07-21 20:33:33 +02:00
use Shaarli\Front\Exception\WrongTokenException;
use Shaarli\Render\TemplatePage;
use Shaarli\Security\CookieManager;
use Shaarli\Security\SessionManager;
2020-09-29 14:41:40 +02:00
use Shaarli\TestCase;
use Slim\Http\Request;
use Slim\Http\Response;
class LoginControllerTest extends TestCase
{
use FrontControllerMockHelper;
/** @var LoginController */
protected $controller;
public function setUp(): void
{
$this->createContainer();
2020-07-21 20:33:33 +02:00
$this->container->cookieManager = $this->createMock(CookieManager::class);
$this->container->sessionManager->method('checkToken')->willReturn(true);
$this->controller = new LoginController($this->container);
}
2020-07-21 20:33:33 +02:00
/**
* Test displaying login form with valid parameters.
*/
public function testValidControllerInvoke(): void
{
$request = $this->createMock(Request::class);
2020-07-21 20:33:33 +02:00
$request
->expects(static::atLeastOnce())
->method('getParam')
->willReturnCallback(function (string $key) {
return 'returnurl' === $key ? '> referer' : null;
})
;
$response = new Response();
$assignedVariables = [];
$this->container->pageBuilder
->method('assign')
->willReturnCallback(function ($key, $value) use (&$assignedVariables) {
$assignedVariables[$key] = $value;
return $this;
})
;
$this->container->loginManager->method('canLogin')->willReturn(true);
$result = $this->controller->index($request, $response);
static::assertInstanceOf(Response::class, $result);
static::assertSame(200, $result->getStatusCode());
2020-07-21 20:33:33 +02:00
static::assertSame(TemplatePage::LOGIN, (string) $result->getBody());
static::assertSame('&gt; referer', $assignedVariables['returnurl']);
static::assertSame(true, $assignedVariables['remember_user_default']);
static::assertSame('Login - Shaarli', $assignedVariables['pagetitle']);
}
2020-07-21 20:33:33 +02:00
/**
* Test displaying login form with username defined in the request.
*/
public function testValidControllerInvokeWithUserName(): void
{
2020-07-21 20:33:33 +02:00
$this->container->environment = ['HTTP_REFERER' => '> referer'];
$request = $this->createMock(Request::class);
2020-07-21 20:33:33 +02:00
$request
->expects(static::atLeastOnce())
->method('getParam')
->willReturnCallback(function (string $key, $default) {
if ('login' === $key) {
return 'myUser>';
}
return $default;
})
;
$response = new Response();
$assignedVariables = [];
$this->container->pageBuilder
->method('assign')
->willReturnCallback(function ($key, $value) use (&$assignedVariables) {
$assignedVariables[$key] = $value;
return $this;
})
;
$this->container->loginManager->expects(static::once())->method('canLogin')->willReturn(true);
$result = $this->controller->index($request, $response);
static::assertInstanceOf(Response::class, $result);
static::assertSame(200, $result->getStatusCode());
static::assertSame('loginform', (string) $result->getBody());
static::assertSame('myUser&gt;', $assignedVariables['username']);
static::assertSame('&gt; referer', $assignedVariables['returnurl']);
static::assertSame(true, $assignedVariables['remember_user_default']);
static::assertSame('Login - Shaarli', $assignedVariables['pagetitle']);
}
2020-07-21 20:33:33 +02:00
/**
* Test displaying login page while being logged in.
*/
public function testLoginControllerWhileLoggedIn(): void
{
$request = $this->createMock(Request::class);
$response = new Response();
$this->container->loginManager->expects(static::once())->method('isLoggedIn')->willReturn(true);
$result = $this->controller->index($request, $response);
static::assertInstanceOf(Response::class, $result);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/'], $result->getHeader('Location'));
}
2020-07-21 20:33:33 +02:00
/**
* Test displaying login page with open shaarli configured: redirect to homepage.
*/
public function testLoginControllerOpenShaarli(): void
{
$request = $this->createMock(Request::class);
$response = new Response();
$conf = $this->createMock(ConfigManager::class);
$conf->method('get')->willReturnCallback(function (string $parameter, $default) {
if ($parameter === 'security.open_shaarli') {
return true;
}
return $default;
});
$this->container->conf = $conf;
$result = $this->controller->index($request, $response);
static::assertInstanceOf(Response::class, $result);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/'], $result->getHeader('Location'));
}
2020-07-21 20:33:33 +02:00
/**
* Test displaying login page while being banned.
*/
public function testLoginControllerWhileBanned(): void
{
$request = $this->createMock(Request::class);
$response = new Response();
$this->container->loginManager->method('isLoggedIn')->willReturn(false);
$this->container->loginManager->method('canLogin')->willReturn(false);
$this->expectException(LoginBannedException::class);
$this->controller->index($request, $response);
}
2020-07-21 20:33:33 +02:00
/**
* 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', 'bob', 'pass')
2020-07-21 20:33:33 +02:00
->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);
}
}