BookStack/tests/Search/EntitySearchTest.php at development · BookStackApp/BookStack · GitHub

History

514 lines (416 loc) · 23.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

<?php

namespace Tests\Search;

use BookStack\Activity\Models\Tag;

use BookStack\Entities\Models\Book;

use BookStack\Entities\Models\Page;

use Tests\TestCase;

class EntitySearchTest extends TestCase

{

public function test_page_search()

{

$book = $this->entities->book();

$page = $book->pages->first();

$search = $this->asEditor()->get('/search?term=' . urlencode($page->name));

$search->assertSee('Search Results');

$search->assertSeeText($page->name, true);

}

public function test_bookshelf_search()

{

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

$search = $this->asEditor()->get('/search?term=' . urlencode($shelf->name) . ' {type:bookshelf}');

$search->assertSee('Search Results');

$search->assertSeeText($shelf->name, true);

}

public function test_search_shows_pagination()

{

$search = $this->asEditor()->get('/search?term=a');

$this->withHtml($search)->assertLinkExists(url('/search?term=a&page=2'), '2');

}

public function test_pagination_considers_sub_path_url_handling()

{

$this->runWithEnv(['APP_URL' => 'https://example.com/subpath'], function () {

$search = $this->asEditor()->get('https://example.com/search?term=a');

$this->withHtml($search)->assertLinkExists('https://example.com/subpath/search?term=a&page=2', '2');

});

}

public function test_invalid_page_search()

{

$resp = $this->asEditor()->get('/search?term=' . urlencode('test'));

$resp->assertSee('Search Results');

$resp->assertStatus(200);

$this->get('/search?term=cat+-')->assertStatus(200);

}

public function test_empty_search_shows_search_page()

{

$res = $this->asEditor()->get('/search');

$res->assertStatus(200);

}

public function test_searching_accents_and_small_terms()

{

$page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéííúü¿¡ test content a2 orange dog']);

$this->asEditor();

$accentSearch = $this->get('/search?term=' . urlencode('áéíí'));

$accentSearch->assertStatus(200)->assertSee($page->name);

$smallSearch = $this->get('/search?term=' . urlencode('a2'));

$smallSearch->assertStatus(200)->assertSee($page->name);

}

public function test_book_search()

{

$book = Book::first();

$page = $book->pages->last();

$chapter = $book->chapters->last();

$pageTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($page->name));

$pageTestResp->assertSee($page->name);

$chapterTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($chapter->name));

$chapterTestResp->assertSee($chapter->name);

}

public function test_chapter_search()

{

$chapter = $this->entities->chapterHasPages();

$page = $chapter->pages[0];

$pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name));

$pageTestResp->assertSee($page->name);

}

public function test_tag_search()

{

$newTags = [

new Tag([

'name' => 'animal',

'value' => 'cat',

]),

new Tag([

'name' => 'color',

'value' => 'red',

]),

];

$pageA = $this->entities->page();

$pageA->tags()->saveMany($newTags);

$pageB = $this->entities->page();

$pageB->tags()->create(['name' => 'animal', 'value' => 'dog']);

$this->asEditor();

$tNameSearch = $this->get('/search?term=%5Banimal%5D');

$tNameSearch->assertSee($pageA->name)->assertSee($pageB->name);

$tNameSearch2 = $this->get('/search?term=%5Bcolor%5D');

$tNameSearch2->assertSee($pageA->name)->assertDontSee($pageB->name);

$tNameValSearch = $this->get('/search?term=%5Banimal%3Dcat%5D');

$tNameValSearch->assertSee($pageA->name)->assertDontSee($pageB->name);

}

public function test_exact_searches()

{

$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);

$exactSearchB = $this->asEditor()->get('/search?term=' . urlencode('"story not about an orange"'));

$exactSearchB->assertStatus(200)->assertDontSee($page->name);

}

public function test_negated_searches()

{

$page = $this->entities->newPage(['name' => 'My new test negation page', 'html' => 'An angry tortoise wore trumpeted plimsoles']);

$page->tags()->saveMany([new Tag(['name' => 'DonkCount', 'value' => '500'])]);

$page->created_by = $this->users->admin()->id;

$page->save();

$otherPage = $this->entities->newPage(['name' => 'A different page in negation tests', 'html' => 'A different page in negation tests']);

$editor = $this->users->editor();

$this->actingAs($editor);

$exactSearch = $this->get('/search?term=' . urlencode('negation -"tortoise"'));

$exactSearch->assertStatus(200)->assertDontSeeText($page->name);

$exactSearch->assertSeeText($otherPage->name);

$tagSearchA = $this->get('/search?term=' . urlencode('negation [DonkCount=500]'));

$tagSearchA->assertStatus(200)->assertSeeText($page->name);

$tagSearchA->assertDontSeeText($otherPage->name);

$tagSearchB = $this->get('/search?term=' . urlencode('negation -[DonkCount=500]'));

$tagSearchB->assertStatus(200)->assertDontSeeText($page->name);

$tagSearchB->assertSeeText($otherPage->name);

$filterSearchA = $this->get('/search?term=' . urlencode('negation -{created_by:me}'));

$filterSearchA->assertStatus(200)->assertSeeText($page->name);

$page->created_by = $editor->id;

$page->save();

$filterSearchB = $this->get('/search?term=' . urlencode('negation -{created_by:me}'));

$filterSearchB->assertStatus(200)->assertDontSeeText($page->name);

}

public function test_search_terms_with_delimiters_are_converted_to_exact_matches()

{

$this->asEditor();

$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) {

$search = $this->get('/search?term=' . urlencode($term));

$search->assertSee($page->name);

}

public function test_search_filters()

{

$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);

$this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertDontSee($page->name);

$this->get($page->getUrl());

$this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertDontSee($page->name);

$this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertSee($page->name);

// User filters

$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:' . $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: ' . $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 = $editor->id;

$page->save();

$this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->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 = $editor->id;

$page->save();

$this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->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);

$this->get('/search?term=' . urlencode('{in_body:danzorbhsing}'))->assertSee($page->name);

$this->get('/search?term=' . urlencode('{in_name:test quaffleachits}'))->assertSee($page->name);

$this->get('/search?term=' . urlencode('{in_body:test quaffleachits}'))->assertDontSee($page->name);

// Restricted filter

$this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertDontSee($page->name);

$this->permissions->setEntityPermissions($page, ['view'], [$editor->roles->first()]);

$this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertSee($page->name);

// Date filters

$this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertDontSee($page->name);

$this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertSee($page->name);

$page->updated_at = '2037-02-01';

$page->save();

$this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertSee($page->name);

$this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertDontSee($page->name);

$this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertDontSee($page->name);

$this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertSee($page->name);

$page->created_at = '2037-02-01';

$page->save();

$this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertSee($page->name);

$this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertDontSee($page->name);

}

public function test_search_tags_with_unexpected_numeric_values_does_not_cause_error()

{

$pageA = $this->entities->page();

$pageA->name = 'MyTestPageWithAwkwardNumericTagValue';

$pageA->save();

$pageA->tags()->save(new Tag(['name' => 'Count', 'value' => '1E999']));

$resp = $this->asEditor()->get('/search?term=' . urlencode('[Count=1E999]'));

$resp->assertStatus(200);

$resp->assertSee('MyTestPageWithAwkwardNumericTagValue');

}

public function test_entity_selector_search()

{

$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('/search/entity-selector?term=' . urlencode($page->name));

$normalSearch->assertSee($page->name);

$bookSearch = $this->get('/search/entity-selector?types=book&term=' . urlencode($page->name));

$bookSearch->assertDontSee($page->name);

$defaultListTest = $this->get('/search/entity-selector');

$defaultListTest->assertSee($page->name);

$defaultListTest->assertDontSee($notVisitedPage->name);

}

public function test_entity_selector_search_shows_breadcrumbs()

{

$chapter = $this->entities->chapter();

$page = $chapter->pages->first();

$this->asEditor();

$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('/search/entity-selector?term=' . urlencode($chapter->name));

$chapterSearch->assertSee($chapter->name);

$chapterSearch->assertSee($chapter->book->getShortName(42));

}

public function test_entity_selector_shows_breadcrumbs_on_default_view()

{

$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 = '/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->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_search_works_on_updated_page_content()

{

$page = $this->entities->page();

$this->asEditor();

$update = $this->put($page->getUrl(), [

'name' => $page->name,

'html' => 'dog pandabearmonster spaghetti',

]);

$search = $this->asEditor()->get('/search?term=pandabearmonster');

$search->assertStatus(200);

$search->assertSeeText($page->name);

$search->assertSee($page->getUrl());

}

public function test_search_ranks_common_words_lower()

{

$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->entities->newPage(['name' => 'Test page ' . $i, 'html' => 'dog']);

}

$search = $this->asEditor()->get('/search?term=cat+dog+biscuit');

$this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page B');

$this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page A');

}

public function test_matching_terms_in_search_results_are_highlighted()

{

$this->entities->newPage(['name' => 'My Meowie Cat', 'html' => 'A superimportant page about meowieable animals', 'tags' => [

['name' => 'Animal', 'value' => 'MeowieCat'],

['name' => 'SuperImportant'],

]]);

$search = $this->asEditor()->get('/search?term=SuperImportant+Meowie');

// Title

$search->assertSee('My Meowie Cat', false);

// Content

$search->assertSee('A superimportant page about meowieable animals', false);

// Tag name

$this->withHtml($search)->assertElementContains('.tag-name.highlight', 'SuperImportant');

// Tag value

$this->withHtml($search)->assertElementContains('.tag-value.highlight', 'MeowieCat');

}

public function test_match_highlighting_works_with_multibyte_content()

{

$this->entities->newPage([

'name' => 'Test Page',

'html' => 'На мен ми трябва нещо добро test',

]);

$search = $this->asEditor()->get('/search?term=' . urlencode('На мен ми трябва нещо добро'));

$search->assertSee('На мен ми трябва нещо добро test', false);

}

public function test_match_highlighting_is_efficient_with_large_frequency_in_content()

{

$content = str_repeat('superbeans ', 10000);

$this->entities->newPage([

'name' => 'Test Page',

'html' => "{$content}",

]);

$time = microtime(true);

$resp = $this->asEditor()->get('/search?term=' . urlencode('superbeans'));

$this->assertLessThan(0.5, microtime(true) - $time);

$resp->assertSee('superbeans', false);

}

public function test_html_entities_in_item_details_remains_escaped_in_search_results()

{

$this->entities->newPage(['name' => 'My <cool> TestPageContent', 'html' => 'My supercool <great> TestPageContent page']);

$search = $this->asEditor()->get('/search?term=TestPageContent');

$search->assertSee('My <cool> TestPageContent', false);

$search->assertSee('My supercool <great> TestPageContent page', false);

}

public function test_words_adjacent_to_lines_breaks_can_be_matched_with_normal_terms()

{

$page = $this->entities->newPage(['name' => 'TermA', 'html' => '

TermA TermB TermC

']);

$search = $this->asEditor()->get('/search?term=' . urlencode('TermB TermC'));

$search->assertSee($page->getUrl(), false);

}

public function test_backslashes_can_be_searched_upon()

{

$page = $this->entities->newPage(['name' => 'TermA', 'html' => '

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_terms_without_controls_includes_them_in_extras()

{

$resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:dan} {created_by:dan} -{viewed_by_me} -[a=b] -"dog" {is_template} {sort_by:last_commented}'));

$this->withHtml($resp)->assertFieldHasValue('extras', '{updated_by:dan} {created_by:dan} {is_template} {sort_by:last_commented} -"dog" -[a=b] -{viewed_by_me}');

}

public function test_negated_searches_dont_show_in_inputs()

{

$resp = $this->asEditor()->get('/search?term=' . urlencode('-{created_by:me} -[a=b] -"dog"'));

$this->withHtml($resp)->assertElementNotExists('input[name="tags[]"][value="a=b"]');

$this->withHtml($resp)->assertElementNotExists('input[name="exact[]"][value="dog"]');

$this->withHtml($resp)->assertElementNotExists('input[name="filters[created_by]"][value="me"][checked="checked"]');

}

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');

}

public function test_draft_pages_not_visible_to_others_in_results()

{

$editor = $this->users->editor();

$creator = $this->users->newUser();

$creator->roles()->sync([$editor->roles()->first()->id]);

$this->actingAs($creator);

$page = $this->entities->newDraftPage(['name' => 'Editors draft page', 'html' => 'My supercool draft page']);

$resp = $this->actingAs($editor)->get('/search?term=' . urlencode("{type:page} {created_by:{$creator->slug}}"));

$resp->assertDontSee('Editors draft page');

}

BookStack/tests/Search/EntitySearchTest.php at development · BookStackApp/BookStack · GitHub

Uh oh!

Uh oh!

BookStack/tests/Search/EntitySearchTest.php at development · BookStackApp/BookStack · GitHub

Uh oh!

Uh oh!

Expand file tree

Breadcrumbs

EntitySearchTest.php

Latest commit

History

Breadcrumbs

EntitySearchTest.php

File metadata and controls