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

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