3 declare(strict_types
=1);
5 namespace Shaarli\Front\Controller\Admin\ManageShaareControllerTest
;
7 use PHPUnit\Framework\TestCase
;
8 use Shaarli\Bookmark\Bookmark
;
9 use Shaarli\Config\ConfigManager
;
10 use Shaarli\Front\Controller\Admin\FrontAdminControllerMockHelper
;
11 use Shaarli\Front\Controller\Admin\ManageShaareController
;
12 use Shaarli\Front\Exception\WrongTokenException
;
13 use Shaarli\Http\HttpAccess
;
14 use Shaarli\Security\SessionManager
;
15 use Shaarli\Thumbnailer
;
16 use Slim\Http\Request
;
17 use Slim\Http\Response
;
19 class SaveBookmarkTest
extends TestCase
21 use FrontAdminControllerMockHelper
;
23 /** @var ManageShaareController */
24 protected $controller;
26 public function setUp(): void
28 $this->createContainer();
30 $this->container
->httpAccess
= $this->createMock(HttpAccess
::class);
31 $this->controller
= new ManageShaareController($this->container
);
35 * Test save a new bookmark
37 public function testSaveBookmark(): void
41 'lf_url' => 'http://url.tld/other?part=3#hash',
42 'lf_title' => 'Provided Title',
43 'lf_description' => 'Provided description.',
44 'lf_tags' => 'abc def',
46 'returnurl' => 'http://shaarli.tld/subfolder/admin/add-shaare'
49 $request = $this->createMock(Request
::class);
52 ->willReturnCallback(function (string $key) use ($parameters): ?string {
53 return $parameters[$key] ?? null;
56 $response = new Response();
58 $checkBookmark = function (Bookmark
$bookmark) use ($parameters) {
59 static::assertSame($parameters['lf_url'], $bookmark->getUrl());
60 static::assertSame($parameters['lf_title'], $bookmark->getTitle());
61 static::assertSame($parameters['lf_description'], $bookmark->getDescription());
62 static::assertSame($parameters['lf_tags'], $bookmark->getTagsString());
63 static::assertTrue($bookmark->isPrivate());
66 $this->container
->bookmarkService
67 ->expects(static::once())
69 ->willReturnCallback(function (Bookmark
$bookmark, bool $save) use ($checkBookmark, $id): void {
70 static::assertFalse($save);
72 $checkBookmark($bookmark);
74 $bookmark->setId($id);
77 $this->container
->bookmarkService
78 ->expects(static::once())
80 ->willReturnCallback(function (Bookmark
$bookmark, bool $save) use ($checkBookmark, $id): void {
81 static::assertTrue($save);
83 $checkBookmark($bookmark);
85 static::assertSame($id, $bookmark->getId());
89 // Make sure that PluginManager hook is triggered
90 $this->container
->pluginManager
91 ->expects(static::at(0))
92 ->method('executeHooks')
93 ->willReturnCallback(function (string $hook, array $data) use ($parameters, $id): array {
94 static::assertSame('save_link', $hook);
96 static::assertSame($id, $data['id']);
97 static::assertSame($parameters['lf_url'], $data['url']);
98 static::assertSame($parameters['lf_title'], $data['title']);
99 static::assertSame($parameters['lf_description'], $data['description']);
100 static::assertSame($parameters['lf_tags'], $data['tags']);
101 static::assertTrue($data['private']);
107 $result = $this->controller
->save($request, $response);
109 static::assertSame(302, $result->getStatusCode());
110 static::assertRegExp('@/subfolder/#[\w\-]{6}@', $result->getHeader('location')[0]);
115 * Test save an existing bookmark
117 public function testSaveExistingBookmark(): void
121 'lf_id' => (string) $id,
122 'lf_url' => 'http://url.tld/other?part=3#hash',
123 'lf_title' => 'Provided Title',
124 'lf_description' => 'Provided description.',
125 'lf_tags' => 'abc def',
127 'returnurl' => 'http://shaarli.tld/subfolder/?page=2'
130 $request = $this->createMock(Request
::class);
133 ->willReturnCallback(function (string $key) use ($parameters): ?string {
134 return $parameters[$key] ?? null;
137 $response = new Response();
139 $checkBookmark = function (Bookmark
$bookmark) use ($parameters, $id) {
140 static::assertSame($id, $bookmark->getId());
141 static::assertSame($parameters['lf_url'], $bookmark->getUrl());
142 static::assertSame($parameters['lf_title'], $bookmark->getTitle());
143 static::assertSame($parameters['lf_description'], $bookmark->getDescription());
144 static::assertSame($parameters['lf_tags'], $bookmark->getTagsString());
145 static::assertTrue($bookmark->isPrivate());
148 $this->container
->bookmarkService
->expects(static::atLeastOnce())->method('exists')->willReturn(true);
149 $this->container
->bookmarkService
150 ->expects(static::once())
152 ->willReturn((new Bookmark())->setId($id)->setUrl('http://other.url'))
154 $this->container
->bookmarkService
155 ->expects(static::once())
157 ->willReturnCallback(function (Bookmark
$bookmark, bool $save) use ($checkBookmark, $id): void {
158 static::assertFalse($save);
160 $checkBookmark($bookmark);
163 $this->container
->bookmarkService
164 ->expects(static::once())
166 ->willReturnCallback(function (Bookmark
$bookmark, bool $save) use ($checkBookmark, $id): void {
167 static::assertTrue($save);
169 $checkBookmark($bookmark);
171 static::assertSame($id, $bookmark->getId());
175 // Make sure that PluginManager hook is triggered
176 $this->container
->pluginManager
177 ->expects(static::at(0))
178 ->method('executeHooks')
179 ->willReturnCallback(function (string $hook, array $data) use ($parameters, $id): array {
180 static::assertSame('save_link', $hook);
182 static::assertSame($id, $data['id']);
183 static::assertSame($parameters['lf_url'], $data['url']);
184 static::assertSame($parameters['lf_title'], $data['title']);
185 static::assertSame($parameters['lf_description'], $data['description']);
186 static::assertSame($parameters['lf_tags'], $data['tags']);
187 static::assertTrue($data['private']);
193 $result = $this->controller
->save($request, $response);
195 static::assertSame(302, $result->getStatusCode());
196 static::assertRegExp('@/subfolder/\?page=2#[\w\-]{6}@', $result->getHeader('location')[0]);
200 * Test save a bookmark - try to retrieve the thumbnail
202 public function testSaveBookmarkWithThumbnail(): void
204 $parameters = ['lf_url' => 'http://url.tld/other?part=3#hash'];
206 $request = $this->createMock(Request
::class);
209 ->willReturnCallback(function (string $key) use ($parameters): ?string {
210 return $parameters[$key] ?? null;
213 $response = new Response();
215 $this->container
->conf
= $this->createMock(ConfigManager
::class);
216 $this->container
->conf
->method('get')->willReturnCallback(function (string $key, $default) {
217 return $key === 'thumbnails.mode' ? Thumbnailer
::MODE_ALL
: $default;
220 $this->container
->thumbnailer
= $this->createMock(Thumbnailer
::class);
221 $this->container
->thumbnailer
222 ->expects(static::once())
224 ->with($parameters['lf_url'])
225 ->willReturn($thumb = 'http://thumb.url')
228 $this->container
->bookmarkService
229 ->expects(static::once())
231 ->willReturnCallback(function (Bookmark
$bookmark, bool $save) use ($thumb): void {
232 static::assertSame($thumb, $bookmark->getThumbnail());
236 $result = $this->controller
->save($request, $response);
238 static::assertSame(302, $result->getStatusCode());
242 * Change the password with a wrong existing password
244 public function testSaveBookmarkFromBookmarklet(): void
246 $parameters = ['source' => 'bookmarklet'];
248 $request = $this->createMock(Request
::class);
251 ->willReturnCallback(function (string $key) use ($parameters): ?string {
252 return $parameters[$key] ?? null;
255 $response = new Response();
257 $result = $this->controller
->save($request, $response);
259 static::assertSame(200, $result->getStatusCode());
260 static::assertSame('<script>self.close();</script>', (string) $result->getBody());
264 * Change the password with a wrong existing password
266 public function testSaveBookmarkWrongToken(): void
268 $this->container
->sessionManager
= $this->createMock(SessionManager
::class);
269 $this->container
->sessionManager
->method('checkToken')->willReturn(false);
271 $this->container
->bookmarkService
->expects(static::never())->method('addOrSet');
272 $this->container
->bookmarkService
->expects(static::never())->method('set');
274 $request = $this->createMock(Request
::class);
275 $response = new Response();
277 $this->expectException(WrongTokenException
::class);
279 $this->controller
->save($request, $response);