949c9c932e
* Add missing `ingroup` to class blocks (and remove from any file blocks) as otherwise the file is indexed twice (e.g. in Doxygen) which makes navigation on doc.wikimedia.org rather messy. Remove duplicate descriptions from file blocks in favour of class doc blocks. This reduces needless duplication and was often incorrect or outdated, and helps make file headers more consistently (visually) ignorable. Ref https://gerrit.wikimedia.org/r/q/message:ingroup+is:merged * Widen `@covers` tags in phpunit tests Given all called methods are de-facto and liberally claimed, and that we keep the coverage limited to the subject class, it maintains the spirit and intent by listing the class explicitly instead. PHPUnit offers a more precise tool when you need it (i.e. when testing legacy monster/god classes), but for well-written code, the class-wide tag is exactly what you want. We lose useful coverage and waste valuable time on keeping tags accurate through refactors (or worse, forget to do so). Tracking tiny per-method details wastes time in realizing (and fixing) when people inevitably don't keep them in sync, and time lost in finding uncovered code to write tests to realize it was already covered but "not yet claimed". Ref https://gerrit.wikimedia.org/r/q/owner:Krinkle+is:merged+message:Widen While at it, improve purposes and explainations of several mail-related classes, and set `@since`: - EmailNotification introduced in r22110 (1.11.0), gita6f6e04841, later moved to a separate file inbf8810d6bc(Ic435bbdbb6). - MailAddress introduced in r12082 (1.6.0, 1.5.7), git5cfddf9a82. - UserMailer converted to class with ::send in r26357 (1.12.0), git353f203ce2. Change-Id: I1216781240bcfabdebf109cef8f995355db0f659
89 lines
3.5 KiB
PHP
89 lines
3.5 KiB
PHP
<?php
|
|
|
|
use MediaWiki\User\User;
|
|
use MediaWiki\User\UserIdentityValue;
|
|
|
|
/**
|
|
* @group Mail
|
|
* @covers \MailAddress
|
|
*/
|
|
class MailAddressTest extends MediaWikiIntegrationTestCase {
|
|
|
|
public function testNewFromUser() {
|
|
if ( wfIsWindows() ) {
|
|
$this->markTestSkipped( 'This test only works on non-Windows platforms' );
|
|
}
|
|
$user = $this->createMock( User::class );
|
|
$user->method( 'getUser' )->willReturn( new UserIdentityValue( 42, 'UserName' ) );
|
|
$user->method( 'getEmail' )->willReturn( 'foo@bar.baz' );
|
|
$user->method( 'getRealName' )->willReturn( 'Real name' );
|
|
|
|
$ma = MailAddress::newFromUser( $user );
|
|
$this->assertInstanceOf( MailAddress::class, $ma );
|
|
|
|
// No setMwGlobals() in a unit test, need some manual logic
|
|
// Don't worry about messing with the actual value, MediaWikiUnitTestCase restores it
|
|
global $wgEnotifUseRealName;
|
|
|
|
$wgEnotifUseRealName = true;
|
|
$this->assertEquals( '"Real name" <foo@bar.baz>', $ma->toString() );
|
|
|
|
$wgEnotifUseRealName = false;
|
|
$this->assertEquals( '"UserName" <foo@bar.baz>', $ma->toString() );
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideEquals
|
|
*/
|
|
public function testEquals( MailAddress $first, MailAddress $second, bool $expected ) {
|
|
$this->assertSame( $expected, $first->equals( $second ) );
|
|
}
|
|
|
|
public static function provideEquals(): Generator {
|
|
$base = new MailAddress( 'a@b.c', 'name', 'realname' );
|
|
|
|
yield 'Different addresses' => [ $base, new MailAddress( 'xxx', 'name', 'realname' ), false ];
|
|
yield 'Different names' => [ $base, new MailAddress( 'a@b.c', 'other name', 'realname' ), false ];
|
|
yield 'Different real names' => [ $base, new MailAddress( 'a@b.c', 'name', 'other realname' ), false ];
|
|
yield 'Equal' => [ $base, new MailAddress( 'a@b.c', 'name', 'realname' ), true ];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideToString
|
|
*/
|
|
public function testToString( $useRealName, $address, $name, $realName, $expected ) {
|
|
if ( wfIsWindows() ) {
|
|
$this->markTestSkipped( 'This test only works on non-Windows platforms' );
|
|
}
|
|
// No setMwGlobals() in a unit test, need some manual logic
|
|
// Don't worry about messing with the actual value, MediaWikiUnitTestCase restores it
|
|
global $wgEnotifUseRealName;
|
|
$wgEnotifUseRealName = $useRealName;
|
|
|
|
$ma = new MailAddress( $address, $name, $realName );
|
|
$this->assertEquals( $expected, $ma->toString() );
|
|
}
|
|
|
|
public static function provideToString() {
|
|
return [
|
|
[ true, 'foo@bar.baz', 'FooBar', 'Foo Bar', '"Foo Bar" <foo@bar.baz>' ],
|
|
[ true, 'foo@bar.baz', 'UserName', null, '"UserName" <foo@bar.baz>' ],
|
|
[ true, 'foo@bar.baz', 'AUser', 'My real name', '"My real name" <foo@bar.baz>' ],
|
|
[ true, 'foo@bar.baz', 'AUser', 'My "real" name', '"My \"real\" name" <foo@bar.baz>' ],
|
|
[ true, 'foo@bar.baz', 'AUser', 'My "A/B" test', '"My \"A/B\" test" <foo@bar.baz>' ],
|
|
[ true, 'foo@bar.baz', 'AUser', 'E=MC2', '=?UTF-8?Q?E=3DMC2?= <foo@bar.baz>' ],
|
|
// A backslash (\) should be escaped (\\). In a string literal that is \\\\ (4x).
|
|
[ true, 'foo@bar.baz', 'AUser', 'My "B\C" test', '"My \"B\\\\C\" test" <foo@bar.baz>' ],
|
|
[ true, 'foo@bar.baz', 'A.user.name', 'my@real.name', '"my@real.name" <foo@bar.baz>' ],
|
|
[ false, 'foo@bar.baz', 'AUserName', 'Some real name', '"AUserName" <foo@bar.baz>' ],
|
|
[ false, 'foo@bar.baz', '', '', 'foo@bar.baz' ],
|
|
[ true, 'foo@bar.baz', '', '', 'foo@bar.baz' ],
|
|
[ true, '', '', '', '' ],
|
|
];
|
|
}
|
|
|
|
public function test__ToString() {
|
|
$ma = new MailAddress( 'some@email.com', 'UserName', 'A real name' );
|
|
$this->assertEquals( $ma->toString(), (string)$ma );
|
|
}
|
|
}
|