Commit graph

32 commits

Author SHA1 Message Date
Timo Tijhof
949c9c932e mail: Improve docs, fix file headers, widen @covers
* 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), git a6f6e04841,
  later moved to a separate file in bf8810d6bc (Ic435bbdbb6).

- MailAddress introduced in r12082 (1.6.0, 1.5.7), git 5cfddf9a82.

- UserMailer converted to class with ::send in r26357 (1.12.0),
  git 353f203ce2.

Change-Id: I1216781240bcfabdebf109cef8f995355db0f659
2024-05-10 19:48:43 +01:00
thiemowmde
62a94f4d24 Remove meaningless constructor tests
These tests do effectively only one thing: Test if the constructor
succeeds without throwing an exception. But these constructors are
all trivial and can't even do that. They are still covered by all
the other tests that also involve the constructor.

Change-Id: I206da47fd93a8ecbb08271390ecc1307ffe9df4e
2024-05-06 09:58:55 +02:00
Reedy
85396a9c99 tests: Fix @covers and @coversDefaultClass to have leading \
Change-Id: I5629f91387f2ac453ee4341bfe4bba310bd52f03
2024-02-16 22:43:56 +00:00
James D. Forrester
4ed5ca48b1 Follow-up 71ff05267: Stop writing to tablesUsed in tests, now unnecessary
Bug: T342301
Change-Id: I5ea01f7ee103570165261bde0965c5b65e04c369
2023-11-21 09:02:48 -05:00
James D. Forrester
a209ca5190 EmailNotificationTest: Expand coverage to be more accurate
PHPUnit won't spot the private method coverage if we only
cover the public methods directly, rather than the class.

Change-Id: I08fabab1eca5bfca1653a366ab9c439ea2eb8f53
2023-10-30 18:21:40 -04:00
James D. Forrester
1d0b7ae1e2 Namespace User under \MediaWiki\User
Bug: T166010
Change-Id: I7257302b485588af31384d4f7fc8e30551f161f1
2023-09-19 19:18:16 +00:00
Umherirrender
d36073cdcf tests: Make some PHPUnit data providers static
Initally used a new sniff with autofix (T333745),
but some provide are defined non-static in TestBase class
and need more work to make them static in a compatible way

Bug: T332865
Change-Id: I889d33424f0c01fb26f2d86f8d4fc3de3e568843
2023-05-20 01:05:27 +02:00
Daimona Eaytoy
e5f17be06c mail: Round 2 of EmailUser refactoring
- Strengthen types
- Use StatusValue instead of Status
- Extract duplicated code to a new private method
- Add MailAddress::equals to compare addresses, instead of relying on
  the weak '!=' comparison. There might be a question of whether having
  the same address should be enough for two MailAddress objects to be
  equal, but the implementation in this patch preserves the status quo.
- Make the new validateTarget accept a User object directly. This is
  better than passing strings around just to have the "validator" create
  a user for you.
- Avoid returning false if there's a hook error in submit(). Accepting 5
  different error formats in the same hook is simply unreasonable, and
  this should eventually be standardized to use StatusValue. The old
  methods in SpecialEmailUser retain BC.

Bug: T265541
Change-Id: Ia0ba27fe634e328dff1a6c06fb9979cb8ce4f7e7
2023-05-17 09:58:21 +00:00
James D. Forrester
ad06527fb4 Reorg: Namespace the Title class
This is moderately messy.

Process was principally:

* xargs rg --files-with-matches '^use Title;' | grep 'php$' | \
  xargs -P 1 -n 1 sed -i -z 's/use Title;/use MediaWiki\\Title\\Title;/1'
* rg --files-without-match 'MediaWiki\\Title\\Title;' . | grep 'php$' | \
  xargs rg --files-with-matches 'Title\b' | \
  xargs -P 1 -n 1 sed -i -z 's/\nuse /\nuse MediaWiki\\Title\\Title;\nuse /1'
* composer fix

Then manual fix-ups for a few files that don't have any use statements.

Bug: T166010
Follows-Up: Ia5d8cb759dc3bc9e9bbe217d0fb109e2f8c4101a
Change-Id: If8fc9d0d95fc1a114021e282a706fc3e7da3524b
2023-03-02 08:46:53 -05:00
Umherirrender
e5e276d6c4 tests: Add missing @group Database
$tablesUsed does not let the test run in the correct group in CI
Fix casing and remove duplicate as well

Change-Id: Id9e092865464de4900965840834d946925c728e5
2022-08-06 22:55:12 +02:00
Derick Alangi
175832a8e9 Migrate usage of setMwGlobals() to overrideConfigValue(s)
Change-Id: I49d97864d8f9d8cadf01b0c0dc653fbac4ca9e94
2022-08-01 06:16:22 +01:00
Umherirrender
047c184bfe tests: Use Title::makeTitle instead of Title::newFromText
Avoid parsing known titles in tests to improve performance

Change-Id: Ibfccfe696f0b8bfda0b99abae324e60bbecef7d8
2022-07-06 00:44:00 +02:00
daniel
b56dde0d83 Remove access to config globals from more classes
Bug: T294739
Depends-On: I84056024b0d3a9dcddb1ab4dc8596118bb3fe8ea
Change-Id: If005958c76bbfabba74def4215c48fe94f297797
2022-04-28 18:36:28 +03:00
Alexander Vorwerk
decbaf4f38 phpunit: use ->getServiceContainer() in integration tests
Change-Id: I38299cb65eeaadfdc0eb05db4e8c0b0119cfb37d
2022-01-27 22:04:16 +01:00
DannyS712
c8ebb7113a Make MailAddressTest a unit test
Requires a bit of manual manipulation of globals, but
other than than no reason to make an integration test.

Change-Id: I56342770f856092992660e104e06aa65a24e0e20
2021-07-23 10:30:04 +00:00
Thiemo Kreuz
f36808dddc Use UserIdentityValue in tests where possible
… instead of PHPUnit mocks. The tiny value class is made for
this.

Change-Id: Ie04cde57126fcafabf8906f9644c6e80345d8a48
2021-04-22 09:32:43 +02:00
Petr Pchelko
c621548cf8 Convert mail namespace to Authority/UserIdentity
Change-Id: I1e1ea72f94735ddaf66eab29aad1296e1abffb9b
2021-04-01 15:46:09 -06:00
DannyS712
52359768c5 Convert or split some tests to MediaWikiUnitTestCase
Don't require any integration

Change-Id: I293a84ce8fe87fc6932f8a6400d6ca443ccc6235
2021-01-07 17:51:27 +00:00
addshore
959bc315f2 MediaWikiTestCase to MediaWikiIntegrationTestCase
The name change happened some time ago, and I think its
about time to start using the name name!
(Done with a find and replace)

My personal motivation for doing this is that I have started
trying out vscode as an IDE for mediawiki development, and
right now it doesn't appear to handle php aliases very well
or at all.

Change-Id: I412235d91ae26e4c1c6a62e0dbb7e7cf3c5ed4a6
2020-06-30 17:02:22 +01:00
MusikAnimal
1ff6ca3fca Filter out expired watched items when sending email notifications
Bug: T253035
Change-Id: I9ebfee4042b6ac40726162fa8c887f757d7528b8
2020-06-24 12:07:08 -04:00
Alexia E. Smith
2b28a56d8a mail: Always quote uncoded names in MailAddress
Otherwise, names that contain whitespace (but no special characters
that need Q-encoding) will be sent as-is in an email header. While
that's valid by RFC 1036, RFC 5322 and others, some mail programs
fail to correctly process spaces. Avoid these problems by simply
quoting the name always - except for cases which are Q-encoded,
which must remain unquoted to be valid (and also cannot contain
spaces, thus unaffected).

Before:
> From: Foo Bar <fb@example.org>

After:
> From "Foo Bar" <fb@example.org>

Update test to work with the new criteria.

Bug: T191931
Change-Id: I4b2a0a80e8b43ecc943939fc5ebaa356a4f840e0
2018-04-24 21:29:25 +00:00
Umherirrender
45da581551 Use ::class to resolve class names in tests
This helps to find renamed or misspelled classes earlier.
Phan will check the class names

Change-Id: Ie541a7baae10ab6f5c13f95ac2ff6598b8f8950c
2018-01-26 22:49:13 +01:00
Timo Tijhof
447ce7e39a phpunit: Avoid use of deprecated getMock for PHPUnit 5 compat
The default will remain PHPUnit 4.x due to PHP 5.5 support.

But, we should allow developers to run tests with newer PHPUnit
versions which are noticably faster (especially for code coverage
reports).

* <https://github.com/sebastianbergmann/phpunit/wiki/Release-Announcement-for-PHPUnit-5.4.0>
  PHPUnit 5 deprecates the getMock() shortcut for getMockBuilder()->getMock().
  It instead introduces the shortcut createMock() which has better defaults
  than getMockBuilder(). For example, it sets 'disableArgumentCloning' and
  other things by default.

  Going forward, code should either use getMockBuilder directly and configure
  it using the setter methods (instead of the confusing variadic arguments
  of getMock) or simply use the new minimalistic createMock method. This patch
  backports the createMock method to MediaWikiTestCase so that we can start
  using it.

Change-Id: I091c0289b21d2b1c876adba89529dc3e72b99af2
2017-04-06 00:44:32 +00:00
Kunal Mehta
6e9b4f0e9c Convert all array() syntax to []
Per wikitech-l consensus:
 https://lists.wikimedia.org/pipermail/wikitech-l/2016-February/084821.html

Notes:
* Disabled CallTimePassByReference due to false positives (T127163)

Change-Id: I2c8ce713ce6600a0bb7bf67537c87044c7a45c4b
2016-02-17 01:33:00 -08:00
Amir E. Aharoni
bfdd3369c2 Fix Generic.Files.LineLength phpcs check in files under phpunit/includes
Bug: T102614
Change-Id: Iee3df5f064f595ecebe8210cc936bc3d20a122c9
2015-10-03 17:13:29 +00:00
jenkins-bot
f330eea930 Merge "Skip MailAddressTest::testNewFromUser on windows" 2014-09-30 22:38:47 +00:00
umherirrender
df24b7209d Fixed spacing
- Added newline at end of file
- Removed double spaces/newlines
- Added space after if/function and parentheses/brackets
- Removed space before comma/cast
- Fixed indent of some lines

Change-Id: I29867ffdffdfb7d2b56997e9393497c7dc12f7d3
2014-09-29 20:46:19 +02:00
umherirrender
4654a2e802 Skip MailAddressTest::testNewFromUser on windows
1) MailAddressTest::testNewFromUser
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'Real name <foo@bar.baz>'
+'foo@bar.baz'

Change-Id: I0c9724130730c39a355c22d06b2c0f0629c1d0e3
2014-09-27 11:43:47 +02:00
Kunal Mehta
3a34ae5731 Improve coverage of MailAddress::toString()
Change-Id: I8d5a1e8f293afa03d94167b722d3078f467cf59e
2014-09-21 18:17:38 -07:00
Kunal Mehta
eab5a7d6ef Add MailAddress::newFromUser()
And tests!

Change-Id: I5214c50855f6bc756f6d748e435ae2124b2264c1
2014-09-14 19:03:18 +00:00
Kunal Mehta
c1e9250124 Add tests for MailAddress
Change-Id: Ia192919322743854096aceb24be0fcf9b1aa32b4
2014-09-14 19:03:13 +00:00
Kunal Mehta
bf8810d6bc Split UserMailer.php into includes/mail/
Change-Id: Ic435bbdbb690028a5d34e8176522fcf4aa44fa92
2014-09-14 19:03:03 +00:00