From a0e1eafc35e1007056555651ace7221d09cd8270 Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Sun, 24 Jul 2016 10:55:49 +0200 Subject: [PATCH] Add some tests Also, retrieve tag from the request instead of the query (which will be the same but it's more easy to test). Moved down `deleteTagAction` because it conflicted with the new action: api_delete_tag => /api/tags/{tag}.{_format} api_delete_tags_label => /api/tags/label.{_format} And finally, throw exception when a tag is not found before removing it. --- .../Controller/WallabagRestController.php | 58 +++++---- .../Controller/WallabagRestControllerTest.php | 113 +++++++++++++++++- 2 files changed, 145 insertions(+), 26 deletions(-) diff --git a/src/Wallabag/ApiBundle/Controller/WallabagRestController.php b/src/Wallabag/ApiBundle/Controller/WallabagRestController.php index 43225149..869fdc56 100644 --- a/src/Wallabag/ApiBundle/Controller/WallabagRestController.php +++ b/src/Wallabag/ApiBundle/Controller/WallabagRestController.php @@ -334,15 +334,22 @@ class WallabagRestController extends FOSRestController * * @ApiDoc( * requirements={ - * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"} + * {"name"="tag", "dataType"="string", "required"=true, "requirement"="\w+", "description"="Tag as a string"} * } * ) * * @return Response */ - public function deleteTagAction(Tag $tag) + public function deleteTagLabelAction(Request $request) { $this->validateAuthentication(); + $label = $request->request->get('tag', ''); + + $tag = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($label); + + if (empty($tag)) { + throw $this->createNotFoundException('Tag not found'); + } $this->getDoctrine() ->getRepository('WallabagCoreBundle:Entry') @@ -354,60 +361,65 @@ class WallabagRestController extends FOSRestController } /** - * Permanently remove one tag from **every** entry. + * Permanently remove some tags from **every** entry. * * @ApiDoc( * requirements={ - * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag as a string"} + * {"name"="tags", "dataType"="string", "required"=true, "format"="tag1,tag2", "description"="Tags as strings (comma splitted)"} * } * ) * * @return Response */ - public function deleteTagLabelAction(Request $request) + public function deleteTagsLabelAction(Request $request) { $this->validateAuthentication(); - $label = $request->query->get('tag', ''); - $tag = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($label); + $tagsLabels = $request->request->get('tags', ''); + + $tags = []; + + foreach (explode(',', $tagsLabels) as $tagLabel) { + $tagEntity = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($tagLabel); + + if (!empty($tagEntity)) { + $tags[] = $tagEntity; + } + } + + if (empty($tags)) { + throw $this->createNotFoundException('Tags not found'); + } + $this->getDoctrine() ->getRepository('WallabagCoreBundle:Entry') - ->removeTag($this->getUser()->getId(), $tag); + ->removeTags($this->getUser()->getId(), $tags); - $json = $this->get('serializer')->serialize($tag, 'json'); + $json = $this->get('serializer')->serialize($tags, 'json'); return $this->renderJsonResponse($json); } /** - * Permanently remove some tags from **every** entry. + * Permanently remove one tag from **every** entry. * * @ApiDoc( * requirements={ - * {"name"="tags", "dataType"="string", "required"=true, "format"="tag1,tag2", "description"="The tags as strings"} + * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"} * } * ) * * @return Response */ - public function deleteTagsLabelAction(Request $request) + public function deleteTagAction(Tag $tag) { $this->validateAuthentication(); - $tagsLabels = $request->query->get('tags', ''); - - $tags = array(); - - foreach (explode(',', $tagsLabels) as $tagLabel) { - $tagEntity = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($tagLabel); - $tags[] = $tagEntity; - } - $this->getDoctrine() ->getRepository('WallabagCoreBundle:Entry') - ->removeTags($this->getUser()->getId(), $tags); + ->removeTag($this->getUser()->getId(), $tag); - $json = $this->get('serializer')->serialize($tags, 'json'); + $json = $this->get('serializer')->serialize($tag, 'json'); return $this->renderJsonResponse($json); } diff --git a/tests/Wallabag/ApiBundle/Controller/WallabagRestControllerTest.php b/tests/Wallabag/ApiBundle/Controller/WallabagRestControllerTest.php index 528366af..ee5b2ab7 100644 --- a/tests/Wallabag/ApiBundle/Controller/WallabagRestControllerTest.php +++ b/tests/Wallabag/ApiBundle/Controller/WallabagRestControllerTest.php @@ -3,6 +3,7 @@ namespace Tests\Wallabag\ApiBundle\Controller; use Tests\Wallabag\ApiBundle\WallabagApiTestCase; +use Wallabag\CoreBundle\Entity\Tag; class WallabagRestControllerTest extends WallabagApiTestCase { @@ -359,7 +360,7 @@ class WallabagRestControllerTest extends WallabagApiTestCase $entry = $this->client->getContainer() ->get('doctrine.orm.entity_manager') ->getRepository('WallabagCoreBundle:Entry') - ->findOneWithTags(1); + ->findOneWithTags($this->user->getId()); $entry = $entry[0]; @@ -421,7 +422,7 @@ class WallabagRestControllerTest extends WallabagApiTestCase $entry = $this->client->getContainer() ->get('doctrine.orm.entity_manager') ->getRepository('WallabagCoreBundle:Entry') - ->findOneWithTags(1); + ->findOneWithTags($this->user->getId()); $entry = $entry[0]; if (!$entry) { @@ -472,7 +473,7 @@ class WallabagRestControllerTest extends WallabagApiTestCase $this->assertEquals($tag['label'], $content['label']); $this->assertEquals($tag['slug'], $content['slug']); - $entries = $entry = $this->client->getContainer() + $entries = $this->client->getContainer() ->get('doctrine.orm.entity_manager') ->getRepository('WallabagCoreBundle:Entry') ->findAllByTagId($this->user->getId(), $tag['id']); @@ -480,6 +481,112 @@ class WallabagRestControllerTest extends WallabagApiTestCase $this->assertCount(0, $entries); } + public function testDeleteTagByLabel() + { + $em = $this->client->getContainer()->get('doctrine.orm.entity_manager'); + $entry = $this->client->getContainer() + ->get('doctrine.orm.entity_manager') + ->getRepository('WallabagCoreBundle:Entry') + ->findOneWithTags($this->user->getId()); + + $entry = $entry[0]; + + $tag = new Tag(); + $tag->setLabel('Awesome tag for test'); + $em->persist($tag); + + $entry->addTag($tag); + + $em->persist($entry); + $em->flush(); + + $this->client->request('DELETE', '/api/tag/label.json', ['tag' => $tag->getLabel()]); + + $this->assertEquals(200, $this->client->getResponse()->getStatusCode()); + + $content = json_decode($this->client->getResponse()->getContent(), true); + + $this->assertArrayHasKey('label', $content); + $this->assertEquals($tag->getLabel(), $content['label']); + $this->assertEquals($tag->getSlug(), $content['slug']); + + $entries = $this->client->getContainer() + ->get('doctrine.orm.entity_manager') + ->getRepository('WallabagCoreBundle:Entry') + ->findAllByTagId($this->user->getId(), $tag->getId()); + + $this->assertCount(0, $entries); + } + + public function testDeleteTagByLabelNotFound() + { + $this->client->request('DELETE', '/api/tag/label.json', ['tag' => 'does not exist']); + + $this->assertEquals(404, $this->client->getResponse()->getStatusCode()); + } + + public function testDeleteTagsByLabel() + { + $em = $this->client->getContainer()->get('doctrine.orm.entity_manager'); + $entry = $this->client->getContainer() + ->get('doctrine.orm.entity_manager') + ->getRepository('WallabagCoreBundle:Entry') + ->findOneWithTags($this->user->getId()); + + $entry = $entry[0]; + + $tag = new Tag(); + $tag->setLabel('Awesome tag for tagsLabel'); + $em->persist($tag); + + $tag2 = new Tag(); + $tag2->setLabel('Awesome tag for tagsLabel 2'); + $em->persist($tag2); + + $entry->addTag($tag); + $entry->addTag($tag2); + + $em->persist($entry); + $em->flush(); + + $this->client->request('DELETE', '/api/tags/label.json', ['tags' => $tag->getLabel().','.$tag2->getLabel()]); + + $this->assertEquals(200, $this->client->getResponse()->getStatusCode()); + + $content = json_decode($this->client->getResponse()->getContent(), true); + + $this->assertCount(2, $content); + + $this->assertArrayHasKey('label', $content[0]); + $this->assertEquals($tag->getLabel(), $content[0]['label']); + $this->assertEquals($tag->getSlug(), $content[0]['slug']); + + $this->assertArrayHasKey('label', $content[1]); + $this->assertEquals($tag2->getLabel(), $content[1]['label']); + $this->assertEquals($tag2->getSlug(), $content[1]['slug']); + + $entries = $this->client->getContainer() + ->get('doctrine.orm.entity_manager') + ->getRepository('WallabagCoreBundle:Entry') + ->findAllByTagId($this->user->getId(), $tag->getId()); + + $this->assertCount(0, $entries); + + $entries = $this->client->getContainer() + ->get('doctrine.orm.entity_manager') + ->getRepository('WallabagCoreBundle:Entry') + ->findAllByTagId($this->user->getId(), $tag2->getId()); + + $this->assertCount(0, $entries); + } + + public function testDeleteTagsByLabelNotFound() + { + $this->client->request('DELETE', '/api/tags/label.json', ['tags' => 'does not exist']); + + $this->assertEquals(404, $this->client->getResponse()->getStatusCode()); + } + public function testGetVersion() { $this->client->request('GET', '/api/version'); -- 2.41.0