tests/front/controller/admin/ShaarliAdminControllerTest.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace Shaarli\Front\Controller\Admin;
   6
   7 use Shaarli\Front\Exception\WrongTokenException;
   8 use Shaarli\Security\SessionManager;
   9 use Shaarli\TestCase;
  10 use Slim\Http\Request;
  11
  12 /**
  13  * Class ShaarliControllerTest
  14  *
  15  * This class is used to test default behavior of ShaarliAdminController abstract class.
  16  * It uses a dummy non abstract controller.
  17  */
  18 class ShaarliAdminControllerTest extends TestCase
  19 {
  20     use FrontAdminControllerMockHelper;
  21
  22     /** @var ShaarliAdminController */
  23     protected $controller;
  24
  25     public function setUp(): void
  26     {
  27         $this->createContainer();
  28
  29         $this->controller = new class($this->container) extends ShaarliAdminController
  30         {
  31             public function checkToken(Request $request): bool
  32             {
  33                 return parent::checkToken($request);
  34             }
  35
  36             public function saveSuccessMessage(string $message): void
  37             {
  38                 parent::saveSuccessMessage($message);
  39             }
  40
  41             public function saveWarningMessage(string $message): void
  42             {
  43                 parent::saveWarningMessage($message);
  44             }
  45
  46             public function saveErrorMessage(string $message): void
  47             {
  48                 parent::saveErrorMessage($message);
  49             }
  50         };
  51     }
  52
  53     /**
  54      * Trigger controller's checkToken with a valid token.
  55      */
  56     public function testCheckTokenWithValidToken(): void
  57     {
  58         $request = $this->createMock(Request::class);
  59         $request->method('getParam')->with('token')->willReturn($token = '12345');
  60
  61         $this->container->sessionManager = $this->createMock(SessionManager::class);
  62         $this->container->sessionManager->method('checkToken')->with($token)->willReturn(true);
  63
  64         static::assertTrue($this->controller->checkToken($request));
  65     }
  66
  67     /**
  68      * Trigger controller's checkToken with na valid token should raise an exception.
  69      */
  70     public function testCheckTokenWithNotValidToken(): void
  71     {
  72         $request = $this->createMock(Request::class);
  73         $request->method('getParam')->with('token')->willReturn($token = '12345');
  74
  75         $this->container->sessionManager = $this->createMock(SessionManager::class);
  76         $this->container->sessionManager->method('checkToken')->with($token)->willReturn(false);
  77
  78         $this->expectException(WrongTokenException::class);
  79
  80         $this->controller->checkToken($request);
  81     }
  82
  83     /**
  84      * Test saveSuccessMessage() with a first message.
  85      */
  86     public function testSaveSuccessMessage(): void
  87     {
  88         $this->container->sessionManager
  89             ->expects(static::once())
  90             ->method('setSessionParameter')
  91             ->with(SessionManager::KEY_SUCCESS_MESSAGES, [$message = 'bravo!'])
  92         ;
  93
  94         $this->controller->saveSuccessMessage($message);
  95     }
  96
  97     /**
  98      * Test saveSuccessMessage() with existing messages.
  99      */
 100     public function testSaveSuccessMessageWithExistingMessages(): void
 101     {
 102         $this->container->sessionManager
 103             ->expects(static::once())
 104             ->method('getSessionParameter')
 105             ->with(SessionManager::KEY_SUCCESS_MESSAGES)
 106             ->willReturn(['success1', 'success2'])
 107         ;
 108         $this->container->sessionManager
 109             ->expects(static::once())
 110             ->method('setSessionParameter')
 111             ->with(SessionManager::KEY_SUCCESS_MESSAGES, ['success1', 'success2', $message = 'bravo!'])
 112         ;
 113
 114         $this->controller->saveSuccessMessage($message);
 115     }
 116
 117     /**
 118      * Test saveWarningMessage() with a first message.
 119      */
 120     public function testSaveWarningMessage(): void
 121     {
 122         $this->container->sessionManager
 123             ->expects(static::once())
 124             ->method('setSessionParameter')
 125             ->with(SessionManager::KEY_WARNING_MESSAGES, [$message = 'warning!'])
 126         ;
 127
 128         $this->controller->saveWarningMessage($message);
 129     }
 130
 131     /**
 132      * Test saveWarningMessage() with existing messages.
 133      */
 134     public function testSaveWarningMessageWithExistingMessages(): void
 135     {
 136         $this->container->sessionManager
 137             ->expects(static::once())
 138             ->method('getSessionParameter')
 139             ->with(SessionManager::KEY_WARNING_MESSAGES)
 140             ->willReturn(['warning1', 'warning2'])
 141         ;
 142         $this->container->sessionManager
 143             ->expects(static::once())
 144             ->method('setSessionParameter')
 145             ->with(SessionManager::KEY_WARNING_MESSAGES, ['warning1', 'warning2', $message = 'warning!'])
 146         ;
 147
 148         $this->controller->saveWarningMessage($message);
 149     }
 150
 151     /**
 152      * Test saveErrorMessage() with a first message.
 153      */
 154     public function testSaveErrorMessage(): void
 155     {
 156         $this->container->sessionManager
 157             ->expects(static::once())
 158             ->method('setSessionParameter')
 159             ->with(SessionManager::KEY_ERROR_MESSAGES, [$message = 'error!'])
 160         ;
 161
 162         $this->controller->saveErrorMessage($message);
 163     }
 164
 165     /**
 166      * Test saveErrorMessage() with existing messages.
 167      */
 168     public function testSaveErrorMessageWithExistingMessages(): void
 169     {
 170         $this->container->sessionManager
 171             ->expects(static::once())
 172             ->method('getSessionParameter')
 173             ->with(SessionManager::KEY_ERROR_MESSAGES)
 174             ->willReturn(['error1', 'error2'])
 175         ;
 176         $this->container->sessionManager
 177             ->expects(static::once())
 178             ->method('setSessionParameter')
 179             ->with(SessionManager::KEY_ERROR_MESSAGES, ['error1', 'error2', $message = 'error!'])
 180         ;
 181
 182         $this->controller->saveErrorMessage($message);
 183     }
 184 }