[Tests] Fixed ConfigurationFactory test cases

* Added missing type hints to:
  - \Ibexa\Tests\Bundle\IO\DependencyInjection\ConfigurationFactoryTestCase
  - \Ibexa\Tests\Bundle\IO\DependencyInjection\ConfigurationFactory\BinarydataHandler\FlysystemTest
  - \Ibexa\Tests\Bundle\IO\DependencyInjection\ConfigurationFactory\MetadataHandler\FlysystemTest
  - \Ibexa\Tests\Bundle\IO\DependencyInjection\ConfigurationFactory\BaseFlysystemTestCase

* Fixed broken \Ibexa\Tests\Bundle\IO\DependencyInjection\ConfigurationFactory\MetadataHandler\FlysystemTest

* Improved \Ibexa\Tests\Bundle\IO\DependencyInjection\ConfigurationFactory\BaseFlysystemTestCase

Author: alongosz

tests/bundle/IO/DependencyInjection/ConfigurationFactory/BaseFlysystemTestCase.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Tests\Bundle\IO\DependencyInjection\ConfigurationFactory;
 
@@ -13,11 +14,11 @@
 
 abstract class BaseFlysystemTestCase extends ConfigurationFactoryTestCase
 {
-    private $flysystemAdapterServiceId = 'oneup_flysystem.test_adapter';
+    private string $flysystemAdapterServiceId = 'oneup_flysystem.test_adapter';
 
     private string $filesystemServiceId = 'ibexa.core.io.flysystem.my_test_handler_filesystem';
 
-    public function provideHandlerConfiguration()
+    public function provideHandlerConfiguration(): array
     {
         $this->setDefinition($this->flysystemAdapterServiceId, new Definition());
 
@@ -26,15 +27,15 @@ public function provideHandlerConfiguration()
         ];
     }
 
-    public function provideParentServiceDefinition()
+    public function provideParentServiceDefinition(): Definition
     {
         return new Definition(null, [null]);
     }
 
-    public function validateConfiguredHandler($handlerDefinitionId)
+    public function validateConfiguredHandler(string $handlerServiceId): void
     {
-        self::assertContainerBuilderHasServiceDefinitionWithArgument(
-            $handlerDefinitionId,
+        $this->assertContainerBuilderHasServiceDefinitionWithArgument(
+            $handlerServiceId,
             0,
             new Reference($this->filesystemServiceId)
         );

tests/bundle/IO/DependencyInjection/ConfigurationFactory/BinarydataHandler/FlysystemTest.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Tests\Bundle\IO\DependencyInjection\ConfigurationFactory\BinarydataHandler;
 
@@ -17,9 +18,6 @@ public function provideTestedFactory(): Flysystem
         return new Flysystem();
     }
 
-    /**
-     * Returns the expected parent service id.
-     */
     public function provideExpectedParentServiceId(): string
     {
         return 'ibexa.core.io.binarydata_handler.flysystem';

tests/bundle/IO/DependencyInjection/ConfigurationFactory/MetadataHandler/FlysystemTest.php

@@ -4,26 +4,21 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Tests\Bundle\IO\DependencyInjection\ConfigurationFactory\MetadataHandler;
 
+use Ibexa\Bundle\IO\DependencyInjection\ConfigurationFactory;
 use Ibexa\Bundle\IO\DependencyInjection\ConfigurationFactory\MetadataHandler\Flysystem;
+use Ibexa\Tests\Bundle\IO\DependencyInjection\ConfigurationFactory\BaseFlysystemTestCase;
 
-class FlysystemTest
+class FlysystemTest extends BaseFlysystemTestCase
 {
-    /**
-     * Returns an instance of the tested factory.
-     *
-     * @return \Ibexa\Bundle\IO\DependencyInjection\ConfigurationFactory\MetadataHandler\Flysystem
-     */
-    public function provideTestedFactory()
+    public function provideTestedFactory(): ConfigurationFactory
     {
         return new Flysystem();
     }
 
-    /**
-     * Returns the expected parent service id.
-     */
     public function provideExpectedParentServiceId(): string
     {
         return 'ibexa.core.io.metadata_handler.flysystem';

tests/bundle/IO/DependencyInjection/ConfigurationFactoryTestCase.php

@@ -4,11 +4,14 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Tests\Bundle\IO\DependencyInjection;
 
+use Ibexa\Bundle\IO\DependencyInjection\ConfigurationFactory;
 use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractContainerBuilderTestCase;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\DependencyInjection\Definition;
 
 /**
  * Abstract class for testing ConfigurationFactory implementations.
@@ -17,8 +20,7 @@
  */
 abstract class ConfigurationFactoryTestCase extends AbstractContainerBuilderTestCase
 {
-    /** @var \Ibexa\Bundle\IO\DependencyInjection\ConfigurationFactory */
-    protected $factory;
+    protected ConfigurationFactory $factory;
 
     protected function setUp(): void
     {
@@ -27,24 +29,24 @@ protected function setUp(): void
         $this->factory = $this->provideTestedFactory();
     }
 
-    public function testGetParentServiceId()
+    public function testGetParentServiceId(): void
     {
         self::assertEquals(
             $this->provideExpectedParentServiceId(),
             $this->factory->getParentServiceId()
         );
     }
 
-    public function testAddConfiguration()
+    public function testAddConfiguration(): void
     {
         $node = new ArrayNodeDefinition('handler');
         $this->factory->addConfiguration($node);
-        self::assertInstanceOf(ArrayNodeDefinition::class, $node);
+        self::assertNotEmpty($node->getChildNodeDefinitions());
 
         // @todo customized testing of configuration node ?
     }
 
-    public function testConfigureHandler()
+    public function testConfigureHandler(): void
     {
         $handlerConfiguration =
             $this->provideHandlerConfiguration() +
@@ -60,7 +62,7 @@ public function testConfigureHandler()
     /**
      * Registers the handler in the container, like the pass would have done.
      */
-    private function registerHandler($name): string
+    private function registerHandler(string $name): string
     {
         $this->setDefinition($this->provideExpectedParentServiceId(), $this->provideParentServiceDefinition());
         $handlerServiceId = sprintf('%s.%s', $this->provideExpectedParentServiceId(), $name);
@@ -71,10 +73,8 @@ private function registerHandler($name): string
 
     /**
      * Returns an instance of the tested factory.
-     *
-     * @return \Ibexa\Bundle\IO\DependencyInjection\ConfigurationFactory
      */
-    abstract public function provideTestedFactory();
+    abstract public function provideTestedFactory(): ConfigurationFactory;
 
     /**
      * Returns the expected parent service id.
@@ -84,20 +84,18 @@ abstract public function provideExpectedParentServiceId();
     /**
      * Provides the parent service definition, as defined in the bundle's services definition.
      * Required so that getArguments / replaceCalls work correctly.
-     *
-     * @return \Symfony\Component\DependencyInjection\Definition
      */
-    abstract public function provideParentServiceDefinition();
+    abstract public function provideParentServiceDefinition(): Definition;
 
     /**
      * Provides the configuration array given to the handler, and initializes the container.
      * The name and type index are automatically set to respectively 'my_handler' and 'my_handler_test'.
      *
      * The method can also configure the container via $this->container.
      *
-     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
+     * @return array<string, string>
      */
-    abstract public function provideHandlerConfiguration();
+    abstract public function provideHandlerConfiguration(): array;
 
     /**
      * Lets you test the handler definition after it was configured.
@@ -106,5 +104,5 @@ abstract public function provideHandlerConfiguration();
      *
      * @param string $handlerServiceId id of the service that was registered by the compiler pass
      */
-    abstract public function validateConfiguredHandler($handlerServiceId);
+    abstract public function validateConfiguredHandler(string $handlerServiceId): void;
 }