[Tests] Add support for codeception 5 (pimcore#630)

* [Tests] Add support for codeception 5

* [Tests] Add support for codeception 5

Author: mcop1

Diff for: .github/workflows/codeception_pimcore_x.yml

@@ -34,7 +34,6 @@ jobs:
         strategy:
             matrix:
                 include:
-                    - { php-version: 8.0, database: "mariadb:10.7", dependencies: highest, experimental: false }
                     - { php-version: 8.0, database: "mariadb:10.7", dependencies: lowest, experimental: false }
                     - { php-version: 8.1, database: "mariadb:10.7", dependencies: highest, experimental: false }
         services:
@@ -74,6 +73,14 @@ jobs:
                   chmod 755 .github/ci/scripts/setup-pimcore-x-environment.sh
                   .github/ci/scripts/setup-pimcore-x-environment.sh
 
+            - name: "Update Pimcore version"
+              env:
+                  PIMCORE_VERSION: "${{ matrix.pimcore_version }}"
+              run: |
+                  if [ ! -z "$PIMCORE_VERSION" ]; then
+                        composer require --no-update pimcore/pimcore:"${PIMCORE_VERSION} as 10.99.9"
+                  fi    
+
             - name: "Install dependencies with Composer"
               uses: "ramsey/composer-install@v2"
               with:
@@ -90,4 +97,4 @@ jobs:
                   bin/console doctrine:migrations:sync-metadata-storage -vvv
 
             - name: "Run Codeception"
-              run: "vendor/bin/codecept run -c . -vvv --json"
+              run: "vendor/bin/codecept run -c . -vvv --xml"

Diff for: codeception.dist.yml

@@ -2,7 +2,7 @@ namespace: DataHubBundle\Tests
 actor: Tester
 paths:
     tests: tests
-    log: tests/_output
+    output: tests/_output
     data: tests/_data
     support: tests/_support
     envs: tests/_envs

Diff for: composer.json

@@ -10,17 +10,18 @@
         "*": "dist"
       }
   },
+  "prefer-stable": true,
+  "minimum-stability": "dev",
   "require": {
-    "php": "^8.0",
-    "pimcore/pimcore": "^10.5",
+    "php": "^8.0 || ^8.1",
+    "pimcore/pimcore": "dev-test_support_fc_layer || 11.x-dev",
     "webonyx/graphql-php": "^14.6"
   },
   "require-dev": {
     "phpstan/phpstan": "^1.6.0",
     "phpunit/phpunit": "^9.3",
     "symfony/phpunit-bridge": "^6",
-    "codeception/module-symfony": "^1.6",
-    "codeception/codeception": "^4.1.12",
+    "codeception/codeception": "^4.1.12 || ^5.0.3",
     "codeception/phpunit-wrapper": "^9",
     "codeception/module-asserts": "^2"
   },

Diff for: tests/GraphQL.suite.yml

@@ -1,6 +1,6 @@
 actor: GraphQLTester
 modules:
     enabled:
-        - \Pimcore\Tests\Helper\Pimcore:
+        - \Pimcore\Tests\Support\Helper\Pimcore:
               connect_db: true
               cache_router: false

Diff for: tests/GraphQL/ResolveTest.php

@@ -21,9 +21,10 @@
 use Pimcore\Model\Translation;
 use Pimcore\Tool;
 use Symfony\Component\EventDispatcher\EventDispatcher;
+use Codeception\Test\Unit;
 
 
-class ResolveTest extends \PHPUnit_Framework_TestCase
+class ResolveTest extends Unit
 {
     private Service|null $service;
 

Diff for: tests/GraphQL/Traits/ElementIdentificationTraitTest.php

@@ -15,7 +15,7 @@
 
 namespace Pimcore\Bundle\DataHubBundle\Tests\GraphQL\Traits;
 
-use PHPUnit_Framework_TestCase;
+use Codeception\Test\Unit;
 use \Pimcore\Bundle\DataHubBundle\GraphQL\Traits\ElementIdentificationTrait;
 
 use Pimcore\Bundle\DataHubBundle\GraphQL\Exception\ClientSafeException;
@@ -38,7 +38,7 @@ protected function getElementByPath($elementType)
     }
 }
 
-class ElementIdentificationTraitTest extends PHPUnit_Framework_TestCase
+class ElementIdentificationTraitTest extends Unit
 {
     const TRAIT_TO_TEST = '\Pimcore\Bundle\DataHubBundle\GraphQL\Traits\ElementIdentificationTrait';
     const TEST_TYPE = 'object';

Diff for: tests/Model.suite.yml

@@ -2,7 +2,7 @@ actor: ModelTester
 modules:
     enabled:
         - \DataHubBundle\Tests\Helper\Model
-        - \Pimcore\Tests\Helper\Pimcore:
+        - \Pimcore\Tests\Support\Helper\Pimcore:
               connect_db: true
               cache_router: false
-        - \Pimcore\Tests\Helper\ClassManager
+        - \Pimcore\Tests\Support\Helper\ClassManager

Diff for: tests/Model/ImportingConfigTest.php

@@ -16,8 +16,8 @@
 namespace Pimcore\Tests\Model\DataObject;
 
 use Pimcore\Bundle\DataHubBundle\Configuration;
-use Pimcore\Tests\Helper\DataType\TestDataHelper;
-use Pimcore\Tests\Test\ModelTestCase;
+use Pimcore\Tests\Support\Helper\DataType\TestDataHelper;
+use Pimcore\Tests\Support\Test\ModelTestCase;
 use Pimcore\Model\DataObject\DataHubTestEntity;
 
 /**

Diff for: tests/Service.suite.dist.yml

@@ -1,6 +1,6 @@
 actor: ServiceTester
 modules:
     enabled:
-        - \Pimcore\Tests\Helper\Pimcore:
+        - \Pimcore\Tests\Support\Helper\Pimcore:
             connect_db: true
             cache_router: false

Diff for: tests/Service/CheckConsumerPermissionsServiceTest.php

@@ -14,11 +14,11 @@
  */
 namespace Pimcore\Bundle\DataHubBundle\Tests\Controller;
 
-use PHPUnit_Framework_TestCase;
+use Codeception\Test\Unit;
 use Pimcore\Bundle\DataHubBundle\Configuration;
 use Symfony\Component\HttpFoundation\Request;
 
-class CheckConsumerPermissionsServiceTest extends PHPUnit_Framework_TestCase
+class CheckConsumerPermissionsServiceTest extends Unit
 {
     const CORRECT_API_KEY = "correct_key";
 

Diff for: tests/Service/OutputCacheServiceTest.php

@@ -14,13 +14,13 @@
  */
 namespace Pimcore\Bundle\DataHubBundle\Service;
 
-use PHPUnit_Framework_TestCase;
+use Codeception\Test\Unit;
 use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\JsonResponse;
 
-class OutputCacheServiceTest extends PHPUnit_Framework_TestCase
+class OutputCacheServiceTest extends Unit
 {
 
     protected $container;

Diff for: tests/_bootstrap.php

@@ -1,34 +1,39 @@
 <?php
 
-use Pimcore\Tests\Util\Autoloader;
+use Pimcore\Tests\Support\Util\Autoloader;
 
-$pimcoreTestsSupportDir = '';
 
 if (file_exists(__DIR__ . '/../vendor/autoload.php')) {
     include __DIR__ . '/../vendor/autoload.php';
-    $pimcoreTestsSupportDir = __DIR__ . '/../vendor/pimcore/pimcore/tests/_support';
+    $pimcoreTestDir = __DIR__ . '/../vendor/pimcore/pimcore/tests';
 } elseif (file_exists(__DIR__ . '/../../../../vendor/autoload.php')) {
     include __DIR__ . '/../../../../vendor/autoload.php';
-    $pimcoreTestsSupportDir = __DIR__ . '/../../../../vendor/pimcore/pimcore/tests/_support';
+    $pimcoreTestDir = __DIR__ . '/../../../../vendor/pimcore/pimcore/tests';
 } elseif (getenv('PIMCORE_PROJECT_ROOT') != '' && file_exists(getenv('PIMCORE_PROJECT_ROOT') . '/vendor/autoload.php')) {
     include getenv('PIMCORE_PROJECT_ROOT') . '/vendor/autoload.php';
-    $pimcoreTestsSupportDir = getenv('PIMCORE_PROJECT_ROOT') . '/vendor/pimcore/pimcore/tests/_support';
+    $pimcoreTestDir = getenv('PIMCORE_PROJECT_ROOT') . '/vendor/pimcore/pimcore/tests';
 } elseif (getenv('PIMCORE_PROJECT_ROOT') != '') {
     throw new \Exception('Invalid Pimcore project root "' . getenv('PIMCORE_PROJECT_ROOT') . '"');
 } else {
     throw new \Exception('Unknown configuration! Pimcore project root not found, please set env variable PIMCORE_PROJECT_ROOT.');
 }
 
+$pimcoreTestsSupportDir = $pimcoreTestDir . '/Support';
+
+//Pimcore 10 BC layer
+if (!is_dir($pimcoreTestsSupportDir)) {
+    $pimcoreTestsSupportDir = $pimcoreTestDir . '/_support';
+}
+
 include $pimcoreTestsSupportDir . '/Util/Autoloader.php';
 
 \Pimcore\Bootstrap::setProjectRoot();
 \Pimcore\Bootstrap::bootstrap();
 
 //error_reporting(E_ALL & ~E_NOTICE & ~E_STRICT & ~E_WARNING);
 
-//Codeception\Util\Autoload::addNamespace();
-Autoloader::addNamespace('Pimcore\Tests', $pimcoreTestsSupportDir);
-//Autoloader::addNamespace('Pimcore\Model\DataObject', __DIR__ . '/_output/var/classes/DataObject');
+Autoloader::addNamespace('Pimcore\Tests', $pimcoreTestsSupportDir); //Pimcore 10 BC layer
+Autoloader::addNamespace('Pimcore\Tests\Support', $pimcoreTestsSupportDir);
 Autoloader::addNamespace('Pimcore\Model\DataObject', PIMCORE_CLASS_DIRECTORY . '/DataObject');
 Autoloader::addNamespace('DataHubBundle\Tests', __DIR__);
 Autoloader::addNamespace('DataHubBundle\Tests', __DIR__ . '/_support');

Diff for: tests/_support/Helper/Model.php

@@ -5,11 +5,12 @@
 // here you can define custom actions
 // all public methods declared in helper class will be available in $I
 
-use Pimcore\Bundle\DataHubBundle\Installer;
-use Pimcore\Tests\Helper\AbstractDefinitionHelper;
-use Pimcore\Tests\Helper\Pimcore;
-use Pimcore\Tests\Util\Autoloader;
-use Pimcore\Model\DataObject;
+use \Pimcore\Bundle\DataHubBundle\Installer;
+use Pimcore\Model\DataObject\Customer;
+use Pimcore\Tests\Support\Helper\AbstractDefinitionHelper;
+use Pimcore\Tests\Support\Helper\ClassManager;
+use Pimcore\Tests\Support\Helper\Pimcore;
+use Pimcore\Tests\Support\Util\Autoloader;
 
 class Model extends AbstractDefinitionHelper
 {
@@ -45,7 +46,7 @@ public function _beforeSuite($settings = [])
 
     public function initializeDefinitions()
     {
-        $cm = $this->getClassManager();
+        $cm = $this->getModule('\\' . ClassManager::class);
         $class = $cm->setupClass('DataHubTestEntity', __DIR__ . '/../Resources/class_DataHubTestEntity_import.json');
         $this->prepareData($class);
     }

Diff for: tests/_support/Helper/Service.php

@@ -3,9 +3,9 @@
 
 use Pimcore\Model\DataObject\ClassDefinition;
 use Pimcore\Model\DataObject\Unittest;
-use Pimcore\Tests\Helper\ClassManager;
-use Pimcore\Tests\Helper\DataType\TestDataHelper;
-use Pimcore\Tests\Helper\Model;
+use Pimcore\Tests\Support\Helper\ClassManager;
+use Pimcore\Tests\Support\Helper\DataType\TestDataHelper;
+use Pimcore\Tests\Support\Helper\Model;
 use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
 
 class Service extends Model

Diff for: tests/_support/Test/ModelTestCase.php

@@ -15,13 +15,14 @@
 
 namespace Pimcore\Tests\Test;
 
-use Pimcore\Tests\Helper\DataType\Calculator;
-use Pimcore\Tests\ModelTester;
+use Pimcore\Tests\Support\Helper\DataType\Calculator;
+use Pimcore\Tests\Support\ModelTester;
+use Codeception\Test\Unit;
 
 /**
  * @property ModelTester $tester
  */
-abstract class ModelTestCase extends TestCase
+abstract class ModelTestCase extends Unit
 {
     /**
      * {@inheritdoc}

Diff for: tests/_support/Test/TestCase.php

@@ -16,7 +16,7 @@
 namespace DataHubBundle\Tests\Test;
 
 use Codeception\TestCase\Test;
-use Pimcore\Tests\Util\TestHelper;
+use Pimcore\Tests\Support\Util\TestHelper;
 
 abstract class TestCase extends Test
 {