Merge pull request #1268 from tarlepp/refactor/phpstan-configuration

Refactor/PHPStan setup + code cleanup
tarlepp · Jun 8, 2021 · 5c333d8 · 5c333d8
2 parents fdfcae3 + 7be5341
commit 5c333d8
Show file tree

Hide file tree

Showing 29 changed files with 68 additions and 228 deletions.
diff --git a/.env b/.env
@@ -24,5 +24,5 @@ APP_SECRET=c200e4e3cdc72f0a12d3eada5f694526
 ###< symfony/framework-bundle ###
 
 ###> symfony-flex-backend ###
-APPLICATION_CONFIG=/app/secrets/application.json
+APPLICATION_CONFIG=./secrets/application.json
 ###< symfony-flex-backend ###
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -42,13 +42,6 @@ jobs:
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
           restore-keys: ${{ runner.os }}-composer-
 
-      - name: Configure application for CI run
-        run: |
-          cp .env.gh-actions .env
-          cp .env.gh-actions .env.test
-          make generate-jwt-keys
-          chmod 644 ./config/jwt/private.pem
-
       - name: Validate composer.json and composer.lock
         run: composer validate
 

diff --git a/Makefile b/Makefile
@@ -210,7 +210,7 @@ psalm: ## Runs Psalm static analysis tool
 ifeq ($(INSIDE_DOCKER), 1)
 	@echo "\033[32mRunning Psalm - A static analysis tool for PHP\033[39m"
 	@mkdir -p build
-	@@bin/console cache:clear --env=test
+	@@bin/console cache:clear
 	@php ./vendor/bin/psalm --version
 	@php ./vendor/bin/psalm --no-cache --report=./build/psalm.json
 else
@@ -221,7 +221,7 @@ psalm-shepherd: ## Runs Psalm static analysis tool + report results to shepherd
 ifeq ($(INSIDE_DOCKER), 1)
 	@echo "\033[32mRunning Psalm - A static analysis tool for PHP\033[39m"
 	@mkdir -p build
-	@@bin/console cache:clear --env=test
+	@@bin/console cache:clear
 	@php ./vendor/bin/psalm --version
 	@php ./vendor/bin/psalm --no-cache --shepherd --report=./build/psalm.json
 else
@@ -232,7 +232,7 @@ psalm-github: ## Runs Psalm static analysis tool
 ifeq ($(INSIDE_DOCKER), 1)
 	@echo "\033[32mRunning Psalm - A static analysis tool for PHP\033[39m"
 	@mkdir -p build
-	@@bin/console cache:clear --env=test
+	@@bin/console cache:clear
 	@php ./vendor/bin/psalm --version
 	@php ./vendor/bin/psalm --no-cache --shepherd --report=./build/psalm.json --output-format=github
 else
@@ -242,7 +242,7 @@ endif
 phpstan: ## Runs PHPStan static analysis tool
 ifeq ($(INSIDE_DOCKER), 1)
 	@echo "\033[32mRunning PHPStan - PHP Static Analysis Tool\033[39m"
-	@@bin/console cache:clear --env=test
+	@@bin/console cache:clear
 	@./vendor/bin/phpstan --version
 	@./vendor/bin/phpstan
 else

diff --git a/config/services.yaml b/config/services.yaml
@@ -91,6 +91,24 @@ when@dev:
         App\Utils\Tests\:
             resource: '../src/Utils/Tests'
 
+        App\Tests\E2E\Rest\src\:
+            resource: '../tests/E2E/Rest/src/*'
+
+        App\Tests\E2E\Rest\src\Controller\:
+            resource: '../tests/E2E/Rest/src/Controller/*'
+            tags:
+                - 'controller.service_arguments'
+                - 'app.rest.controller'
+
+        App\Tests\E2E\Rest\Traits\Actions\src\:
+            resource: '../tests/E2E/Rest/Traits/Actions/src/*'
+            tags:
+                - 'controller.service_arguments'
+                - 'app.rest.controller'
+
+        App\Tests\Integration\Helpers\src\:
+            resource: '../tests/Integration/Helpers/src/*'
+
         ProxyManager\Factory\AccessInterceptorValueHolderFactory:
             class: ProxyManager\Factory\AccessInterceptorValueHolderFactory
 

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -5,7 +5,8 @@ parameters:
         - tests
     editorUrl: '%%file%%:%%line%%'
     checkGenericClassInNonGenericObjectType: false
-
+    symfony:
+        container_xml_path: var/cache/dev/App_KernelDevDebugContainer.xml
 includes:
     - tools/02_phpstan/vendor/phpstan/phpstan/conf/bleedingEdge.neon
     - tools/02_phpstan/vendor/phpstan/phpstan-phpunit/extension.neon

diff --git a/tests/E2E/Controller/HealthzControllerTest.php b/tests/E2E/Controller/HealthzControllerTest.php
@@ -38,7 +38,6 @@ public function testThatHealthzRouteReturns200(): void
      */
     public function testThatHealthzRouteDoesNotMakeRequestLog(): void
     {
-        /** @var LogRequestResource $resource */
         $resource = static::getContainer()->get(LogRequestResource::class);
 
         $expectedLogCount = $resource->count();

diff --git a/tests/E2E/Controller/Profile/GroupsControllerTest.php b/tests/E2E/Controller/Profile/GroupsControllerTest.php
@@ -170,7 +170,6 @@ public function dataProviderTestThatGroupsActionReturnExpected(): Generator
      */
     public function dataProviderTestThatGroupsActionReturnExpectedWithValidApiKey(): Generator
     {
-        /** @var RolesService $rolesService */
         $rolesService = static::getContainer()->get(RolesService::class);
 
         foreach ($rolesService->getRoles() as $role) {

diff --git a/tests/E2E/Controller/Profile/IndexControllerTest.php b/tests/E2E/Controller/Profile/IndexControllerTest.php
@@ -155,7 +155,6 @@ public function dataProviderTestThatGetTokenReturnsJwtWithValidCredentials(): Ge
      */
     public function dataProviderTestThatProfileActionReturnsExpected(): Generator
     {
-        /** @var RolesService $rolesService */
         $rolesService = static::getContainer()->get(RolesService::class);
 
         foreach ($rolesService->getRoles() as $role) {

diff --git a/tests/E2E/Controller/Profile/RolesControllerTest.php b/tests/E2E/Controller/Profile/RolesControllerTest.php
@@ -158,7 +158,6 @@ public function dataProviderTestThatRolesActionReturnsExpected(): Generator
      */
     public function dataProviderTestThatRolesActionReturnsExpectedWithValidApiKey(): Generator
     {
-        /** @var RolesService $rolesService */
         $rolesService = static::getContainer()->get(RolesService::class);
 
         foreach ($rolesService->getRoles() as $role) {

diff --git a/tests/E2E/Controller/User/UserRolesControllerTest.php b/tests/E2E/Controller/User/UserRolesControllerTest.php
@@ -127,7 +127,6 @@ public function dataProviderTestThatGetRolesActionsReturns403ForInvalidUser(): G
      */
     public function dataProviderTestThatGetUserRolesReturns200ForUserHimself(): Generator
     {
-        /** @var RolesService $rolesService */
         $rolesService = static::getContainer()->get(RolesService::class);
 
         yield [
@@ -180,7 +179,6 @@ public function dataProviderTestThatGetUserRolesReturns200ForUserHimself(): Gene
      */
     public function dataProviderTestThatGetRolesReturns200ForRootRoleUser(): Generator
     {
-        /** @var RolesService $rolesService */
         $rolesService = static::getContainer()->get(RolesService::class);
 
         yield [LoadUserData::$uuids['john'], '[]'];

diff --git a/tests/E2E/Controller/VersionControllerTest.php b/tests/E2E/Controller/VersionControllerTest.php
@@ -40,7 +40,6 @@ public function testThatVersionRouteReturns200(): void
      */
     public function testThatVersionRouteDoesNotMakeRequestLog(): void
     {
-        /** @var LogRequestResource $resource */
         $resource = static::getContainer()->get(LogRequestResource::class);
 
         $expectedLogCount = $resource->count();

diff --git a/tests/E2E/Rest/ResourceLifeCycleTest.php b/tests/E2E/Rest/ResourceLifeCycleTest.php
@@ -14,7 +14,6 @@
 use App\Utils\Tests\WebTestCase;
 use Generator;
 use Throwable;
-use UnexpectedValueException;
 use function sprintf;
 
 /**
@@ -25,27 +24,6 @@
  */
 class ResourceLifeCycleTest extends WebTestCase
 {
-    private ?RoleRepository $repository = null;
-
-    /**
-     * @throws Throwable
-     */
-    protected function setUp(): void
-    {
-        parent::setUp();
-
-        static::bootKernel();
-
-        $testResource = static::$kernel->getContainer()->get(ResourceForLifeCycleTests::class);
-
-        /** @psalm-suppress TypeDoesNotContainType */
-        if (!($testResource instanceof ResourceForLifeCycleTests)) {
-            throw new UnexpectedValueException('Invalid resource class');
-        }
-
-        $this->repository = $testResource->getRepository();
-    }
-
     /**
      * @dataProvider dataProviderTestThatModifiedEntityIsNotFlushedIfLifeCycleMethodThrowsAnException
      *
@@ -80,6 +58,6 @@ public function dataProviderTestThatModifiedEntityIsNotFlushedIfLifeCycleMethodT
 
     private function getRepository(): RoleRepository
     {
-        return $this->repository ?? throw new UnexpectedValueException('Invalid resource class');
+        return static::getContainer()->get(ResourceForLifeCycleTests::class)->getRepository();
     }
 }
diff --git a/tests/Functional/ArgumentResolver/LoggedInUserValueResolverTest.php b/tests/Functional/ArgumentResolver/LoggedInUserValueResolverTest.php
@@ -21,7 +21,6 @@
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
 use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
 use Throwable;
-use function assert;
 use function iterator_to_array;
 
 /**
@@ -32,18 +31,6 @@
  */
 class LoggedInUserValueResolverTest extends KernelTestCase
 {
-    private ?UserRepository $repository = null;
-
-    protected function setUp(): void
-    {
-        parent::setUp();
-
-        /** @var UserRepository $repository */
-        $repository = static::getContainer()->get(UserRepository::class);
-
-        $this->repository = $repository;
-    }
-
     /**
      * @dataProvider dataProviderValidUsers
      *
@@ -126,8 +113,6 @@ public function dataProviderValidUsers(): Generator
 
     private function getRepository(): UserRepository
     {
-        assert($this->repository instanceof UserRepository);
-
-        return $this->repository;
+        return static::getContainer()->get(UserRepository::class);
     }
 }
diff --git a/tests/Functional/Repository/HealthzRepositoryTest.php b/tests/Functional/Repository/HealthzRepositoryTest.php
@@ -14,7 +14,6 @@
 use Exception;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Throwable;
-use function assert;
 
 /**
  * Class HealthzRepositoryTest
@@ -24,8 +23,6 @@
  */
 class HealthzRepositoryTest extends KernelTestCase
 {
-    private ?HealthzRepository $repository = null;
-
     /**
      * @throws Throwable
      */
@@ -40,24 +37,13 @@ public static function tearDownAfterClass(): void
         parent::tearDownAfterClass();
     }
 
-    /**
-     * @throws Throwable
-     */
-    protected function setUp(): void
-    {
-        parent::setUp();
-
-        /** @var HealthzRepository $repository */
-        $repository = static::getContainer()->get(HealthzRepository::class);
-
-        $this->repository = $repository;
-    }
-
     /**
      * @throws Throwable
      */
     public function testThatReadValueMethodReturnsExpectedWithEmptyDatabase(): void
     {
+        static::bootKernel();
+
         PhpUnitUtil::loadFixtures(static::$kernel);
 
         static::assertNull($this->getRepository()->read());
@@ -96,8 +82,6 @@ public function testThatCleanupMethodClearsDatabaseReturnsExpected(): void
 
     private function getRepository(): HealthzRepository
     {
-        assert($this->repository instanceof HealthzRepository);
-
-        return $this->repository;
+        return static::getContainer()->get(HealthzRepository::class);
     }
 }
diff --git a/tests/Functional/Repository/LogRequestRepositoryTest.php b/tests/Functional/Repository/LogRequestRepositoryTest.php
@@ -25,9 +25,6 @@ class LogRequestRepositoryTest extends KernelTestCase
      */
     public function testThatCleanHistoryReturnsExpected(): void
     {
-        /** @var LogRequestRepository $repository */
-        $repository = static::getContainer()->get(LogRequestRepository::class);
-
-        static::assertSame(0, $repository->cleanHistory());
+        static::assertSame(0, static::getContainer()->get(LogRequestRepository::class)->cleanHistory());
     }
 }
diff --git a/tests/Functional/Repository/RoleRepositoryTest.php b/tests/Functional/Repository/RoleRepositoryTest.php
@@ -40,7 +40,6 @@ public static function tearDownAfterClass(): void
      */
     public function testThatResetMethodDeletesAllRecords(): void
     {
-        /** @var RoleRepository $repository */
         $repository = static::getContainer()->get(RoleRepository::class);
 
         static::assertSame(5, $repository->countAdvanced());

diff --git a/tests/Functional/Repository/UserRepositoryTest.php b/tests/Functional/Repository/UserRepositoryTest.php
@@ -128,11 +128,14 @@ public function testThatResetMethodDeletesAllRecords(): void
 
     private function getRepository(): UserRepository
     {
-        static::bootKernel();
+        static $cache;
+
+        if ($cache === null) {
+            static::bootKernel();
 
-        /** @var UserRepository $repository */
-        $repository = static::getContainer()->get(UserRepository::class);
+            $cache = static::getContainer()->get(UserRepository::class);
+        }
 
-        return $repository;
+        return $cache;
     }
 }
diff --git a/tests/Functional/Security/Provider/ApiKeyUserProviderTest.php b/tests/Functional/Security/Provider/ApiKeyUserProviderTest.php
@@ -141,7 +141,6 @@ public function testThatSupportsClassReturnsExpected(bool $expected, string $cla
      */
     public function dataProviderTestThatGetApiKeyReturnsExpected(): array
     {
-        /** @var RolesService $rolesService */
         $rolesService = static::getContainer()->get(RolesService::class);
 
         $iterator = static fn (string $role): array => [$rolesService->getShort($role)];

diff --git a/tests/Functional/Security/Provider/SecurityUserFactoryTest.php b/tests/Functional/Security/Provider/SecurityUserFactoryTest.php
@@ -129,17 +129,11 @@ public function dataProviderTestThatLoadUserByIdentifierReturnsExpectedUserInsta
 
     private function getSecurityUserFactory(): SecurityUserFactory
     {
-        /** @var SecurityUserFactory $securityUserFactory */
-        $securityUserFactory = static::getContainer()->get(SecurityUserFactory::class);
-
-        return $securityUserFactory;
+        return static::getContainer()->get(SecurityUserFactory::class);
     }
 
     private function getUserRepository(): UserRepository
     {
-        /** @var UserRepository $userRepository */
-        $userRepository = static::getContainer()->get(UserRepository::class);
-
-        return $userRepository;
+        return static::getContainer()->get(UserRepository::class);
     }
 }
diff --git a/tests/Integration/Entity/ApiKeyTest.php b/tests/Integration/Entity/ApiKeyTest.php
@@ -45,7 +45,7 @@ public function testThatGetRolesContainsExpectedRole(): void
      * @dataProvider dataProviderTestThatApiKeyHasExpectedRoles
      *
      * @phpstan-param StringableArrayObject<array<int, string>> $expectedRoles
-     * @phpstan-param StringableArrayObject<array<mixed>> $criteria
+     * @phpstan-param StringableArrayObject<array> $criteria
      * @psalm-param StringableArrayObject $expectedRoles
      * @psalm-param StringableArrayObject $criteria
      *
@@ -55,10 +55,7 @@ public function testThatApiKeyHasExpectedRoles(
         StringableArrayObject $expectedRoles,
         StringableArrayObject $criteria
     ): void {
-        /** @var ApiKeyRepository $repository */
-        $repository = static::getContainer()->get(ApiKeyRepository::class);
-
-        $apiKey = $repository->findOneBy($criteria->getArrayCopy());
+        $apiKey = static::getContainer()->get(ApiKeyRepository::class)->findOneBy($criteria->getArrayCopy());
 
         static::assertInstanceOf(ApiKey::class, $apiKey);
         static::assertSame($expectedRoles->getArrayCopy(), $apiKey->getRoles());
@@ -69,7 +66,6 @@ public function testThatApiKeyHasExpectedRoles(
      */
     public function dataProviderTestThatApiKeyHasExpectedRoles(): Generator
     {
-        /** @var RolesService $rolesService */
         $rolesService = static::getContainer()->get(RolesService::class);
 
         foreach ($rolesService->getRoles() as $role) {