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     /**
 111      * @dataProvider dataForEachAnnotations
 112      */
 113     public function testSetAnnotationWithQuoteTooLong($prefixUrl)
 114     {
 115         $em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
 116
 117         if ('annotations' === $prefixUrl) {
 118             $this->logInAs('admin');
 119         }
 120
 121         /** @var Entry $entry */
 122         $entry = $em
 123             ->getRepository('WallabagCoreBundle:Entry')
 124             ->findOneByUsernameAndNotArchived('admin');
 125
 126         $longQuote = str_repeat('a', 10001);
 127         $headers = ['CONTENT_TYPE' => 'application/json'];
 128         $content = json_encode([
 129             'text' => 'my annotation',
 130             'quote' => $longQuote,
 131             'ranges' => [
 132                 ['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31],
 133             ],
 134         ]);
 135         $this->client->request('POST', $prefixUrl . '/' . $entry->getId() . '.json', [], [], $headers, $content);
 136
 137         $this->assertSame(400, $this->client->getResponse()->getStatusCode());
 138     }
 139
 140     /**
 141      * Test editing an existing annotation.
 142      *
 143      * @dataProvider dataForEachAnnotations
 144      */
 145     public function testEditAnnotation($prefixUrl)
 146     {
 147         $em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
 148
 149         $user = $em
 150             ->getRepository('WallabagUserBundle:User')
 151             ->findOneByUserName('admin');
 152         $entry = $em
 153             ->getRepository('WallabagCoreBundle:Entry')
 154             ->findOneByUsernameAndNotArchived('admin');
 155
 156         $annotation = new Annotation($user);
 157         $annotation->setEntry($entry);
 158         $annotation->setText('This is my annotation /o/');
 159         $annotation->setQuote('my quote');
 160
 161         $em->persist($annotation);
 162         $em->flush();
 163
 164         $headers = ['CONTENT_TYPE' => 'application/json'];
 165         $content = json_encode([
 166             'text' => 'a modified annotation',
 167         ]);
 168         $this->client->request('PUT', $prefixUrl . '/' . $annotation->getId() . '.json', [], [], $headers, $content);
 169         $this->assertSame(200, $this->client->getResponse()->getStatusCode());
 170
 171         $content = json_decode($this->client->getResponse()->getContent(), true);
 172
 173         $this->assertSame('Big boss', $content['user']);
 174         $this->assertSame('v1.0', $content['annotator_schema_version']);
 175         $this->assertSame('a modified annotation', $content['text']);
 176         $this->assertSame('my quote', $content['quote']);
 177
 178         /** @var Annotation $annotationUpdated */
 179         $annotationUpdated = $em
 180             ->getRepository('WallabagAnnotationBundle:Annotation')
 181             ->findOneById($annotation->getId());
 182         $this->assertSame('a modified annotation', $annotationUpdated->getText());
 183
 184         $em->remove($annotationUpdated);
 185         $em->flush();
 186     }
 187
 188     /**
 189      * Test deleting an annotation.
 190      *
 191      * @dataProvider dataForEachAnnotations
 192      */
 193     public function testDeleteAnnotation($prefixUrl)
 194     {
 195         $em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
 196
 197         $user = $em
 198             ->getRepository('WallabagUserBundle:User')
 199             ->findOneByUserName('admin');
 200         $entry = $em
 201             ->getRepository('WallabagCoreBundle:Entry')
 202             ->findOneByUsernameAndNotArchived('admin');
 203
 204         $annotation = new Annotation($user);
 205         $annotation->setEntry($entry);
 206         $annotation->setText('This is my annotation /o/');
 207         $annotation->setQuote('my quote');
 208
 209         $em->persist($annotation);
 210         $em->flush();
 211
 212         if ('annotations' === $prefixUrl) {
 213             $this->logInAs('admin');
 214         }
 215
 216         $headers = ['CONTENT_TYPE' => 'application/json'];
 217         $content = json_encode([
 218             'text' => 'a modified annotation',
 219         ]);
 220         $this->client->request('DELETE', $prefixUrl . '/' . $annotation->getId() . '.json', [], [], $headers, $content);
 221         $this->assertSame(200, $this->client->getResponse()->getStatusCode());
 222
 223         $content = json_decode($this->client->getResponse()->getContent(), true);
 224
 225         $this->assertSame('This is my annotation /o/', $content['text']);
 226
 227         $annotationDeleted = $em
 228             ->getRepository('WallabagAnnotationBundle:Annotation')
 229             ->findOneById($annotation->getId());
 230
 231         $this->assertNull($annotationDeleted);
 232     }
 233 }