assertArraySubset() will be removed in PHPUnit 9
Closed, ResolvedPublic
Actions

Description

I cut a few lines from Traivs CI:

assertArraySubset() is deprecated and will be removed in PHPUnit 9.

tests/phpunit/MediaWikiIntegrationTestCase.php:416
maintenance/doMaintenance.php:99

assertArraySubset() used for:

[root@Alice mediawiki]# grep -nr "\bassertArraySubset\b" tests/
tests/phpunit/structure/ApiStructureTest.php:447:					$this->assertArraySubset(
tests/phpunit/PHPUnit6And8Compat.php:32:				'assertArraySubset\(\)',
tests/phpunit/includes/skins/SkinTemplateTest.php:105:		$this->assertArraySubset(
tests/phpunit/includes/specials/ContribsPagerTest.php:34:		$this->assertArraySubset( $expectedOpts, ContribsPager::processDateFilter( $inputOpts ) );
tests/phpunit/includes/api/ApiBlockInfoTraitTest.php:25:		$this->assertArraySubset( $subset, $info );
tests/phpunit/includes/api/ApiQueryBlocksTest.php:54:		$this->assertArraySubset( $subset, $data['query']['blocks'][0] );
tests/phpunit/includes/api/ApiQueryBlocksTest.php:84:		$this->assertArraySubset( $subset, $data['query']['blocks'][0] );
tests/phpunit/includes/api/ApiQueryBlocksTest.php:144:		$this->assertArraySubset( $flagSubset, $data['query']['blocks'][0] );
tests/phpunit/includes/api/ApiQueryBlocksTest.php:170:		$this->assertArraySubset( $restrictionsSubset, $data['query']['blocks'][0] );
tests/phpunit/includes/api/ApiQueryRecentChangesIntegrationTest.php:168:		$this->assertArraySubset(
tests/phpunit/includes/api/ApiQueryRecentChangesIntegrationTest.php:424:		$this->assertArraySubset(
tests/phpunit/includes/api/ApiQueryRecentChangesIntegrationTest.php:474:		$this->assertArraySubset(
tests/phpunit/includes/api/ApiQueryRecentChangesIntegrationTest.php:498:		$this->assertArraySubset( [ 'anon' => true ], $items[0] );
tests/phpunit/includes/api/ApiQueryRecentChangesIntegrationTest.php:1017:		$this->assertArraySubset(
tests/phpunit/includes/PagePropsTest.php:147:	 * does not yet include assertArraySubset(), we needed to code the

Task in Github about deprecating the method.

Details

	Subject	Repo	Branch	Lines +/-
	Add MediaWikiIntegrationTestCase::assertArraySubmapSame()	mediawiki/core	master	+69 -17

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Resolved	Daimona	T262076 Package phpunit/php-token-stream is abandoned
Resolved	None	T320245 Migrate all Wikimedia codebases to use PHPUnit 9
Resolved	Daimona	T243600 Migrate MediaWiki core (and thus extensions and skins) to PHPUnit 9
Resolved	aaron	T244095 assertArraySubset() will be removed in PHPUnit 9
Resolved	• Mholloway	T244378 assertArraySubset() will be removed in PHPUnit 9, fix it for reading lists

Event Timeline

RazeSoldier created this task.Feb 2 2020, 7:41 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 2 2020, 7:41 PM

RazeSoldier moved this task from Inbox to PHPUnit on the MediaWiki-Core-Tests board.Feb 2 2020, 7:42 PM

RazeSoldier added a parent task: T243600: Migrate MediaWiki core (and thus extensions and skins) to PHPUnit 9.Feb 2 2020, 7:44 PM

Outside of core, also used by some extensions.
Code search for current usage in WMF deployed code: https://codesearch.wmflabs.org/deployed/?q=assertArraySubset&i=nope&files=&repos=

Restricted Application added projects: Growth-Team, Product-Infrastructure-Team-Backlog-Deprecated. · View Herald TranscriptFeb 3 2020, 6:18 AM

LGoto moved this task from Needs triage to Tracking on the Product-Infrastructure-Team-Backlog-Deprecated board.Feb 5 2020, 4:37 PM

We need to port assertArraySubset() to mediawiki. We have two plans:

Copy the code to MediaWikiTestCaseTrait.
Or add https://packagist.org/packages/dms/phpunit-arraysubset-asserts as a dev dependency and call it.

See T192167#5685401. Alternatively, we may also just stop using assertArraySubset.

This warnings are fairly spammy, so it would be nice to have a replacement method.

Adding a replacement method to …IntegrationTest is probably the simplest way forward?

• Mholloway closed subtask T244378: assertArraySubset() will be removed in PHPUnit 9, fix it for reading lists as Resolved.Mar 3 2020, 5:38 PM

In T244095#5937899, @Jdforrester-WMF wrote:

Adding a replacement method to …IntegrationTest is probably the simplest way forward?

In MediaWikiTestCaseTrait, I'd say. We could either implement our own simplified version of assertArraySubset (probably better), or pull an external library with the full version.

Also, I'd recommend not to name it "assertArraySubset".

In T244095#5937930, @Daimona wrote:

In T244095#5937899, @Jdforrester-WMF wrote:

Adding a replacement method to …IntegrationTest is probably the simplest way forward?

In MediaWikiTestCaseTrait, I'd say.

I thought we were trying to keep that as light as possible (for the sake of MediaWikiUnitTestCase)? But I see it's already got a few similar methods. Fine.

We could either implement our own simplified version of assertArraySubset (probably better), or pull an external library with the full version.

Also, I'd recommend not to name it "assertArraySubset".

Definitely.

Is anyone working on this atm?

In T244095#5983011, @aaron wrote:

Is anyone working on this atm?

I don't think so, mainly because it's not clear how to proceed. Although probably, given how much assertArraySubset is used, we should probably just implement our own simplified version of it.

In T244095#5983247, @Daimona wrote:

In T244095#5983011, @aaron wrote:

Is anyone working on this atm?

I don't think so, mainly because it's not clear how to proceed. Although probably, given how much assertArraySubset is used, we should probably just implement our own simplified version of it.

I would just go with that for now. It can always be changed later. Maybe callers that can easily use something else can be migrated too (if any).

Change 581786 had a related patch set uploaded (by Aaron Schulz; owner: Aaron Schulz):
[mediawiki/core@master] Add MediaWikiIntegrationTestCase::assertArraySubmapSame()

https://gerrit.wikimedia.org/r/581786

gerritbot added a project: Patch-For-Review.Mar 19 2020, 11:04 PM

Change 581786 merged by jenkins-bot:
[mediawiki/core@master] Add MediaWikiIntegrationTestCase::assertArraySubmapSame()

https://gerrit.wikimedia.org/r/581786

ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.25; 2020-03-24).Mar 20 2020, 1:00 AM

aaron closed this task as Resolved.Mar 20 2020, 1:50 AM

aaron claimed this task.

Daimona mentioned this in T320331: Test failures on PHPUnit 9.5: "Error: Class 'PHPUnit\Framework\Constraint\ArraySubset' not found".Oct 8 2022, 8:33 PM

Maintenance_bot removed a project: Patch-For-Review.Oct 8 2022, 9:30 PM

Daimona mentioned this in T320339: PageTriage tests failing due to assertArraySubset dependency.Oct 9 2022, 11:41 AM