X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/ee24635e06a8c01d751f80caba47c57f76e8989d..06901b878f2c8057a6f9b7d2e0adfda425c68dee:/tests/Entity/EntitySearchTest.php diff --git a/tests/Entity/EntitySearchTest.php b/tests/Entity/EntitySearchTest.php index 3a9b9f31b..9b77a32ab 100644 --- a/tests/Entity/EntitySearchTest.php +++ b/tests/Entity/EntitySearchTest.php @@ -2,18 +2,17 @@ namespace Tests\Entity; -use BookStack\Actions\Tag; +use BookStack\Activity\Models\Tag; use BookStack\Entities\Models\Book; use BookStack\Entities\Models\Bookshelf; use BookStack\Entities\Models\Chapter; -use BookStack\Entities\Models\Page; use Tests\TestCase; class EntitySearchTest extends TestCase { public function test_page_search() { - $book = Book::all()->first(); + $book = $this->entities->book(); $page = $book->pages->first(); $search = $this->asEditor()->get('/search?term=' . urlencode($page->name)); @@ -23,8 +22,7 @@ class EntitySearchTest extends TestCase public function test_bookshelf_search() { - /** @var Bookshelf $shelf */ - $shelf = Bookshelf::query()->first(); + $shelf = $this->entities->shelf(); $search = $this->asEditor()->get('/search?term=' . urlencode($shelf->name) . ' {type:bookshelf}'); $search->assertSee('Search Results'); @@ -47,7 +45,7 @@ class EntitySearchTest extends TestCase public function test_searching_accents_and_small_terms() { - $page = $this->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéÃÃúü¿¡ test content a2 orange dog']); + $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéÃÃúü¿¡ test content a2 orange dog']); $this->asEditor(); $accentSearch = $this->get('/search?term=' . urlencode('áéÃÃ')); @@ -72,7 +70,7 @@ class EntitySearchTest extends TestCase public function test_chapter_search() { - $chapter = Chapter::has('pages')->first(); + $chapter = $this->entities->chapterHasPages(); $page = $chapter->pages[0]; $pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name)); @@ -92,10 +90,10 @@ class EntitySearchTest extends TestCase ]), ]; - $pageA = Page::first(); + $pageA = $this->entities->page(); $pageA->tags()->saveMany($newTags); - $pageB = Page::all()->last(); + $pageB = $this->entities->page(); $pageB->tags()->create(['name' => 'animal', 'value' => 'dog']); $this->asEditor(); @@ -111,7 +109,7 @@ class EntitySearchTest extends TestCase public function test_exact_searches() { - $page = $this->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']); + $page = $this->entities->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']); $exactSearchA = $this->asEditor()->get('/search?term=' . urlencode('"story about an orange"')); $exactSearchA->assertStatus(200)->assertSee($page->name); @@ -123,7 +121,7 @@ class EntitySearchTest extends TestCase public function test_search_terms_with_delimiters_are_converted_to_exact_matches() { $this->asEditor(); - $page = $this->newPage(['name' => 'Delimiter test', 'html' => '
1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`
']); + $page = $this->entities->newPage(['name' => 'Delimiter test', 'html' => '1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`
']); $terms = explode(' ', '1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`'); foreach ($terms as $term) { @@ -134,10 +132,9 @@ class EntitySearchTest extends TestCase public function test_search_filters() { - $page = $this->newPage(['name' => 'My new test quaffleachits', 'html' => 'this is about an orange donkey danzorbhsing']); - $this->asEditor(); - $editorId = $this->getEditor()->id; - $editorSlug = $this->getEditor()->slug; + $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'this is about an orange donkey danzorbhsing']); + $editor = $this->users->editor(); + $this->actingAs($editor); // Viewed filter searches $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertSee($page->name); @@ -150,22 +147,22 @@ class EntitySearchTest extends TestCase $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertDontSee($page->name); $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name); $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name); - $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editorSlug . '}'))->assertDontSee($page->name); - $page->created_by = $editorId; + $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editor->slug . '}'))->assertDontSee($page->name); + $page->created_by = $editor->id; $page->save(); $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertSee($page->name); - $this->get('/search?term=' . urlencode('danzorbhsing {created_by: ' . $editorSlug . '}'))->assertSee($page->name); + $this->get('/search?term=' . urlencode('danzorbhsing {created_by: ' . $editor->slug . '}'))->assertSee($page->name); $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name); $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name); - $page->updated_by = $editorId; + $page->updated_by = $editor->id; $page->save(); $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertSee($page->name); - $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editorSlug . '}'))->assertSee($page->name); + $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editor->slug . '}'))->assertSee($page->name); $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name); - $page->owned_by = $editorId; + $page->owned_by = $editor->id; $page->save(); $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertSee($page->name); - $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:' . $editorSlug . '}'))->assertSee($page->name); + $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:' . $editor->slug . '}'))->assertSee($page->name); // Content filters $this->get('/search?term=' . urlencode('{in_name:danzorbhsing}'))->assertDontSee($page->name); @@ -175,8 +172,7 @@ class EntitySearchTest extends TestCase // Restricted filter $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertDontSee($page->name); - $page->restricted = true; - $page->save(); + $this->permissions->setEntityPermissions($page, ['view'], [$editor->roles->first()]); $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertSee($page->name); // Date filters @@ -195,63 +191,107 @@ class EntitySearchTest extends TestCase $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertDontSee($page->name); } - public function test_ajax_entity_search() + public function test_entity_selector_search() { - $page = $this->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']); - $notVisitedPage = Page::first(); + $page = $this->entities->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']); + $notVisitedPage = $this->entities->page(); // Visit the page to make popular $this->asEditor()->get($page->getUrl()); - $normalSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name)); + $normalSearch = $this->get('/search/entity-selector?term=' . urlencode($page->name)); $normalSearch->assertSee($page->name); - $bookSearch = $this->get('/ajax/search/entities?types=book&term=' . urlencode($page->name)); + $bookSearch = $this->get('/search/entity-selector?types=book&term=' . urlencode($page->name)); $bookSearch->assertDontSee($page->name); - $defaultListTest = $this->get('/ajax/search/entities'); + $defaultListTest = $this->get('/search/entity-selector'); $defaultListTest->assertSee($page->name); $defaultListTest->assertDontSee($notVisitedPage->name); } - public function test_ajax_entity_search_shows_breadcrumbs() + public function test_entity_selector_search_shows_breadcrumbs() { - $chapter = Chapter::first(); + $chapter = $this->entities->chapter(); $page = $chapter->pages->first(); $this->asEditor(); - $pageSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name)); + $pageSearch = $this->get('/search/entity-selector?term=' . urlencode($page->name)); $pageSearch->assertSee($page->name); $pageSearch->assertSee($chapter->getShortName(42)); $pageSearch->assertSee($page->book->getShortName(42)); - $chapterSearch = $this->get('/ajax/search/entities?term=' . urlencode($chapter->name)); + $chapterSearch = $this->get('/search/entity-selector?term=' . urlencode($chapter->name)); $chapterSearch->assertSee($chapter->name); $chapterSearch->assertSee($chapter->book->getShortName(42)); } - public function test_ajax_entity_search_reflects_items_without_permission() + public function test_entity_selector_shows_breadcrumbs_on_default_view() { - $page = Page::query()->first(); + $page = $this->entities->pageWithinChapter(); + $this->asEditor()->get($page->chapter->getUrl()); + + $resp = $this->asEditor()->get('/search/entity-selector?types=book,chapter&permission=page-create'); + $html = $this->withHtml($resp); + $html->assertElementContains('.chapter.entity-list-item', $page->chapter->name); + $html->assertElementContains('.chapter.entity-list-item .entity-item-snippet', $page->book->getShortName(42)); + } + + public function test_entity_selector_search_reflects_items_without_permission() + { + $page = $this->entities->page(); $baseSelector = 'a[data-entity-type="page"][data-entity-id="' . $page->id . '"]'; - $searchUrl = '/ajax/search/entities?permission=update&term=' . urlencode($page->name); + $searchUrl = '/search/entity-selector?permission=update&term=' . urlencode($page->name); $resp = $this->asEditor()->get($searchUrl); $this->withHtml($resp)->assertElementContains($baseSelector, $page->name); $this->withHtml($resp)->assertElementNotContains($baseSelector, "You don't have the required permissions to select this item"); - $resp = $this->actingAs($this->getViewer())->get($searchUrl); + $resp = $this->actingAs($this->users->viewer())->get($searchUrl); $this->withHtml($resp)->assertElementContains($baseSelector, $page->name); $this->withHtml($resp)->assertElementContains($baseSelector, "You don't have the required permissions to select this item"); } + public function test_entity_template_selector_search() + { + $templatePage = $this->entities->newPage(['name' => 'Template search test', 'html' => 'template test']); + $templatePage->template = true; + $templatePage->save(); + + $nonTemplatePage = $this->entities->newPage(['name' => 'Nontemplate page', 'html' => 'nontemplate', 'template' => false]); + + // Visit both to make popular + $this->asEditor()->get($templatePage->getUrl()); + $this->get($nonTemplatePage->getUrl()); + + $normalSearch = $this->get('/search/entity-selector-templates?term=test'); + $normalSearch->assertSee($templatePage->name); + $normalSearch->assertDontSee($nonTemplatePage->name); + + $normalSearch = $this->get('/search/entity-selector-templates?term=beans'); + $normalSearch->assertDontSee($templatePage->name); + $normalSearch->assertDontSee($nonTemplatePage->name); + + $defaultListTest = $this->get('/search/entity-selector-templates'); + $defaultListTest->assertSee($templatePage->name); + $defaultListTest->assertDontSee($nonTemplatePage->name); + + $this->permissions->disableEntityInheritedPermissions($templatePage); + + $normalSearch = $this->get('/search/entity-selector-templates?term=test'); + $normalSearch->assertDontSee($templatePage->name); + + $defaultListTest = $this->get('/search/entity-selector-templates'); + $defaultListTest->assertDontSee($templatePage->name); + } + public function test_sibling_search_for_pages() { - $chapter = Chapter::query()->with('pages')->first(); + $chapter = $this->entities->chapterHasPages(); $this->assertGreaterThan(2, count($chapter->pages), 'Ensure we\'re testing with at least 1 sibling'); $page = $chapter->pages->first(); - $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page"); + $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page"); $search->assertSuccessful(); foreach ($chapter->pages as $page) { $search->assertSee($page->name); @@ -262,11 +302,11 @@ class EntitySearchTest extends TestCase public function test_sibling_search_for_pages_without_chapter() { - $page = Page::query()->where('chapter_id', '=', 0)->firstOrFail(); + $page = $this->entities->pageNotWithinChapter(); $bookChildren = $page->book->getDirectChildren(); $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling'); - $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page"); + $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page"); $search->assertSuccessful(); foreach ($bookChildren as $child) { $search->assertSee($child->name); @@ -277,11 +317,11 @@ class EntitySearchTest extends TestCase public function test_sibling_search_for_chapters() { - $chapter = Chapter::query()->firstOrFail(); + $chapter = $this->entities->chapter(); $bookChildren = $chapter->book->getDirectChildren(); $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling'); - $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter"); + $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter"); $search->assertSuccessful(); foreach ($bookChildren as $child) { $search->assertSee($child->name); @@ -296,7 +336,7 @@ class EntitySearchTest extends TestCase $book = $books->first(); $this->assertGreaterThan(2, count($books), 'Ensure we\'re testing with at least 1 sibling'); - $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book"); + $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book"); $search->assertSuccessful(); foreach ($books as $expectedBook) { $search->assertSee($expectedBook->name); @@ -309,7 +349,7 @@ class EntitySearchTest extends TestCase $shelf = $shelves->first(); $this->assertGreaterThan(2, count($shelves), 'Ensure we\'re testing with at least 1 sibling'); - $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf"); + $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf"); $search->assertSuccessful(); foreach ($shelves as $expectedShelf) { $search->assertSee($expectedShelf->name); @@ -318,7 +358,7 @@ class EntitySearchTest extends TestCase public function test_search_works_on_updated_page_content() { - $page = Page::query()->first(); + $page = $this->entities->page(); $this->asEditor(); $update = $this->put($page->getUrl(), [ @@ -334,15 +374,15 @@ class EntitySearchTest extends TestCase public function test_search_ranks_common_words_lower() { - $this->newPage(['name' => 'Test page A', 'html' => 'dog biscuit dog dog
']); - $this->newPage(['name' => 'Test page B', 'html' => 'cat biscuit
']); + $this->entities->newPage(['name' => 'Test page A', 'html' => 'dog biscuit dog dog
']); + $this->entities->newPage(['name' => 'Test page B', 'html' => 'cat biscuit
']); $search = $this->asEditor()->get('/search?term=cat+dog+biscuit'); $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page A'); $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page B'); for ($i = 0; $i < 2; $i++) { - $this->newPage(['name' => 'Test page ' . $i, 'html' => 'dog
']); + $this->entities->newPage(['name' => 'Test page ' . $i, 'html' => 'dog
']); } $search = $this->asEditor()->get('/search?term=cat+dog+biscuit'); @@ -352,7 +392,7 @@ class EntitySearchTest extends TestCase public function test_terms_in_headers_have_an_adjusted_index_score() { - $page = $this->newPage(['name' => 'Test page A', 'html' => ' + $page = $this->entities->newPage(['name' => 'Test page A', 'html' => 'TermA
TermA
']); @@ -389,7 +429,7 @@ class EntitySearchTest extends TestCase public function test_tag_names_and_values_are_indexed_for_search() { - $page = $this->newPage(['name' => 'PageA', 'html' => 'content
', 'tags' => [ + $page = $this->entities->newPage(['name' => 'PageA', 'html' => 'content
', 'tags' => [ ['name' => 'Animal', 'value' => 'MeowieCat'], ['name' => 'SuperImportant'], ]]); @@ -402,7 +442,7 @@ class EntitySearchTest extends TestCase public function test_matching_terms_in_search_results_are_highlighted() { - $this->newPage(['name' => 'My Meowie Cat', 'html' => 'A superimportant page about meowieable animals
', 'tags' => [ + $this->entities->newPage(['name' => 'My Meowie Cat', 'html' => 'A superimportant page about meowieable animals
', 'tags' => [ ['name' => 'Animal', 'value' => 'MeowieCat'], ['name' => 'SuperImportant'], ]]); @@ -420,7 +460,7 @@ class EntitySearchTest extends TestCase public function test_match_highlighting_works_with_multibyte_content() { - $this->newPage([ + $this->entities->newPage([ 'name' => 'Test Page', 'html' => 'Ðа мен ми ÑÑÑбва неÑо добÑо test
', ]); @@ -431,7 +471,7 @@ class EntitySearchTest extends TestCase public function test_html_entities_in_item_details_remains_escaped_in_search_results() { - $this->newPage(['name' => 'MyMy supercool <great> TestPageContent page
']); + $this->entities->newPage(['name' => 'MyMy supercool <great> TestPageContent page
']); $search = $this->asEditor()->get('/search?term=TestPageContent'); $search->assertSee('My <cool> TestPageContent', false); @@ -440,7 +480,7 @@ class EntitySearchTest extends TestCase public function test_words_adjacent_to_lines_breaks_can_be_matched_with_normal_terms() { - $page = $this->newPage(['name' => 'TermA', 'html' => ' + $page = $this->entities->newPage(['name' => 'TermA', 'html' => 'TermA
TermB
TermC
More info is at the path \\\\cat\\dog\\badger
+ ']); + $page->tags()->save(new Tag(['name' => '\\Category', 'value' => '\\animals\\fluffy'])); + + $search = $this->asEditor()->get('/search?term=' . urlencode('\\\\cat\\dog')); + $search->assertSee($page->getUrl(), false); + + $search = $this->asEditor()->get('/search?term=' . urlencode('"\\dog\\\\"')); + $search->assertSee($page->getUrl(), false); + + $search = $this->asEditor()->get('/search?term=' . urlencode('"\\badger\\\\"')); + $search->assertDontSee($page->getUrl(), false); + + $search = $this->asEditor()->get('/search?term=' . urlencode('[\\Categorylike%\\fluffy]')); + $search->assertSee($page->getUrl(), false); + } + public function test_searches_with_user_filters_adds_them_into_advanced_search_form() { - $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:me} {created_by:dan}')); - $this->withHtml($resp)->assertElementExists('form input[type="hidden"][name="filters[updated_by]"][value="me"]'); - $this->withHtml($resp)->assertElementExists('form input[type="hidden"][name="filters[created_by]"][value="dan"]'); + $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:dan} {created_by:dan}')); + $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="dan"]'); + $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="dan"]'); + } + + public function test_searches_with_user_filters_using_me_adds_them_into_advanced_search_form() + { + $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:me} {created_by:me}')); + $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="me"][checked="checked"]'); + $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="me"][checked="checked"]'); + } + + public function test_search_suggestion_endpoint() + { + $this->entities->newPage(['name' => 'My suggestion page', 'html' => 'My supercool suggestion page
']); + + // Test specific search + $resp = $this->asEditor()->get('/search/suggest?term="supercool+suggestion"'); + $resp->assertSee('My suggestion page'); + $resp->assertDontSee('My supercool suggestion page'); + $resp->assertDontSee('No items available'); + $this->withHtml($resp)->assertElementCount('a', 1); + + // Test search limit + $resp = $this->asEditor()->get('/search/suggest?term=et'); + $this->withHtml($resp)->assertElementCount('a', 5); + + // Test empty state + $resp = $this->asEditor()->get('/search/suggest?term=spaghettisaurusrex'); + $this->withHtml($resp)->assertElementCount('a', 0); + $resp->assertSee('No items available'); } }