Support for Codeception 5 (#53)

Co-authored-by: Dan Barrett <[email protected]>
Co-authored-by: Gintautas Miselis <[email protected]>

Author: 3 people

.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        php: [7.4, 8.0, 8.1]
+        php: [8.0, 8.1]
 
     steps:
     - name: Checkout code

composer.json

@@ -13,19 +13,20 @@
             "name":"Alex Kunin"
         }
     ],
-    "minimum-stability": "RC",
+    "minimum-stability": "dev",
     "require": {
-        "php": "^7.4 | ^8.0",
+        "php": "^8.0",
         "ext-pdo": "*",
         "ext-json": "*",
-        "codeception/codeception": "^4.0"
+        "codeception/codeception": "^5.0.0-alpha1"
     },
     "require-dev": {
-        "doctrine/annotations": "^1",
-        "doctrine/data-fixtures": "^1",
+        "codeception/stub": "^4.0",
+        "doctrine/annotations": "^1.13",
+        "doctrine/data-fixtures": "^1.5",
         "doctrine/orm": "^2.10",
-        "phpstan/phpstan": "^0.12",
-        "ramsey/uuid-doctrine": "^1.5",
+        "phpstan/phpstan": "^1.0",
+        "ramsey/uuid-doctrine": "^1.6",
         "symfony/cache": "^4.4 | ^5.4 | ^6.0"
     },
     "autoload": {

phpstan.neon

@@ -2,14 +2,15 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-  level: 6
+  level: 3
   paths:
     - src
     - tests
   excludePaths:
     analyse:
         - tests/data/doctrine2_fixtures/TestFixture1.php
         - tests/data/doctrine2_fixtures/TestFixture2.php
+        - tests/_support/UnitTester.php
   checkMissingIterableValueType: false
   reportUnmatchedIgnoredErrors: false
   ignoreErrors:

src/Codeception/Module/Doctrine2.php

@@ -11,9 +11,9 @@
 use Codeception\Lib\Interfaces\DependsOnModule;
 use Codeception\Lib\Interfaces\DoctrineProvider;
 use Codeception\Module as CodeceptionModule;
+use Codeception\Stub;
 use Codeception\TestInterface;
 use Codeception\Util\ReflectionPropertyAccessor;
-use Codeception\Util\Stub;
 use Doctrine\Common\Collections\Criteria;
 use Doctrine\Common\Collections\Expr\Expression;
 use Doctrine\Common\DataFixtures\Executor\ORMExecutor;
@@ -168,7 +168,7 @@ class Doctrine2 extends CodeceptionModule implements DependsOnModule, DataMapper
 
     public ?EntityManagerInterface $em = null;
 
-    public function _depends()
+    public function _depends(): array
     {
         if ($this->config['connection_callback']) {
             return [];
@@ -177,26 +177,17 @@ public function _depends()
         return [DoctrineProvider::class => $this->dependencyMessage];
     }
 
-    /**
-     * @return void
-     */
-    public function _inject(DoctrineProvider $dependentModule = null)
+    public function _inject(DoctrineProvider $dependentModule = null): void
     {
         $this->dependentModule = $dependentModule;
     }
 
-    /**
-     * @return void
-     */
-    public function _beforeSuite($settings = [])
+    public function _beforeSuite($settings = []): void
     {
         $this->retrieveEntityManager();
     }
 
-    /**
-     * @return void
-     */
-    public function _before(TestInterface $test)
+    public function _before(TestInterface $test): void
     {
         $this->cleanupEntityManager();
     }
@@ -836,7 +827,7 @@ private function populateEmbeddables(object $entityObject, array $data): void
      * @param array $params
      * @return void
      */
-    public function seeInRepository($entity, $params = [])
+    public function seeInRepository(string $entity, array $params = []): void
     {
         $res = $this->proceedSeeInRepository($entity, $params);
         $this->assert($res);
@@ -849,7 +840,7 @@ public function seeInRepository($entity, $params = [])
      * @param array $params
      * @return void
      */
-    public function dontSeeInRepository($entity, $params = [])
+    public function dontSeeInRepository(string $entity, array $params = []): void
     {
         $res = $this->proceedSeeInRepository($entity, $params);
         $this->assertNot($res);
@@ -891,7 +882,7 @@ protected function proceedSeeInRepository(string $entity, array $params = []): a
      * @param array $params
      * @return mixed
      */
-    public function grabFromRepository($entity, $field, $params = [])
+    public function grabFromRepository(string $entity, string $field, array $params = [])
     {
         // we need to store to database...
         $this->em->flush();
@@ -995,11 +986,7 @@ protected function _buildAssociationQuery(QueryBuilder $qb, string $assoc, strin
         }
     }
 
-    /**
-     * @return \Doctrine\ORM\EntityManagerInterface
-     * @throws ModuleConfigException
-     */
-    public function _getEntityManager()
+    public function _getEntityManager(): EntityManagerInterface
     {
         if (is_null($this->em)) {
             $this->retrieveEntityManager();

src/Codeception/Util/ReflectionPropertyAccessor.php

@@ -0,0 +1,100 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codeception\Util;
+
+use InvalidArgumentException;
+use ReflectionClass;
+use ReflectionException;
+use function array_key_exists;
+use function get_class;
+use function get_parent_class;
+use function gettype;
+use function is_object;
+
+class ReflectionPropertyAccessor
+{
+    /**
+     * @return mixed
+     * @throws ReflectionException
+     */
+    public function getProperty(object $obj, string $field)
+    {
+        $class = get_class($obj);
+        do {
+            $reflectedEntity = new ReflectionClass($class);
+            if ($reflectedEntity->hasProperty($field)) {
+                $property = $reflectedEntity->getProperty($field);
+                $property->setAccessible(true);
+                return $property->getValue($obj);
+            }
+            $class = get_parent_class($class);
+        } while ($class);
+        throw new InvalidArgumentException('Property "' . $field . '" does not exists in class "' . get_class($obj) . '" and its parents');
+    }
+
+    /**
+     * @throws ReflectionException
+     */
+    private function setPropertiesForClass(?object $obj, string $class, array $data): object
+    {
+        $reflectedEntity = new ReflectionClass($class);
+
+        if ($obj === null) {
+            $constructorParameters = [];
+            $constructor = $reflectedEntity->getConstructor();
+            if (null !== $constructor) {
+                foreach ($constructor->getParameters() as $parameter) {
+                    if ($parameter->isOptional()) {
+                        $constructorParameters[] = $parameter->getDefaultValue();
+                    } elseif (array_key_exists($parameter->getName(), $data)) {
+                        $constructorParameters[] = $data[$parameter->getName()];
+                    } else {
+                        throw new InvalidArgumentException(
+                            'Constructor parameter "'.$parameter->getName().'" missing'
+                        );
+                    }
+                }
+            }
+
+            $obj = $reflectedEntity->newInstance(...$constructorParameters);
+        }
+
+        foreach ($reflectedEntity->getProperties() as $property) {
+            if (isset($data[$property->name])) {
+                $property->setAccessible(true);
+                $property->setValue($obj, $data[$property->name]);
+            }
+        }
+        return $obj;
+    }
+
+    /**
+     * @throws ReflectionException
+     */
+    public function setProperties(?object $obj, array $data): void
+    {
+        if (!$obj || !is_object($obj)) {
+            throw new InvalidArgumentException('Cannot set properties for "' . gettype($obj) . '", expecting object');
+        }
+        $class = get_class($obj);
+        do {
+            $obj = $this->setPropertiesForClass($obj, $class, $data);
+            $class = get_parent_class($class);
+        } while ($class);
+    }
+
+    /**
+     * @throws ReflectionException
+     */
+    public function createWithProperties(string $class, array $data): object
+    {
+        $obj = null;
+        do {
+            $obj = $this->setPropertiesForClass($obj, $class, $data);
+            $class = get_parent_class($class);
+        } while ($class);
+        return $obj;
+    }
+}

tests/unit/Codeception/Module/Doctrine2Test.php

@@ -5,8 +5,8 @@
 use Codeception\Exception\ModuleException;
 use Codeception\Lib\ModuleContainer;
 use Codeception\Module\Doctrine2;
+use Codeception\Stub;
 use Codeception\Test\Unit;
-use Codeception\Util\Stub;
 use Doctrine\Common\Collections\Criteria;
 use Doctrine\Common\DataFixtures\Executor\ORMExecutor;
 use Doctrine\Common\DataFixtures\Loader;