Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added posix permission selector (#1209)
- Loading branch information
Showing
7 changed files
with
244 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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 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
82 changes: 82 additions & 0 deletions
82
classes/phing/types/selectors/PosixPermissionsSelector.php
This file contains 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,82 @@ | ||
| <?php | ||
| /** | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| * | ||
| * This software consists of voluntary contributions made by many individuals | ||
| * and is licensed under the LGPL. For more information please see | ||
| * <http://phing.info>. | ||
| */ | ||
|
|
||
| /** | ||
| * A selector that selects files based on their POSIX permissions. | ||
| * | ||
| * @author Siad Ardroumli <siad.ardroumli@gmail.com> | ||
| * @package phing.types.selectors | ||
| */ | ||
| class PosixPermissionsSelector implements FileSelector | ||
| { | ||
| /** @var string $permissions */ | ||
| private $permissions; | ||
|
|
||
| /** | ||
| * Sets the permissions to look for. | ||
| * @param string $permissions the permissions string (rwxrwxrwx or octal) | ||
| */ | ||
| public function setPermissions(string $permissions): void | ||
| { | ||
| $this->validate($permissions); | ||
|
|
||
| if (strlen($permissions) === 3) { | ||
| $this->permissions = $permissions; | ||
| return; | ||
| } | ||
|
|
||
| $this->permissions = implode( | ||
| '', | ||
| array_map( | ||
| 'array_sum', | ||
| array_chunk( | ||
| str_split( | ||
| strtr( | ||
| $permissions, | ||
| array_combine( | ||
| ['r', 'w', 'x', '-'], | ||
| [4, 2, 1, 0] | ||
| ) | ||
| ) | ||
| ), | ||
| 3 | ||
| ) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| private function validate(string $permissions): void | ||
| { | ||
| if ( | ||
| preg_match('/^[0-7]{3}$/', $permissions) !== 1 && | ||
| preg_match('/^[r-][w-][x-][r-][w-][x-][r-][w-][x-]$/', $permissions) !== 1 | ||
| ) { | ||
| throw new BuildException("the permissions attribute {$permissions} is invalid"); | ||
| } | ||
| } | ||
|
|
||
| public function isSelected(PhingFile $basedir, $filename, PhingFile $file): bool | ||
| { | ||
| if ($this->permissions === null) { | ||
| throw new BuildException('the permissions attribute is required'); | ||
| } | ||
|
|
||
| return decoct(fileperms($file->getPath()) & 0777) === $this->permissions; | ||
| } | ||
| } |
This file contains 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 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 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
107 changes: 107 additions & 0 deletions
107
test/classes/phing/types/selectors/PosixPermissionsSelectorTest.php
This file contains 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,107 @@ | ||
| <?php | ||
| /** | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| * | ||
| * This software consists of voluntary contributions made by many individuals | ||
| * and is licensed under the LGPL. For more information please see | ||
| * <http://phing.info>. | ||
| */ | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use OsCondition as Os; | ||
|
|
||
| /** | ||
| * Class PosixPermissionsSelectorTest | ||
| */ | ||
| class PosixPermissionsSelectorTest extends TestCase | ||
| { | ||
| /** @var PosixPermissionsSelector $selector */ | ||
| private $selector; | ||
|
|
||
| protected function setUp(): void | ||
| { | ||
| if (!Os::isFamily(Os::FAMILY_UNIX)) { | ||
| $this->markTestSkipped('Not POSIX'); | ||
| } | ||
|
|
||
| $this->selector = new PosixPermissionsSelector(); | ||
| } | ||
|
|
||
| public function tearDown(): void | ||
| { | ||
| $this->selector = null; | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function argumentRequired(): void | ||
| { | ||
| $this->expectException(BuildException::class); | ||
| $this->expectExceptionMessage('the permissions attribute is required'); | ||
|
|
||
| $this->selector->isSelected(new PhingFile(__DIR__), '', new PhingFile(__FILE__)); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| */ | ||
| public function isSelected(): void | ||
| { | ||
| $this->selector->setPermissions('rw-rw-r--'); | ||
| $this->assertTrue( | ||
| $this->selector->isSelected( | ||
| new PhingFile(__DIR__), | ||
| (new PhingFile(__FILE__))->getName(), | ||
| new PhingFile(__FILE__) | ||
| ), | ||
| 'File permission is wrong. Actual ' . decoct(fileperms(__FILE__) & 0777) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @test | ||
| * @dataProvider illegalArgumentProvider | ||
| * @dataProvider legalArgumentProvider | ||
| * @param string $permission | ||
| * @param bool $throws | ||
| */ | ||
| public function argument(string $permission, $throws = false): void | ||
| { | ||
| if ($throws) { | ||
| $this->expectException(BuildException::class); | ||
| } else { | ||
| $this->expectNotToPerformAssertions(); | ||
| } | ||
|
|
||
| $this->selector->setPermissions($permission); | ||
| } | ||
|
|
||
| public function legalArgumentProvider(): array | ||
| { | ||
| return [ | ||
| 'legal octal string' => ['750'], | ||
| 'legal posix string' => ['rwxr-x---'], | ||
| ]; | ||
| } | ||
|
|
||
| public function illegalArgumentProvider(): array | ||
| { | ||
| return [ | ||
| ['855', true], | ||
| ['4555', true], | ||
| ['-rwxr-xr-x', true], | ||
| ['xrwr-xr-x', true], | ||
| ]; | ||
| } | ||
| } |