-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Fix version comparison with minor and patch level requirements #9024
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.
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
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * @copyright 2018 Christoph Wurst <[email protected]> | ||
| * | ||
| * @author 2018 Christoph Wurst <[email protected]> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * 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 Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OC\App; | ||
|
|
||
| use InvalidArgumentException; | ||
|
|
||
| class CompareVersion { | ||
|
|
||
| const REGEX_MAJOR = '/^\d+$/'; | ||
| const REGEX_MAJOR_MINOR = '/^\d+.\d+$/'; | ||
| const REGEX_MAJOR_MINOR_PATCH = '/^\d+.\d+.\d+$/'; | ||
| const REGEX_SERVER = '/^\d+.\d+.\d+(.\d+)?$/'; | ||
|
|
||
| /** | ||
| * Checks if the given server version fulfills the given (app) version requirements. | ||
| * | ||
| * Version requirements can be 'major.minor.patch', 'major.minor' or just 'major', | ||
| * so '13.0.1', '13.0' and '13' are valid. | ||
| * | ||
| * @param string $actual version as major.minor.patch notation | ||
| * @param string $required version where major is requried and minor and patch are optional | ||
| * @param string $comparator passed to `version_compare` | ||
| * @return bool whether the requirement is fulfilled | ||
| * @throws InvalidArgumentException if versions specified in an invalid format | ||
| */ | ||
| public function isCompatible(string $actual, string $required, | ||
| string $comparator = '>='): bool { | ||
|
|
||
| if (!preg_match(self::REGEX_SERVER, $actual)) { | ||
| throw new InvalidArgumentException('server version is invalid'); | ||
| } | ||
|
|
||
| if (preg_match(self::REGEX_MAJOR, $required) === 1) { | ||
| return $this->compareMajor($actual, $required, $comparator); | ||
| } else if (preg_match(self::REGEX_MAJOR_MINOR, $required) === 1) { | ||
| return $this->compareMajorMinor($actual, $required, $comparator); | ||
| } else if (preg_match(self::REGEX_MAJOR_MINOR_PATCH, $required) === 1) { | ||
| return $this->compareMajorMinorPatch($actual, $required, $comparator); | ||
| } else { | ||
| throw new InvalidArgumentException('required version is invalid'); | ||
| } | ||
| } | ||
|
|
||
| private function compareMajor(string $actual, string $required, | ||
| string $comparator) { | ||
| $actualMajor = explode('.', $actual)[0]; | ||
| $requiredMajor = explode('.', $required)[0]; | ||
|
|
||
| return version_compare($actualMajor, $requiredMajor, $comparator); | ||
| } | ||
|
|
||
| private function compareMajorMinor(string $actual, string $required, | ||
| string $comparator) { | ||
| $actualMajor = explode('.', $actual)[0]; | ||
| $actualMinor = explode('.', $actual)[1]; | ||
| $requiredMajor = explode('.', $required)[0]; | ||
| $requiredMinor = explode('.', $required)[1]; | ||
|
|
||
| return version_compare("$actualMajor.$actualMinor", | ||
| "$requiredMajor.$requiredMinor", $comparator); | ||
| } | ||
|
|
||
| private function compareMajorMinorPatch($actual, $required, $comparator) { | ||
| $actualMajor = explode('.', $actual)[0]; | ||
| $actualMinor = explode('.', $actual)[1]; | ||
| $actualPatch = explode('.', $actual)[2]; | ||
| $requiredMajor = explode('.', $required)[0]; | ||
| $requiredMinor = explode('.', $required)[1]; | ||
| $requiredPatch = explode('.', $required)[2]; | ||
|
|
||
| return version_compare("$actualMajor.$actualMinor.$actualPatch", | ||
| "$requiredMajor.$requiredMinor.$requiredPatch", $comparator); | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * @copyright 2018 Christoph Wurst <[email protected]> | ||
| * | ||
| * @author 2018 Christoph Wurst <[email protected]> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * 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 Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace Test\App; | ||
|
|
||
| use InvalidArgumentException; | ||
| use OC\App\CompareVersion; | ||
| use Test\TestCase; | ||
|
|
||
| class CompareVersionTest extends TestCase { | ||
|
|
||
| /** @var CompareVersion */ | ||
| private $compare; | ||
|
|
||
| protected function setUp() { | ||
| parent::setUp(); | ||
|
|
||
| $this->compare = new CompareVersion(); | ||
| } | ||
|
|
||
| public function comparisonData() { | ||
| return [ | ||
| // Compatible versions | ||
| ['13.0.0.3', '13.0.0', '>=', true], | ||
| ['13.0.0.3', '13.0.0', '<=', true], | ||
| ['13.0.0', '13.0.0', '>=', true], | ||
| ['13.0.0', '13.0', '<=', true], | ||
| ['13.0.0', '13', '>=', true], | ||
| ['13.0.1', '13', '>=', true], | ||
| ['13.0.1', '13', '<=', true], | ||
| // Incompatible major versions | ||
| ['13.0.0.3', '13.0.0', '<', false], | ||
| ['12.0.0', '13.0.0', '>=', false], | ||
| ['12.0.0', '13.0', '>=', false], | ||
| ['12.0.0', '13', '>=', false], | ||
| // Incompatible minor and patch versions | ||
| ['13.0.0', '13.0.1', '>=', false], | ||
| ['13.0.0', '13.1', '>=', false], | ||
| // Compatible minor and patch versions | ||
| ['13.0.1', '13.0.0', '>=', true], | ||
| ['13.2.0', '13.1', '>=', true], | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider comparisonData | ||
| */ | ||
| public function testComparison(string $actualVersion, string $requiredVersion, | ||
| string $comparator, bool $expected) { | ||
| $isCompatible = $this->compare->isCompatible($actualVersion, $requiredVersion, | ||
| $comparator); | ||
|
|
||
| $this->assertEquals($expected, $isCompatible); | ||
| } | ||
|
|
||
| public function testInvalidServerVersion() { | ||
| $actualVersion = '13'; | ||
| $this->expectException(InvalidArgumentException::class); | ||
|
|
||
| $this->compare->isCompatible($actualVersion, '13.0.0'); | ||
| } | ||
|
|
||
| public function testInvalidRequiredVersion() { | ||
| $actualVersion = '13.0.0'; | ||
| $this->expectException(InvalidArgumentException::class); | ||
|
|
||
| $this->compare->isCompatible($actualVersion, '13.0.0.9'); | ||
| } | ||
|
|
||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't it make sense to do then only a check agains
REGEX_MAJOR_MINOR_PATCHbecause it is excluded below anyways (in the else branch)?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Below only
$requiredis checked, not$actual. And the server version is in x.x.x(.x) format, hence the special regex with the optional forth-level version.