diff options
Diffstat (limited to 'apps/files_trashbin/tests/Command/CleanUpTest.php')
-rw-r--r-- | apps/files_trashbin/tests/Command/CleanUpTest.php | 183 |
1 files changed, 80 insertions, 103 deletions
diff --git a/apps/files_trashbin/tests/Command/CleanUpTest.php b/apps/files_trashbin/tests/Command/CleanUpTest.php index dad73aaadfc..41ed0e1e960 100644 --- a/apps/files_trashbin/tests/Command/CleanUpTest.php +++ b/apps/files_trashbin/tests/Command/CleanUpTest.php @@ -1,38 +1,23 @@ <?php + +declare(strict_types=1); /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Björn Schießle <bjoern@schiessle.org> - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @author Joas Schilling <coding@schilljs.com> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * @author Thomas Müller <thomas.mueller@tmit.eu> - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * 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, version 3, - * along with this program. If not, see <http://www.gnu.org/licenses/> - * + * SPDX-FileCopyrightText: 2017-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ - namespace OCA\Files_Trashbin\Tests\Command; -use OC\User\Manager; use OCA\Files_Trashbin\Command\CleanUp; use OCP\Files\IRootFolder; use OCP\IDBConnection; +use OCP\IUserManager; +use OCP\Server; +use OCP\UserInterface; +use PHPUnit\Framework\MockObject\MockObject; use Symfony\Component\Console\Exception\InvalidOptionException; use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\NullOutput; use Symfony\Component\Console\Output\OutputInterface; use Test\TestCase; @@ -44,33 +29,19 @@ use Test\TestCase; * @package OCA\Files_Trashbin\Tests\Command */ class CleanUpTest extends TestCase { - - /** @var CleanUp */ - protected $cleanup; - - /** @var \PHPUnit\Framework\MockObject\MockObject | Manager */ - protected $userManager; - - /** @var \PHPUnit\Framework\MockObject\MockObject | IRootFolder */ - protected $rootFolder; - - /** @var IDBConnection */ - protected $dbConnection; - - /** @var string */ - protected $trashTable = 'files_trash'; - - /** @var string */ - protected $user0 = 'user0'; + protected IUserManager&MockObject $userManager; + protected IRootFolder&MockObject $rootFolder; + protected IDBConnection $dbConnection; + protected CleanUp $cleanup; + protected string $trashTable = 'files_trash'; + protected string $user0 = 'user0'; protected function setUp(): void { parent::setUp(); - $this->rootFolder = $this->getMockBuilder('OCP\Files\IRootFolder') - ->disableOriginalConstructor()->getMock(); - $this->userManager = $this->getMockBuilder('OC\User\Manager') - ->disableOriginalConstructor()->getMock(); + $this->rootFolder = $this->createMock(IRootFolder::class); + $this->userManager = $this->createMock(IUserManager::class); - $this->dbConnection = \OC::$server->getDatabaseConnection(); + $this->dbConnection = Server::get(IDBConnection::class); $this->cleanup = new CleanUp($this->rootFolder, $this->userManager, $this->dbConnection); } @@ -78,76 +49,73 @@ class CleanUpTest extends TestCase { /** * populate files_trash table with 10 dummy values */ - public function initTable() { + public function initTable(): void { $query = $this->dbConnection->getQueryBuilder(); - $query->delete($this->trashTable)->execute(); + $query->delete($this->trashTable)->executeStatement(); for ($i = 0; $i < 10; $i++) { $query->insert($this->trashTable) ->values([ - 'id' => $query->expr()->literal('file'.$i), + 'id' => $query->expr()->literal('file' . $i), 'timestamp' => $query->expr()->literal($i), 'location' => $query->expr()->literal('.'), - 'user' => $query->expr()->literal('user'.$i % 2) - ])->execute(); + 'user' => $query->expr()->literal('user' . $i % 2) + ])->executeStatement(); } $getAllQuery = $this->dbConnection->getQueryBuilder(); $result = $getAllQuery->select('id') ->from($this->trashTable) - ->execute() + ->executeQuery() ->fetchAll(); - $this->assertSame(10, count($result)); + $this->assertCount(10, $result); } - /** - * @dataProvider dataTestRemoveDeletedFiles - * @param boolean $nodeExists - */ - public function testRemoveDeletedFiles($nodeExists) { + #[\PHPUnit\Framework\Attributes\DataProvider('dataTestRemoveDeletedFiles')] + public function testRemoveDeletedFiles(bool $nodeExists): void { $this->initTable(); - $this->rootFolder->expects($this->once()) + $this->rootFolder ->method('nodeExists') ->with('/' . $this->user0 . '/files_trashbin') - ->willReturn($nodeExists); + ->willReturnOnConsecutiveCalls($nodeExists, false); if ($nodeExists) { - $this->rootFolder->expects($this->once()) + $this->rootFolder ->method('get') ->with('/' . $this->user0 . '/files_trashbin') ->willReturn($this->rootFolder); - $this->rootFolder->expects($this->once()) + $this->rootFolder ->method('delete'); } else { $this->rootFolder->expects($this->never())->method('get'); $this->rootFolder->expects($this->never())->method('delete'); } - $this->invokePrivate($this->cleanup, 'removeDeletedFiles', [$this->user0]); + self::invokePrivate($this->cleanup, 'removeDeletedFiles', [$this->user0, new NullOutput(), false]); if ($nodeExists) { - // if the delete operation was execute only files from user1 + // if the delete operation was executed only files from user1 // should be left. $query = $this->dbConnection->getQueryBuilder(); $query->select('user') ->from($this->trashTable); - $qResult = $query->execute(); + $qResult = $query->executeQuery(); $result = $qResult->fetchAll(); $qResult->closeCursor(); - $this->assertSame(5, count($result)); + $this->assertCount(5, $result); foreach ($result as $r) { $this->assertSame('user1', $r['user']); } } else { - // if no delete operation was execute we should still have all 10 + // if no delete operation was executed we should still have all 10 // database entries $getAllQuery = $this->dbConnection->getQueryBuilder(); $result = $getAllQuery->select('id') ->from($this->trashTable) - ->execute() + ->executeQuery() ->fetchAll(); - $this->assertSame(10, count($result)); + $this->assertCount(10, $result); } } - public function dataTestRemoveDeletedFiles() { + public static function dataTestRemoveDeletedFiles(): array { return [ [true], [false] @@ -157,91 +125,100 @@ class CleanUpTest extends TestCase { /** * test remove deleted files from users given as parameter */ - public function testExecuteDeleteListOfUsers() { + public function testExecuteDeleteListOfUsers(): void { $userIds = ['user1', 'user2', 'user3']; - $instance = $this->getMockBuilder('OCA\Files_Trashbin\Command\CleanUp') - ->setMethods(['removeDeletedFiles']) + $instance = $this->getMockBuilder(CleanUp::class) + ->onlyMethods(['removeDeletedFiles']) ->setConstructorArgs([$this->rootFolder, $this->userManager, $this->dbConnection]) ->getMock(); $instance->expects($this->exactly(count($userIds))) ->method('removeDeletedFiles') - ->willReturnCallback(function ($user) use ($userIds) { + ->willReturnCallback(function ($user) use ($userIds): void { $this->assertTrue(in_array($user, $userIds)); }); $this->userManager->expects($this->exactly(count($userIds))) ->method('userExists')->willReturn(true); - $inputInterface = $this->getMockBuilder('\Symfony\Component\Console\Input\InputInterface') - ->disableOriginalConstructor()->getMock(); - $inputInterface->expects($this->once())->method('getArgument') + $inputInterface = $this->createMock(\Symfony\Component\Console\Input\InputInterface::class); + $inputInterface->method('getArgument') ->with('user_id') ->willReturn($userIds); - $outputInterface = $this->getMockBuilder('\Symfony\Component\Console\Output\OutputInterface') - ->disableOriginalConstructor()->getMock(); - $this->invokePrivate($instance, 'execute', [$inputInterface, $outputInterface]); + $inputInterface->method('getOption') + ->willReturnMap([ + ['all-users', false], + ['verbose', false], + ]); + $outputInterface = $this->createMock(\Symfony\Component\Console\Output\OutputInterface::class); + self::invokePrivate($instance, 'execute', [$inputInterface, $outputInterface]); } /** * test remove deleted files of all users */ - public function testExecuteAllUsers() { + public function testExecuteAllUsers(): void { $userIds = []; $backendUsers = ['user1', 'user2']; - $instance = $this->getMockBuilder('OCA\Files_Trashbin\Command\CleanUp') - ->setMethods(['removeDeletedFiles']) + $instance = $this->getMockBuilder(CleanUp::class) + ->onlyMethods(['removeDeletedFiles']) ->setConstructorArgs([$this->rootFolder, $this->userManager, $this->dbConnection]) ->getMock(); - $backend = $this->createMock(\OCP\UserInterface::class); - $backend->expects($this->once())->method('getUsers') + $backend = $this->createMock(UserInterface::class); + $backend->method('getUsers') ->with('', 500, 0) ->willReturn($backendUsers); $instance->expects($this->exactly(count($backendUsers))) ->method('removeDeletedFiles') - ->willReturnCallback(function ($user) use ($backendUsers) { + ->willReturnCallback(function ($user) use ($backendUsers): void { $this->assertTrue(in_array($user, $backendUsers)); }); $inputInterface = $this->createMock(InputInterface::class); - $inputInterface->expects($this->once())->method('getArgument') + $inputInterface->method('getArgument') ->with('user_id') ->willReturn($userIds); $inputInterface->method('getOption') - ->with('all-users') - ->willReturn(true); + ->willReturnMap([ + ['all-users', true], + ['verbose', false], + ]); $outputInterface = $this->createMock(OutputInterface::class); - $this->userManager->expects($this->once()) + $this->userManager ->method('getBackends') ->willReturn([$backend]); - $this->invokePrivate($instance, 'execute', [$inputInterface, $outputInterface]); + self::invokePrivate($instance, 'execute', [$inputInterface, $outputInterface]); } - public function testExecuteNoUsersAndNoAllUsers() { + public function testExecuteNoUsersAndNoAllUsers(): void { $inputInterface = $this->createMock(InputInterface::class); - $inputInterface->expects($this->once())->method('getArgument') + $inputInterface->method('getArgument') ->with('user_id') ->willReturn([]); $inputInterface->method('getOption') - ->with('all-users') - ->willReturn(false); + ->willReturnMap([ + ['all-users', false], + ['verbose', false], + ]); $outputInterface = $this->createMock(OutputInterface::class); $this->expectException(InvalidOptionException::class); $this->expectExceptionMessage('Either specify a user_id or --all-users'); - $this->invokePrivate($this->cleanup, 'execute', [$inputInterface, $outputInterface]); + self::invokePrivate($this->cleanup, 'execute', [$inputInterface, $outputInterface]); } - public function testExecuteUsersAndAllUsers() { + public function testExecuteUsersAndAllUsers(): void { $inputInterface = $this->createMock(InputInterface::class); - $inputInterface->expects($this->once())->method('getArgument') + $inputInterface->method('getArgument') ->with('user_id') ->willReturn(['user1', 'user2']); $inputInterface->method('getOption') - ->with('all-users') - ->willReturn(true); + ->willReturnMap([ + ['all-users', true], + ['verbose', false], + ]); $outputInterface = $this->createMock(OutputInterface::class); $this->expectException(InvalidOptionException::class); $this->expectExceptionMessage('Either specify a user_id or --all-users'); - $this->invokePrivate($this->cleanup, 'execute', [$inputInterface, $outputInterface]); + self::invokePrivate($this->cleanup, 'execute', [$inputInterface, $outputInterface]); } } |