diff options
Diffstat (limited to 'tests/front/ShaarliMiddlewareTest.php')
-rw-r--r-- | tests/front/ShaarliMiddlewareTest.php | 163 |
1 files changed, 157 insertions, 6 deletions
diff --git a/tests/front/ShaarliMiddlewareTest.php b/tests/front/ShaarliMiddlewareTest.php index 80974f37..655c5bba 100644 --- a/tests/front/ShaarliMiddlewareTest.php +++ b/tests/front/ShaarliMiddlewareTest.php | |||
@@ -4,16 +4,23 @@ declare(strict_types=1); | |||
4 | 4 | ||
5 | namespace Shaarli\Front; | 5 | namespace Shaarli\Front; |
6 | 6 | ||
7 | use PHPUnit\Framework\TestCase; | ||
8 | use Shaarli\Config\ConfigManager; | 7 | use Shaarli\Config\ConfigManager; |
9 | use Shaarli\Container\ShaarliContainer; | 8 | use Shaarli\Container\ShaarliContainer; |
10 | use Shaarli\Front\Exception\LoginBannedException; | 9 | use Shaarli\Front\Exception\LoginBannedException; |
10 | use Shaarli\Front\Exception\UnauthorizedException; | ||
11 | use Shaarli\Render\PageBuilder; | 11 | use Shaarli\Render\PageBuilder; |
12 | use Shaarli\Render\PageCacheManager; | ||
13 | use Shaarli\Security\LoginManager; | ||
14 | use Shaarli\TestCase; | ||
15 | use Shaarli\Updater\Updater; | ||
12 | use Slim\Http\Request; | 16 | use Slim\Http\Request; |
13 | use Slim\Http\Response; | 17 | use Slim\Http\Response; |
18 | use Slim\Http\Uri; | ||
14 | 19 | ||
15 | class ShaarliMiddlewareTest extends TestCase | 20 | class ShaarliMiddlewareTest extends TestCase |
16 | { | 21 | { |
22 | protected const TMP_MOCK_FILE = '.tmp'; | ||
23 | |||
17 | /** @var ShaarliContainer */ | 24 | /** @var ShaarliContainer */ |
18 | protected $container; | 25 | protected $container; |
19 | 26 | ||
@@ -23,12 +30,37 @@ class ShaarliMiddlewareTest extends TestCase | |||
23 | public function setUp(): void | 30 | public function setUp(): void |
24 | { | 31 | { |
25 | $this->container = $this->createMock(ShaarliContainer::class); | 32 | $this->container = $this->createMock(ShaarliContainer::class); |
33 | |||
34 | touch(static::TMP_MOCK_FILE); | ||
35 | |||
36 | $this->container->conf = $this->createMock(ConfigManager::class); | ||
37 | $this->container->conf->method('getConfigFileExt')->willReturn(static::TMP_MOCK_FILE); | ||
38 | |||
39 | $this->container->loginManager = $this->createMock(LoginManager::class); | ||
40 | |||
41 | $this->container->environment = ['REQUEST_URI' => 'http://shaarli/subfolder/path']; | ||
42 | |||
26 | $this->middleware = new ShaarliMiddleware($this->container); | 43 | $this->middleware = new ShaarliMiddleware($this->container); |
27 | } | 44 | } |
28 | 45 | ||
46 | public function tearDown(): void | ||
47 | { | ||
48 | unlink(static::TMP_MOCK_FILE); | ||
49 | } | ||
50 | |||
51 | /** | ||
52 | * Test middleware execution with valid controller call | ||
53 | */ | ||
29 | public function testMiddlewareExecution(): void | 54 | public function testMiddlewareExecution(): void |
30 | { | 55 | { |
31 | $request = $this->createMock(Request::class); | 56 | $request = $this->createMock(Request::class); |
57 | $request->method('getUri')->willReturnCallback(function (): Uri { | ||
58 | $uri = $this->createMock(Uri::class); | ||
59 | $uri->method('getBasePath')->willReturn('/subfolder'); | ||
60 | |||
61 | return $uri; | ||
62 | }); | ||
63 | |||
32 | $response = new Response(); | 64 | $response = new Response(); |
33 | $controller = function (Request $request, Response $response): Response { | 65 | $controller = function (Request $request, Response $response): Response { |
34 | return $response->withStatus(418); // I'm a tea pot | 66 | return $response->withStatus(418); // I'm a tea pot |
@@ -41,9 +73,20 @@ class ShaarliMiddlewareTest extends TestCase | |||
41 | static::assertSame(418, $result->getStatusCode()); | 73 | static::assertSame(418, $result->getStatusCode()); |
42 | } | 74 | } |
43 | 75 | ||
44 | public function testMiddlewareExecutionWithException(): void | 76 | /** |
77 | * Test middleware execution with controller throwing a known front exception. | ||
78 | * The exception should be thrown to be later handled by the error handler. | ||
79 | */ | ||
80 | public function testMiddlewareExecutionWithFrontException(): void | ||
45 | { | 81 | { |
46 | $request = $this->createMock(Request::class); | 82 | $request = $this->createMock(Request::class); |
83 | $request->method('getUri')->willReturnCallback(function (): Uri { | ||
84 | $uri = $this->createMock(Uri::class); | ||
85 | $uri->method('getBasePath')->willReturn('/subfolder'); | ||
86 | |||
87 | return $uri; | ||
88 | }); | ||
89 | |||
47 | $response = new Response(); | 90 | $response = new Response(); |
48 | $controller = function (): void { | 91 | $controller = function (): void { |
49 | $exception = new LoginBannedException(); | 92 | $exception = new LoginBannedException(); |
@@ -57,14 +100,122 @@ class ShaarliMiddlewareTest extends TestCase | |||
57 | }); | 100 | }); |
58 | $this->container->pageBuilder = $pageBuilder; | 101 | $this->container->pageBuilder = $pageBuilder; |
59 | 102 | ||
60 | $conf = $this->createMock(ConfigManager::class); | 103 | $this->expectException(LoginBannedException::class); |
61 | $this->container->conf = $conf; | 104 | |
105 | $this->middleware->__invoke($request, $response, $controller); | ||
106 | } | ||
107 | |||
108 | /** | ||
109 | * Test middleware execution with controller throwing a not authorized exception | ||
110 | * The middle should send a redirection response to the login page. | ||
111 | */ | ||
112 | public function testMiddlewareExecutionWithUnauthorizedException(): void | ||
113 | { | ||
114 | $request = $this->createMock(Request::class); | ||
115 | $request->method('getUri')->willReturnCallback(function (): Uri { | ||
116 | $uri = $this->createMock(Uri::class); | ||
117 | $uri->method('getBasePath')->willReturn('/subfolder'); | ||
118 | |||
119 | return $uri; | ||
120 | }); | ||
121 | |||
122 | $response = new Response(); | ||
123 | $controller = function (): void { | ||
124 | throw new UnauthorizedException(); | ||
125 | }; | ||
126 | |||
127 | /** @var Response $result */ | ||
128 | $result = $this->middleware->__invoke($request, $response, $controller); | ||
129 | |||
130 | static::assertSame(302, $result->getStatusCode()); | ||
131 | static::assertSame( | ||
132 | '/subfolder/login?returnurl=' . urlencode('http://shaarli/subfolder/path'), | ||
133 | $result->getHeader('location')[0] | ||
134 | ); | ||
135 | } | ||
136 | |||
137 | /** | ||
138 | * Test middleware execution with controller throwing a not authorized exception. | ||
139 | * The exception should be thrown to be later handled by the error handler. | ||
140 | */ | ||
141 | public function testMiddlewareExecutionWithServerException(): void | ||
142 | { | ||
143 | $request = $this->createMock(Request::class); | ||
144 | $request->method('getUri')->willReturnCallback(function (): Uri { | ||
145 | $uri = $this->createMock(Uri::class); | ||
146 | $uri->method('getBasePath')->willReturn('/subfolder'); | ||
147 | |||
148 | return $uri; | ||
149 | }); | ||
150 | |||
151 | $dummyException = new class() extends \Exception {}; | ||
152 | |||
153 | $response = new Response(); | ||
154 | $controller = function () use ($dummyException): void { | ||
155 | throw $dummyException; | ||
156 | }; | ||
157 | |||
158 | $parameters = []; | ||
159 | $this->container->pageBuilder = $this->createMock(PageBuilder::class); | ||
160 | $this->container->pageBuilder->method('render')->willReturnCallback(function (string $message): string { | ||
161 | return $message; | ||
162 | }); | ||
163 | $this->container->pageBuilder | ||
164 | ->method('assign') | ||
165 | ->willReturnCallback(function (string $key, string $value) use (&$parameters): void { | ||
166 | $parameters[$key] = $value; | ||
167 | }) | ||
168 | ; | ||
169 | |||
170 | $this->expectException(get_class($dummyException)); | ||
171 | |||
172 | $this->middleware->__invoke($request, $response, $controller); | ||
173 | } | ||
174 | |||
175 | public function testMiddlewareExecutionWithUpdates(): void | ||
176 | { | ||
177 | $request = $this->createMock(Request::class); | ||
178 | $request->method('getUri')->willReturnCallback(function (): Uri { | ||
179 | $uri = $this->createMock(Uri::class); | ||
180 | $uri->method('getBasePath')->willReturn('/subfolder'); | ||
181 | |||
182 | return $uri; | ||
183 | }); | ||
184 | |||
185 | $response = new Response(); | ||
186 | $controller = function (Request $request, Response $response): Response { | ||
187 | return $response->withStatus(418); // I'm a tea pot | ||
188 | }; | ||
189 | |||
190 | $this->container->loginManager = $this->createMock(LoginManager::class); | ||
191 | $this->container->loginManager->method('isLoggedIn')->willReturn(true); | ||
192 | |||
193 | $this->container->conf = $this->createMock(ConfigManager::class); | ||
194 | $this->container->conf->method('get')->willReturnCallback(function (string $key): string { | ||
195 | return $key; | ||
196 | }); | ||
197 | $this->container->conf->method('getConfigFileExt')->willReturn(static::TMP_MOCK_FILE); | ||
198 | |||
199 | $this->container->pageCacheManager = $this->createMock(PageCacheManager::class); | ||
200 | $this->container->pageCacheManager->expects(static::once())->method('invalidateCaches'); | ||
201 | |||
202 | $this->container->updater = $this->createMock(Updater::class); | ||
203 | $this->container->updater | ||
204 | ->expects(static::once()) | ||
205 | ->method('update') | ||
206 | ->willReturn(['update123']) | ||
207 | ; | ||
208 | $this->container->updater->method('getDoneUpdates')->willReturn($updates = ['update123', 'other']); | ||
209 | $this->container->updater | ||
210 | ->expects(static::once()) | ||
211 | ->method('writeUpdates') | ||
212 | ->with('resource.updates', $updates) | ||
213 | ; | ||
62 | 214 | ||
63 | /** @var Response $result */ | 215 | /** @var Response $result */ |
64 | $result = $this->middleware->__invoke($request, $response, $controller); | 216 | $result = $this->middleware->__invoke($request, $response, $controller); |
65 | 217 | ||
66 | static::assertInstanceOf(Response::class, $result); | 218 | static::assertInstanceOf(Response::class, $result); |
67 | static::assertSame(401, $result->getStatusCode()); | 219 | static::assertSame(418, $result->getStatusCode()); |
68 | static::assertContains('error', (string) $result->getBody()); | ||
69 | } | 220 | } |
70 | } | 221 | } |