AddTest::testValid() - Code Metrics - Inspection of "Add polls:share:* CLI commands" - nextcloud/polls - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1516)

by Daniel

created 2021-04-16 17:10 UTC

AddTest::testValid() A

↳ Parent: AddTest

Complexity

Conditions	4
Paths	3

Size

Total Lines	53
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	38
c	1
b	0
f	0
dl	0
loc	53
rs	9.312
cc	4
nc	3
nop	2

How to fix Long Method

<?php
/**
 * @copyright Copyright (c) 2021 Daniel Rudolf <[email protected]>
 *
 * @author Daniel Rudolf <[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 OCA\Polls\Tests\Integration\Command\Share;

use OCA\Polls\Command\Share\Add;
use OCA\Polls\Db\Poll;
use OCA\Polls\Db\Share;
use OCA\Polls\Exceptions\ShareAlreadyExistsException;
use OCA\Polls\Model\Email;
use OCA\Polls\Model\Group;
use OCA\Polls\Model\User;
use OCP\AppFramework\Db\DoesNotExistException;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Console\Exception\RuntimeException as ConsoleRuntimeException;
use Symfony\Component\Console\Tester\CommandTester;

class AddTest extends TestCase
{
	use TShareCommandTest;

	public function setUp(): void {
		parent::setUp();

		$this->setUpMocks();
	}

	public function testMissingArguments(): void {
		$this->pollMapper
			->expects($this->never())
			->method('find');

		$this->expectException(ConsoleRuntimeException::class);
		$this->expectExceptionMessage('Not enough arguments (missing: "id").');

		$command = new Add(
			$this->pollMapper,
			$this->shareMapper,
			$this->shareService,
			$this->userManager,
			$this->groupManager
		);

		$tester = new CommandTester($command);
		$tester->execute([]);
	}

	public function testPollNotFound(): void {
		$pollId = 123;

		$this->pollMapper
			->expects($this->once())
			->method('find')
			->with($pollId)
			->willReturnCallback(function (int $id): Poll {
			->willReturnCallback(function (/** @scrutinizer ignore-unused */ int $id): Poll {
				throw new DoesNotExistException('');
			});

		$command = new Add(
			$this->pollMapper,
			$this->shareMapper,
			$this->shareService,
			$this->userManager,
			$this->groupManager
		);

		$tester = new CommandTester($command);
		$tester->execute(['id' => $pollId]);

		$this->assertEquals("Poll not found.\n", $tester->getDisplay());
	}

	/**
	 * @dataProvider validProvider
	 */
	public function testValid(array $input, array $pollData): void {
		$expectedShareCount = count($pollData['expectedShares']['user'])
			+ count($pollData['expectedShares']['group'])
			+ count($pollData['expectedShares']['email']);
		$expectedInvitationCount = count($pollData['expectedInvitations']['user'])
			+ count($pollData['expectedInvitations']['group'])
			+ count($pollData['expectedInvitations']['email']);

		$expectedInvitationShareTokens = [];
		foreach ($pollData['expectedInvitations'] as $type => $shares) {
			foreach ($shares as $userId) {
				$expectedInvitationShareTokens[] = $this->getShareToken($pollData['pollId'], $type, $userId);
			}
		}

		$this->pollMapper
			->expects($this->once())
			->method('find')
			->with($pollData['pollId'])
			->willReturnCallback([$this, 'createPollMock']);

		$this->shareService
			->expects($this->exactly($expectedShareCount))
			->method('add')
			->with($pollData['pollId'], $this->logicalOr(User::TYPE, Group::TYPE, Email::TYPE), $this->anything())
			->willReturnCallback(function (int $pollId, string $type, string $userId = '') use ($pollData): Share {
				$userIdConstraint = $this->logicalOr(...$pollData['expectedShares'][$type] ?? []);
				$userIdConstraint->evaluate($userId);

				if (in_array($userId, $pollData['initialShares'][$type] ?? [])) {
					throw new ShareAlreadyExistsException();
				}

				return $this->createShareMock($pollId, $type, $userId);
			});

		$this->shareService
			->expects($this->exactly($expectedInvitationCount))
			->method('sendInvitation')
			->with($this->logicalOr(...$expectedInvitationShareTokens));

		$command = new Add(
			$this->pollMapper,
			$this->shareMapper,
			$this->shareService,
			$this->userManager,
			$this->groupManager
		);

		$tester = new CommandTester($command);
		$tester->execute($input);

		$this->assertEquals("Users successfully invited to poll.\n", $tester->getDisplay());
	}

	public function validProvider(): array {
		return [
			[
				[
					'id' => 1,
				],
				[
					'pollId' => 1,
				],
			],
			[
				[
					'id' => 123,
					'--user' => ['user1', 'user2'],
					'--group' => ['group1'],
					'--email' => ['[email protected]', '[email protected]'],
				],
				[
					'pollId' => 123,
					'expectedShares' => [
						'user' => ['user1', 'user2'],
						'group' => ['group1'],
						'email' => ['[email protected]', '[email protected]'],
					],
					'expectedInvitations' => [
						'user' => ['user1', 'user2'],
						'group' => ['group1'],
						'email' => ['[email protected]', '[email protected]'],
					],
				],
			],
			[
				[
					'id' => 456,
					'--user' => ['user2', 'user3', 'user4'],
					'--email' => ['[email protected]', '[email protected]'],
				],
				[
					'pollId' => 456,
					'initialShares' => [
						'user' => ['user1', 'user2'],
						'email' => ['[email protected]'],
					],
					'expectedShares' => [
						'user' => ['user2', 'user3', 'user4'],
						'email' => ['[email protected]', '[email protected]'],
					],
					'expectedInvitations' => [
						'user' => ['user3', 'user4'],
						'email' => ['[email protected]'],
					],
				],
			],
		];
	}
}


nextcloud / polls

Pull Request — master (#1516)

AddTest::testValid() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like