Updated composer dependencies, refactored tests and added a new testing strategy: "Robust Testing: Our 3-Level Approach" (video will be published on our official YouTube channel).

Author: DKravtsov

.idea/php.xml

@@ -14,7 +14,7 @@
 		"Elasticsearch"
 	],
 	"homepage": "https://github.com/systemsdk/docker-symfony-api",
-	"version": "v3.7.0",
+	"version": "v3.8.0",
 	"license": "MIT",
 	"authors": [
 		{
@@ -43,7 +43,7 @@
 		"ext-pdo_mysql": "*",
 		"beberlei/doctrineextensions": "1.5.*",
 		"doctrine/doctrine-bundle": "3.0.*",
-		"doctrine/doctrine-migrations-bundle": "3.5.*",
+		"doctrine/doctrine-migrations-bundle": "3.7.*",
 		"doctrine/orm": "3.5.*",
 		"friendsofphp/proxy-manager-lts": "^1.0.19",
 		"dukecity/command-scheduler-bundle": "6.0.*",
@@ -53,9 +53,9 @@
 		"mark-gerarts/automapper-plus-bundle": "1.5.*",
 		"matomo/device-detector": "6.4.*",
 		"matthiasnoback/symfony-console-form": "6.0.*",
-		"nelmio/api-doc-bundle": "5.6.*",
+		"nelmio/api-doc-bundle": "5.8.*",
 		"nelmio/cors-bundle": "2.6.*",
-		"phpdocumentor/reflection-docblock": "^5.6.3",
+		"phpdocumentor/reflection-docblock": "^5.6.4",
 		"ramsey/uuid-doctrine": "2.1.*",
 		"symfony/amqp-messenger": "7.3.*",
 		"symfony/asset": "7.3.*",
@@ -66,7 +66,7 @@
 		"symfony/doctrine-messenger": "7.3.*",
 		"symfony/dotenv": "7.3.*",
 		"symfony/expression-language": "7.3.*",
-		"symfony/flex": "^2.9.0",
+		"symfony/flex": "^2.10.0",
 		"symfony/form": "7.3.*",
 		"symfony/framework-bundle": "7.3.*",
 		"symfony/http-client": "7.3.*",
@@ -91,7 +91,7 @@
 		"symfony/validator": "7.3.*",
 		"symfony/web-link": "7.3.*",
 		"symfony/yaml": "7.3.*",
-		"twig/extra-bundle": "^2.12|^3.22",
+		"twig/extra-bundle": "^2.12|^3.22.1",
 		"twig/twig": "^2.12|^3.22.0"
 	},
 	"conflict": {

composer.json

@@ -16,7 +16,7 @@ when@dev: &dev
             info:
                 title: Symfony Api
                 description: This is an symfony api environment example
-                version: 3.7.0
+                version: 3.8.0
             components:
                 securitySchemes:
                     Bearer:

composer.lock

@@ -8,6 +8,8 @@ This environment uses [PHPUnit](https://phpunit.de/) and includes the following
 * Integration tests
 * Unit tests
 
+To learn about our practical strategy for applying these tests efficiently in real-world projects, watch our video guide on YouTube: [Robust Testing](https://www.youtube.com/@systemsdk).
+
 Note on naming: In Symfony's terminology, `Application` tests are the same as `Functional` tests. We follow the official Symfony naming convention as described [here](https://symfony.com/doc/current/testing.html#application-tests).
 
 ## 🚀 How to Run Tests
@@ -38,13 +40,13 @@ Once inside the container, you can execute phpunit directly.
 
 * To run a single test class:
 ```bash
-./vendor/bin/phpunit ./tests/Application/Controller/ApiKeyControllerTest.php
+./vendor/bin/phpunit ./tests/Application/ApiKey/Transport/Controller/Api/V1/ApiKeyControllerTest.php
 ```
 
 * To run all tests in a directory:
 
 ```bash
-./vendor/bin/phpunit ./tests/Application/Controller/
+./vendor/bin/phpunit ./tests/Application/ApiKey/Transport/Controller/Api/V2/
 ```
 
 * To run a specific test suite (e.g., Unit, as defined in phpunit.xml.dist):

config/packages/nelmio_api_doc.yaml

@@ -119,6 +119,15 @@ public function testThatCreateActionForRootUserReturnsSuccessResponse(): void
         $responseData = JSON::decode($content, true);
         $this->checkBasicFieldsInResponse($responseData);
         self::assertEquals($requestData['description'], $responseData['description']);
+
+        // let's check db state
+        $resource = static::getContainer()->get(ApiKeyResource::class);
+        $apiKeyCreatedEntity = $resource->findOne((string)$responseData['id']);
+        self::assertInstanceOf(ApiKey::class, $apiKeyCreatedEntity);
+        self::assertCount(1, $apiKeyCreatedEntity->getUserGroups());
+        $apiKeyUserGroup = $apiKeyCreatedEntity->getUserGroups()->first();
+        self::assertInstanceOf(UserGroup::class, $apiKeyUserGroup);
+        self::assertSame($requestData['userGroups'][0], $apiKeyUserGroup->getId());
     }
 
     /**

docs/testing.md

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests\Integration\ApiKey\Application\Service\Crypt;
+
+use App\ApiKey\Application\Service\Crypt\Interfaces\OpenSslCryptApiKeyServiceInterface;
+use App\ApiKey\Domain\Entity\ApiKey;
+use App\Role\Domain\Enum\Role;
+use App\User\Domain\Entity\UserGroup;
+use App\User\Domain\Repository\Interfaces\UserGroupRepositoryInterface;
+use PHPUnit\Framework\Attributes\TestDox;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Throwable;
+
+/**
+ * @package App\Tests
+ */
+class OpenSslCryptApiKeyServiceTest extends KernelTestCase
+{
+    private readonly OpenSslCryptApiKeyServiceInterface $service;
+    private readonly ApiKey $apiKeyEntity;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->service = static::getContainer()->get(OpenSslCryptApiKeyServiceInterface::class);
+        $userGroupRepository = static::getContainer()->get(UserGroupRepositoryInterface::class);
+        $userGroup = $userGroupRepository->findOneBy([
+            'role' => Role::API->value,
+        ]);
+        self::assertInstanceOf(UserGroup::class, $userGroup);
+        $this->apiKeyEntity = new ApiKey()->setDescription('Test description')->addUserGroup($userGroup);
+    }
+
+    /**
+     * @throws Throwable
+     */
+    #[TestDox('Test that encryptToken method will not encrypt token with wrong length.')]
+    public function testThatEncryptTokenMethodWillNotEncryptTokenWithWrongLength(): void
+    {
+        // Add extra characters to the token to make its length invalid.
+        $token = $this->apiKeyEntity->getToken() . 'test';
+        $this->apiKeyEntity->setToken($token);
+
+        $this->service->encryptToken($this->apiKeyEntity);
+
+        // check that the token was not encrypted and other params remains unchanged.
+        self::assertSame($token, $this->apiKeyEntity->getToken());
+        self::assertNull($this->apiKeyEntity->getTokenParameters());
+        self::assertNull($this->apiKeyEntity->getTokenHash());
+    }
+
+    /**
+     * @throws Throwable
+     */
+    #[TestDox('Test that decryptToken method will not decrypt token with missing token params or already decrypted.')]
+    public function testThatDecryptTokenMethodWillNotDecryptTokenWithMissingTokenParamsOrAlreadyDecrypted(): void
+    {
+        $token = $this->apiKeyEntity->getToken();
+
+        $this->service->decryptToken($this->apiKeyEntity);
+
+        // Check that the token was not decrypted.
+        self::assertSame($token, $this->apiKeyEntity->getToken());
+    }
+}

tests/Application/ApiKey/Transport/Controller/Api/V1/ApiKeyControllerTest.php

@@ -9,15 +9,15 @@
 use DateTimeImmutable;
 use DateTimeZone;
 use PHPUnit\Framework\Attributes\TestDox;
-use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use PHPUnit\Framework\TestCase;
 use Throwable;
 
 use function floor;
 
 /**
  * @package App\Tests
  */
-class DateDimensionTest extends KernelTestCase
+class DateDimensionTest extends TestCase
 {
     /**
      * @throws Throwable

tests/Integration/ApiKey/Application/Service/Crypt/OpenSslCryptApiKeyServiceTest.php

@@ -4,13 +4,13 @@
 
 namespace App\Tests\Unit;
 
-use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use PHPUnit\Framework\TestCase;
 use Throwable;
 
 /**
  * @package App\Tests\Unit
  */
-class ExampleTest extends KernelTestCase
+class ExampleTest extends TestCase
 {
     /**
      * A basic test example.

tests/Unit/DateDimension/Domain/Entity/DateDimensionTest.php

@@ -2,19 +2,19 @@
 
 declare(strict_types=1);
 
-namespace App\Tests\Integration\General\Application\Validator\Constraints;
+namespace App\Tests\Unit\General\Application\Validator\Constraints;
 
 use App\General\Application\Validator\Constraints\EntityReferenceExists;
 use App\General\Application\Validator\Constraints\EntityReferenceExistsValidator;
 use App\General\Domain\Entity\Interfaces\EntityInterface;
-use App\Tests\Integration\General\Application\Validator\Constraints\Src\TestEntityReference;
+use App\Tests\Unit\General\Application\Validator\Constraints\Src\TestEntityReference;
 use App\Tool\Application\Validator\Constraints\Language;
 use Generator;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 use stdClass;
-use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\Component\Validator\Context\ExecutionContextInterface;
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 use Symfony\Component\Validator\Exception\UnexpectedValueException;
@@ -26,7 +26,7 @@
 /**
  * @package App\Tests
  */
-class EntityReferenceExistsValidatorTest extends KernelTestCase
+class EntityReferenceExistsValidatorTest extends TestCase
 {
     /**
      * @throws Throwable
@@ -41,7 +41,7 @@ public function testThatValidateMethodThrowsUnexpectedTypeException(): void
         );
         $constraint = new Language();
 
-        (new EntityReferenceExistsValidator($loggerMock))->validate('', $constraint);
+        new EntityReferenceExistsValidator($loggerMock)->validate('', $constraint);
     }
 
     /**
@@ -60,7 +60,7 @@ public function testThatValidateMethodThrowsUnexpectedValueException(
         $constraint = new EntityReferenceExists();
         $constraint->entityClass = $entityClass;
 
-        (new EntityReferenceExistsValidator($loggerMock))->validate($value, $constraint);
+        new EntityReferenceExistsValidator($loggerMock)->validate($value, $constraint);
     }
 
     #[TestDox('Test that `validate` method throws an exception if value is `stdClass`.')]