adding unit test + improving code

Julien Neuhart · Julien Neuhart · commit def3b9369180 · 2019-06-19T18:09:20.000+02:00
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -38,6 +38,16 @@ services:
       - mysql_data:/var/lib/mysql
       - ./services/mysql/utf8mb4.cnf:/etc/mysql/conf.d/utf8mb4.cnf:ro
 
+  mysql_tests:
+    image: mysql:5.7
+    environment:
+      MYSQL_ROOT_PASSWORD: "admin"
+      MYSQL_DATABASE: "tests"
+      MYSQL_USER: "foo"
+      MYSQL_PASSWORD: "bar"
+    volumes:
+      - ./services/mysql/utf8mb4.cnf:/etc/mysql/conf.d/utf8mb4.cnf:ro
+
   phpmyadmin:
     image: phpmyadmin/phpmyadmin:4.7
     labels:
diff --git a/sources/app/assets/vue/api/post.js b/sources/app/assets/vue/api/post.js
@@ -2,11 +2,11 @@ import axios from "axios";
 
 export default {
   create(message) {
-    return axios.post("/api/post/create", {
+    return axios.post("/api/posts", {
       message: message
     });
   },
-  posts() {
+  findAll() {
     return axios.get("/api/posts");
   }
 };
diff --git a/sources/app/assets/vue/components/ErrorMessage.vue b/sources/app/assets/vue/components/ErrorMessage.vue
@@ -12,7 +12,7 @@ export default {
   name: "ErrorMessage",
   props: {
     error: {
-      type: Object,
+      type: Error,
       required: true
     }
   },
diff --git a/sources/app/assets/vue/store/post.js b/sources/app/assets/vue/store/post.js
@@ -74,10 +74,10 @@ export default {
         return null;
       }
     },
-    async posts({ commit }) {
+    async findAll({ commit }) {
       commit(FETCHING_POSTS);
       try {
-        let response = await PostAPI.posts();
+        let response = await PostAPI.findAll();
         commit(FETCHING_POSTS_SUCCESS, response.data);
         return response.data;
       } catch (error) {
diff --git a/sources/app/assets/vue/views/Posts.vue b/sources/app/assets/vue/views/Posts.vue
@@ -99,7 +99,7 @@ export default {
     }
   },
   created() {
-    this.$store.dispatch("post/posts");
+    this.$store.dispatch("post/findAll");
   },
   methods: {
     async createPost() {
diff --git a/sources/app/composer.json b/sources/app/composer.json
@@ -40,6 +40,7 @@
         "squizlabs/php_codesniffer": "^3.4",
         "symfony/debug-pack": "*",
         "symfony/maker-bundle": "^1.0",
+        "symfony/phpunit-bridge": "^4.3",
         "symfony/profiler-pack": "*",
         "symfony/test-pack": "*",
         "symfony/web-server-bundle": "4.3.*",
@@ -73,7 +74,7 @@
     "scripts": {
         "csfix": "phpcbf --ignore=src/Migrations/**,src/Kernel.php",
         "cscheck": "phpcs --ignore=src/Migrations/**,src/Kernel.php",
-        "phpstan": "phpstan analyse src/ tests/ -c phpstan.neon --level=7 --no-progress -vvv --memory-limit=1024M",
+        "phpstan": "phpstan analyse src/ -c phpstan.neon --level=7 --no-progress -vvv --memory-limit=1024M",
         "auto-scripts": {
             "cache:clear": "symfony-cmd",
             "assets:install %PUBLIC_DIR%": "symfony-cmd"
diff --git a/sources/app/composer.lock b/sources/app/composer.lock
diff --git a/sources/app/config/packages/security.yaml b/sources/app/config/packages/security.yaml
@@ -2,7 +2,7 @@ security:
     # https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
     encoders:
         App\Entity\User:
-            algorithm: bcrypt
+            algorithm: auto
     providers:
         in_memory: { memory: ~ }
         pdo:
diff --git a/sources/app/config/services.yaml b/sources/app/config/services.yaml
@@ -26,6 +26,10 @@ services:
 
     # add more service definitions when explicit configuration is needed
     # please note that last definitions always *replace* previous ones
+    App\Exception\HTTPExceptionListener:
+        tags:
+            - { name: kernel.event_listener, event: kernel.exception }
+
     app.security.hash.password.listener:
         class: App\Security\HashPasswordListener
         tags:
diff --git a/sources/app/phpcs.xml.dist b/sources/app/phpcs.xml.dist
@@ -10,7 +10,7 @@
 
     <!-- Directories to be checked -->
     <file>src</file>
-    <!-- <file>tests</file> -->
+    <file>tests</file>
 
     <exclude-pattern>tests/dependencies/*</exclude-pattern>
 
diff --git a/sources/app/phpunit.xml.dist b/sources/app/phpunit.xml.dist
@@ -5,14 +5,16 @@
          xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.5/phpunit.xsd"
          backupGlobals="false"
          colors="true"
-         bootstrap="config/bootstrap.php"
+         bootstrap="tests/bootstrap.php"
 >
     <php>
         <ini name="error_reporting" value="-1" />
-        <server name="APP_ENV" value="test" force="true" />
-        <server name="SHELL_VERBOSITY" value="-1" />
-        <server name="SYMFONY_PHPUNIT_REMOVE" value="" />
-        <server name="SYMFONY_PHPUNIT_VERSION" value="6.5" />
+        <env name="APP_ENV" value="test" force="true" />
+        <env name="SHELL_VERBOSITY" value="-1" />
+        <env name="SYMFONY_PHPUNIT_REMOVE" value="" />
+        <env name="SYMFONY_PHPUNIT_VERSION" value="6.5" />
+        <env name="KERNEL_CLASS" value="App\Kernel" />
+        <env name="DATABASE_URL" value="mysql://foo:bar@mysql_tests/tests" force="true" />
     </php>
 
     <testsuites>
diff --git a/sources/app/src/Controller/PostController.php b/sources/app/src/Controller/PostController.php
@@ -11,10 +11,13 @@
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\SerializerInterface;
 
 /**
+ * @Rest\Route("/api")
  * @IsGranted("IS_AUTHENTICATED_FULLY")
  */
 final class PostController extends AbstractController
@@ -32,29 +35,34 @@ public function __construct(EntityManagerInterface $em, SerializerInterface $ser
     }
 
     /**
-     * @Rest\Post("/api/post/create", name="createPost")
+     * @throws BadRequestHttpException
+     *
+     * @Rest\Post("/posts", name="createPost")
      * @IsGranted("ROLE_FOO")
      */
     public function createAction(Request $request): JsonResponse
     {
         $message = $request->request->get('message');
+        if (empty($message)) {
+            throw new BadRequestHttpException('message cannot be empty');
+        }
         $post = new Post();
         $post->setMessage($message);
         $this->em->persist($post);
         $this->em->flush();
         $data = $this->serializer->serialize($post, JsonEncoder::FORMAT);
 
-        return new JsonResponse($data, 200, [], true);
+        return new JsonResponse($data, Response::HTTP_CREATED, [], true);
     }
 
     /**
-     * @Rest\Get("/api/posts", name="posts")
+     * @Rest\Get("/posts", name="findAllPosts")
      */
-    public function postsAction(): JsonResponse
+    public function findAllAction(): JsonResponse
     {
         $posts = $this->em->getRepository(Post::class)->findBy([], ['id' => 'DESC']);
         $data = $this->serializer->serialize($posts, JsonEncoder::FORMAT);
 
-        return new JsonResponse($data, 200, [], true);
+        return new JsonResponse($data, Response::HTTP_OK, [], true);
     }
 }
diff --git a/sources/app/src/Controller/SecurityController.php b/sources/app/src/Controller/SecurityController.php
@@ -8,10 +8,14 @@
 use RuntimeException;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\SerializerInterface;
 
+/**
+ * @Route("/api")
+ */
 final class SecurityController extends AbstractController
 {
     /** @var SerializerInterface */
@@ -23,7 +27,7 @@ public function __construct(SerializerInterface $serializer)
     }
 
     /**
-     * @Route("/api/security/login", name="login")
+     * @Route("/security/login", name="login")
      */
     public function loginAction(): JsonResponse
     {
@@ -33,13 +37,13 @@ public function loginAction(): JsonResponse
         $userClone->setPassword('');
         $data = $this->serializer->serialize($userClone, JsonEncoder::FORMAT);
 
-        return new JsonResponse($data, 200, [], true);
+        return new JsonResponse($data, Response::HTTP_OK, [], true);
     }
 
     /**
      * @throws RuntimeException
      *
-     * @Route("/api/security/logout", name="logout")
+     * @Route("/security/logout", name="logout")
      */
     public function logoutAction(): void
     {
diff --git a/sources/app/src/DataFixtures/AppFixtures.php b/sources/app/src/DataFixtures/AppFixtures.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\DataFixtures;
+
+use Doctrine\Bundle\FixturesBundle\Fixture;
+use Doctrine\Common\Persistence\ObjectManager;
+
+final class AppFixtures extends Fixture
+{
+    public function load(ObjectManager $manager): void
+    {
+        $manager->flush();
+    }
+}
diff --git a/sources/app/src/DataFixtures/UserFixtures.php b/sources/app/src/DataFixtures/UserFixtures.php
@@ -10,12 +10,29 @@
 
 final class UserFixtures extends Fixture
 {
+    public const DEFAULT_USER_LOGIN = 'foo';
+
+    public const DEFAULT_USER_PASSWORD = 'bar';
+
+    public const USER_LOGIN_ROLE_BAR = 'bar';
+
+    public const USER_PASSWORD_ROLE_BAR = 'foo';
+
     public function load(ObjectManager $manager): void
+    {
+        $this->createUser($manager, self::DEFAULT_USER_LOGIN, self::DEFAULT_USER_PASSWORD, ['ROLE_FOO']);
+        $this->createUser($manager, self::USER_LOGIN_ROLE_BAR, self::USER_PASSWORD_ROLE_BAR, ['ROLE_BAR']);
+    }
+
+    /**
+     * @param string[] $roles
+     */
+    private function createUser(ObjectManager $manager, string $login, string $password, array $roles): void
     {
         $userEntity = new User();
-        $userEntity->setLogin('foo');
-        $userEntity->setPlainPassword('bar');
-        $userEntity->setRoles(['ROLE_FOO']);
+        $userEntity->setLogin($login);
+        $userEntity->setPlainPassword($password);
+        $userEntity->setRoles($roles);
         $manager->persist($userEntity);
         $manager->flush();
     }
diff --git a/sources/app/src/Exception/HTTPExceptionListener.php b/sources/app/src/Exception/HTTPExceptionListener.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Exception;
+
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpKernel\Event\ExceptionEvent;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+use function strpos;
+
+final class HTTPExceptionListener
+{
+    public function onKernelException(ExceptionEvent $event): void
+    {
+        $exception = $event->getException();
+        if (! ($exception instanceof HttpException) || strpos($event->getRequest()->getRequestUri(), '/api/') === false) {
+            return;
+        }
+
+        $response = new JsonResponse(['error' => $exception->getMessage()]);
+        $response->setStatusCode($exception->getStatusCode());
+        $event->setResponse($response);
+    }
+}
diff --git a/sources/app/src/Migrations/Version20190618152017.php b/sources/app/src/Migrations/Version20190618152017.php
@@ -22,7 +22,7 @@ public function up(Schema $schema) : void
         // this up() migration is auto-generated, please modify it to your needs
         $this->abortIf($this->connection->getDatabasePlatform()->getName() !== 'mysql', 'Migration can only be executed safely on \'mysql\'.');
 
-        $this->addSql('CREATE TABLE users (id CHAR(36) NOT NULL COMMENT \'(DC2Type:uuid)\', login VARCHAR(255) NOT NULL, password VARCHAR(255) NOT NULL, roles LONGTEXT NOT NULL COMMENT \'(DC2Type:simple_array)\', created DATETIME NOT NULL, updated DATETIME DEFAULT NULL, UNIQUE INDEX UNIQ_8D93D649AA08CB10 (login), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE = InnoDB');
+        $this->addSql('CREATE TABLE users (id CHAR(36) NOT NULL COMMENT \'(DC2Type:uuid)\', login VARCHAR(255) NOT NULL, password VARCHAR(255) NOT NULL, roles LONGTEXT NOT NULL COMMENT \'(DC2Type:simple_array)\', created DATETIME NOT NULL, updated DATETIME DEFAULT NULL, UNIQUE INDEX UNIQ_1483A5E9AA08CB10 (login), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE = InnoDB');
     }
 
     public function down(Schema $schema) : void
diff --git a/sources/app/tests/Controller/AbstractControllerWebTestCase.php b/sources/app/tests/Controller/AbstractControllerWebTestCase.php
@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests\Controller;
+
+use App\DataFixtures\UserFixtures;
+use Safe\Exceptions\JsonException;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use function Safe\json_decode;
+use function Safe\json_encode;
+
+abstract class AbstractControllerWebTestCase extends WebTestCase
+{
+    /** @var KernelBrowser */
+    protected $client;
+
+    protected function setUp(): void
+    {
+        self::bootKernel();
+        $this->client = static::createClient();
+    }
+
+    /**
+     * @param mixed[] $data
+     *
+     * @throws JsonException
+     */
+    protected function JSONRequest(string $method, string $uri, array $data = []): void
+    {
+        $this->client->request($method, $uri, [], [], ['CONTENT_TYPE' => 'application/json'], json_encode($data));
+    }
+
+    /**
+     * @return mixed
+     *
+     * @throws JsonException
+     */
+    protected function assertJSONResponse(Response $response, int $expectedStatusCode)
+    {
+        $this->assertEquals($expectedStatusCode, $response->getStatusCode());
+        $this->assertTrue($response->headers->contains('Content-Type', 'application/json'));
+        $this->assertJson($response->getContent());
+
+        return json_decode($response->getContent(), true);
+    }
+
+    /**
+     * @throws JsonException
+     */
+    protected function login(string $username = UserFixtures::DEFAULT_USER_LOGIN, string $password = UserFixtures::DEFAULT_USER_PASSWORD): void
+    {
+        $this->client->request(Request::METHOD_POST, '/api/security/login', [], [], ['CONTENT_TYPE' => 'application/json'], json_encode(['username' => $username, 'password' => $password]));
+        $this->assertEquals(Response::HTTP_OK, $this->client->getResponse()->getStatusCode());
+    }
+}
diff --git a/sources/app/tests/Controller/PostControllerTest.php b/sources/app/tests/Controller/PostControllerTest.php
diff --git a/sources/app/tests/bootstrap.php b/sources/app/tests/bootstrap.php

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ export default {`
`12`	`12`	`name: "ErrorMessage",`
`13`	`13`	`props: {`
`14`	`14`	`error: {`
`15`		`- type: Object,`
	`15`	`+ type: Error,`
`16`	`16`	`required: true`
`17`	`17`	`}`
`18`	`18`	`},`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ export default {`
`99`	`99`	`}`
`100`	`100`	`},`
`101`	`101`	`created() {`
`102`		`- this.$store.dispatch("post/posts");`
	`102`	`+ this.$store.dispatch("post/findAll");`
`103`	`103`	`},`
`104`	`104`	`methods: {`
`105`	`105`	`async createPost() {`