`SapiTest` fails on Windows

[live627]

got this while testing #9586

PHPUnit 13.3.2 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.5.0
Configuration: C:\Users\John\repos\SMF2.1\phpunit.xml.dist

...............................................................  63 / 202 ( 31%)
...........................F................................... 126 / 202 ( 62%)
............................................................... 189 / 202 ( 93%)
.............                                                   202 / 202 (100%)

Time: 00:00.136, Memory: 30.00 MB

There was 1 failure:

1) SMF\Tests\Unit\SapiTest::testCanonicalPathResolvesDotSegments
Failed asserting that two strings are identical.
--- Expected
+++ Actual
@@ @@
-'/a/c'
+'C:\a\c'

C:\Users\John\repos\SMF2.1\tests\Unit\SapiTest.php:21

FAILURES!
Tests: 202, Assertions: 294, Failures: 1.
Script phpunit --no-coverage handling the test event returned with error code 1

This raises a new question: Shall we test on Windows in CI? Adding it to the build matrix in the gh-action is trivial. I have absolutely no clue on a Docker container.

[jdarwood007]

It should pass. There will need to be some logic on the unit test to determine if we are on windows and if so, correct the path we expect.

[albertlast]

Looked into this. The test is wrong, not Sapi::canonicalPath().

On Windows the separators normalise to \, and a path that starts at the root but names no drive is rooted on the current drive, so getcwd()'s letter gets prepended. C:\a\c is the correct canonical form of \a\c there — realpath() would say the same. The assertion had simply baked in the shape an absolute path has on POSIX.

Three pull requests, since they are separate things:

• [3.0][Testing] Anchor the canonical path test to the root the platform actually uses #9600 fixes the test. It names the root in the path under test, so the result no longer depends on which drive the checkout sits on.
• [3.0][Testing] Run the unit tests on Windows as well as Linux #9601 answers your CI question: os: [ ubuntu-latest, windows-latest ] in the matrix. The suite needs no database, no server and no Docker, so it really is as trivial as you thought — the only wrinkle is that the default shell on a Windows runner is PowerShell, which cannot execute the extensionless Composer proxy, so the step runs composer test instead of vendor/bin/phpunit. It needs [3.0][Testing] Anchor the canonical path test to the root the platform actually uses #9600 first, or the two new jobs are red on exactly this bug. With both applied, all four jobs pass.
• [3.0] Tell agents the unit suite has to pass on Windows #9602 writes the rule into AGENTS.md. An agent verifies its work in the Docker environment, which is Linux, so a POSIX-only path assertion looks correct right through review and only fails once somebody on Windows runs the suite.

Worth noting that the Windows run found nothing else: 168 of the 169 tests were already green there.