mirror of
https://github.com/wallabag/wallabag.git
synced 2024-05-13 14:52:38 +00:00
293 lines
10 KiB
PHP
293 lines
10 KiB
PHP
<?php
|
|
|
|
namespace Tests\Wallabag\AnnotationBundle\Controller;
|
|
|
|
use Doctrine\ORM\EntityManagerInterface;
|
|
use Tests\Wallabag\AnnotationBundle\WallabagAnnotationTestCase;
|
|
use Wallabag\AnnotationBundle\Entity\Annotation;
|
|
use Wallabag\CoreBundle\Entity\Entry;
|
|
use Wallabag\UserBundle\Entity\User;
|
|
|
|
class AnnotationControllerTest extends WallabagAnnotationTestCase
|
|
{
|
|
/**
|
|
* This data provider allow to tests annotation from the :
|
|
* - API POV (when user use the api to manage annotations)
|
|
* - and User POV (when user use the web interface - using javascript - to manage annotations).
|
|
*/
|
|
public function dataForEachAnnotations()
|
|
{
|
|
return [
|
|
['/api/annotations'],
|
|
['annotations'],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Test fetching annotations for an entry.
|
|
*
|
|
* @dataProvider dataForEachAnnotations
|
|
*/
|
|
public function testGetAnnotations($prefixUrl)
|
|
{
|
|
$em = $this->client->getContainer()->get(EntityManagerInterface::class);
|
|
|
|
$user = $em
|
|
->getRepository(User::class)
|
|
->findOneByUserName('admin');
|
|
$entry = $em
|
|
->getRepository(Entry::class)
|
|
->findOneByUsernameAndNotArchived('admin');
|
|
|
|
$annotation = new Annotation($user);
|
|
$annotation->setEntry($entry);
|
|
$annotation->setText('This is my annotation /o/');
|
|
$annotation->setQuote('content');
|
|
|
|
$em->persist($annotation);
|
|
$em->flush();
|
|
|
|
if ('annotations' === $prefixUrl) {
|
|
$this->logInAs('admin');
|
|
}
|
|
|
|
$this->client->request('GET', $prefixUrl . '/' . $entry->getId() . '.json');
|
|
$this->assertSame(200, $this->client->getResponse()->getStatusCode());
|
|
|
|
$content = json_decode($this->client->getResponse()->getContent(), true);
|
|
$this->assertGreaterThanOrEqual(1, $content['total']);
|
|
$this->assertSame($annotation->getText(), $content['rows'][0]['text']);
|
|
|
|
// we need to re-fetch the annotation becase after the flush, it has been "detached" from the entity manager
|
|
$annotation = $em->getRepository(Annotation::class)->findAnnotationById($annotation->getId());
|
|
$em->remove($annotation);
|
|
$em->flush();
|
|
}
|
|
|
|
/**
|
|
* Test creating an annotation for an entry.
|
|
*
|
|
* @dataProvider dataForEachAnnotations
|
|
*/
|
|
public function testSetAnnotation($prefixUrl)
|
|
{
|
|
$em = $this->client->getContainer()->get(EntityManagerInterface::class);
|
|
|
|
if ('annotations' === $prefixUrl) {
|
|
$this->logInAs('admin');
|
|
}
|
|
|
|
/** @var Entry $entry */
|
|
$entry = $em
|
|
->getRepository(Entry::class)
|
|
->findOneByUsernameAndNotArchived('admin');
|
|
|
|
$headers = ['CONTENT_TYPE' => 'application/json'];
|
|
$content = json_encode([
|
|
'text' => 'my annotation',
|
|
'quote' => 'my quote',
|
|
'ranges' => [
|
|
['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31],
|
|
],
|
|
]);
|
|
$this->client->request('POST', $prefixUrl . '/' . $entry->getId() . '.json', [], [], $headers, $content);
|
|
|
|
$this->assertSame(200, $this->client->getResponse()->getStatusCode());
|
|
|
|
$content = json_decode($this->client->getResponse()->getContent(), true);
|
|
|
|
$this->assertSame('Big boss', $content['user']);
|
|
$this->assertSame('v1.0', $content['annotator_schema_version']);
|
|
$this->assertSame('my annotation', $content['text']);
|
|
$this->assertSame('my quote', $content['quote']);
|
|
|
|
/** @var Annotation $annotation */
|
|
$annotation = $em
|
|
->getRepository(Annotation::class)
|
|
->findLastAnnotationByPageId($entry->getId(), 1);
|
|
|
|
$this->assertSame('my annotation', $annotation->getText());
|
|
}
|
|
|
|
public function testAllowEmptyQuote()
|
|
{
|
|
$em = $this->client->getContainer()->get(EntityManagerInterface::class);
|
|
|
|
/** @var Entry $entry */
|
|
$entry = $em
|
|
->getRepository(Entry::class)
|
|
->findOneByUsernameAndNotArchived('admin');
|
|
|
|
$headers = ['CONTENT_TYPE' => 'application/json'];
|
|
$content = json_encode([
|
|
'text' => 'my annotation',
|
|
'quote' => null,
|
|
'ranges' => [
|
|
['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31],
|
|
],
|
|
]);
|
|
$this->client->request('POST', '/api/annotations/' . $entry->getId() . '.json', [], [], $headers, $content);
|
|
|
|
$this->assertSame(200, $this->client->getResponse()->getStatusCode());
|
|
|
|
$content = json_decode($this->client->getResponse()->getContent(), true);
|
|
|
|
$this->assertSame('Big boss', $content['user']);
|
|
$this->assertSame('v1.0', $content['annotator_schema_version']);
|
|
$this->assertSame('my annotation', $content['text']);
|
|
$this->assertSame('', $content['quote']);
|
|
}
|
|
|
|
public function testAllowOmmittedQuote()
|
|
{
|
|
$em = $this->client->getContainer()->get(EntityManagerInterface::class);
|
|
|
|
/** @var Entry $entry */
|
|
$entry = $em
|
|
->getRepository(Entry::class)
|
|
->findOneByUsernameAndNotArchived('admin');
|
|
|
|
$headers = ['CONTENT_TYPE' => 'application/json'];
|
|
$content = json_encode([
|
|
'text' => 'my new annotation',
|
|
'ranges' => [
|
|
['start' => '', 'startOffset' => 25, 'end' => '', 'endOffset' => 32],
|
|
],
|
|
]);
|
|
$this->client->request('POST', '/api/annotations/' . $entry->getId() . '.json', [], [], $headers, $content);
|
|
|
|
$this->assertSame(200, $this->client->getResponse()->getStatusCode());
|
|
|
|
$content = json_decode($this->client->getResponse()->getContent(), true);
|
|
|
|
$this->assertSame('Big boss', $content['user']);
|
|
$this->assertSame('v1.0', $content['annotator_schema_version']);
|
|
$this->assertSame('my new annotation', $content['text']);
|
|
$this->assertSame('', $content['quote']);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider dataForEachAnnotations
|
|
*/
|
|
public function testSetAnnotationWithQuoteTooLong($prefixUrl)
|
|
{
|
|
$em = $this->client->getContainer()->get(EntityManagerInterface::class);
|
|
|
|
if ('annotations' === $prefixUrl) {
|
|
$this->logInAs('admin');
|
|
}
|
|
|
|
/** @var Entry $entry */
|
|
$entry = $em
|
|
->getRepository(Entry::class)
|
|
->findOneByUsernameAndNotArchived('admin');
|
|
|
|
$longQuote = str_repeat('a', 10001);
|
|
$headers = ['CONTENT_TYPE' => 'application/json'];
|
|
$content = json_encode([
|
|
'text' => 'my annotation',
|
|
'quote' => $longQuote,
|
|
'ranges' => [
|
|
['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31],
|
|
],
|
|
]);
|
|
$this->client->request('POST', $prefixUrl . '/' . $entry->getId() . '.json', [], [], $headers, $content);
|
|
|
|
$this->assertSame(400, $this->client->getResponse()->getStatusCode());
|
|
}
|
|
|
|
/**
|
|
* Test editing an existing annotation.
|
|
*
|
|
* @dataProvider dataForEachAnnotations
|
|
*/
|
|
public function testEditAnnotation($prefixUrl)
|
|
{
|
|
$em = $this->client->getContainer()->get(EntityManagerInterface::class);
|
|
|
|
$user = $em
|
|
->getRepository(User::class)
|
|
->findOneByUserName('admin');
|
|
$entry = $em
|
|
->getRepository(Entry::class)
|
|
->findOneByUsernameAndNotArchived('admin');
|
|
|
|
$annotation = new Annotation($user);
|
|
$annotation->setEntry($entry);
|
|
$annotation->setText('This is my annotation /o/');
|
|
$annotation->setQuote('my quote');
|
|
|
|
$em->persist($annotation);
|
|
$em->flush();
|
|
|
|
$headers = ['CONTENT_TYPE' => 'application/json'];
|
|
$content = json_encode([
|
|
'text' => 'a modified annotation',
|
|
]);
|
|
$this->client->request('PUT', $prefixUrl . '/' . $annotation->getId() . '.json', [], [], $headers, $content);
|
|
$this->assertSame(200, $this->client->getResponse()->getStatusCode());
|
|
|
|
$content = json_decode($this->client->getResponse()->getContent(), true);
|
|
|
|
$this->assertSame('Big boss', $content['user']);
|
|
$this->assertSame('v1.0', $content['annotator_schema_version']);
|
|
$this->assertSame('a modified annotation', $content['text']);
|
|
$this->assertSame('my quote', $content['quote']);
|
|
|
|
/** @var Annotation $annotationUpdated */
|
|
$annotationUpdated = $em
|
|
->getRepository(Annotation::class)
|
|
->findOneById($annotation->getId());
|
|
$this->assertSame('a modified annotation', $annotationUpdated->getText());
|
|
|
|
$em->remove($annotationUpdated);
|
|
$em->flush();
|
|
}
|
|
|
|
/**
|
|
* Test deleting an annotation.
|
|
*
|
|
* @dataProvider dataForEachAnnotations
|
|
*/
|
|
public function testDeleteAnnotation($prefixUrl)
|
|
{
|
|
$em = $this->client->getContainer()->get(EntityManagerInterface::class);
|
|
|
|
$user = $em
|
|
->getRepository(User::class)
|
|
->findOneByUserName('admin');
|
|
$entry = $em
|
|
->getRepository(Entry::class)
|
|
->findOneByUsernameAndNotArchived('admin');
|
|
|
|
$annotation = new Annotation($user);
|
|
$annotation->setEntry($entry);
|
|
$annotation->setText('This is my annotation /o/');
|
|
$annotation->setQuote('my quote');
|
|
|
|
$em->persist($annotation);
|
|
$em->flush();
|
|
|
|
if ('annotations' === $prefixUrl) {
|
|
$this->logInAs('admin');
|
|
}
|
|
|
|
$headers = ['CONTENT_TYPE' => 'application/json'];
|
|
$content = json_encode([
|
|
'text' => 'a modified annotation',
|
|
]);
|
|
$this->client->request('DELETE', $prefixUrl . '/' . $annotation->getId() . '.json', [], [], $headers, $content);
|
|
$this->assertSame(200, $this->client->getResponse()->getStatusCode());
|
|
|
|
$content = json_decode($this->client->getResponse()->getContent(), true);
|
|
|
|
$this->assertSame('This is my annotation /o/', $content['text']);
|
|
|
|
$annotationDeleted = $em
|
|
->getRepository(Annotation::class)
|
|
->findOneById($annotation->getId());
|
|
|
|
$this->assertNull($annotationDeleted);
|
|
}
|
|
}
|