mirror/php-flarum
1
0
Fork 0
mirror of https://github.com/flarum/core.git synced 2025-07-31 13:40:20 +02:00
Code Issues Releases Wiki Activity

Optional Dependencies (#2579)

Browse Source 
* Add and calculate optional dependencies
* Add extension dependency resolver (Kahn's algorithm), plus unit tests
* Resolve extension dependency on enable/disable
This commit is contained in:
Alexander Skvortsov
2021-02-21 13:49:33 -05:00
committed by GitHub
parent 40ede179cd
commit fa10d794a4
3 changed files with 283 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
tests/unit/Foundation/ExtensionDependencyResolutionTest.php Normal file
View File

@@ -0,0 +1,142 @@
<?php
/*
* This file is part of Flarum.
*
* For detailed copyright and license information, please view the
* LICENSE file that was distributed with this source code.
*/
namespace Flarum\Tests\unit\Foundation;
use Flarum\Extension\ExtensionManager;
use Flarum\Tests\unit\TestCase;
class ExtensionDependencyResolutionTest extends TestCase
{
public function setUp(): void
{
parent::setUp();
$this->tags = new FakeExtension('flarum-tags', []);
$this->categories = new FakeExtension('flarum-categories', ['flarum-tags', 'flarum-tag-backgrounds']);
$this->tagBackgrounds = new FakeExtension('flarum-tag-backgrounds', ['flarum-tags']);
$this->something = new FakeExtension('flarum-something', ['flarum-categories', 'flarum-help']);
$this->help = new FakeExtension('flarum-help', []);
$this->missing = new FakeExtension('flarum-missing', ['this-does-not-exist', 'flarum-tags', 'also-not-exists']);
$this->circular1 = new FakeExtension('circular1', ['circular2']);
$this->circular2 = new FakeExtension('circular2', ['circular1']);
$this->optionalDependencyCategories = new FakeExtension('flarum-categories', ['flarum-tags'], ['flarum-tag-backgrounds']);
}
/** @test */
public function works_with_empty_set()
{
$expected = [
'valid' => [],
'missingDependencies' => [],
'circularDependencies' => [],
];
$this->assertEquals($expected, ExtensionManager::resolveExtensionOrder([]));
}
/** @test */
public function works_with_proper_data()
{
$exts = [$this->tags, $this->categories, $this->tagBackgrounds, $this->something, $this->help];
$expected = [
'valid' => [$this->tags, $this->tagBackgrounds, $this->help, $this->categories, $this->something],
'missingDependencies' => [],
'circularDependencies' => [],
];
$this->assertEquals($expected, ExtensionManager::resolveExtensionOrder($exts));
}
/** @test */
public function works_with_missing_dependencies()
{
$exts = [$this->tags, $this->categories, $this->tagBackgrounds, $this->something, $this->help, $this->missing];
$expected = [
'valid' => [$this->tags, $this->tagBackgrounds, $this->help, $this->categories, $this->something],
'missingDependencies' => ['flarum-missing' => ['this-does-not-exist', 'also-not-exists']],
'circularDependencies' => [],
];
$this->assertEquals($expected, ExtensionManager::resolveExtensionOrder($exts));
}
/** @test */
public function works_with_circular_dependencies()
{
$exts = [$this->tags, $this->categories, $this->tagBackgrounds, $this->something, $this->help, $this->circular1, $this->circular2];
$expected = [
'valid' => [$this->tags, $this->tagBackgrounds, $this->help, $this->categories, $this->something],
'missingDependencies' => [],
'circularDependencies' => ['circular2', 'circular1'],
];
$this->assertEquals($expected, ExtensionManager::resolveExtensionOrder($exts));
}
/** @test */
public function works_with_optional_dependencies()
{
$exts = [$this->tags, $this->optionalDependencyCategories, $this->tagBackgrounds, $this->something, $this->help];
$expected = [
'valid' => [$this->tags, $this->tagBackgrounds, $this->help, $this->optionalDependencyCategories, $this->something],
'missingDependencies' => [],
'circularDependencies' => [],
];
$this->assertEquals($expected, ExtensionManager::resolveExtensionOrder($exts));
}
/** @test */
public function works_with_optional_dependencies_if_optional_dependency_missing()
{
$exts = [$this->tags, $this->optionalDependencyCategories, $this->something, $this->help];
$expected = [
'valid' => [$this->tags, $this->help, $this->optionalDependencyCategories, $this->something],
'missingDependencies' => [],
'circularDependencies' => [],
];
$this->assertEquals($expected, ExtensionManager::resolveExtensionOrder($exts));
}
}
class FakeExtension
{
protected $id;
protected $extensionDependencies;
protected $optionalDependencies;
public function __construct($id, $extensionDependencies, $optionalDependencies = [])
{
$this->id = $id;
$this->extensionDependencies = $extensionDependencies;
$this->optionalDependencies = $optionalDependencies;
}
public function getId()
{
return $this->id;
}
public function getExtensionDependencyIds()
{
return $this->extensionDependencies;
}
public function getOptionalDependencyIds()
{
return $this->optionalDependencies;
}
}