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

   1 <?php namespace Tests\Entity;
   2
   3 use BookStack\Actions\Tag;
   4 use BookStack\Entities\Models\Book;
   5 use BookStack\Entities\Models\Bookshelf;
   6 use BookStack\Entities\Models\Chapter;
   7 use BookStack\Entities\Models\Page;
   8 use Tests\TestCase;
   9
  10 class EntitySearchTest extends TestCase
  11 {
  12
  13     public function test_page_search()
  14     {
  15         $book = Book::all()->first();
  16         $page = $book->pages->first();
  17
  18         $search = $this->asEditor()->get('/search?term=' . urlencode($page->name));
  19         $search->assertSee('Search Results');
  20         $search->assertSee($page->name);
  21     }
  22
  23     public function test_bookshelf_search()
  24     {
  25         $shelf = Bookshelf::first();
  26         $search = $this->asEditor()->get('/search?term=' . urlencode(mb_substr($shelf->name, 0, 3)) . '  {type:bookshelf}');
  27         $search->assertStatus(200);
  28         $search->assertSee($shelf->name);
  29     }
  30
  31     public function test_invalid_page_search()
  32     {
  33         $resp = $this->asEditor()->get('/search?term=' . urlencode('<p>test</p>'));
  34         $resp->assertSee('Search Results');
  35         $resp->assertStatus(200);
  36         $this->get('/search?term=cat+-')->assertStatus(200);
  37     }
  38
  39     public function test_empty_search_shows_search_page()
  40     {
  41         $res = $this->asEditor()->get('/search');
  42         $res->assertStatus(200);
  43     }
  44
  45     public function test_searching_accents_and_small_terms()
  46     {
  47         $page = $this->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéííúü¿¡ test content a2 orange dog']);
  48         $this->asEditor();
  49
  50         $accentSearch = $this->get('/search?term=' . urlencode('áéíí'));
  51         $accentSearch->assertStatus(200)->assertSee($page->name);
  52
  53         $smallSearch = $this->get('/search?term=' . urlencode('a2'));
  54         $smallSearch->assertStatus(200)->assertSee($page->name);
  55     }
  56
  57     public function test_book_search()
  58     {
  59         $book = Book::first();
  60         $page = $book->pages->last();
  61         $chapter = $book->chapters->last();
  62
  63         $pageTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($page->name));
  64         $pageTestResp->assertSee($page->name);
  65
  66         $chapterTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($chapter->name));
  67         $chapterTestResp->assertSee($chapter->name);
  68     }
  69
  70     public function test_chapter_search()
  71     {
  72         $chapter = Chapter::has('pages')->first();
  73         $page = $chapter->pages[0];
  74
  75         $pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name));
  76         $pageTestResp->assertSee($page->name);
  77     }
  78
  79     public function test_tag_search()
  80     {
  81         $newTags = [
  82             new Tag([
  83                 'name' => 'animal',
  84                 'value' => 'cat'
  85             ]),
  86             new Tag([
  87                 'name' => 'color',
  88                 'value' => 'red'
  89             ])
  90         ];
  91
  92         $pageA = Page::first();
  93         $pageA->tags()->saveMany($newTags);
  94
  95         $pageB = Page::all()->last();
  96         $pageB->tags()->create(['name' => 'animal', 'value' => 'dog']);
  97
  98         $this->asEditor();
  99         $tNameSearch = $this->get('/search?term=%5Banimal%5D');
 100         $tNameSearch->assertSee($pageA->name)->assertSee($pageB->name);
 101
 102         $tNameSearch2 = $this->get('/search?term=%5Bcolor%5D');
 103         $tNameSearch2->assertSee($pageA->name)->assertDontSee($pageB->name);
 104
 105         $tNameValSearch = $this->get('/search?term=%5Banimal%3Dcat%5D');
 106         $tNameValSearch->assertSee($pageA->name)->assertDontSee($pageB->name);
 107     }
 108
 109     public function test_exact_searches()
 110     {
 111         $page = $this->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']);
 112
 113         $exactSearchA = $this->asEditor()->get('/search?term=' . urlencode('"story about an orange"'));
 114         $exactSearchA->assertStatus(200)->assertSee($page->name);
 115
 116         $exactSearchB = $this->asEditor()->get('/search?term=' . urlencode('"story not about an orange"'));
 117         $exactSearchB->assertStatus(200)->assertDontSee($page->name);
 118     }
 119
 120     public function test_search_filters()
 121     {
 122         $page = $this->newPage(['name' => 'My new test quaffleachits', 'html' => 'this is about an orange donkey danzorbhsing']);
 123         $this->asEditor();
 124         $editorId = $this->getEditor()->id;
 125
 126         // Viewed filter searches
 127         $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertSee($page->name);
 128         $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertDontSee($page->name);
 129         $this->get($page->getUrl());
 130         $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertDontSee($page->name);
 131         $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertSee($page->name);
 132
 133         // User filters
 134         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertDontSee($page->name);
 135         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
 136         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 137         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:'.$editorId.'}'))->assertDontSee($page->name);
 138         $page->created_by = $editorId;
 139         $page->save();
 140         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertSee($page->name);
 141         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:'.$editorId.'}'))->assertSee($page->name);
 142         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
 143         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 144         $page->updated_by = $editorId;
 145         $page->save();
 146         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertSee($page->name);
 147         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:'.$editorId.'}'))->assertSee($page->name);
 148         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 149         $page->owned_by = $editorId;
 150         $page->save();
 151         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertSee($page->name);
 152         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:'.$editorId.'}'))->assertSee($page->name);
 153
 154         // Content filters
 155         $this->get('/search?term=' . urlencode('{in_name:danzorbhsing}'))->assertDontSee($page->name);
 156         $this->get('/search?term=' . urlencode('{in_body:danzorbhsing}'))->assertSee($page->name);
 157         $this->get('/search?term=' . urlencode('{in_name:test quaffleachits}'))->assertSee($page->name);
 158         $this->get('/search?term=' . urlencode('{in_body:test quaffleachits}'))->assertDontSee($page->name);
 159
 160         // Restricted filter
 161         $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertDontSee($page->name);
 162         $page->restricted = true;
 163         $page->save();
 164         $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertSee($page->name);
 165
 166         // Date filters
 167         $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertDontSee($page->name);
 168         $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertSee($page->name);
 169         $page->updated_at = '2037-02-01';
 170         $page->save();
 171         $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertSee($page->name);
 172         $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertDontSee($page->name);
 173
 174         $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertDontSee($page->name);
 175         $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertSee($page->name);
 176         $page->created_at = '2037-02-01';
 177         $page->save();
 178         $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertSee($page->name);
 179         $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertDontSee($page->name);
 180     }
 181
 182     public function test_ajax_entity_search()
 183     {
 184         $page = $this->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']);
 185         $notVisitedPage = Page::first();
 186
 187         // Visit the page to make popular
 188         $this->asEditor()->get($page->getUrl());
 189
 190         $normalSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
 191         $normalSearch->assertSee($page->name);
 192
 193         $bookSearch = $this->get('/ajax/search/entities?types=book&term=' . urlencode($page->name));
 194         $bookSearch->assertDontSee($page->name);
 195
 196         $defaultListTest = $this->get('/ajax/search/entities');
 197         $defaultListTest->assertSee($page->name);
 198         $defaultListTest->assertDontSee($notVisitedPage->name);
 199     }
 200
 201     public function test_ajax_entity_serach_shows_breadcrumbs()
 202     {
 203         $chapter = Chapter::first();
 204         $page = $chapter->pages->first();
 205         $this->asEditor();
 206
 207         $pageSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
 208         $pageSearch->assertSee($page->name);
 209         $pageSearch->assertSee($chapter->getShortName(42));
 210         $pageSearch->assertSee($page->book->getShortName(42));
 211
 212         $chapterSearch = $this->get('/ajax/search/entities?term=' . urlencode($chapter->name));
 213         $chapterSearch->assertSee($chapter->name);
 214         $chapterSearch->assertSee($chapter->book->getShortName(42));
 215     }
 216
 217     public function test_sibling_search_for_pages()
 218     {
 219         $chapter = Chapter::query()->with('pages')->first();
 220         $this->assertGreaterThan(2, count($chapter->pages), 'Ensure we\'re testing with at least 1 sibling');
 221         $page = $chapter->pages->first();
 222
 223         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
 224         $search->assertSuccessful();
 225         foreach ($chapter->pages as $page) {
 226             $search->assertSee($page->name);
 227         }
 228
 229         $search->assertDontSee($chapter->name);
 230     }
 231
 232     public function test_sibling_search_for_pages_without_chapter()
 233     {
 234         $page = Page::query()->where('chapter_id', '=', 0)->firstOrFail();
 235         $bookChildren = $page->book->getDirectChildren();
 236         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
 237
 238         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
 239         $search->assertSuccessful();
 240         foreach ($bookChildren as $child) {
 241             $search->assertSee($child->name);
 242         }
 243
 244         $search->assertDontSee($page->book->name);
 245     }
 246
 247     public function test_sibling_search_for_chapters()
 248     {
 249         $chapter = Chapter::query()->firstOrFail();
 250         $bookChildren = $chapter->book->getDirectChildren();
 251         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
 252
 253         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter");
 254         $search->assertSuccessful();
 255         foreach ($bookChildren as $child) {
 256             $search->assertSee($child->name);
 257         }
 258
 259         $search->assertDontSee($chapter->book->name);
 260     }
 261
 262     public function test_sibling_search_for_books()
 263     {
 264         $books = Book::query()->take(10)->get();
 265         $book = $books->first();
 266         $this->assertGreaterThan(2, count($books), 'Ensure we\'re testing with at least 1 sibling');
 267
 268         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book");
 269         $search->assertSuccessful();
 270         foreach ($books as $expectedBook) {
 271             $search->assertSee($expectedBook->name);
 272         }
 273     }
 274
 275     public function test_sibling_search_for_shelves()
 276     {
 277         $shelves = Bookshelf::query()->take(10)->get();
 278         $shelf = $shelves->first();
 279         $this->assertGreaterThan(2, count($shelves), 'Ensure we\'re testing with at least 1 sibling');
 280
 281         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf");
 282         $search->assertSuccessful();
 283         foreach ($shelves as $expectedShelf) {
 284             $search->assertSee($expectedShelf->name);
 285         }
 286     }
 287
 288     public function test_search_works_on_updated_page_content()
 289     {
 290         $page = Page::query()->first();
 291         $this->asEditor();
 292
 293         $update = $this->put($page->getUrl(), [
 294             'name' => $page->name,
 295             'html' => '<p>dog pandabearmonster spaghetti</p>',
 296         ]);
 297
 298         $search = $this->asEditor()->get('/search?term=pandabearmonster');
 299         $search->assertStatus(200);
 300         $search->assertSeeText($page->name);
 301         $search->assertSee($page->getUrl());
 302     }
 303 }