mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo
synced 2024-11-25 08:15:35 +00:00
cc11b3c81a
Right now, if certain users should be excluded, that would have to be part of the user-locators already. This is annoying because it's hard to write "generic" user locators when you want to exclude just a couple of people in certain cases. In Flow, for example, we have user-locators for users watching a board or topic. We don't want to send the notification to people that have also been mentioned in that post (they'll get a separate notification). We could build that exception into those user-locators, but then we couldn't re-use them in other places... This basically means we couldn't use EchoUserLocator::locateUsersWatchingTitle, we would have to roll our own that also excludes mentioned users. Instead, this lets you add 'user-filters' (that functionality actually exists already, but is not currently exposed), which lists users to not send the notification to, even though they could be in a user-locator. Bug: T125428 Change-Id: Ifa0e2d3283f57624af4c5ec264f9f66223508e83
332 lines
8.3 KiB
PHP
332 lines
8.3 KiB
PHP
<?php
|
|
|
|
class EchoAttributeManagerTest extends MediaWikiTestCase {
|
|
|
|
public function testNewFromGlobalVars() {
|
|
$this->assertInstanceOf( 'EchoAttributeManager', EchoAttributeManager::newFromGlobalVars() );
|
|
}
|
|
|
|
public static function getUserLocatorsProvider() {
|
|
return array(
|
|
array(
|
|
'No errors when requesting unknown type',
|
|
// expected result
|
|
array(),
|
|
// event type
|
|
'foo',
|
|
// notification configuration
|
|
array(),
|
|
),
|
|
|
|
array(
|
|
'Returns selected notification configuration',
|
|
// expected result
|
|
array( 'woot!' ),
|
|
// event type
|
|
'magic',
|
|
// notification configuration
|
|
array(
|
|
'foo' => array(
|
|
EchoAttributeManager::ATTR_LOCATORS => array( 'frown' ),
|
|
),
|
|
'magic' => array(
|
|
EchoAttributeManager::ATTR_LOCATORS => array( 'woot!' ),
|
|
),
|
|
),
|
|
),
|
|
|
|
array(
|
|
'Accepts user-locators as string and returns array',
|
|
// expected result
|
|
array( 'sagen' ),
|
|
// event type
|
|
'challah',
|
|
// notification configuration
|
|
array(
|
|
'challah' => array(
|
|
EchoAttributeManager::ATTR_LOCATORS => 'sagen',
|
|
),
|
|
),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider getUserLocatorsProvider
|
|
*/
|
|
public function testGetUserLocators( $message, $expect, $type, $notifications ) {
|
|
$manager = new EchoAttributeManager( $notifications, array() );
|
|
|
|
$result = $manager->getUserCallable( $type, EchoAttributeManager::ATTR_LOCATORS );
|
|
$this->assertEquals( $expect, $result, $message );
|
|
}
|
|
|
|
public function testGetCategoryEligibility() {
|
|
$notif = array(
|
|
'event_one' => array(
|
|
'category' => 'category_one'
|
|
),
|
|
);
|
|
$category = array(
|
|
'category_one' => array(
|
|
'priority' => 10
|
|
)
|
|
);
|
|
$manager = new EchoAttributeManager( $notif, $category );
|
|
$this->assertTrue( $manager->getCategoryEligibility( $this->mockUser(), 'category_one' ) );
|
|
$category = array(
|
|
'category_one' => array(
|
|
'priority' => 10,
|
|
'usergroups' => array(
|
|
'sysop'
|
|
)
|
|
)
|
|
);
|
|
$manager = new EchoAttributeManager( $notif, $category );
|
|
$this->assertFalse( $manager->getCategoryEligibility( $this->mockUser(), 'category_one' ) );
|
|
}
|
|
|
|
public function testGetNotificationCategory() {
|
|
$notif = array(
|
|
'event_one' => array(
|
|
'category' => 'category_one'
|
|
),
|
|
);
|
|
$category = array(
|
|
'category_one' => array(
|
|
'priority' => 10
|
|
)
|
|
);
|
|
$manager = new EchoAttributeManager( $notif, $category );
|
|
$this->assertEquals( $manager->getNotificationCategory( 'event_one' ), 'category_one' );
|
|
|
|
$manager = new EchoAttributeManager( $notif, array() );
|
|
$this->assertEquals( $manager->getNotificationCategory( 'event_one' ), 'other' );
|
|
|
|
$notif = array(
|
|
'event_one' => array(
|
|
'category' => 'category_two'
|
|
),
|
|
);
|
|
$category = array(
|
|
'category_one' => array(
|
|
'priority' => 10
|
|
)
|
|
);
|
|
$manager = new EchoAttributeManager( $notif, $category );
|
|
$this->assertEquals( $manager->getNotificationCategory( 'event_one' ), 'other' );
|
|
}
|
|
|
|
public function testGetCategoryPriority() {
|
|
$notif = array(
|
|
'event_one' => array(
|
|
'category' => 'category_two'
|
|
),
|
|
);
|
|
$category = array(
|
|
'category_one' => array(
|
|
'priority' => 6
|
|
),
|
|
'category_two' => array(
|
|
'priority' => 100
|
|
),
|
|
'category_three' => array(
|
|
'priority' => -10
|
|
),
|
|
'category_four' => array()
|
|
);
|
|
$manager = new EchoAttributeManager( $notif, $category );
|
|
$this->assertEquals( 6, $manager->getCategoryPriority( 'category_one' ) );
|
|
$this->assertEquals( 10, $manager->getCategoryPriority( 'category_two' ) );
|
|
$this->assertEquals( 10, $manager->getCategoryPriority( 'category_three' ) );
|
|
$this->assertEquals( 10, $manager->getCategoryPriority( 'category_four' ) );
|
|
}
|
|
|
|
public function testGetNotificationPriority() {
|
|
$notif = array(
|
|
'event_one' => array(
|
|
'category' => 'category_one'
|
|
),
|
|
'event_two' => array(
|
|
'category' => 'category_two'
|
|
),
|
|
'event_three' => array(
|
|
'category' => 'category_three'
|
|
),
|
|
'event_four' => array(
|
|
'category' => 'category_four'
|
|
)
|
|
);
|
|
$category = array(
|
|
'category_one' => array(
|
|
'priority' => 6
|
|
),
|
|
'category_two' => array(
|
|
'priority' => 100
|
|
),
|
|
'category_three' => array(
|
|
'priority' => -10
|
|
),
|
|
'category_four' => array()
|
|
);
|
|
$manager = new EchoAttributeManager( $notif, $category );
|
|
$this->assertEquals( 6, $manager->getNotificationPriority( 'event_one' ) );
|
|
$this->assertEquals( 10, $manager->getNotificationPriority( 'event_two' ) );
|
|
$this->assertEquals( 10, $manager->getNotificationPriority( 'event_three' ) );
|
|
$this->assertEquals( 10, $manager->getNotificationPriority( 'event_four' ) );
|
|
}
|
|
|
|
public function testGetMessageEvents() {
|
|
$notif = array(
|
|
'event_one' => array(
|
|
'category' => 'category_one',
|
|
'section' => 'message'
|
|
),
|
|
'event_two' => array(
|
|
'category' => 'category_two'
|
|
),
|
|
'event_three' => array(
|
|
'category' => 'category_three',
|
|
'section' => 'message'
|
|
),
|
|
'event_four' => array(
|
|
'category' => 'category_four'
|
|
)
|
|
);
|
|
$category = array(
|
|
'category_one' => array(
|
|
'priority' => 6
|
|
)
|
|
);
|
|
$manager = new EchoAttributeManager( $notif, $category );
|
|
$this->assertEquals( $manager->getMessageEvents(), array( 'event_one', 'event_three' ) );
|
|
}
|
|
|
|
public function testGetAlertEvents() {
|
|
$notif = array(
|
|
'event_one' => array(
|
|
'category' => 'category_one',
|
|
'section' => 'message'
|
|
),
|
|
'event_two' => array(
|
|
'category' => 'category_two'
|
|
),
|
|
'event_three' => array(
|
|
'category' => 'category_three',
|
|
'section' => 'alert'
|
|
),
|
|
'event_four' => array(
|
|
'category' => 'category_four'
|
|
)
|
|
);
|
|
$category = array(
|
|
'category_one' => array(
|
|
'priority' => 6
|
|
)
|
|
);
|
|
$manager = new EchoAttributeManager( $notif, $category );
|
|
$this->assertEquals( $manager->getAlertEvents(), array( 'event_two', 'event_three', 'event_four' ) );
|
|
}
|
|
|
|
public function testGetUserEnabledEvents() {
|
|
$notif = array(
|
|
'event_one' => array(
|
|
'category' => 'category_one'
|
|
),
|
|
'event_two' => array(
|
|
'category' => 'category_two'
|
|
),
|
|
'event_three' => array(
|
|
'category' => 'category_three'
|
|
),
|
|
);
|
|
$category = array(
|
|
'category_one' => array(
|
|
'priority' => 10,
|
|
'usergroups' => array(
|
|
'sysop'
|
|
)
|
|
),
|
|
'category_two' => array(
|
|
'priority' => 10,
|
|
'usergroups' => array(
|
|
'echo_group'
|
|
)
|
|
),
|
|
'category_three' => array(
|
|
'priority' => 10,
|
|
),
|
|
);
|
|
$manager = new EchoAttributeManager( $notif, $category );
|
|
$this->assertEquals( $manager->getUserEnabledEvents( $this->mockUser(), 'web' ), array( 'event_two', 'event_three' ) );
|
|
}
|
|
|
|
public function testGetUserEnabledEventsbySections() {
|
|
$notif = array(
|
|
'event_one' => array(
|
|
'category' => 'category_one'
|
|
),
|
|
'event_two' => array(
|
|
'category' => 'category_two',
|
|
'section' => 'message'
|
|
),
|
|
'event_three' => array(
|
|
'category' => 'category_three',
|
|
'section' => 'alert'
|
|
),
|
|
'event_four' => array(
|
|
'category' => 'category_three',
|
|
),
|
|
);
|
|
$category = array(
|
|
'category_one' => array(
|
|
'priority' => 10,
|
|
),
|
|
'category_two' => array(
|
|
'priority' => 10,
|
|
),
|
|
'category_three' => array(
|
|
'priority' => 10
|
|
),
|
|
);
|
|
$manager = new EchoAttributeManager( $notif, $category );
|
|
$expected = array( 'event_one', 'event_three', 'event_four' );
|
|
$actual = $manager->getUserEnabledEventsBySections( $this->mockUser(), 'web', array( 'alert' ) );
|
|
sort( $expected );
|
|
sort( $actual );
|
|
$this->assertEquals( $actual, $expected );
|
|
|
|
$expected = array( 'event_two' );
|
|
$actual = $manager->getUserEnabledEventsBySections( $this->mockUser(), 'web', array( 'message' ) );
|
|
sort( $expected );
|
|
sort( $actual );
|
|
$this->assertEquals( $actual, $expected );
|
|
|
|
$expected = array( 'event_one', 'event_two', 'event_three', 'event_four' );
|
|
$actual = $manager->getUserEnabledEventsBySections( $this->mockUser(), 'web', array( 'message', 'alert' ) );
|
|
sort( $expected );
|
|
sort( $actual );
|
|
$this->assertEquals( $actual, $expected );
|
|
}
|
|
|
|
/**
|
|
* Mock object of User
|
|
*/
|
|
protected function mockUser() {
|
|
$user = $this->getMockBuilder( 'User' )
|
|
->disableOriginalConstructor()
|
|
->getMock();
|
|
$user->expects( $this->any() )
|
|
->method( 'getID' )
|
|
->will( $this->returnValue( 1 ) );
|
|
$user->expects( $this->any() )
|
|
->method( 'getOption' )
|
|
->will( $this->returnValue( true ) );
|
|
$user->expects( $this->any() )
|
|
->method( 'getGroups' )
|
|
->will( $this->returnValue( array( 'echo_group' ) ) );
|
|
|
|
return $user;
|
|
}
|
|
}
|