mediawiki-extensions-Echo/tests/phpunit/NotifUserTest.php

188 lines
6 KiB
PHP
Raw Normal View History

<?php
use MediaWiki\Extension\Notifications\Gateway\UserNotificationGateway;
use MediaWiki\Extension\Notifications\Mapper\NotificationMapper;
use MediaWiki\Extension\Notifications\Mapper\TargetPageMapper;
use MediaWiki\Extension\Notifications\Model\Event;
use MediaWiki\Extension\Notifications\Model\Notification;
use MediaWiki\MediaWikiServices;
use MediaWiki\User\UserOptionsLookup;
/**
* @covers \MWEchoNotifUser
* @group Echo
*/
class MWEchoNotifUserTest extends MediaWikiIntegrationTestCase {
/**
* @var WANObjectCache
*/
private $cache;
protected function setUp(): void {
parent::setUp();
$this->cache = new WANObjectCache( [
'cache' => MediaWikiServices::getInstance()->getMainObjectStash(),
] );
}
public function testNewFromUser() {
$exception = false;
try {
MWEchoNotifUser::newFromUser( User::newFromId( 0 ) );
} catch ( Exception $e ) {
$exception = true;
$this->assertEquals( "User must be logged in to view notification!",
$e->getMessage() );
}
$this->assertTrue( $exception, "Got exception" );
$notifUser = MWEchoNotifUser::newFromUser( User::newFromId( 2 ) );
$this->assertInstanceOf( MWEchoNotifUser::class, $notifUser );
}
public function testGetEmailFormat() {
$userOptionsLookup = $this->getServiceContainer()->getUserOptionsLookup();
$user = User::newFromId( 2 );
$notifUser = MWEchoNotifUser::newFromUser( $user );
$this->setMwGlobals( 'wgAllowHTMLEmail', true );
$this->assertEquals( $notifUser->getEmailFormat(),
$userOptionsLookup->getOption( $user, 'echo-email-format' ) );
$this->setMwGlobals( 'wgAllowHTMLEmail', false );
$this->assertEquals( EchoEmailFormat::PLAIN_TEXT, $notifUser->getEmailFormat() );
}
public function testMarkRead() {
$notifUser = new MWEchoNotifUser(
User::newFromId( 2 ),
$this->cache,
$this->mockUserNotificationGateway( [ 'markRead' => true ] ),
$this->mockNotificationMapper(),
$this->createMock( TargetPageMapper::class ),
$this->createNoOpMock( UserOptionsLookup::class ),
$this->getServiceContainer()->getUserFactory(),
$this->getServiceContainer()->getReadOnlyMode()
);
$this->assertFalse( $notifUser->markRead( [] ) );
$this->assertTrue( $notifUser->markRead( [ 1 ] ) );
$notifUser = new MWEchoNotifUser(
User::newFromId( 2 ),
$this->cache,
$this->mockUserNotificationGateway( [ 'markRead' => false ] ),
$this->mockNotificationMapper(),
$this->createMock( TargetPageMapper::class ),
$this->createNoOpMock( UserOptionsLookup::class ),
$this->getServiceContainer()->getUserFactory(),
$this->getServiceContainer()->getReadOnlyMode()
);
$this->assertFalse( $notifUser->markRead( [] ) );
$this->assertFalse( $notifUser->markRead( [ 1 ] ) );
}
public function testMarkAllRead() {
// Successful mark as read & non empty fetch
$notifUser = new MWEchoNotifUser(
User::newFromId( 2 ),
$this->cache,
$this->mockUserNotificationGateway( [ 'markRead' => true ] ),
$this->mockNotificationMapper( [ $this->mockNotification() ] ),
$this->createMock( TargetPageMapper::class ),
$this->createNoOpMock( UserOptionsLookup::class ),
$this->getServiceContainer()->getUserFactory(),
$this->getServiceContainer()->getReadOnlyMode()
);
$this->assertTrue( $notifUser->markAllRead() );
// Unsuccessful mark as read & non empty fetch
$notifUser = new MWEchoNotifUser(
User::newFromId( 2 ),
$this->cache,
$this->mockUserNotificationGateway( [ 'markRead' => false ] ),
$this->mockNotificationMapper( [ $this->mockNotification() ] ),
$this->createMock( TargetPageMapper::class ),
$this->createNoOpMock( UserOptionsLookup::class ),
$this->getServiceContainer()->getUserFactory(),
$this->getServiceContainer()->getReadOnlyMode()
);
$this->assertFalse( $notifUser->markAllRead() );
// Successful mark as read & empty fetch
$notifUser = new MWEchoNotifUser(
User::newFromId( 2 ),
$this->cache,
$this->mockUserNotificationGateway( [ 'markRead' => true ] ),
$this->mockNotificationMapper(),
$this->createMock( TargetPageMapper::class ),
$this->createNoOpMock( UserOptionsLookup::class ),
$this->getServiceContainer()->getUserFactory(),
$this->getServiceContainer()->getReadOnlyMode()
);
$this->assertFalse( $notifUser->markAllRead() );
// Unsuccessful mark as read & empty fetch
$notifUser = new MWEchoNotifUser(
User::newFromId( 2 ),
$this->cache,
$this->mockUserNotificationGateway( [ 'markRead' => false ] ),
$this->mockNotificationMapper(),
$this->createMock( TargetPageMapper::class ),
$this->createNoOpMock( UserOptionsLookup::class ),
$this->getServiceContainer()->getUserFactory(),
$this->getServiceContainer()->getReadOnlyMode()
);
$this->assertFalse( $notifUser->markAllRead() );
}
public function mockUserNotificationGateway( array $dbResult = [] ) {
$dbResult += [
'markRead' => true
];
$gateway = $this->createMock( UserNotificationGateway::class );
$gateway->method( 'markRead' )
->willReturn( $dbResult['markRead'] );
$gateway->method( 'getDB' )
->willReturn( $this->createMock( IDatabase::class ) );
return $gateway;
}
public function mockNotificationMapper( array $result = [] ) {
$mapper = $this->createMock( NotificationMapper::class );
$mapper->method( 'fetchUnreadByUser' )
->willReturn( $result );
return $mapper;
}
protected function mockNotification() {
$notification = $this->createMock( Notification::class );
$notification->method( 'getEvent' )
->willReturn( $this->mockEvent() );
return $notification;
}
protected function mockEvent() {
$event = $this->createMock( Event::class );
$event->method( 'getId' )
->willReturn( 1 );
return $event;
}
protected function newNotifUser() {
return new MWEchoNotifUser(
User::newFromId( 2 ),
$this->cache,
$this->mockUserNotificationGateway(),
$this->mockNotificationMapper(),
$this->createMock( TargetPageMapper::class ),
$this->createNoOpMock( UserOptionsLookup::class ),
$this->getServiceContainer()->getUserFactory(),
$this->getServiceContainer()->getReadOnlyMode()
);
}
}