assertEqualsCanonicalizing() doesn't compare keys

[joachim-n]

Q	A
PHPUnit version	9.5.20
PHP version	7.4
Installation Method	Composer

Summary

The following assertion passes:

$this->assertEqualsCanonicalizing(['a' => 3], ['b' => 3]);

The docs for this assertion at https://docs.phpunit.de/en/9.6/assertions.html#assertequalscanonicalizing don't mention associative arrays explicitly, but they don't say that assertEqualsCanonicalizing() is only intended for indexed arrays.

Current behavior

The assertion passes / the docs are incorrect.

How to reproduce

Expected behavior

I would say that the assertion should fail. But if it's by design that it passes, the docs need to mention this.

[janzankowski]

Honestly, this bug plus the lack of another function like assertArraysIdentical() seems a major hole to me... I'm now stuck between writing my own function taking into account keys (an hour lost), investigating the code for assertEquals() to check if on arrays it will do canonicalization, recursion AND check key names (an hour lost), or including a different testing library (a bit less time lost, but code bloat). :(

Nevertheless, thank you so much for writing and maintaining PHPUnit!

[kubawerlos]

This seems not to be an issue in PHPUnit 10 anymore, the assertion from report:

$this->assertEqualsCanonicalizing(['a' => 3], ['b' => 3]);

results now with:

There was 1 failure:

1) Test::testFoo
Failed asserting that two arrays are equal.
--- Expected
+++ Actual
@@ @@
 Array (
-    'a' => 3
+    'b' => 3
 )

[fmccown]

The issue appears to be back in PHPUnit 11.1.1 (using PHP 8.2.1).

[sebastianbergmann]

The issue appears to be back in PHPUnit 11.1.1 (using PHP 8.2.1).

Please see #5967.