test(invites): Add unit tests for invite API

Signed-off-by: Joas Schilling <coding@schilljs.com>

lib/Controller/RoomController.php

@@ -2485,7 +2485,7 @@ class RoomController extends AEnvironmentAwareController {
 		}
 
 		try {
-			$data = $this->guestManager->importEmails($this->room, $file, $testRun);
+			$data = $this->guestManager->importEmails($this->room, $file['tmp_name'], $testRun);
 			return new DataResponse($data);
 		} catch (GuestImportException $e) {
 			return new DataResponse($e->getData(), Http::STATUS_BAD_REQUEST);

lib/Exceptions/GuestImportException.php

@@ -28,7 +28,7 @@ class GuestImportException extends \Exception {
 		protected readonly ?int $invites = null,
 		protected readonly ?int $duplicates = null,
 	) {
-		parent::__construct();
+		parent::__construct($reason);
 	}
 
 	/**

lib/GuestManager.php

@@ -84,7 +84,7 @@ class GuestManager {
 	 * @return array{invites: non-negative-int, duplicates: non-negative-int, invalid?: non-negative-int, invalidLines?: list<non-negative-int>, type?: int<-1, 6>}
 	 * @throws GuestImportException
 	 */
-	public function importEmails(Room $room, $file, bool $testRun): array {
+	public function importEmails(Room $room, string $filePath, bool $testRun): array {
 		if ($room->getType() === Room::TYPE_ONE_TO_ONE
 			|| $room->getType() === Room::TYPE_ONE_TO_ONE_FORMER
 			|| $room->getType() === Room::TYPE_NOTE_TO_SELF
@@ -93,7 +93,7 @@ class GuestManager {
 			throw new GuestImportException(GuestImportException::REASON_ROOM);
 		}
 
-		$content = fopen($file['tmp_name'], 'rb');
+		$content = fopen($filePath, 'rb');
 		$details = fgetcsv($content, escape: '');
 
 		$emailKey = $nameKey = null;
@@ -119,7 +119,8 @@ class GuestManager {
 		$participants = $this->participantService->getParticipantsByActorType($room, Attendee::ACTOR_EMAILS);
 		$alreadyInvitedEmails = array_flip(array_map(static fn (Participant $participant): string => $participant->getAttendee()->getInvitedCloudId(), $participants));
 
-		$line = $duplicates = 0;
+		$line = 1;
+		$duplicates = 0;
 		$emailsToAdd = $invalidLines = [];
 		while ($details = fgetcsv($content, escape: '')) {
 			$line++;

tests/php/GuestManagerTest.php

@@ -0,0 +1,148 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Talk\Tests\php;
+
+use OCA\Talk\Config;
+use OCA\Talk\Exceptions\GuestImportException;
+use OCA\Talk\GuestManager;
+use OCA\Talk\Participant;
+use OCA\Talk\Room;
+use OCA\Talk\Service\ParticipantService;
+use OCA\Talk\Service\PollService;
+use OCA\Talk\Service\RoomService;
+use OCP\Defaults;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\IUserSession;
+use OCP\Mail\IMailer;
+use PHPUnit\Framework\MockObject\MockObject;
+use Psr\Log\LoggerInterface;
+use Test\TestCase;
+
+class GuestManagerTest extends TestCase {
+	protected Config&MockObject $talkConfig;
+	protected IMailer&MockObject $mailer;
+	protected Defaults&MockObject $defaults;
+	protected IUserSession&MockObject $userSession;
+	protected ParticipantService&MockObject $participantService;
+	protected PollService&MockObject $pollService;
+	protected RoomService&MockObject $roomService;
+	protected IURLGenerator&MockObject $urlGenerator;
+	protected IL10N&MockObject $l;
+	protected IEventDispatcher&MockObject $dispatcher;
+	protected LoggerInterface&MockObject $logger;
+
+	public function setUp(): void {
+		parent::setUp();
+		$this->talkConfig = $this->createMock(Config::class);
+		$this->mailer = $this->createMock(IMailer::class);
+		$this->defaults = $this->createMock(Defaults::class);
+		$this->userSession = $this->createMock(IUserSession::class);
+		$this->participantService = $this->createMock(ParticipantService::class);
+		$this->pollService = $this->createMock(PollService::class);
+		$this->roomService = $this->createMock(RoomService::class);
+		$this->urlGenerator = $this->createMock(IURLGenerator::class);
+		$this->l = $this->createMock(IL10N::class);
+		$this->dispatcher = $this->createMock(IEventDispatcher::class);
+		$this->logger = $this->createMock(LoggerInterface::class);
+	}
+
+	public function getGuestManager(array $methods = []): GuestManager|MockObject {
+		if (!empty($methods)) {
+			return $this->getMockBuilder(GuestManager::class)
+				->setConstructorArgs([
+					$this->talkConfig,
+					$this->mailer,
+					$this->defaults,
+					$this->userSession,
+					$this->participantService,
+					$this->pollService,
+					$this->roomService,
+					$this->urlGenerator,
+					$this->l,
+					$this->dispatcher,
+					$this->logger,
+				])
+				->onlyMethods($methods)
+				->getMock();
+		}
+
+		$this->guestManager = new GuestManager(
+			$this->talkConfig,
+			$this->mailer,
+			$this->defaults,
+			$this->userSession,
+			$this->participantService,
+			$this->pollService,
+			$this->roomService,
+			$this->urlGenerator,
+			$this->l,
+			$this->dispatcher,
+			$this->logger,
+		);
+	}
+
+	public static function dataImportEmails(): array {
+		return [
+			[
+				'import-valid-only-email.csv',
+				1,
+				0,
+				[['valid@example.tld', null]],
+			],
+			[
+				'import-valid-email-and-name.csv',
+				1,
+				0,
+				[['valid@example.tld', 'Name']],
+			],
+			[
+				'import-valid-filter-duplicates-by-email.csv',
+				2,
+				1,
+				[['valid-1@example.tld', 'Valid 1'], ['valid-2@example.tld',null]],
+				GuestImportException::REASON_ROWS,
+				[4],
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider dataImportEmails
+	 */
+	public function testImportEmails(string $fileName, int $invites, int $duplicates, array $invited, ?string $reason = null, array $invalidLines = []): void {
+		$this->mailer->method('validateMailAddress')
+			->willReturnCallback(static fn (string $email): bool => str_starts_with($email, 'valid'));
+
+		$actualInvites = [];
+		$this->participantService->method('inviteEmailAddress')
+			->willReturnCallback(function ($room, $actorId, string $email, ?string $name) use (&$actualInvites): Participant {
+				$actualInvites[] = [$email, $name];
+				return $this->createMock(Participant::class);
+			});
+
+		$room = $this->createMock(Room::class);
+
+		try {
+			$guestManager = $this->getGuestManager(['sendEmailInvitation']);
+			$data = $guestManager->importEmails($room, __DIR__ . '/data/' . $fileName, false);
+		} catch (GuestImportException $e) {
+			if ($reason === null) {
+				throw $e;
+			}
+
+			$data = $e->getData();
+			$this->assertSame($invalidLines, $data['invalidLines']);
+		}
+
+		$this->assertSame($invited, $actualInvites);
+		$this->assertSame($invites, $data['invites'], 'Invites count mismatch');
+		$this->assertSame($duplicates, $data['duplicates'], 'Duplicates count mismatch');
+	}
+}

tests/php/data/import-valid-email-and-name.csv

@@ -0,0 +1,2 @@
+"name","email"
+"Name","valid@example.tld"

tests/php/data/import-valid-email-and-name.csv.license

@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+SPDX-License-Identifier: AGPL-3.0-or-later

tests/php/data/import-valid-filter-duplicates-by-email.csv

@@ -0,0 +1,5 @@
+"email","name"
+"valid-1@example.tld","Valid 1"
+"valid-2@example.tld","valid-2@example.tld"
+"invalid","Valid 2"
+"valid-1@example.tld","Valid 1 again"

tests/php/data/import-valid-filter-duplicates-by-email.csv.license

@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+SPDX-License-Identifier: AGPL-3.0-or-later

tests/php/data/import-valid-only-email.csv

@@ -0,0 +1,2 @@
+"email"
+"valid@example.tld"

tests/php/data/import-valid-only-email.csv.license

@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+SPDX-License-Identifier: AGPL-3.0-or-later