Feature/dependency free seed

install/class.Setup.php

@@ -26,6 +26,7 @@
 use oat\oatbox\log\LoggerService;
 use oat\oatbox\service\ConfigurableService;
 use oat\oatbox\service\ServiceManager;
+use oat\tao\model\install\seed\SeedSorter;
 use Zend\ServiceManager\ServiceLocatorAwareInterface;
 
 class tao_install_Setup implements Action
@@ -52,6 +53,7 @@ class tao_install_Setup implements Action
      * @throws common_ext_ExtensionException When a presented parameter is invalid or malformed.
      * @throws InvalidArgumentException
      * @throws tao_install_utils_Exception
+     * @throws ReflectionException
      */
     public function __invoke($params)
     {
@@ -223,8 +225,11 @@ public function __invoke($params)
         } elseif (!isset($persistences['type'])) {
             throw new InvalidArgumentException('Your config should have a \'default\' key under \'persistences\'');
         }
-
+        $seedSorter = new SeedSorter();
         foreach ($parameters['configuration'] as $extension => $configs) {
+
+            $configs = $seedSorter->sort($configs);
+
             foreach ($configs as $key => $config) {
                 if (isset($config['type']) && $config['type'] === 'configurableService') {
                     $className = $config['class'];

manifest.php

@@ -62,7 +62,7 @@
     'label' => 'TAO Base',
     'description' => 'TAO meta-extension',
     'license' => 'GPL-2.0',
-    'version' => '45.7.0',
+    'version' => '45.8.0',
     'author' => 'Open Assessment Technologies, CRP Henri Tudor',
     'requires' => [
         'generis' => '>=13.0.0',

models/classes/install/seed/SeedSorter.php

@@ -0,0 +1,119 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA;
+ *
+ */
+
+declare(strict_types=1);
+
+namespace oat\tao\model\install\seed;
+
+use ReflectionClass;
+use ReflectionException;
+
+class SeedSorter
+{
+    /**
+     * @throws ReflectionException
+     */
+    public function sort(array $config): array
+    {
+        $sortedConfig = [];
+
+        foreach ($config as $serviceKey => $serviceConfig) {
+            $this->sortDependencies($config, $serviceKey, $sortedConfig);
+        }
+
+        return $sortedConfig;
+    }
+
+    /**
+     * @throws ReflectionException
+     */
+    private function getDependencies(string $className): array
+    {
+        $reflection = new ReflectionClass($className);
+
+        $constructor = $reflection->getConstructor();
+
+        if (null === $constructor) {
+            return [];
+        }
+
+        $dependencies = [];
+
+        foreach ($constructor->getParameters() as $parameter) {
+            if ($class = $parameter->getClass()) {
+                $dependencies[] = $class->name;
+            }
+        }
+
+        return $dependencies;
+    }
+
+    /**
+     * @throws ReflectionException
+     */
+    private function sortDependencies(array $config, string $serviceKey, array &$result): void
+    {
+        if (isset($result[$serviceKey])) {
+            return;
+        }
+
+        if (!isset($config[$serviceKey]['class'])) {
+            $result[$serviceKey] = $config[$serviceKey];
+
+            return;
+        }
+
+        $serviceClassName = $config[$serviceKey]['class'];
+
+        $dependencies = $this->getDependencies($serviceClassName);
+
+        foreach ($dependencies as $dependencyClassName) {
+            try {
+                $dependencyKey = $this->findServiceKey($config, $dependencyClassName);
+                $this->sortDependencies($config, $dependencyKey, $result);
+            } catch (SeedSorterException $e) {
+            }
+        }
+
+        $result[$serviceKey] = $config[$serviceKey];
+    }
+
+    private function findServiceKey(array $config, string $className)
+    {
+        foreach ($config as $serviceKey => $serviceConfig) {
+            if (empty($serviceConfig['class'])) {
+                throw new SeedSorterException(
+                    sprintf('%s not a class', $className)
+                );
+            }
+
+            if (
+                $serviceConfig['class'] === $className
+                || is_subclass_of($serviceConfig['class'], $className)
+            ) {
+                return $serviceKey;
+            }
+        }
+
+        throw new SeedSorterException(
+            sprintf('Service key for class %s not found', $className)
+        );
+    }
+}

models/classes/install/seed/SeedSorterException.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA;
+ *
+ */
+
+declare(strict_types=1);
+
+namespace oat\tao\model\install\seed;
+
+use RuntimeException;
+
+class SeedSorterException extends RuntimeException
+{
+}

test/unit/install/seed/SeedSorterTest.php

@@ -0,0 +1,174 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA;
+ *
+ */
+
+declare(strict_types=1);
+
+namespace oat\tao\test\unit\models\install\seed;
+
+use oat\generis\test\TestCase;
+use oat\tao\model\install\seed\SeedSorter;
+use ReflectionException;
+
+interface NoDepInterface {
+
+}
+
+class NoDepClass implements NoDepInterface
+{
+}
+
+class NoDepNotInConfigClass
+{
+}
+
+class DepFromServiceInConfigClass
+{
+    public function __construct(NoDepClass $class)
+    {
+    }
+}
+
+class DepFromInterfaceInConfigClass
+{
+    public function __construct(NoDepInterface $class)
+    {
+    }
+}
+
+class Dep2FromServiceInConfigClass
+{
+    public function __construct(DepFromServiceInConfigClass $class)
+    {
+    }
+}
+
+class DoubleDepFromServiceInConfigClass
+{
+    public function __construct(DepFromServiceInConfigClass $class, NoDepClass $class2)
+    {
+    }
+}
+
+class DoubleDepFromServiceInConfigAndNotInConfigClass
+{
+    public function __construct(NoDepNotInConfigClass $class, DoubleDepFromServiceInConfigClass $class2)
+    {
+    }
+}
+
+class DepFromServiceNotInConfigClass
+{
+    public function __construct(NoDepNotInConfigClass $class)
+    {
+    }
+}
+
+class NoDepArrayClass
+{
+    public function __construct(array $array)
+    {
+    }
+}
+
+class SeedSorterTest extends TestCase
+{
+    /** @var SeedSorter */
+    private $sorter;
+
+    protected function setUp(): void
+    {
+        $this->sorter = new SeedSorter();
+    }
+
+    /**
+     * @throws ReflectionException
+     */
+    public function testSortConfigs(): void
+    {
+        $configConfiguration = [
+            'DepFromInterfaceInConfigClass' => [
+                'class' => DepFromInterfaceInConfigClass::class,
+            ],
+            'DoubleDepFromServiceInConfigAndNotInConfigClass' => [
+                'class' => DoubleDepFromServiceInConfigAndNotInConfigClass::class,
+            ],
+            'DepFromServiceNotInConfigClass'                  => [
+                'class' => DepFromServiceNotInConfigClass::class,
+            ],
+            'Dep2FromServiceInConfigClass'                    => [
+                'class' => Dep2FromServiceInConfigClass::class,
+            ],
+            'DoubleDepFromServiceInConfigClass'               => [
+                'class' => DoubleDepFromServiceInConfigClass::class,
+            ],
+            'DepFromServiceInConfigClass'                     => [
+                'class' => DepFromServiceInConfigClass::class,
+            ],
+            'NoDepArrayClass'                                 => [
+                'class' => NoDepArrayClass::class,
+            ],
+            'NoDepClass'                                      => [
+                'class' => NoDepClass::class,
+            ],
+            'NotAClass'                                       => [
+                'some' => 'config',
+            ],
+        ];
+
+        $sortedConfigs = $this->sorter->sort($configConfiguration);
+
+        $this->assertKeysAfter(['NoDepClass'], 'DepFromServiceInConfigClass', $sortedConfigs);
+        $this->assertKeysAfter(['NoDepClass'], 'DepFromInterfaceInConfigClass', $sortedConfigs);
+        $this->assertKeysAfter(
+            ['DoubleDepFromServiceInConfigClass'],
+            'DoubleDepFromServiceInConfigAndNotInConfigClass',
+            $sortedConfigs
+        );
+        $this->assertKeysAfter(
+            ['NoDepClass', 'DepFromServiceInConfigClass'],
+            'DoubleDepFromServiceInConfigClass',
+            $sortedConfigs
+        );
+
+        self::assertArrayHasKey('NoDepClass', $sortedConfigs);
+        self::assertArrayHasKey('NoDepArrayClass', $sortedConfigs);
+        self::assertArrayHasKey('DepFromServiceNotInConfigClass', $sortedConfigs);
+        self::assertArrayHasKey('NotAClass', $sortedConfigs);
+    }
+
+    private function assertKeysAfter(array $priorKeys, string $needleKey, array $array): void
+    {
+        $maxKeyIndex = 0;
+
+        $arrayKeys = array_keys($array);
+
+        foreach ($priorKeys as $priorKey) {
+            $keyIndex = array_search($priorKey, $arrayKeys, true);
+
+            self::assertIsInt($keyIndex);
+
+            if ($maxKeyIndex < $keyIndex) {
+                $maxKeyIndex = $keyIndex;
+            }
+        }
+
+        self::assertTrue($maxKeyIndex < array_search($needleKey, $arrayKeys, true));
+    }
+}