From 7a2b3ccfa8835c461ffca89ead1ecf76ea90ba1e Mon Sep 17 00:00:00 2001 From: Sean Molenaar Date: Thu, 25 Mar 2021 22:57:28 +0100 Subject: chore: Improve test coverage Signed-off-by: Sean Molenaar --- CHANGELOG.md | 1 + lib/Command/Debug/FeedItemList.php | 2 +- lib/Command/Debug/ItemList.php | 2 +- tests/Unit/Command/FeedItemListTest.php | 158 ++++++++++++++++++++++++ tests/Unit/Command/FolderItemListTest.php | 191 ++++++++++++++++++++++++++++++ tests/Unit/Command/ItemListTest.php | 156 ++++++++++++++++++++++++ tests/Unit/Config/FetcherConfigTest.php | 65 ++++++++++ 7 files changed, 573 insertions(+), 2 deletions(-) create mode 100644 tests/Unit/Command/FeedItemListTest.php create mode 100644 tests/Unit/Command/FolderItemListTest.php create mode 100644 tests/Unit/Command/ItemListTest.php create mode 100644 tests/Unit/Config/FetcherConfigTest.php diff --git a/CHANGELOG.md b/CHANGELOG.md index 775697a4f..60ca83327 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ The format is almost based on [Keep a Changelog](https://keepachangelog.com/en/1 - Update serialization of item to include categories (#1248) - Make PHPStan stricter - Restore search in news +- Improve test coverage ### Fixed - Do not show deleted feeds in item list diff --git a/lib/Command/Debug/FeedItemList.php b/lib/Command/Debug/FeedItemList.php index 49820993c..ba3e995b3 100644 --- a/lib/Command/Debug/FeedItemList.php +++ b/lib/Command/Debug/FeedItemList.php @@ -63,7 +63,7 @@ class FeedItemList extends Command $feed = $input->getArgument('feed'); if (!is_numeric($feed)) { - $output->writeln('Invalid Type!'); + $output->writeln('Invalid feed ID!'); return 255; } diff --git a/lib/Command/Debug/ItemList.php b/lib/Command/Debug/ItemList.php index 06f8b1c1b..18a2ba56c 100644 --- a/lib/Command/Debug/ItemList.php +++ b/lib/Command/Debug/ItemList.php @@ -63,7 +63,7 @@ class ItemList extends Command $type = $input->getOption('type'); if (!is_numeric($type)) { - $output->writeln('Invalid Type!'); + $output->writeln('Invalid type!'); return 255; } $limit = $input->getOption('limit'); diff --git a/tests/Unit/Command/FeedItemListTest.php b/tests/Unit/Command/FeedItemListTest.php new file mode 100644 index 000000000..37f34e398 --- /dev/null +++ b/tests/Unit/Command/FeedItemListTest.php @@ -0,0 +1,158 @@ + + * + * @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 + * + */ + +namespace OCA\News\Tests\Unit\Command; + +use OCA\News\Command\Debug\FeedItemList; +use OCA\News\Command\Updater\UpdateFeed; +use OCA\News\Service\ItemServiceV2; +use PHPUnit\Framework\MockObject\MockObject; +use PHPUnit\Framework\TestCase; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; + +class FeedItemListTest extends TestCase +{ + /** @var MockObject|ItemServiceV2 */ + protected $service; + /** @var MockObject|InputInterface */ + protected $consoleInput; + /** @var MockObject|OutputInterface */ + protected $consoleOutput; + + /** @var FeedItemList */ + protected $command; + + protected function setUp(): void + { + $this->service = $this->getMockBuilder(ItemServiceV2::class) + ->disableOriginalConstructor() + ->getMock(); + + $this->consoleInput = $this->getMockBuilder(InputInterface::class)->getMock(); + $this->consoleOutput = $this->getMockBuilder(OutputInterface::class)->getMock(); + + $this->command = new FeedItemList($this->service); + } + + /** + * Test a valid call will work + */ + public function testInvalidFeedId() + { + $this->consoleInput->expects($this->exactly(2)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ['feed', 'a'], + ])); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('Invalid feed ID!'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(255, $result); + } + + /** + * Test a valid call will work + */ + public function testInvalidLimit() + { + $this->consoleInput->expects($this->exactly(2)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ['feed', '1'], + ])); + $this->consoleInput->expects($this->exactly(1)) + ->method('getOption') + ->will($this->returnValueMap([ + ['limit', 'admin'], + ])); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('Invalid limit!'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(255, $result); + } + + /** + * Test a valid call will work + */ + public function testInvalidOffset() + { + $this->consoleInput->expects($this->exactly(2)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ['feed', '1'], + ])); + $this->consoleInput->expects($this->exactly(2)) + ->method('getOption') + ->will($this->returnValueMap([ + ['limit', '1'], + ['offset', 'admin'], + ])); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('Invalid offset!'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(255, $result); + } + + /** + * Test a valid call will work + */ + public function testValid() + { + $this->consoleInput->expects($this->exactly(2)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ['feed', '1'], + ])); + $this->consoleInput->expects($this->exactly(4)) + ->method('getOption') + ->will($this->returnValueMap([ + ['limit', '1'], + ['offset', '2'], + ['reverse-sort', false], + ['hide-read', false], + ])); + + $this->service->expects($this->exactly(1)) + ->method('findAllInFeedWithFilters') + ->with('admin', 1, 1, 2, false, false) + ->willReturn([]); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('[]'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(0, $result); + } +} diff --git a/tests/Unit/Command/FolderItemListTest.php b/tests/Unit/Command/FolderItemListTest.php new file mode 100644 index 000000000..c484ba438 --- /dev/null +++ b/tests/Unit/Command/FolderItemListTest.php @@ -0,0 +1,191 @@ + + * + * @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 + * + */ + +namespace OCA\News\Tests\Unit\Command; + +use OCA\News\Command\Debug\FolderItemList; +use OCA\News\Command\Updater\UpdateFeed; +use OCA\News\Service\ItemServiceV2; +use PHPUnit\Framework\MockObject\MockObject; +use PHPUnit\Framework\TestCase; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; + +class FolderItemListTest extends TestCase +{ + /** @var MockObject|ItemServiceV2 */ + protected $service; + /** @var MockObject|InputInterface */ + protected $consoleInput; + /** @var MockObject|OutputInterface */ + protected $consoleOutput; + + /** @var FolderItemList */ + protected $command; + + protected function setUp(): void + { + $this->service = $this->getMockBuilder(ItemServiceV2::class) + ->disableOriginalConstructor() + ->getMock(); + + $this->consoleInput = $this->getMockBuilder(InputInterface::class)->getMock(); + $this->consoleOutput = $this->getMockBuilder(OutputInterface::class)->getMock(); + + $this->command = new FolderItemList($this->service); + } + + /** + * Test a valid call will work + */ + public function testInvalidFolderId() + { + $this->consoleInput->expects($this->exactly(2)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ['folder', 'a'], + ])); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('Invalid folder ID!'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(255, $result); + } + + /** + * Test a valid call will work + */ + public function testInvalidLimit() + { + $this->consoleInput->expects($this->exactly(2)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ['folder', '1'], + ])); + $this->consoleInput->expects($this->exactly(1)) + ->method('getOption') + ->will($this->returnValueMap([ + ['limit', 'admin'], + ])); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('Invalid limit!'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(255, $result); + } + + /** + * Test a valid call will work + */ + public function testInvalidOffset() + { + $this->consoleInput->expects($this->exactly(2)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ['folder', '1'], + ])); + $this->consoleInput->expects($this->exactly(2)) + ->method('getOption') + ->will($this->returnValueMap([ + ['limit', '1'], + ['offset', 'admin'], + ])); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('Invalid offset!'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(255, $result); + } + + /** + * Test a valid call will work + */ + public function testValid() + { + $this->consoleInput->expects($this->exactly(2)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ['folder', '1'], + ])); + $this->consoleInput->expects($this->exactly(4)) + ->method('getOption') + ->will($this->returnValueMap([ + ['limit', '1'], + ['offset', '2'], + ['reverse-sort', false], + ['hide-read', false], + ])); + + $this->service->expects($this->exactly(1)) + ->method('findAllInFolderWithFilters') + ->with('admin', 1, 1, 2, false, false) + ->willReturn([]); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('[]'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(0, $result); + } + + /** + * Test a valid call will work + */ + public function testValidNullFolder() + { + $this->consoleInput->expects($this->exactly(2)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ['folder', null], + ])); + $this->consoleInput->expects($this->exactly(4)) + ->method('getOption') + ->will($this->returnValueMap([ + ['limit', '1'], + ['offset', '2'], + ['reverse-sort', false], + ['hide-read', false], + ])); + + $this->service->expects($this->exactly(1)) + ->method('findAllInFolderWithFilters') + ->with('admin', null, 1, 2, false, false) + ->willReturn([]); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('[]'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(0, $result); + } +} diff --git a/tests/Unit/Command/ItemListTest.php b/tests/Unit/Command/ItemListTest.php new file mode 100644 index 000000000..9387e761e --- /dev/null +++ b/tests/Unit/Command/ItemListTest.php @@ -0,0 +1,156 @@ + + * + * @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 + * + */ + +namespace OCA\News\Tests\Unit\Command; + +use OCA\News\Command\Debug\ItemList; +use OCA\News\Command\Updater\UpdateFeed; +use OCA\News\Service\ItemServiceV2; +use PHPUnit\Framework\MockObject\MockObject; +use PHPUnit\Framework\TestCase; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; + +class ItemListTest extends TestCase +{ + /** @var MockObject|ItemServiceV2 */ + protected $service; + /** @var MockObject|InputInterface */ + protected $consoleInput; + /** @var MockObject|OutputInterface */ + protected $consoleOutput; + + /** @var ItemList */ + protected $command; + + protected function setUp(): void + { + $this->service = $this->getMockBuilder(ItemServiceV2::class) + ->disableOriginalConstructor() + ->getMock(); + + $this->consoleInput = $this->getMockBuilder(InputInterface::class)->getMock(); + $this->consoleOutput = $this->getMockBuilder(OutputInterface::class)->getMock(); + + $this->command = new ItemList($this->service); + } + + /** + * Test a valid call will work + */ + public function testInvalidType() + { + $this->consoleInput->expects($this->exactly(1)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ])); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('Invalid type!'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(255, $result); + } + + /** + * Test a valid call will work + */ + public function testInvalidLimit() + { + $this->consoleInput->expects($this->exactly(1)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ])); + $this->consoleInput->expects($this->exactly(2)) + ->method('getOption') + ->will($this->returnValueMap([ + ['type', '1'], + ['limit', 'admin'], + ])); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('Invalid limit!'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(255, $result); + } + + /** + * Test a valid call will work + */ + public function testInvalidOffset() + { + $this->consoleInput->expects($this->exactly(1)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ])); + $this->consoleInput->expects($this->exactly(3)) + ->method('getOption') + ->will($this->returnValueMap([ + ['type', '1'], + ['limit', '1'], + ['offset', 'admin'], + ])); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('Invalid offset!'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(255, $result); + } + + /** + * Test a valid call will work + */ + public function testValid() + { + $this->consoleInput->expects($this->exactly(1)) + ->method('getArgument') + ->will($this->returnValueMap([ + ['user-id', 'admin'], + ])); + $this->consoleInput->expects($this->exactly(4)) + ->method('getOption') + ->will($this->returnValueMap([ + ['type', '1'], + ['limit', '1'], + ['offset', '2'], + ['reverse-sort', false], + ])); + + $this->service->expects($this->exactly(1)) + ->method('findAllWithFilters') + ->with('admin', 1, 1, 2, false, []) + ->willReturn([]); + + $this->consoleOutput->expects($this->exactly(1)) + ->method('writeln') + ->with('[]'); + + $result = $this->command->run($this->consoleInput, $this->consoleOutput); + $this->assertSame(0, $result); + } +} diff --git a/tests/Unit/Config/FetcherConfigTest.php b/tests/Unit/Config/FetcherConfigTest.php new file mode 100644 index 000000000..6f5364490 --- /dev/null +++ b/tests/Unit/Config/FetcherConfigTest.php @@ -0,0 +1,65 @@ + + * + * @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 + * + */ + +namespace OCA\News\Tests\Config; + +use OCA\News\Command\Debug\ItemList; +use OCA\News\Command\Updater\UpdateFeed; +use OCA\News\Config\FetcherConfig; +use OCA\News\Fetcher\Client\FeedIoClient; +use OCA\News\Service\ItemServiceV2; +use OCP\IConfig; +use PHPUnit\Framework\MockObject\MockObject; +use PHPUnit\Framework\TestCase; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; + +/** + * Class FetcherConfigTest + * + * TODO: Improve this + * + * @package OCA\News\Tests\Config + */ +class FetcherConfigTest extends TestCase +{ + /** @var MockObject|IConfig */ + protected $config; + + /** @var FetcherConfig */ + protected $class; + + protected function setUp(): void + { + $this->config = $this->getMockBuilder(IConfig::class) + ->disableOriginalConstructor() + ->getMock(); + } + + /** + * Test a valid call will work + */ + public function testGetClient() + { + $this->class = new FetcherConfig($this->config); + + $this->assertInstanceOf(FeedIoClient::class, $this->class->getClient()); + } +} -- cgit v1.2.3