Skip to content

[Fix] 1.2 - PluginManager Normalization #588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bennothommo merged 3 commits into from
Jun 29, 2022
Merged

[Fix] 1.2 - PluginManager Normalization #588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc04534
Added fix to ensure correct normalization return and aliased normaliz…
jaxwilko Jun 29, 2022
b2c223f
Added plugin normalization test
jaxwilko Jun 29, 2022
a97d1d9
Update modules/system/classes/PluginManager.php
bennothommo Jun 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions modules/system/classes/PluginManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,8 +574,7 @@ public function getNamespace(PluginBase|string $plugin): string
*/
public function normalizeIdentifier(string $code): string
{
$code = strtolower($code);
return $this->normalizedMap[$code] ?? $code;
return $this->getNormalizedIdentifier($code);
}

/**
Expand All @@ -584,7 +583,8 @@ public function normalizeIdentifier(string $code): string
*/
public function getNormalizedIdentifier(PluginBase|string $plugin, bool $lower = false): string
{
$identifier = $this->normalizeIdentifier($this->getIdentifier($plugin));
$code = $this->getIdentifier($plugin);
$identifier = $this->normalizedMap[strtolower($code)] ?? $code;
return $lower ? strtolower($identifier) : $identifier;
}

Expand Down
46 changes: 46 additions & 0 deletions modules/system/tests/classes/PluginManagerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
use System\Classes\PluginManager;
use System\Classes\UpdateManager;
use System\Classes\VersionManager;
use System\Classes\PluginBase;
use ReflectionClass;

use Winter\Storm\Database\Model as ActiveRecord;
Expand Down Expand Up @@ -543,4 +544,49 @@ public function testFlagDisabling()
$flags = $this->manager->getPluginFlags($plugin);
$this->assertEmpty($flags);
}

public function testPluginNormalization()
{
// test lower to upper
$this->assertEquals('Database.Tester', $this->manager->normalizeIdentifier('database.tester'));
$this->assertEquals('Database.Tester', $this->manager->getNormalizedIdentifier('database.tester'));

// test exact match
$this->assertEquals('DependencyTest.Found', $this->manager->normalizeIdentifier('DependencyTest.Found'));
$this->assertEquals('DependencyTest.Found', $this->manager->getNormalizedIdentifier('DependencyTest.Found'));

// test mixed case
$this->assertEquals('DependencyTest.Found', $this->manager->normalizeIdentifier('Dependencytest.Found'));
$this->assertEquals('DependencyTest.Found', $this->manager->getNormalizedIdentifier('Dependencytest.Found'));

// test typeo
$this->assertEquals('dpendencytest.Found', $this->manager->normalizeIdentifier('dpendencytest.Found'));
$this->assertEquals('dpendencytest.Found', $this->manager->getNormalizedIdentifier('dpendencytest.Found'));
$this->assertEquals('Winter.NoUpdate', $this->manager->normalizeIdentifier('Winter.NoUpdate'));
$this->assertEquals('Winter.NoUpdate', $this->manager->getNormalizedIdentifier('Winter.NoUpdate'));

// test multiple mixed case installed plugin
$this->assertEquals('Winter.NoUpdates', $this->manager->normalizeIdentifier('Winter.NoUpdates'));
$this->assertEquals('Winter.NoUpdates', $this->manager->normalizeIdentifier('winter.noUpdates'));
$this->assertEquals('Winter.NoUpdates', $this->manager->normalizeIdentifier('winter.noupdates'));
$this->assertEquals('Winter.NoUpdates', $this->manager->getNormalizedIdentifier('Winter.NoUpdates'));
$this->assertEquals('Winter.NoUpdates', $this->manager->getNormalizedIdentifier('winter.noUpdates'));
$this->assertEquals('Winter.NoUpdates', $this->manager->getNormalizedIdentifier('winter.noupdates'));

// test multiple mixed case not installed plugin
$this->assertEquals('Winter.MissingPlugin', $this->manager->normalizeIdentifier('Winter.MissingPlugin'));
$this->assertEquals('Winter.Missingplugin', $this->manager->normalizeIdentifier('Winter.Missingplugin'));
$this->assertEquals('Winter.missingplugin', $this->manager->normalizeIdentifier('Winter.missingplugin'));
$this->assertEquals('winter.missingplugin', $this->manager->normalizeIdentifier('winter.missingplugin'));
$this->assertEquals('Winter.MissingPlugin', $this->manager->getNormalizedIdentifier('Winter.MissingPlugin'));
$this->assertEquals('Winter.Missingplugin', $this->manager->getNormalizedIdentifier('Winter.Missingplugin'));
$this->assertEquals('Winter.missingplugin', $this->manager->getNormalizedIdentifier('Winter.missingplugin'));
$this->assertEquals('winter.missingplugin', $this->manager->getNormalizedIdentifier('winter.missingplugin'));

// test passing plugin object
$plugin = $this->manager->findByIdentifier('Winter.NoUpdates');
$this->assertInstanceOf(PluginBase::class, $plugin);

$this->assertEquals('Winter.NoUpdates', $this->manager->getNormalizedIdentifier($plugin));
}
}