namespace Shaarli\Front;
-use PHPUnit\Framework\TestCase;
use Shaarli\Config\ConfigManager;
use Shaarli\Container\ShaarliContainer;
use Shaarli\Front\Exception\LoginBannedException;
+use Shaarli\Front\Exception\UnauthorizedException;
use Shaarli\Render\PageBuilder;
+use Shaarli\Render\PageCacheManager;
+use Shaarli\Security\LoginManager;
+use Shaarli\TestCase;
+use Shaarli\Updater\Updater;
use Slim\Http\Request;
use Slim\Http\Response;
+use Slim\Http\Uri;
class ShaarliMiddlewareTest extends TestCase
{
+ protected const TMP_MOCK_FILE = '.tmp';
+
/** @var ShaarliContainer */
protected $container;
public function setUp(): void
{
$this->container = $this->createMock(ShaarliContainer::class);
+
+ touch(static::TMP_MOCK_FILE);
+
+ $this->container->conf = $this->createMock(ConfigManager::class);
+ $this->container->conf->method('getConfigFileExt')->willReturn(static::TMP_MOCK_FILE);
+
+ $this->container->loginManager = $this->createMock(LoginManager::class);
+
+ $this->container->environment = ['REQUEST_URI' => 'http://shaarli/subfolder/path'];
+
$this->middleware = new ShaarliMiddleware($this->container);
}
+ public function tearDown(): void
+ {
+ unlink(static::TMP_MOCK_FILE);
+ }
+
+ /**
+ * Test middleware execution with valid controller call
+ */
public function testMiddlewareExecution(): void
{
$request = $this->createMock(Request::class);
+ $request->method('getUri')->willReturnCallback(function (): Uri {
+ $uri = $this->createMock(Uri::class);
+ $uri->method('getBasePath')->willReturn('/subfolder');
+
+ return $uri;
+ });
+
$response = new Response();
$controller = function (Request $request, Response $response): Response {
return $response->withStatus(418); // I'm a tea pot
static::assertSame(418, $result->getStatusCode());
}
- public function testMiddlewareExecutionWithException(): void
+ /**
+ * Test middleware execution with controller throwing a known front exception.
+ * The exception should be thrown to be later handled by the error handler.
+ */
+ public function testMiddlewareExecutionWithFrontException(): void
{
$request = $this->createMock(Request::class);
+ $request->method('getUri')->willReturnCallback(function (): Uri {
+ $uri = $this->createMock(Uri::class);
+ $uri->method('getBasePath')->willReturn('/subfolder');
+
+ return $uri;
+ });
+
$response = new Response();
$controller = function (): void {
$exception = new LoginBannedException();
});
$this->container->pageBuilder = $pageBuilder;
- $conf = $this->createMock(ConfigManager::class);
- $this->container->conf = $conf;
+ $this->expectException(LoginBannedException::class);
+
+ $this->middleware->__invoke($request, $response, $controller);
+ }
+
+ /**
+ * Test middleware execution with controller throwing a not authorized exception
+ * The middle should send a redirection response to the login page.
+ */
+ public function testMiddlewareExecutionWithUnauthorizedException(): void
+ {
+ $request = $this->createMock(Request::class);
+ $request->method('getUri')->willReturnCallback(function (): Uri {
+ $uri = $this->createMock(Uri::class);
+ $uri->method('getBasePath')->willReturn('/subfolder');
+
+ return $uri;
+ });
+
+ $response = new Response();
+ $controller = function (): void {
+ throw new UnauthorizedException();
+ };
+
+ /** @var Response $result */
+ $result = $this->middleware->__invoke($request, $response, $controller);
+
+ static::assertSame(302, $result->getStatusCode());
+ static::assertSame(
+ '/subfolder/login?returnurl=' . urlencode('http://shaarli/subfolder/path'),
+ $result->getHeader('location')[0]
+ );
+ }
+
+ /**
+ * Test middleware execution with controller throwing a not authorized exception.
+ * The exception should be thrown to be later handled by the error handler.
+ */
+ public function testMiddlewareExecutionWithServerException(): void
+ {
+ $request = $this->createMock(Request::class);
+ $request->method('getUri')->willReturnCallback(function (): Uri {
+ $uri = $this->createMock(Uri::class);
+ $uri->method('getBasePath')->willReturn('/subfolder');
+
+ return $uri;
+ });
+
+ $dummyException = new class() extends \Exception {};
+
+ $response = new Response();
+ $controller = function () use ($dummyException): void {
+ throw $dummyException;
+ };
+
+ $parameters = [];
+ $this->container->pageBuilder = $this->createMock(PageBuilder::class);
+ $this->container->pageBuilder->method('render')->willReturnCallback(function (string $message): string {
+ return $message;
+ });
+ $this->container->pageBuilder
+ ->method('assign')
+ ->willReturnCallback(function (string $key, string $value) use (&$parameters): void {
+ $parameters[$key] = $value;
+ })
+ ;
+
+ $this->expectException(get_class($dummyException));
+
+ $this->middleware->__invoke($request, $response, $controller);
+ }
+
+ public function testMiddlewareExecutionWithUpdates(): void
+ {
+ $request = $this->createMock(Request::class);
+ $request->method('getUri')->willReturnCallback(function (): Uri {
+ $uri = $this->createMock(Uri::class);
+ $uri->method('getBasePath')->willReturn('/subfolder');
+
+ return $uri;
+ });
+
+ $response = new Response();
+ $controller = function (Request $request, Response $response): Response {
+ return $response->withStatus(418); // I'm a tea pot
+ };
+
+ $this->container->loginManager = $this->createMock(LoginManager::class);
+ $this->container->loginManager->method('isLoggedIn')->willReturn(true);
+
+ $this->container->conf = $this->createMock(ConfigManager::class);
+ $this->container->conf->method('get')->willReturnCallback(function (string $key): string {
+ return $key;
+ });
+ $this->container->conf->method('getConfigFileExt')->willReturn(static::TMP_MOCK_FILE);
+
+ $this->container->pageCacheManager = $this->createMock(PageCacheManager::class);
+ $this->container->pageCacheManager->expects(static::once())->method('invalidateCaches');
+
+ $this->container->updater = $this->createMock(Updater::class);
+ $this->container->updater
+ ->expects(static::once())
+ ->method('update')
+ ->willReturn(['update123'])
+ ;
+ $this->container->updater->method('getDoneUpdates')->willReturn($updates = ['update123', 'other']);
+ $this->container->updater
+ ->expects(static::once())
+ ->method('writeUpdates')
+ ->with('resource.updates', $updates)
+ ;
/** @var Response $result */
$result = $this->middleware->__invoke($request, $response, $controller);
static::assertInstanceOf(Response::class, $result);
- static::assertSame(401, $result->getStatusCode());
- static::assertContains('error', (string) $result->getBody());
+ static::assertSame(418, $result->getStatusCode());
}
}