Fix phpstan errors for tests

composer.json

@@ -74,8 +74,10 @@
         "matthiasnoback/symfony-config-test": "^4.2",
         "matthiasnoback/symfony-dependency-injection-test": "^4.1",
         "phpstan/extension-installer": "^1.0",
-        "phpstan/phpstan": "^0.12.29",
-        "phpstan/phpstan-symfony": "^0.12.10",
+        "phpstan/phpstan": "^0.12.82",
+        "phpstan/phpstan-phpunit": "^0.12.18",
+        "phpstan/phpstan-symfony": "^0.12.21",
+        "psalm/plugin-phpunit": "^0.15.1",
         "psalm/plugin-symfony": "^2.0",
         "psr/event-dispatcher": "^1.0",
         "sonata-project/intl-bundle": "^2.4",
@@ -107,5 +109,13 @@
         "psr-4": {
             "Sonata\\AdminBundle\\Tests\\": "tests/"
         }
+    },
+    "scripts": {
+        "post-install-cmd": [
+            "[ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/simple-phpunit install"
+        ],
+        "post-update-cmd": [
+            "[ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/simple-phpunit install"
+        ]
     }
 }

phpstan.neon.dist

@@ -1,10 +1,18 @@
 parameters:
     level: 5
+    bootstrapFiles:
+        - vendor/bin/.phpunit/phpunit/vendor/autoload.php
     paths:
         - src
-    excludes_analyse:
-        # temporarily ignore template files
-        - src/Resources/**.tpl.php
+        - tests
+    excludePaths:
+        analyseAndScan:
+            # temporarily ignore template files
+            - src/Resources/**.tpl.php
+            # BC-layer is not supported by phpstan https://github.com/phpstan/phpstan/issues/3542
+            - tests/Fixtures/StubTranslator.php
+    ignoreErrors:
+        - '#Trying to mock an undefined method [a-zA-Z]*\(\) on class stdClass\.#'
     treatPhpDocTypesAsCertain: false
     checkGenericClassInNonGenericObjectType: true
     checkMissingIterableValueType: true

psalm.xml

@@ -1,10 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<psalm xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://getpsalm.org/schema/config" errorLevel="6" resolveFromConfigFile="true" xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd" errorBaseline="psalm-baseline.xml">
+<psalm xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://getpsalm.org/schema/config" errorLevel="6" resolveFromConfigFile="true" xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd" autoloader="vendor/bin/.phpunit/phpunit/vendor/autoload.php" errorBaseline="psalm-baseline.xml">
     <projectFiles>
         <directory name="src"/>
+        <directory name="tests"/>
         <ignoreFiles>
             <directory name="src/Resources/skeleton"/>
             <directory name="vendor"/>
         </ignoreFiles>
     </projectFiles>
+    <plugins>
+        <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin"/>
+        <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
+    </plugins>
 </psalm>

src/Admin/AdminInterface.php

@@ -357,8 +357,6 @@ public function setSubClasses(array $subClasses): void;
 
     /**
      * Returns true if the admin has the sub classes.
-     *
-     * @phpstan-param class-string<T> $name
      */
     public function hasSubClass(string $name): bool;
 

src/Admin/Pool.php

@@ -27,9 +27,9 @@
  *  item_adds: array,
  *  items: array<array-key, array{
  *      admin?: string,
- *      label?: string,
+ *      label: string,
  *      roles: list<string>,
- *      route?: string,
+ *      route: string,
  *      router_absolute: bool,
  *      route_params: array<string, string>
  *  }>,
@@ -67,6 +67,14 @@ final class Pool
      */
     private $adminClasses = [];
 
+    /**
+     * @param string[]                            $adminServices
+     * @param array<string, array<string, mixed>> $adminGroups
+     * @param array<class-string, string[]>       $adminClasses
+     *
+     * @phpstan-param array<string, array<string, mixed>> $adminGroups
+     * @psalm-param array<string, Group> $adminGroups
+     */
     public function __construct(
         ContainerInterface $container,
         array $adminServices = [],

src/Command/GenerateObjectAclCommand.php

@@ -108,7 +108,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
 
             $securityIdentity = null;
             if ($input->getOption('step') && $this->askConfirmation($input, $output, "<question>Set an object owner?</question>\n", 'no')) {
-                $username = $this->askAndValidate($input, $output, 'Please enter the username: ', '', 'Sonata\AdminBundle\Command\Validators::validateUsername');
+                $username = $this->askAndValidate($input, $output, 'Please enter the username: ', '', [Validators::class, 'validateUsername']);
 
                 $securityIdentity = new UserSecurityIdentity($username, $this->getUserModelClass($input, $output));
             }

src/Datagrid/ProxyQueryInterface.php

@@ -20,13 +20,6 @@
  */
 interface ProxyQueryInterface
 {
-    /**
-     * @param mixed[] $args
-     *
-     * @return mixed
-     */
-    public function __call(string $name, array $args);
-
     /**
      * @return mixed
      */

src/FieldDescription/FieldDescriptionInterface.php

@@ -231,7 +231,7 @@ public function hasAdmin(): bool;
     /**
      * Merge option values related to the provided option name.
      *
-     * @param array<string, mixed> $options
+     * @param mixed[] $options
      *
      * @throws \RuntimeException
      */

src/Filter/FilterFactory.php

@@ -32,6 +32,8 @@ final class FilterFactory implements FilterFactoryInterface
 
     /**
      * @param array<string, string> $types
+     *
+     * @psalm-suppress ContainerDependency
      */
     public function __construct(ContainerInterface $container, array $types = [])
     {

src/Filter/FilterInterface.php

@@ -57,6 +57,11 @@ public function setLabel($label): void;
      */
     public function getDefaultOptions(): array;
 
+    /**
+     * @return array<string, mixed>
+     */
+    public function getOptions(): array;
+
     /**
      * @param mixed $default
      *
@@ -80,7 +85,7 @@ public function initialize(string $name, array $options = []): void;
     public function getFieldName(): string;
 
     /**
-     * @return array<string, string> array of mappings
+     * @return array<array<string, mixed>> array of mappings
      */
     public function getParentAssociationMappings(): array;
 

src/Form/DataTransformer/ModelToIdPropertyTransformer.php

@@ -122,13 +122,13 @@ public function reverseTransform($value)
     }
 
     /**
-     * @param object|object[]|null $value
+     * @param object|object[]|\ArrayAccess<string|int, object>|null $value
      *
      * @throws \InvalidArgumentException
      *
      * @return array<string|int, int|string|array<string>>
      *
-     * @phpstan-param T|T[]|null $value
+     * @phpstan-param T|T[]|\ArrayAccess<string|int, T>|null $value
      */
     public function transform($value)
     {
@@ -138,8 +138,8 @@ public function transform($value)
             return $result;
         }
 
+        $isArray = \is_array($value);
         if ($this->multiple) {
-            $isArray = \is_array($value);
             if (!$isArray && substr(\get_class($value), -1 * \strlen($this->className)) === $this->className) {
                 throw new \InvalidArgumentException(
                     'A multiple selection must be passed a collection not a single value.'
@@ -157,9 +157,9 @@ public function transform($value)
                 );
             }
         } else {
-            if (substr(\get_class($value), -1 * \strlen($this->className)) === $this->className) {
+            if (!$isArray && substr(\get_class($value), -1 * \strlen($this->className)) === $this->className) {
                 $collection = [$value];
-            } elseif ($value instanceof \ArrayAccess) {
+            } elseif ($isArray || ($value instanceof \ArrayAccess)) {
                 throw new \InvalidArgumentException(
                     'A single selection must be passed a single value not a collection.'
                     .' Make sure that form option "multiple=false" is set for many-to-one relation and "multiple=true"'

src/Model/AuditManager.php

@@ -31,6 +31,9 @@ final class AuditManager implements AuditManagerInterface
      */
     private $container;
 
+    /**
+     * @psalm-suppress ContainerDependency
+     */
     public function __construct(ContainerInterface $container)
     {
         $this->container = $container;

src/Route/AdminPoolLoader.php

@@ -43,6 +43,8 @@ final class AdminPoolLoader extends Loader
 
     /**
      * @param string[] $adminServiceIds
+     *
+     * @psalm-suppress ContainerDependency
      */
     public function __construct(Pool $pool, array $adminServiceIds, ContainerInterface $container)
     {

src/Route/RouteCollectionInterface.php

@@ -24,8 +24,8 @@ interface RouteCollectionInterface
      * @param array<string, mixed>  $defaults
      * @param array<string, string> $requirements
      * @param array<string, mixed>  $options
-     * @param array<string, string> $schemes
-     * @param array<string, string> $methods
+     * @param string[]              $schemes
+     * @param string[]              $methods
      *
      * @return static
      */

src/Twig/Extension/RenderElementExtension.php

@@ -44,6 +44,8 @@ final class RenderElementExtension extends AbstractExtension
 
     /**
      * @internal This class should only be used through Twig
+     *
+     * @psalm-suppress ContainerDependency
      */
     public function __construct(
         PropertyAccessorInterface $propertyAccessor,

src/Twig/Extension/TemplateRegistryExtension.php

@@ -32,6 +32,9 @@ final class TemplateRegistryExtension extends AbstractExtension
      */
     private $container;
 
+    /**
+     * @psalm-suppress ContainerDependency
+     */
     public function __construct(TemplateRegistryInterface $globalTemplateRegistry, ContainerInterface $container)
     {
         $this->globalTemplateRegistry = $globalTemplateRegistry;

src/Util/FormViewIterator.php

@@ -52,7 +52,9 @@ public function next(): void
 
     public function key(): string
     {
-        return $this->current()->vars['id'];
+        $current = $this->current();
+
+        return $current->vars['id'];
     }
 
     public function valid(): bool

tests/Action/AppendFormFieldElementActionTest.php

@@ -13,9 +13,9 @@
 
 namespace Sonata\AdminBundle\Tests\Action;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Sonata\AdminBundle\Action\AppendFormFieldElementAction;
-use Sonata\AdminBundle\Action\GetShortObjectDescriptionAction;
 use Sonata\AdminBundle\Admin\AdminHelper;
 use Sonata\AdminBundle\Admin\AdminInterface;
 use Sonata\AdminBundle\Admin\Pool;
@@ -37,34 +37,34 @@ final class AppendFormFieldElementActionTest extends TestCase
     private $pool;
 
     /**
-     * @var Environment
+     * @var Environment&MockObject
      */
     private $twig;
 
     /**
-     * @var GetShortObjectDescriptionAction
+     * @var AppendFormFieldElementAction
      */
     private $action;
 
     /**
-     * @var AdminInterface
+     * @var AdminInterface&MockObject
      */
     private $admin;
 
     /**
-     * @var AdminHelper
+     * @var AdminHelper&MockObject
      */
     private $helper;
 
     protected function setUp(): void
     {
-        $this->twig = $this->createStub(Environment::class);
+        $this->twig = $this->createMock(Environment::class);
         $this->admin = $this->createMock(AdminInterface::class);
         $this->admin->expects($this->once())->method('setRequest');
         $container = new Container();
         $container->set('sonata.post.admin', $this->admin);
         $this->pool = new Pool($container, ['sonata.post.admin']);
-        $this->helper = $this->createStub(AdminHelper::class);
+        $this->helper = $this->createMock(AdminHelper::class);
         $this->action = new AppendFormFieldElementAction(
             $this->twig,
             $this->pool,

tests/Action/DashboardActionTest.php

@@ -13,6 +13,7 @@
 
 namespace Sonata\AdminBundle\Tests\Action;
 
+use PHPUnit\Framework\MockObject\Stub;
 use PHPUnit\Framework\TestCase;
 use Sonata\AdminBundle\Action\DashboardAction;
 use Sonata\AdminBundle\Admin\BreadcrumbsBuilderInterface;
@@ -26,7 +27,7 @@
 class DashboardActionTest extends TestCase
 {
     /**
-     * @var MutableTemplateRegistryInterface
+     * @var MutableTemplateRegistryInterface&Stub
      */
     private $templateRegistry;
 

tests/Action/GetShortObjectDescriptionActionTest.php

@@ -13,6 +13,7 @@
 
 namespace Sonata\AdminBundle\Tests\Action;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Sonata\AdminBundle\Action\GetShortObjectDescriptionAction;
 use Sonata\AdminBundle\Admin\AdminInterface;
@@ -42,7 +43,7 @@ final class GetShortObjectDescriptionActionTest extends TestCase
     private $action;
 
     /**
-     * @var AdminInterface
+     * @var AdminInterface&MockObject
      */
     private $admin;
 

tests/Action/RetrieveAutocompleteItemsActionTest.php

@@ -13,9 +13,8 @@
 
 namespace Sonata\AdminBundle\Tests\Action;
 
-use PHPUnit\Framework\MockObject\Stub;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use Sonata\AdminBundle\Action\GetShortObjectDescriptionAction;
 use Sonata\AdminBundle\Action\RetrieveAutocompleteItemsAction;
 use Sonata\AdminBundle\Admin\AdminInterface;
 use Sonata\AdminBundle\Admin\Pool;
@@ -39,12 +38,12 @@ final class RetrieveAutocompleteItemsActionTest extends TestCase
     private $pool;
 
     /**
-     * @var GetShortObjectDescriptionAction
+     * @var RetrieveAutocompleteItemsAction
      */
     private $action;
 
     /**
-     * @var AdminInterface
+     * @var AdminInterface&MockObject
      */
     private $admin;
 
@@ -230,12 +229,12 @@ public function testRetrieveAutocompleteItemsComplexProperty(): void
         $this->assertSame('{"status":"OK","more":false,"items":[{"id":"123","label":"FOO"}]}', $response->getContent());
     }
 
-    private function configureAutocompleteItemsDatagrid(): Stub
+    private function configureAutocompleteItemsDatagrid(): MockObject
     {
         $model = new \stdClass();
 
         $targetAdmin = $this->createMock(AdminInterface::class);
-        $datagrid = $this->createStub(DatagridInterface::class);
+        $datagrid = $this->createMock(DatagridInterface::class);
         $metadata = $this->createStub(MetadataInterface::class);
         $pager = $this->createStub(PagerInterface::class);
         $fieldDescription = $this->createStub(FieldDescriptionInterface::class);