Merge pull request #56 from stlgaits/main

retrofit
stlgaits · Nov 20, 2022 · dd71fe1 · dd71fe1
2 parents bb52b66 + 7c085ee
commit dd71fe1
Show file tree

Hide file tree

Showing 11 changed files with 319 additions and 175 deletions.
diff --git a/.phpunit.cache/test-results b/.phpunit.cache/test-results
diff --git a/clover.xml b/clover.xml
diff --git a/docs/README.md b/docs/README.md
@@ -12,14 +12,14 @@
 [![docsify](https://img.shields.io/badge/documented%20with-docsify-cc00ff.svg)](https://docsify.js.org/)
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/def1dc4a68e847998365282ad9e8b3ee)](https://www.codacy.com/gh/EstelleMyddleware/todo/dashboard?utm_source=github.com&utm_medium=referral&utm_content=EstelleMyddleware/todo&utm_campaign=Badge_Coverage)
 
+:mega::mega::mega: **You can view the detailed documentation & UML diagrams of this project [here](https://stlgaits.github.io/todo/)** :mega::mega::mega:
+
 !> This project is part of the Openclassrooms PHP / Symfony Apps Developer training course. It consists in auditing, 
 unit-testing, profiling & making improvements to an existing to-do list app built in Symfony 3.1 
 (available [here](https://github.com/saro0h/projet8-TodoList)).
 
 [![Estelle's GitHub stats](https://github-readme-stats.vercel.app/api?username=stlgaits&show_icons=true&theme=tokyonight)](https://github.com/stlgaits/github-readme-stats)
 
-You can view the detailed documentation of this project [here](https://stlgaits.github.io/todo/)
-
 ## Installation
 
 ### Downloading the project

diff --git a/src/Test/CustomTestCase.php b/src/Test/CustomTestCase.php
@@ -10,6 +10,10 @@
 use Hautelook\AliceBundle\PhpUnit\RefreshDatabaseTrait;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 
+
+/**
+ * @codeCoverageIgnore
+ */
 class CustomTestCase extends WebTestCase
 {
     use RefreshDatabaseTrait;

diff --git a/tests/Controller/DefaultControllerTest.php b/tests/Controller/DefaultControllerTest.php
@@ -7,10 +7,16 @@
 use App\Test\CustomTestCase;
 
 /**
- * @covers \App\Entity\DefaultController
+ * @covers \App\Controller\DefaultController
+ * @uses \App\Security\Voter\TaskVoter
+ * @uses \App\Entity\User
  */
 final class DefaultControllerTest extends CustomTestCase
 {
+
+    /**
+     * @covers \App\Controller\DefaultController::index
+     */
     public function testIndex(): void
     {
         self::ensureKernelShutdown();
@@ -23,6 +29,9 @@ public function testIndex(): void
         $this->assertSelectorTextContains('h1', "Bienvenue sur Todo List, l'application vous permettant de gérer l'ensemble de vos tâches sans effort !");
     }
 
+    /**
+     * @covers \App\Controller\DefaultController::index
+     */
     public function testVisitingWhileLoggedIn(): void
     {
         $client = self::createClient();

diff --git a/tests/Controller/SecurityControllerTest.php b/tests/Controller/SecurityControllerTest.php
@@ -9,16 +9,24 @@
 /**
  * @group security
  * @covers \App\Controller\SecurityController
+ * @covers \App\Security\Voter\TaskVoter
+ * @uses \App\Entity\User
  */
 final class SecurityControllerTest extends CustomTestCase
 {
+    /**
+     * @covers \App\Controller\SecurityController::login
+     */
     public function testAnyoneCanAccessLoginForm(): void
     {
         $client = $this->createClient();
         $client->request('GET', '/login');
         $this->assertResponseIsSuccessful();
     }
 
+    /**
+     * @covers \App\Controller\SecurityController::login
+     */
     public function testLogin(): void
     {
         $client = $this->createClient();
@@ -28,6 +36,9 @@ public function testLogin(): void
         $this->assertResponseIsSuccessful();
     }
 
+    /**
+     * @covers \App\Controller\SecurityController::login
+     */
     public function testUserCanLoginViaForm(): void
     {
         $client = $this->createClient();
@@ -43,6 +54,9 @@ public function testUserCanLoginViaForm(): void
     }
 
 
+    /**
+     * @covers \App\Controller\SecurityController::login
+     */
     public function testCannotLoginWithInvalidCredentials(): void
     {
         $client = static::createClient();
@@ -60,6 +74,9 @@ public function testCannotLoginWithInvalidCredentials(): void
     }
 
 
+    /**
+     * @covers \App\Controller\SecurityController::logout
+     */
     public function testLogout(): void
     {
         $this->markTestSkipped();

diff --git a/tests/Controller/TaskControllerTest.php b/tests/Controller/TaskControllerTest.php
@@ -9,10 +9,17 @@
 use App\Test\CustomTestCase;
 
 /**
- * @covers \App\Entity\TaskController
+ * @covers \App\Controller\TaskController
+ * @uses \App\Security\Voter\TaskVoter
+ * @uses \App\Entity\Task
+ * @uses \App\Repository\TaskRepository
+ * @uses \App\Entity\User
  */
 final class TaskControllerTest extends CustomTestCase
 {
+    /**
+     * @covers \App\Controller\TaskController::list
+     */
     public function testUserCanReadTasksList(): void
     {
         $client = $this->createClient();
@@ -22,6 +29,10 @@ public function testUserCanReadTasksList(): void
         $this->assertResponseIsSuccessful();
     }
 
+    /**
+     * @covers \App\Controller\TaskController::list
+     * @uses \App\Controller\DefaultController::index
+     */
     public function testUserCanAccessTaskListViaALink(): void
     {
         $client = $this->createClient();
@@ -35,6 +46,9 @@ public function testUserCanAccessTaskListViaALink(): void
         $this->assertSelectorTextContains("button", "Marquer comme faite");
     }
 
+    /**
+     * @covers \App\Controller\TaskController::list
+     */
     public function testCannotAccessTasksListAnonymously(): void
     {
         $client = $this->createClient();
@@ -44,6 +58,10 @@ public function testCannotAccessTasksListAnonymously(): void
     }
 
 
+    /**
+     * @covers \App\Controller\TaskController::create
+     * @uses \App\Controller\SecurityController::login
+     */
     public function testCannotCreateTaskAnonymously(): void
     {
         $client = $this->createClient();
@@ -57,6 +75,10 @@ public function testCannotCreateTaskAnonymously(): void
         );
     }
 
+    /**
+     * @covers \App\Controller\TaskController::create
+     * @uses \App\Form\TaskType
+     */
     public function testLoggedInUsersCanAccessTaskCreationPage(): void
     {
         $client = $this->createClient();
@@ -70,6 +92,10 @@ public function testLoggedInUsersCanAccessTaskCreationPage(): void
         $this->assertSelectorExists('button[type="submit"]');
     }
 
+    /**
+     * @covers \App\Controller\TaskController::create
+     * @uses \App\Form\TaskType
+     */
     public function testUserCanCreateNewTask(): void
     {
         $client = $this->createClient();
@@ -91,6 +117,10 @@ public function testUserCanCreateNewTask(): void
     }
 
 
+    /**
+     * @covers \App\Controller\TaskController::edit
+     * @uses \App\Form\TaskType
+     */
     public function testCannotEditTaskAuthor(): void
     {
         $client = $this->createClient();
@@ -117,6 +147,9 @@ public function testCannotEditTaskAuthor(): void
         $this->assertResponseRedirects('/tasks', 303);
     }
 
+    /**
+     * @covers \App\Controller\TaskController::deleteTask
+     */
     public function testAdminUserCanDeleteDefaultTasks(): void
     {
         $client = $this->createClient();
@@ -131,6 +164,10 @@ public function testAdminUserCanDeleteDefaultTasks(): void
         $this->assertResponseRedirects('/tasks', 303);
     }
 
+    /**
+     * @covers \App\Controller\TaskController::edit
+     * @uses \App\Form\TaskType
+     */
     public function testAuthorCanAccessTaskEditForm(): void
     {
         $client = $this->createClient();
@@ -147,6 +184,10 @@ public function testAuthorCanAccessTaskEditForm(): void
         $this->assertSelectorExists('button[type="submit"]');
     }
 
+    /**
+     * @covers \App\Controller\TaskController::edit
+     * @uses \App\Form\TaskType
+     */
     public function testTaskCanBeEdited(): void
     {
         $client = $this->createClient();
@@ -169,6 +210,9 @@ public function testTaskCanBeEdited(): void
     }
 
 
+    /**
+     * @covers \App\Controller\TaskController::toggleTask
+     */
     public function testUserCanToggleATask(): void
     {
         $client = $this->createClient();
@@ -186,6 +230,9 @@ public function testUserCanToggleATask(): void
         $this->assertResponseRedirects("/tasks", 303);
     }
 
+    /**
+     * @covers \App\Controller\TaskController::deleteTask
+     */
     public function testAuthorCanDeleteTheirOwnTask(): void
     {
         $client = $this->createClient();
@@ -199,6 +246,9 @@ public function testAuthorCanDeleteTheirOwnTask(): void
         $this->assertNull($taskRepository->find(2));
     }
 
+    /**
+     * @covers \App\Controller\TaskController::deleteTask
+     */
     public function testCannotDeleteTaskOfWhichUserIsNotTheAuthor(): void
     {
         $client = $this->createClient();

diff --git a/tests/Controller/UserControllerTest.php b/tests/Controller/UserControllerTest.php
@@ -5,12 +5,19 @@
 namespace App\Tests\Controller;
 
 use App\Test\CustomTestCase;
+use http\Client\Curl\User;
 
 /**
  * @group security
+ * @covers  App\Controller\UserController
+ * @uses \App\Entity\User
+ * @uses \App\Security\Voter\TaskVoter
  */
 final class UserControllerTest extends CustomTestCase
 {
+    /**
+     * @covers \App\Controller\UserController::list
+     */
     public function testOnlyAdminUsersCanAccessUsersListPage(): void
     {
         $client = $this->createClient();
@@ -20,6 +27,9 @@ public function testOnlyAdminUsersCanAccessUsersListPage(): void
         $this->assertResponseIsSuccessful();
     }
 
+    /**
+     * @covers \App\Controller\UserController::list
+     */
     public function testAnonymousUserCannotAccessUsersListPage(): void
     {
         $client = $this->createClient();
@@ -28,6 +38,9 @@ public function testAnonymousUserCannotAccessUsersListPage(): void
         $this->assertResponseStatusCodeSame(302);
     }
 
+    /**
+     * @covers \App\Controller\UserController::list
+     */
     public function testNonAdminUserCannotAccessUsersListPage(): void
     {
         $client = $this->createClient();
@@ -37,10 +50,14 @@ public function testNonAdminUserCannotAccessUsersListPage(): void
         $this->assertResponseStatusCodeSame(403);
     }
 
+    /**
+     * @covers \App\Controller\UserController::create
+     */
     public function testAdminUserCanCreateNewUser(): void
     {
         $client = $this->createClient();
-        $user = $this->createAdminUser("IamAdmin", "mysupersecureadminpwd", "[email protected]");
+        $userRepository = $this->getEntityManager()->getRepository(User::class);
+        $user = $userRepository->findOneBy(['username' => 'admin']);
         $client->loginUser($user);
         $client->request('GET', '/users/create');
         $this->markTestIncomplete();
@@ -51,26 +68,41 @@ public function testAdminUserCanCreateNewUser(): void
         $this->assertResponseIsSuccessful();
     }
 
+    /**
+     * @covers \App\Controller\UserController::create
+     */
     public function testNonAdminUserCannotCreateNewUser(): void
     {
         $this->markTestIncomplete();
     }
 
+    /**
+     * @covers \App\Controller\UserController::edit
+     */
     public function testAdminUserCanEditAnotherUser(): void
     {
         $this->markTestIncomplete();
     }
 
+    /**
+     * @covers \App\Controller\UserController::edit
+     */
     public function testAdminUserCanPromoteAnotherUser(): void
     {
         $this->markTestIncomplete();
     }
 
+    /**
+     * @covers \App\Controller\UserController::edit
+     */
     public function testAdminUserCanDemoteAnotherUser(): void
     {
         $this->markTestIncomplete();
     }
 
+    /**
+     * @covers \App\Controller\UserController::edit
+     */
     public function testNonAdminUserCannotEditAnotherUser(): void
     {
         $this->markTestIncomplete();