[CI] Ensure that all possible @return are turned into native types

nicolas-grekas · nicolas-grekas · commit d32b12ec25e0 · 2021-08-25T17:06:48.000+02:00
diff --git a/.github/expected-missing-return-types.diff b/.github/expected-missing-return-types.diff
diff --git a/.github/patch-types.php b/.github/patch-types.php
@@ -20,6 +20,7 @@
         case false !== strpos($file, '/src/Symfony/Component/Config/Tests/Fixtures/BadFileName.php'):
         case false !== strpos($file, '/src/Symfony/Component/Config/Tests/Fixtures/BadParent.php'):
         case false !== strpos($file, '/src/Symfony/Component/Config/Tests/Fixtures/ParseError.php'):
+        case false !== strpos($file, '/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php'):
         case false !== strpos($file, '/src/Symfony/Component/DependencyInjection/Tests/Compiler/OptionalServiceClass.php'):
         case false !== strpos($file, '/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/autowiring_classes.php'):
         case false !== strpos($file, '/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/intersectiontype_classes.php'):
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
@@ -137,12 +137,12 @@ jobs:
       - name: Patch return types
         if: "${{ matrix.php == '8.0' && ! matrix.mode }}"
         run: |
-          sed -i 's/"\*\*\/Tests\/"//' composer.json
+          patch -sp1 < .github/expected-missing-return-types.diff
           git add .
           composer install -q --optimize-autoloader
-          SYMFONY_PATCH_TYPE_DECLARATIONS=force=1 php .github/patch-types.php
-          SYMFONY_PATCH_TYPE_DECLARATIONS=force=1 php .github/patch-types.php # ensure the script is idempotent
-          git diff --exit-code
+          SYMFONY_PATCH_TYPE_DECLARATIONS=force=2 php .github/patch-types.php
+          SYMFONY_PATCH_TYPE_DECLARATIONS=force=2 php .github/patch-types.php # ensure the script is idempotent
+          git diff --exit-code && git checkout .
 
       - name: Run tests
         run: |
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AbstractRecursivePass.php b/src/Symfony/Component/DependencyInjection/Compiler/AbstractRecursivePass.php
@@ -66,6 +66,8 @@ protected function inExpression(bool $reset = true): bool
 
     /**
      * Processes a value found in a definition tree.
+     *
+     * @return mixed
      */
     protected function processValue(mixed $value, bool $isRoot = false)
     {
diff --git a/src/Symfony/Component/Ldap/Adapter/QueryInterface.php b/src/Symfony/Component/Ldap/Adapter/QueryInterface.php
@@ -11,7 +11,6 @@
 
 namespace Symfony\Component\Ldap\Adapter;
 
-use Symfony\Component\Ldap\Entry;
 use Symfony\Component\Ldap\Exception\LdapException;
 use Symfony\Component\Ldap\Exception\NotBoundException;
 
@@ -33,8 +32,6 @@ interface QueryInterface
     /**
      * Executes a query and returns the list of Ldap entries.
      *
-     * @return CollectionInterface|Entry[]
-     *
      * @throws NotBoundException
      * @throws LdapException
      */
diff --git a/src/Symfony/Component/Security/Http/Tests/Firewall/ExceptionListenerTest.php b/src/Symfony/Component/Security/Http/Tests/Firewall/ExceptionListenerTest.php
@@ -74,8 +74,17 @@ public function getAuthenticationExceptionProvider()
         ];
     }
 
+    /**
+     * This test should be removed in Symfony 7.0 when adding native return types to AuthenticationEntryPointInterface::start().
+     *
+     * @group legacy
+     */
     public function testExceptionWhenEntryPointReturnsBadValue()
     {
+        if ((new \ReflectionMethod(AuthenticationEntryPointInterface::class, 'start'))->hasReturnType()) {
+            $this->markTestSkipped('Native return type found');
+        }
+
         $event = $this->createEvent(new AuthenticationException());
 
         $entryPoint = $this->createMock(AuthenticationEntryPointInterface::class);

Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,8 @@ protected function inExpression(bool $reset = true): bool`
`66`	`66`
`67`	`67`	`/**`
`68`	`68`	`* Processes a value found in a definition tree.`
	`69`	`+ *`
	`70`	`+ * @return mixed`
`69`	`71`	`*/`
`70`	`72`	`protected function processValue(mixed $value, bool $isRoot = false)`
`71`	`73`	`{`