tests/Wallabag/AnnotationBundle/Controller/AnnotationControllerTest.php

   1 <?php
   2
   3 namespace Tests\Wallabag\AnnotationBundle\Controller;
   4
   5 use Tests\Wallabag\AnnotationBundle\WallabagAnnotationTestCase;
   6 use Wallabag\AnnotationBundle\Entity\Annotation;
   7 use Wallabag\CoreBundle\Entity\Entry;
   8
   9 class AnnotationControllerTest extends WallabagAnnotationTestCase
  10 {
  11     /**
  12      * This data provider allow to tests annotation from the :
  13      *     - API POV (when user use the api to manage annotations)
  14      *     - and User POV (when user use the web interface - using javascript - to manage annotations).
  15      */
  16     public function dataForEachAnnotations()
  17     {
  18         return [
  19             ['/api/annotations'],
  20             ['annotations'],
  21         ];
  22     }
  23
  24     /**
  25      * Test fetching annotations for an entry.
  26      *
  27      * @dataProvider dataForEachAnnotations
  28      */
  29     public function testGetAnnotations($prefixUrl)
  30     {
  31         $em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
  32
  33         $user = $em
  34             ->getRepository('WallabagUserBundle:User')
  35             ->findOneByUserName('admin');
  36         $entry = $em
  37             ->getRepository('WallabagCoreBundle:Entry')
  38             ->findOneByUsernameAndNotArchived('admin');
  39
  40         $annotation = new Annotation($user);
  41         $annotation->setEntry($entry);
  42         $annotation->setText('This is my annotation /o/');
  43         $annotation->setQuote('content');
  44
  45         $em->persist($annotation);
  46         $em->flush();
  47
  48         if ('annotations' === $prefixUrl) {
  49             $this->logInAs('admin');
  50         }
  51
  52         $this->client->request('GET', $prefixUrl . '/' . $entry->getId() . '.json');
  53         $this->assertSame(200, $this->client->getResponse()->getStatusCode());
  54
  55         $content = json_decode($this->client->getResponse()->getContent(), true);
  56         $this->assertGreaterThanOrEqual(1, $content['total']);
  57         $this->assertSame($annotation->getText(), $content['rows'][0]['text']);
  58
  59         // we need to re-fetch the annotation becase after the flush, it has been "detached" from the entity manager
  60         $annotation = $em->getRepository('WallabagAnnotationBundle:Annotation')->findAnnotationById($annotation->getId());
  61         $em->remove($annotation);
  62         $em->flush();
  63     }
  64
  65     /**
  66      * Test creating an annotation for an entry.
  67      *
  68      * @dataProvider dataForEachAnnotations
  69      */
  70     public function testSetAnnotation($prefixUrl)
  71     {
  72         $em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
  73
  74         if ('annotations' === $prefixUrl) {
  75             $this->logInAs('admin');
  76         }
  77
  78         /** @var Entry $entry */
  79         $entry = $em
  80             ->getRepository('WallabagCoreBundle:Entry')
  81             ->findOneByUsernameAndNotArchived('admin');
  82
  83         $headers = ['CONTENT_TYPE' => 'application/json'];
  84         $content = json_encode([
  85             'text' => 'my annotation',
  86             'quote' => 'my quote',
  87             'ranges' => [
  88                 ['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31],
  89             ],
  90         ]);
  91         $this->client->request('POST', $prefixUrl . '/' . $entry->getId() . '.json', [], [], $headers, $content);
  92
  93         $this->assertSame(200, $this->client->getResponse()->getStatusCode());
  94
  95         $content = json_decode($this->client->getResponse()->getContent(), true);
  96
  97         $this->assertSame('Big boss', $content['user']);
  98         $this->assertSame('v1.0', $content['annotator_schema_version']);
  99         $this->assertSame('my annotation', $content['text']);
 100         $this->assertSame('my quote', $content['quote']);
 101
 102         /** @var Annotation $annotation */
 103         $annotation = $em
 104             ->getRepository('WallabagAnnotationBundle:Annotation')
 105             ->findLastAnnotationByPageId($entry->getId(), 1);
 106
 107         $this->assertSame('my annotation', $annotation->getText());
 108     }
 109
 110     public function testCouldNotSetAnnotationWithoutQuote()
 111     {
 112         $em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
 113
 114         /** @var Entry $entry */
 115         $entry = $em
 116             ->getRepository('WallabagCoreBundle:Entry')
 117             ->findOneByUsernameAndNotArchived('admin');
 118
 119         $headers = ['CONTENT_TYPE' => 'application/json'];
 120         $content = json_encode([
 121             'text' => 'my annotation',
 122             'quote' => null,
 123             'ranges' => [
 124                 ['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31],
 125             ],
 126         ]);
 127         $this->client->request('POST', '/api/annotations/' . $entry->getId() . '.json', [], [], $headers, $content);
 128
 129         $this->assertSame(400, $this->client->getResponse()->getStatusCode());
 130
 131         $content = json_decode($this->client->getResponse()->getContent(), true);
 132
 133         $this->assertCount(
 134             1,
 135             $content['errors']['children']['quote']['errors'],
 136             'The quote field should contains an error'
 137         );
 138     }
 139
 140     /**
 141      * @dataProvider dataForEachAnnotations
 142      */
 143     public function testSetAnnotationWithQuoteTooLong($prefixUrl)
 144     {
 145         $em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
 146
 147         if ('annotations' === $prefixUrl) {
 148             $this->logInAs('admin');
 149         }
 150
 151         /** @var Entry $entry */
 152         $entry = $em
 153             ->getRepository('WallabagCoreBundle:Entry')
 154             ->findOneByUsernameAndNotArchived('admin');
 155
 156         $longQuote = str_repeat('a', 10001);
 157         $headers = ['CONTENT_TYPE' => 'application/json'];
 158         $content = json_encode([
 159             'text' => 'my annotation',
 160             'quote' => $longQuote,
 161             'ranges' => [
 162                 ['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31],
 163             ],
 164         ]);
 165         $this->client->request('POST', $prefixUrl . '/' . $entry->getId() . '.json', [], [], $headers, $content);
 166
 167         $this->assertSame(400, $this->client->getResponse()->getStatusCode());
 168     }
 169
 170     /**
 171      * Test editing an existing annotation.
 172      *
 173      * @dataProvider dataForEachAnnotations
 174      */
 175     public function testEditAnnotation($prefixUrl)
 176     {
 177         $em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
 178
 179         $user = $em
 180             ->getRepository('WallabagUserBundle:User')
 181             ->findOneByUserName('admin');
 182         $entry = $em
 183             ->getRepository('WallabagCoreBundle:Entry')
 184             ->findOneByUsernameAndNotArchived('admin');
 185
 186         $annotation = new Annotation($user);
 187         $annotation->setEntry($entry);
 188         $annotation->setText('This is my annotation /o/');
 189         $annotation->setQuote('my quote');
 190
 191         $em->persist($annotation);
 192         $em->flush();
 193
 194         $headers = ['CONTENT_TYPE' => 'application/json'];
 195         $content = json_encode([
 196             'text' => 'a modified annotation',
 197         ]);
 198         $this->client->request('PUT', $prefixUrl . '/' . $annotation->getId() . '.json', [], [], $headers, $content);
 199         $this->assertSame(200, $this->client->getResponse()->getStatusCode());
 200
 201         $content = json_decode($this->client->getResponse()->getContent(), true);
 202
 203         $this->assertSame('Big boss', $content['user']);
 204         $this->assertSame('v1.0', $content['annotator_schema_version']);
 205         $this->assertSame('a modified annotation', $content['text']);
 206         $this->assertSame('my quote', $content['quote']);
 207
 208         /** @var Annotation $annotationUpdated */
 209         $annotationUpdated = $em
 210             ->getRepository('WallabagAnnotationBundle:Annotation')
 211             ->findOneById($annotation->getId());
 212         $this->assertSame('a modified annotation', $annotationUpdated->getText());
 213
 214         $em->remove($annotationUpdated);
 215         $em->flush();
 216     }
 217
 218     /**
 219      * Test deleting an annotation.
 220      *
 221      * @dataProvider dataForEachAnnotations
 222      */
 223     public function testDeleteAnnotation($prefixUrl)
 224     {
 225         $em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
 226
 227         $user = $em
 228             ->getRepository('WallabagUserBundle:User')
 229             ->findOneByUserName('admin');
 230         $entry = $em
 231             ->getRepository('WallabagCoreBundle:Entry')
 232             ->findOneByUsernameAndNotArchived('admin');
 233
 234         $annotation = new Annotation($user);
 235         $annotation->setEntry($entry);
 236         $annotation->setText('This is my annotation /o/');
 237         $annotation->setQuote('my quote');
 238
 239         $em->persist($annotation);
 240         $em->flush();
 241
 242         if ('annotations' === $prefixUrl) {
 243             $this->logInAs('admin');
 244         }
 245
 246         $headers = ['CONTENT_TYPE' => 'application/json'];
 247         $content = json_encode([
 248             'text' => 'a modified annotation',
 249         ]);
 250         $this->client->request('DELETE', $prefixUrl . '/' . $annotation->getId() . '.json', [], [], $headers, $content);
 251         $this->assertSame(200, $this->client->getResponse()->getStatusCode());
 252
 253         $content = json_decode($this->client->getResponse()->getContent(), true);
 254
 255         $this->assertSame('This is my annotation /o/', $content['text']);
 256
 257         $annotationDeleted = $em
 258             ->getRepository('WallabagAnnotationBundle:Annotation')
 259             ->findOneById($annotation->getId());
 260
 261         $this->assertNull($annotationDeleted);
 262     }
 263 }