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 {updated_by:'.$editorId.'}'))->assertDontSee($page->name);
 137         $page->created_by = $editorId;
 138         $page->save();
 139         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertSee($page->name);
 140         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:'.$editorId.'}'))->assertSee($page->name);
 141         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
 142         $page->updated_by = $editorId;
 143         $page->save();
 144         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertSee($page->name);
 145         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:'.$editorId.'}'))->assertSee($page->name);
 146
 147         // Content filters
 148         $this->get('/search?term=' . urlencode('{in_name:danzorbhsing}'))->assertDontSee($page->name);
 149         $this->get('/search?term=' . urlencode('{in_body:danzorbhsing}'))->assertSee($page->name);
 150         $this->get('/search?term=' . urlencode('{in_name:test quaffleachits}'))->assertSee($page->name);
 151         $this->get('/search?term=' . urlencode('{in_body:test quaffleachits}'))->assertDontSee($page->name);
 152
 153         // Restricted filter
 154         $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertDontSee($page->name);
 155         $page->restricted = true;
 156         $page->save();
 157         $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertSee($page->name);
 158
 159         // Date filters
 160         $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertDontSee($page->name);
 161         $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertSee($page->name);
 162         $page->updated_at = '2037-02-01';
 163         $page->save();
 164         $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertSee($page->name);
 165         $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertDontSee($page->name);
 166
 167         $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertDontSee($page->name);
 168         $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertSee($page->name);
 169         $page->created_at = '2037-02-01';
 170         $page->save();
 171         $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertSee($page->name);
 172         $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertDontSee($page->name);
 173     }
 174
 175     public function test_ajax_entity_search()
 176     {
 177         $page = $this->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']);
 178         $notVisitedPage = Page::first();
 179
 180         // Visit the page to make popular
 181         $this->asEditor()->get($page->getUrl());
 182
 183         $normalSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
 184         $normalSearch->assertSee($page->name);
 185
 186         $bookSearch = $this->get('/ajax/search/entities?types=book&term=' . urlencode($page->name));
 187         $bookSearch->assertDontSee($page->name);
 188
 189         $defaultListTest = $this->get('/ajax/search/entities');
 190         $defaultListTest->assertSee($page->name);
 191         $defaultListTest->assertDontSee($notVisitedPage->name);
 192     }
 193
 194     public function test_ajax_entity_serach_shows_breadcrumbs()
 195     {
 196         $chapter = Chapter::first();
 197         $page = $chapter->pages->first();
 198         $this->asEditor();
 199
 200         $pageSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
 201         $pageSearch->assertSee($page->name);
 202         $pageSearch->assertSee($chapter->getShortName(42));
 203         $pageSearch->assertSee($page->book->getShortName(42));
 204
 205         $chapterSearch = $this->get('/ajax/search/entities?term=' . urlencode($chapter->name));
 206         $chapterSearch->assertSee($chapter->name);
 207         $chapterSearch->assertSee($chapter->book->getShortName(42));
 208     }
 209
 210     public function test_sibling_search_for_pages()
 211     {
 212         $chapter = Chapter::query()->with('pages')->first();
 213         $this->assertGreaterThan(2, count($chapter->pages), 'Ensure we\'re testing with at least 1 sibling');
 214         $page = $chapter->pages->first();
 215
 216         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
 217         $search->assertSuccessful();
 218         foreach ($chapter->pages as $page) {
 219             $search->assertSee($page->name);
 220         }
 221
 222         $search->assertDontSee($chapter->name);
 223     }
 224
 225     public function test_sibling_search_for_pages_without_chapter()
 226     {
 227         $page = Page::query()->where('chapter_id', '=', 0)->firstOrFail();
 228         $bookChildren = $page->book->getDirectChildren();
 229         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
 230
 231         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
 232         $search->assertSuccessful();
 233         foreach ($bookChildren as $child) {
 234             $search->assertSee($child->name);
 235         }
 236
 237         $search->assertDontSee($page->book->name);
 238     }
 239
 240     public function test_sibling_search_for_chapters()
 241     {
 242         $chapter = Chapter::query()->firstOrFail();
 243         $bookChildren = $chapter->book->getDirectChildren();
 244         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
 245
 246         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter");
 247         $search->assertSuccessful();
 248         foreach ($bookChildren as $child) {
 249             $search->assertSee($child->name);
 250         }
 251
 252         $search->assertDontSee($chapter->book->name);
 253     }
 254
 255     public function test_sibling_search_for_books()
 256     {
 257         $books = Book::query()->take(10)->get();
 258         $book = $books->first();
 259         $this->assertGreaterThan(2, count($books), 'Ensure we\'re testing with at least 1 sibling');
 260
 261         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book");
 262         $search->assertSuccessful();
 263         foreach ($books as $expectedBook) {
 264             $search->assertSee($expectedBook->name);
 265         }
 266     }
 267
 268     public function test_sibling_search_for_shelves()
 269     {
 270         $shelves = Bookshelf::query()->take(10)->get();
 271         $shelf = $shelves->first();
 272         $this->assertGreaterThan(2, count($shelves), 'Ensure we\'re testing with at least 1 sibling');
 273
 274         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf");
 275         $search->assertSuccessful();
 276         foreach ($shelves as $expectedShelf) {
 277             $search->assertSee($expectedShelf->name);
 278         }
 279     }
 280
 281     public function test_search_works_on_updated_page_content()
 282     {
 283         $page = Page::query()->first();
 284         $this->asEditor();
 285
 286         $update = $this->put($page->getUrl(), [
 287             'name' => $page->name,
 288             'html' => '<p>dog pandabearmonster spaghetti</p>',
 289         ]);
 290
 291         $search = $this->asEditor()->get('/search?term=pandabearmonster');
 292         $search->assertStatus(200);
 293         $search->assertSeeText($page->name);
 294         $search->assertSee($page->getUrl());
 295     }
 296 }