BookStack Code Mirror - bookstack/blob - tests/Entity/BookShelfTest.php

1 <?php

2

3 namespace Tests\Entity;

4

5 use BookStack\Entities\Models\Book;

6 use BookStack\Entities\Models\Bookshelf;

7 use BookStack\Uploads\Image;

8 use BookStack\Users\Models\User;

9 use Illuminate\Support\Str;

10 use Tests\TestCase;

11

12 class BookShelfTest extends TestCase

13 {

14 public function test_shelves_shows_in_header_if_have_view_permissions()

15 {

16 $viewer = $this->users->viewer();

17 $resp = $this->actingAs($viewer)->get('/');

18 $this->withHtml($resp)->assertElementContains('header', 'Shelves');

19

20 $viewer->roles()->delete();

21 $this->permissions->grantUserRolePermissions($viewer, []);

22 $resp = $this->actingAs($viewer)->get('/');

23 $this->withHtml($resp)->assertElementNotContains('header', 'Shelves');

24

25 $this->permissions->grantUserRolePermissions($viewer, ['bookshelf-view-all']);

26 $resp = $this->actingAs($viewer)->get('/');

27 $this->withHtml($resp)->assertElementContains('header', 'Shelves');

28

29 $viewer->roles()->delete();

30 $this->permissions->grantUserRolePermissions($viewer, ['bookshelf-view-own']);

31 $resp = $this->actingAs($viewer)->get('/');

32 $this->withHtml($resp)->assertElementContains('header', 'Shelves');

33 }

34

35 public function test_shelves_shows_in_header_if_have_any_shelve_view_permission()

36 {

37 $user = User::factory()->create();

38 $this->permissions->grantUserRolePermissions($user, ['image-create-all']);

39 $shelf = $this->entities->shelf();

40 $userRole = $user->roles()->first();

41

42 $resp = $this->actingAs($user)->get('/');

43 $this->withHtml($resp)->assertElementNotContains('header', 'Shelves');

44

45 $this->permissions->setEntityPermissions($shelf, ['view'], [$userRole]);

46

47 $resp = $this->get('/');

48 $this->withHtml($resp)->assertElementContains('header', 'Shelves');

49 }

50

51 public function test_shelves_page_contains_create_link()

52 {

53 $resp = $this->asEditor()->get('/shelves');

54 $this->withHtml($resp)->assertElementContains('a', 'New Shelf');

55 }

56

57 public function test_book_not_visible_in_shelf_list_view_if_user_cant_view_shelf()

58 {

59 config()->set([

60 'setting-defaults.user.bookshelves_view_type' => 'list',

61 ]);

62 $shelf = $this->entities->shelf();

63 $book = $shelf->books()->first();

64

65 $resp = $this->asEditor()->get('/shelves');

66 $resp->assertSee($book->name);

67 $resp->assertSee($book->getUrl());

68

69 $this->permissions->setEntityPermissions($book, []);

70

71 $resp = $this->asEditor()->get('/shelves');

72 $resp->assertDontSee($book->name);

73 $resp->assertDontSee($book->getUrl());

74 }

75

76 public function test_shelves_create()

77 {

78 $booksToInclude = Book::take(2)->get();

79 $shelfInfo = [

80 'name' => 'My test book' . Str::random(4),

81 'description' => 'Test book description ' . Str::random(10),

82 ];

83 $resp = $this->asEditor()->post('/shelves', array_merge($shelfInfo, [

84 'books' => $booksToInclude->implode('id', ','),

85 'tags' => [

86 [

87 'name' => 'Test Category',

88 'value' => 'Test Tag Value',

89 ],

90 ],

91 ]));

92 $resp->assertRedirect();

93 $editorId = $this->users->editor()->id;

94 $this->assertDatabaseHas('bookshelves', array_merge($shelfInfo, ['created_by' => $editorId, 'updated_by' => $editorId]));

95

96 $shelf = Bookshelf::where('name', '=', $shelfInfo['name'])->first();

97 $shelfPage = $this->get($shelf->getUrl());

98 $shelfPage->assertSee($shelfInfo['name']);

99 $shelfPage->assertSee($shelfInfo['description']);

100 $this->withHtml($shelfPage)->assertElementContains('.tag-item', 'Test Category');

101 $this->withHtml($shelfPage)->assertElementContains('.tag-item', 'Test Tag Value');

102

103 $this->assertDatabaseHas('bookshelves_books', ['bookshelf_id' => $shelf->id, 'book_id' => $booksToInclude[0]->id]);

104 $this->assertDatabaseHas('bookshelves_books', ['bookshelf_id' => $shelf->id, 'book_id' => $booksToInclude[1]->id]);

105 }

106

107 public function test_shelves_create_sets_cover_image()

108 {

109 $shelfInfo = [

110 'name' => 'My test book' . Str::random(4),

111 'description' => 'Test book description ' . Str::random(10),

112 ];

113

114 $imageFile = $this->files->uploadedImage('shelf-test.png');

115 $resp = $this->asEditor()->call('POST', '/shelves', $shelfInfo, [], ['image' => $imageFile]);

116 $resp->assertRedirect();

117

118 $lastImage = Image::query()->orderByDesc('id')->firstOrFail();

119 $shelf = Bookshelf::query()->where('name', '=', $shelfInfo['name'])->first();

120 $this->assertDatabaseHas('bookshelves', [

121 'id' => $shelf->id,

122 'image_id' => $lastImage->id,

123 ]);

124 $this->assertEquals($lastImage->id, $shelf->cover->id);

125 $this->assertEquals('cover_bookshelf', $lastImage->type);

126 }

127

128 public function test_shelf_view()

129 {

130 $shelf = $this->entities->shelf();

131 $resp = $this->asEditor()->get($shelf->getUrl());

132 $resp->assertStatus(200);

133 $resp->assertSeeText($shelf->name);

134 $resp->assertSeeText($shelf->description);

135

136 foreach ($shelf->books as $book) {

137 $resp->assertSee($book->name);

138 }

139 }

140

141 public function test_shelf_view_shows_action_buttons()

142 {

143 $shelf = $this->entities->shelf();

144 $resp = $this->asAdmin()->get($shelf->getUrl());

145 $resp->assertSee($shelf->getUrl('/create-book'));

146 $resp->assertSee($shelf->getUrl('/edit'));

147 $resp->assertSee($shelf->getUrl('/permissions'));

148 $resp->assertSee($shelf->getUrl('/delete'));

149 $this->withHtml($resp)->assertElementContains('a', 'New Book');

150 $this->withHtml($resp)->assertElementContains('a', 'Edit');

151 $this->withHtml($resp)->assertElementContains('a', 'Permissions');

152 $this->withHtml($resp)->assertElementContains('a', 'Delete');

153

154 $resp = $this->asEditor()->get($shelf->getUrl());

155 $resp->assertDontSee($shelf->getUrl('/permissions'));

156 }

157

158 public function test_shelf_view_has_sort_control_that_defaults_to_default()

159 {

160 $shelf = $this->entities->shelf();

161 $resp = $this->asAdmin()->get($shelf->getUrl());

162 $this->withHtml($resp)->assertElementExists('form[action$="change-sort/shelf_books"]');

163 $this->withHtml($resp)->assertElementContains('form[action$="change-sort/shelf_books"] [aria-haspopup="true"]', 'Default');

164 }

165

166 public function test_shelf_view_sort_takes_action()

167 {

168 $shelf = Bookshelf::query()->whereHas('books')->with('books')->first();

169 $books = Book::query()->take(3)->get(['id', 'name']);

170 $books[0]->fill(['name' => 'bsfsdfsdfsd'])->save();

171 $books[1]->fill(['name' => 'adsfsdfsdfsd'])->save();

172 $books[2]->fill(['name' => 'hdgfgdfg'])->save();

173

174 // Set book ordering

175 $this->asAdmin()->put($shelf->getUrl(), [

176 'books' => $books->implode('id', ','),

177 'tags' => [], 'description' => 'abc', 'name' => 'abc',

178 ]);

179 $this->assertEquals(3, $shelf->books()->count());

180 $shelf->refresh();

181

182 $resp = $this->asEditor()->get($shelf->getUrl());

183 $this->withHtml($resp)->assertElementContains('.book-content a.grid-card:nth-child(1)', $books[0]->name);

184 $this->withHtml($resp)->assertElementNotContains('.book-content a.grid-card:nth-child(3)', $books[0]->name);

185

186 setting()->putUser($this->users->editor(), 'shelf_books_sort_order', 'desc');

187 $resp = $this->asEditor()->get($shelf->getUrl());

188 $this->withHtml($resp)->assertElementNotContains('.book-content a.grid-card:nth-child(1)', $books[0]->name);

189 $this->withHtml($resp)->assertElementContains('.book-content a.grid-card:nth-child(3)', $books[0]->name);

190

191 setting()->putUser($this->users->editor(), 'shelf_books_sort_order', 'desc');

192 setting()->putUser($this->users->editor(), 'shelf_books_sort', 'name');

193 $resp = $this->asEditor()->get($shelf->getUrl());

194 $this->withHtml($resp)->assertElementContains('.book-content a.grid-card:nth-child(1)', 'hdgfgdfg');

195 $this->withHtml($resp)->assertElementContains('.book-content a.grid-card:nth-child(2)', 'bsfsdfsdfsd');

196 $this->withHtml($resp)->assertElementContains('.book-content a.grid-card:nth-child(3)', 'adsfsdfsdfsd');

197 }

198

199 public function test_shelf_edit()

200 {

201 $shelf = $this->entities->shelf();

202 $resp = $this->asEditor()->get($shelf->getUrl('/edit'));

203 $resp->assertSeeText('Edit Shelf');

204

205 $booksToInclude = Book::take(2)->get();

206 $shelfInfo = [

207 'name' => 'My test book' . Str::random(4),

208 'description' => 'Test book description ' . Str::random(10),

209 ];

210

211 $resp = $this->asEditor()->put($shelf->getUrl(), array_merge($shelfInfo, [

212 'books' => $booksToInclude->implode('id', ','),

213 'tags' => [

214 [

215 'name' => 'Test Category',

216 'value' => 'Test Tag Value',

217 ],

218 ],

219 ]));

220 $shelf = Bookshelf::find($shelf->id);

221 $resp->assertRedirect($shelf->getUrl());

222 $this->assertSessionHas('success');

223

224 $editorId = $this->users->editor()->id;

225 $this->assertDatabaseHas('bookshelves', array_merge($shelfInfo, ['id' => $shelf->id, 'created_by' => $editorId, 'updated_by' => $editorId]));

226

227 $shelfPage = $this->get($shelf->getUrl());

228 $shelfPage->assertSee($shelfInfo['name']);

229 $shelfPage->assertSee($shelfInfo['description']);

230 $this->withHtml($shelfPage)->assertElementContains('.tag-item', 'Test Category');

231 $this->withHtml($shelfPage)->assertElementContains('.tag-item', 'Test Tag Value');

232

233 $this->assertDatabaseHas('bookshelves_books', ['bookshelf_id' => $shelf->id, 'book_id' => $booksToInclude[0]->id]);

234 $this->assertDatabaseHas('bookshelves_books', ['bookshelf_id' => $shelf->id, 'book_id' => $booksToInclude[1]->id]);

235 }

236

237 public function test_shelf_create_new_book()

238 {

239 $shelf = $this->entities->shelf();

240 $resp = $this->asEditor()->get($shelf->getUrl('/create-book'));

241

242 $resp->assertSee('Create New Book');

243 $resp->assertSee($shelf->getShortName());

244

245 $testName = 'Test Book in Shelf Name';

246

247 $createBookResp = $this->asEditor()->post($shelf->getUrl('/create-book'), [

248 'name' => $testName,

249 'description' => 'Book in shelf description',

250 ]);

251 $createBookResp->assertRedirect();

252

253 $newBook = Book::query()->orderBy('id', 'desc')->first();

254 $this->assertDatabaseHas('bookshelves_books', [

255 'bookshelf_id' => $shelf->id,

256 'book_id' => $newBook->id,

257 ]);

258

259 $resp = $this->asEditor()->get($shelf->getUrl());

260 $resp->assertSee($testName);

261 }

262

263 public function test_shelf_delete()

264 {

265 $shelf = Bookshelf::query()->whereHas('books')->first();

266 $this->assertNull($shelf->deleted_at);

267 $bookCount = $shelf->books()->count();

268

269 $deleteViewReq = $this->asEditor()->get($shelf->getUrl('/delete'));

270 $deleteViewReq->assertSeeText('Are you sure you want to delete this shelf?');

271

272 $deleteReq = $this->delete($shelf->getUrl());

273 $deleteReq->assertRedirect(url('/shelves'));

274 $this->assertActivityExists('bookshelf_delete', $shelf);

275

276 $shelf->refresh();

277 $this->assertNotNull($shelf->deleted_at);

278

279 $this->assertTrue($shelf->books()->count() === $bookCount);

280 $this->assertTrue($shelf->deletions()->count() === 1);

281

282 $redirectReq = $this->get($deleteReq->baseResponse->headers->get('location'));

283 $this->assertNotificationContains($redirectReq, 'Shelf Successfully Deleted');

284 }

285

286 public function test_shelf_copy_permissions()

287 {

288 $shelf = $this->entities->shelf();

289 $resp = $this->asAdmin()->get($shelf->getUrl('/permissions'));

290 $resp->assertSeeText('Copy Permissions');

291 $resp->assertSee("action=\"{$shelf->getUrl('/copy-permissions')}\"", false);

292

293 $child = $shelf->books()->first();

294 $editorRole = $this->users->editor()->roles()->first();

295 $this->assertFalse($child->hasPermissions(), 'Child book should not be restricted by default');

296 $this->assertTrue($child->permissions()->count() === 0, 'Child book should have no permissions by default');

297

298 $this->permissions->setEntityPermissions($shelf, ['view', 'update'], [$editorRole]);

299 $resp = $this->post($shelf->getUrl('/copy-permissions'));

300 $child = $shelf->books()->first();

301

302 $resp->assertRedirect($shelf->getUrl());

303 $this->assertTrue($child->hasPermissions(), 'Child book should now be restricted');

304 $this->assertTrue($child->permissions()->count() === 2, 'Child book should have copied permissions');

305 $this->assertDatabaseHas('entity_permissions', [

306 'entity_type' => 'book',

307 'entity_id' => $child->id,

308 'role_id' => $editorRole->id,

309 'view' => true, 'update' => true, 'create' => false, 'delete' => false,

310 ]);

311 }

312

313 public function test_permission_page_has_a_warning_about_no_cascading()

314 {

315 $shelf = $this->entities->shelf();

316 $resp = $this->asAdmin()->get($shelf->getUrl('/permissions'));

317 $resp->assertSeeText('Permissions on shelves do not automatically cascade to contained books.');

318 }

319

320 public function test_bookshelves_show_in_breadcrumbs_if_in_context()

321 {

322 $shelf = $this->entities->shelf();

323 $shelfBook = $shelf->books()->first();

324 $shelfPage = $shelfBook->pages()->first();

325 $this->asAdmin();

326

327 $bookVisit = $this->get($shelfBook->getUrl());

328 $this->withHtml($bookVisit)->assertElementNotContains('.breadcrumbs', 'Shelves');

329 $this->withHtml($bookVisit)->assertElementNotContains('.breadcrumbs', $shelf->getShortName());

330

331 $this->get($shelf->getUrl());

332 $bookVisit = $this->get($shelfBook->getUrl());

333 $this->withHtml($bookVisit)->assertElementContains('.breadcrumbs', 'Shelves');

334 $this->withHtml($bookVisit)->assertElementContains('.breadcrumbs', $shelf->getShortName());

335

336 $pageVisit = $this->get($shelfPage->getUrl());

337 $this->withHtml($pageVisit)->assertElementContains('.breadcrumbs', 'Shelves');

338 $this->withHtml($pageVisit)->assertElementContains('.breadcrumbs', $shelf->getShortName());

339

340 $this->get('/books');

341 $pageVisit = $this->get($shelfPage->getUrl());

342 $this->withHtml($pageVisit)->assertElementNotContains('.breadcrumbs', 'Shelves');

343 $this->withHtml($pageVisit)->assertElementNotContains('.breadcrumbs', $shelf->getShortName());

344 }

345

346 public function test_bookshelves_show_on_book()

347 {

348 // Create shelf

349 $shelfInfo = [

350 'name' => 'My test shelf' . Str::random(4),

351 'description' => 'Test shelf description ' . Str::random(10),

352 ];

353

354 $this->asEditor()->post('/shelves', $shelfInfo);

355 $shelf = Bookshelf::where('name', '=', $shelfInfo['name'])->first();

356

357 // Create book and add to shelf

358 $this->asEditor()->post($shelf->getUrl('/create-book'), [

359 'name' => 'Test book name',

360 'description' => 'Book in shelf description',

361 ]);

362

363 $newBook = Book::query()->orderBy('id', 'desc')->first();

364

365 $resp = $this->asEditor()->get($newBook->getUrl());

366 $this->withHtml($resp)->assertElementContains('.tri-layout-left-contents', $shelfInfo['name']);

367

368 // Remove shelf

369 $this->delete($shelf->getUrl());

370

371 $resp = $this->asEditor()->get($newBook->getUrl());

372 $resp->assertDontSee($shelfInfo['name']);

373 }

374

375 public function test_cancel_on_child_book_creation_returns_to_original_shelf()

376 {

377 $shelf = $this->entities->shelf();

378 $resp = $this->asEditor()->get($shelf->getUrl('/create-book'));

379 $this->withHtml($resp)->assertElementContains('form a[href="' . $shelf->getUrl() . '"]', 'Cancel');

380 }

381 }