server/apps/user_status/tests/Unit/Listener/UserLiveStatusListenerTest.php

<?php

declare(strict_types=1);

/**
 * @copyright Copyright (c) 2020, Georg Ehrke
 *
 * @author Georg Ehrke <oc.list@georgehrke.com>
 *
 * @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/>
 *
 */

namespace OCA\UserStatus\Tests\Listener;

use OCA\UserStatus\Db\UserStatus;
use OCA\UserStatus\Db\UserStatusMapper;
use OCA\UserStatus\Listener\UserDeletedListener;
use OCA\UserStatus\Listener\UserLiveStatusListener;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\EventDispatcher\GenericEvent;
use OCP\IUser;
use OCP\User\Events\UserLiveStatusEvent;
use Test\TestCase;

class UserLiveStatusListenerTest extends TestCase {

	/** @var UserStatusMapper|\PHPUnit\Framework\MockObject\MockObject */
	private $mapper;

	/** @var ITimeFactory|\PHPUnit\Framework\MockObject\MockObject */
	private $timeFactory;

	/** @var UserDeletedListener */
	private $listener;

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

		$this->mapper = $this->createMock(UserStatusMapper::class);
		$this->timeFactory = $this->createMock(ITimeFactory::class);
		$this->listener = new UserLiveStatusListener($this->mapper, $this->timeFactory);
	}

	/**
	 * @param string $userId
	 * @param string $previousStatus
	 * @param int $previousTimestamp
	 * @param bool $previousIsUserDefined
	 * @param string $eventStatus
	 * @param int $eventTimestamp
	 * @param bool $expectExisting
	 * @param bool $expectUpdate
	 *
	 * @dataProvider handleEventWithCorrectEventDataProvider
	 */
	public function testHandleWithCorrectEvent(string $userId,
											   string $previousStatus,
											   int $previousTimestamp,
											   bool $previousIsUserDefined,
											   string $eventStatus,
											   int $eventTimestamp,
											   bool $expectExisting,
											   bool $expectUpdate): void {
		$userStatus = new UserStatus();

		if ($expectExisting) {
			$userStatus->setId(42);
			$userStatus->setUserId($userId);
			$userStatus->setStatus($previousStatus);
			$userStatus->setStatusTimestamp($previousTimestamp);
			$userStatus->setIsUserDefined($previousIsUserDefined);

			$this->mapper->expects($this->once())
				->method('findByUserId')
				->with($userId)
				->willReturn($userStatus);
		} else {
			$this->mapper->expects($this->once())
				->method('findByUserId')
				->with($userId)
				->willThrowException(new DoesNotExistException(''));
		}

		$user = $this->createMock(IUser::class);
		$user->method('getUID')->willReturn($userId);
		$event = new UserLiveStatusEvent($user, $eventStatus, $eventTimestamp);

		$this->timeFactory->expects($this->once())
			->method('getTime')
			->willReturn(5000);

		if ($expectUpdate) {
			if ($expectExisting) {
				$this->mapper->expects($this->never())
					->method('insert');
				$this->mapper->expects($this->once())
					->method('update')
					->with($this->callback(function ($userStatus) use ($eventStatus, $eventTimestamp) {
						$this->assertEquals($eventStatus, $userStatus->getStatus());
						$this->assertEquals($eventTimestamp, $userStatus->getStatusTimestamp());
						$this->assertFalse($userStatus->getIsUserDefined());

						return true;
					}));
			} else {
				$this->mapper->expects($this->once())
					->method('insert')
					->with($this->callback(function ($userStatus) use ($eventStatus, $eventTimestamp) {
						$this->assertEquals($eventStatus, $userStatus->getStatus());
						$this->assertEquals($eventTimestamp, $userStatus->getStatusTimestamp());
						$this->assertFalse($userStatus->getIsUserDefined());

						return true;
					}));
				$this->mapper->expects($this->never())
					->method('update');
			}

			$this->listener->handle($event);
		} else {
			$this->mapper->expects($this->never())
				->method('insert');
			$this->mapper->expects($this->never())
				->method('update');

			$this->listener->handle($event);
		}
	}

	public function handleEventWithCorrectEventDataProvider(): array {
		return [
			['john.doe', 'offline', 0, false, 'online', 5000, true, true],
			['john.doe', 'offline', 0, false, 'online', 5000, false, true],
			['john.doe', 'online', 5000, false, 'online', 5000, true, false],
			['john.doe', 'online', 5000, false, 'online', 5000, false, true],
			['john.doe', 'away', 5000, false, 'online', 5000, true, true],
			['john.doe', 'online', 5000, false, 'away', 5000, true, false],
		];
	}

	public function testHandleWithWrongEvent(): void {
		$this->mapper->expects($this->never())
			->method('insertOrUpdate');

		$event = new GenericEvent();
		$this->listener->handle($event);
	}
}