3 declare(strict_types
=1);
5 namespace Shaarli\Front\Controller
;
7 use PHPUnit\Framework\TestCase
;
8 use Shaarli\Config\ConfigManager
;
9 use Shaarli\Container\ShaarliContainer
;
10 use Shaarli\Front\Exception\LoginBannedException
;
11 use Shaarli\Render\PageBuilder
;
12 use Shaarli\Security\LoginManager
;
13 use Slim\Http\Request
;
14 use Slim\Http\Response
;
16 class LoginControllerTest
extends TestCase
18 /** @var ShaarliContainer */
21 /** @var LoginController */
22 protected $controller;
24 public function setUp(): void
26 $this->container
= $this->createMock(ShaarliContainer
::class);
27 $this->controller
= new LoginController($this->container
);
30 public function testValidControllerInvoke(): void
32 $this->createValidContainerMockSet();
34 $request = $this->createMock(Request
::class);
35 $request->expects(static::once())->method('getServerParam')->willReturn('> referer');
36 $response = new Response();
38 $assignedVariables = [];
39 $this->container
->pageBuilder
40 ->expects(static::exactly(3))
42 ->willReturnCallback(function ($key, $value) use (&$assignedVariables) {
43 $assignedVariables[$key] = $value;
49 $result = $this->controller
->index($request, $response);
51 static::assertInstanceOf(Response
::class, $result);
52 static::assertSame(200, $result->getStatusCode());
53 static::assertSame('loginform', (string) $result->getBody());
55 static::assertSame('> referer', $assignedVariables['returnurl']);
56 static::assertSame(true, $assignedVariables['remember_user_default']);
57 static::assertSame('Login - Shaarli', $assignedVariables['pagetitle']);
60 public function testValidControllerInvokeWithUserName(): void
62 $this->createValidContainerMockSet();
64 $request = $this->createMock(Request
::class);
65 $request->expects(static::once())->method('getServerParam')->willReturn('> referer');
66 $request->expects(static::exactly(2))->method('getParam')->willReturn('myUser>');
67 $response = new Response();
69 $assignedVariables = [];
70 $this->container
->pageBuilder
71 ->expects(static::exactly(4))
73 ->willReturnCallback(function ($key, $value) use (&$assignedVariables) {
74 $assignedVariables[$key] = $value;
80 $result = $this->controller
->index($request, $response);
82 static::assertInstanceOf(Response
::class, $result);
83 static::assertSame(200, $result->getStatusCode());
84 static::assertSame('loginform', (string) $result->getBody());
86 static::assertSame('myUser>', $assignedVariables['username']);
87 static::assertSame('> referer', $assignedVariables['returnurl']);
88 static::assertSame(true, $assignedVariables['remember_user_default']);
89 static::assertSame('Login - Shaarli', $assignedVariables['pagetitle']);
92 public function testLoginControllerWhileLoggedIn(): void
94 $request = $this->createMock(Request
::class);
95 $response = new Response();
97 $loginManager = $this->createMock(LoginManager
::class);
98 $loginManager->expects(static::once())->method('isLoggedIn')->willReturn(true);
99 $this->container
->loginManager
= $loginManager;
101 $result = $this->controller
->index($request, $response);
103 static::assertInstanceOf(Response
::class, $result);
104 static::assertSame(302, $result->getStatusCode());
105 static::assertSame(['./'], $result->getHeader('Location'));
108 public function testLoginControllerOpenShaarli(): void
110 $this->createValidContainerMockSet();
112 $request = $this->createMock(Request
::class);
113 $response = new Response();
115 $conf = $this->createMock(ConfigManager
::class);
116 $conf->method('get')->willReturnCallback(function (string $parameter, $default) {
117 if ($parameter === 'security.open_shaarli') {
122 $this->container
->conf
= $conf;
124 $result = $this->controller
->index($request, $response);
126 static::assertInstanceOf(Response
::class, $result);
127 static::assertSame(302, $result->getStatusCode());
128 static::assertSame(['./'], $result->getHeader('Location'));
131 public function testLoginControllerWhileBanned(): void
133 $this->createValidContainerMockSet();
135 $request = $this->createMock(Request
::class);
136 $response = new Response();
138 $loginManager = $this->createMock(LoginManager
::class);
139 $loginManager->method('isLoggedIn')->willReturn(false);
140 $loginManager->method('canLogin')->willReturn(false);
141 $this->container
->loginManager
= $loginManager;
143 $this->expectException(LoginBannedException
::class);
145 $this->controller
->index($request, $response);
148 protected function createValidContainerMockSet(): void
151 $loginManager = $this->createMock(LoginManager
::class);
152 $loginManager->method('isLoggedIn')->willReturn(false);
153 $loginManager->method('canLogin')->willReturn(true);
154 $this->container
->loginManager
= $loginManager;
157 $conf = $this->createMock(ConfigManager
::class);
158 $conf->method('get')->willReturnCallback(function (string $parameter, $default) {
161 $this->container
->conf
= $conf;
164 $pageBuilder = $this->createMock(PageBuilder
::class);
167 ->willReturnCallback(function (string $template): string {
171 $this->container
->pageBuilder
= $pageBuilder;