mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-07-05 02:51:32 +00:00
265f5db03f
For review of meta tag additions as per PR #2393. This commit removes any image guesswork and only uses images that have been set by the author for the specific content. This also adds tests to cover the expected OG tags.
102 lines
3.5 KiB
PHP
102 lines
3.5 KiB
PHP
<?php namespace Tests;
|
|
|
|
use BookStack\Entities\Models\Book;
|
|
use BookStack\Entities\Models\Bookshelf;
|
|
use BookStack\Entities\Models\Chapter;
|
|
use BookStack\Entities\Models\Page;
|
|
use BookStack\Entities\Repos\BookRepo;
|
|
use BookStack\Entities\Repos\BookshelfRepo;
|
|
use Illuminate\Support\Str;
|
|
use Tests\Uploads\UsesImages;
|
|
|
|
class OpenGraphTest extends TestCase
|
|
{
|
|
use UsesImages;
|
|
|
|
public function test_page_tags()
|
|
{
|
|
$page = Page::query()->first();
|
|
$resp = $this->asEditor()->get($page->getUrl());
|
|
$tags = $this->getOpenGraphTags($resp);
|
|
|
|
$this->assertEquals($page->getShortName() . ' | BookStack', $tags['title']);
|
|
$this->assertEquals($page->getUrl(), $tags['url']);
|
|
$this->assertEquals(Str::limit($page->text, 100, '...'), $tags['description']);
|
|
}
|
|
|
|
public function test_chapter_tags()
|
|
{
|
|
$chapter = Chapter::query()->first();
|
|
$resp = $this->asEditor()->get($chapter->getUrl());
|
|
$tags = $this->getOpenGraphTags($resp);
|
|
|
|
$this->assertEquals($chapter->getShortName() . ' | BookStack', $tags['title']);
|
|
$this->assertEquals($chapter->getUrl(), $tags['url']);
|
|
$this->assertEquals(Str::limit($chapter->description, 100, '...'), $tags['description']);
|
|
}
|
|
|
|
public function test_book_tags()
|
|
{
|
|
$book = Book::query()->first();
|
|
$resp = $this->asEditor()->get($book->getUrl());
|
|
$tags = $this->getOpenGraphTags($resp);
|
|
|
|
$this->assertEquals($book->getShortName() . ' | BookStack', $tags['title']);
|
|
$this->assertEquals($book->getUrl(), $tags['url']);
|
|
$this->assertEquals(Str::limit($book->description, 100, '...'), $tags['description']);
|
|
$this->assertArrayNotHasKey('image', $tags);
|
|
|
|
// Test image set if image has cover image
|
|
$bookRepo = app(BookRepo::class);
|
|
$bookRepo->updateCoverImage($book, $this->getTestImage('image.png'));
|
|
$resp = $this->asEditor()->get($book->getUrl());
|
|
$tags = $this->getOpenGraphTags($resp);
|
|
|
|
$this->assertEquals($book->getBookCover(), $tags['image']);
|
|
}
|
|
|
|
public function test_shelf_tags()
|
|
{
|
|
$shelf = Bookshelf::query()->first();
|
|
$resp = $this->asEditor()->get($shelf->getUrl());
|
|
$tags = $this->getOpenGraphTags($resp);
|
|
|
|
$this->assertEquals($shelf->getShortName() . ' | BookStack', $tags['title']);
|
|
$this->assertEquals($shelf->getUrl(), $tags['url']);
|
|
$this->assertEquals(Str::limit($shelf->description, 100, '...'), $tags['description']);
|
|
$this->assertArrayNotHasKey('image', $tags);
|
|
|
|
// Test image set if image has cover image
|
|
$shelfRepo = app(BookshelfRepo::class);
|
|
$shelfRepo->updateCoverImage($shelf, $this->getTestImage('image.png'));
|
|
$resp = $this->asEditor()->get($shelf->getUrl());
|
|
$tags = $this->getOpenGraphTags($resp);
|
|
|
|
$this->assertEquals($shelf->getBookCover(), $tags['image']);
|
|
}
|
|
|
|
/**
|
|
* Parse the open graph tags from a test response.
|
|
*/
|
|
protected function getOpenGraphTags(TestResponse $resp): array
|
|
{
|
|
$tags = [];
|
|
|
|
libxml_use_internal_errors(true);
|
|
$doc = new \DOMDocument();
|
|
$doc->loadHTML($resp->getContent());
|
|
$metaElems = $doc->getElementsByTagName('meta');
|
|
/** @var \DOMElement $elem */
|
|
foreach ($metaElems as $elem) {
|
|
$prop = $elem->getAttribute('property');
|
|
$name = explode(':', $prop)[1] ?? null;
|
|
if ($name) {
|
|
$tags[$name] = $elem->getAttribute('content');
|
|
}
|
|
}
|
|
|
|
return $tags;
|
|
}
|
|
|
|
|
|
} |