Fix: Run commands through PHP binary to ensure they are run on Windows #4335

localheinz · 2020-06-28T09:53:44Z

This PR

explicitly runs commands through PHP binary to ensure they are run on windows-latest
configures git to avoid issues with line endings when running tests on windows-latest
adds slashes
skips a test related to file permissions on Windows

codecov · 2020-06-28T11:18:10Z

Codecov Report

Merging #4335 into 8.5 will increase coverage by 0.43%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##                8.5    #4335      +/-   ##
============================================
+ Coverage     84.20%   84.63%   +0.43%     
  Complexity     3936     3936              
============================================
  Files           154      154              
  Lines          9785    10390     +605     
============================================
+ Hits           8239     8794     +555     
- Misses         1546     1596      +50

Impacted Files	Coverage Δ	Complexity Δ
src/Framework/SkippedTestCase.php	`90.90% <0.00%> (-9.10%)`	`4.00% <0.00%> (ø%)`
src/Framework/IncompleteTestCase.php	`90.90% <0.00%> (-9.10%)`	`4.00% <0.00%> (ø%)`
src/Runner/NullTestResultCache.php	`66.66% <0.00%> (-8.34%)`	`6.00% <0.00%> (ø%)`
src/Framework/MockObject/Stub/ReturnArgument.php	`66.66% <0.00%> (-4.77%)`	`4.00% <0.00%> (ø%)`
src/Framework/Constraint/JsonMatches.php	`96.77% <0.00%> (-3.23%)`	`9.00% <0.00%> (ø%)`
src/Framework/Constraint/IsType.php	`97.87% <0.00%> (-2.13%)`	`23.00% <0.00%> (ø%)`
src/Util/TestDox/ResultPrinter.php	`57.14% <0.00%> (-1.48%)`	`39.00% <0.00%> (ø%)`
...ramework/MockObject/Rule/ConsecutiveParameters.php	`80.95% <0.00%> (-0.63%)`	`14.00% <0.00%> (ø%)`
src/Framework/MockObject/InvocationHandler.php	`76.92% <0.00%> (-0.13%)`	`26.00% <0.00%> (ø%)`
src/Framework/TestResult.php	`71.52% <0.00%> (-0.05%)`	`173.00% <0.00%> (ø%)`
... and 109 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 82a15e6...b162354. Read the comment docs.

localheinz · 2020-06-28T11:19:00Z

.github/workflows/ci.yml

@@ -141,17 +141,17 @@ jobs:

      - name: Install lowest dependencies with composer
        if: matrix.dependencies == 'lowest'
-        run: ./tools/composer update --no-ansi --no-interaction --no-progress --prefer-lowest
+        run: php ./tools/composer update --no-ansi --no-interaction --no-progress --prefer-lowest


@shivammathur

Do you have an idea why it would be necessary to specify the php binary here for running these commands on windows-latest?

Without it, they are not run, see #4333.

@localheinz
#!/usr/bin/env php does not work on Windows, so you will have to call local phar tools with php.

When tools are installed using setup-php on Windows, it creates a batch script to call the tools with php.

Thank you, @shivammathur!

localheinz · 2020-06-28T12:08:41Z

@sebastianbergmann

Tests are running on windows-latest now, but a bunch of them are failing.

Looks like most of them are related to line-endings.

dvdoug · 2020-06-28T17:04:39Z

Tests are running on windows-latest now, but a bunch of them are failing.

Looks like most of them are related to line-endings.

Most of the failures I think will go away if the checkout uses LF, rather than CRLF. Try the workaround on actions/checkout#38 or forcing LF via .gitattributes.

localheinz · 2020-06-28T17:15:29Z

Thank you, @dvdoug - that helped! 👍

localheinz · 2020-06-29T06:00:08Z

Does anyone have an idea how to fix the remaining test failures?

I haven't used Windows in the last 10 years.

shivammathur · 2020-06-29T06:35:11Z

@localheinz To fix XDebugFilterScriptGeneratorTest

phpunit/tests/unit/Util/XDebugFilterScriptGeneratorTest.php

Line 31 in 081dcb4

$expectedDirectory = __DIR__ . DIRECTORY_SEPARATOR;

- $expectedDirectory = __DIR__ . DIRECTORY_SEPARATOR; 
+ $expectedDirectory = addslashes(__DIR__ . DIRECTORY_SEPARATOR);

to match

phpunit/src/Util/XdebugFilterScriptGenerator.php

Line 68 in 081dcb4

addslashes('%s' . DIRECTORY_SEPARATOR),

Related issue - #3834

localheinz · 2020-06-29T07:05:00Z

@shivammathur

I applied a fix with 77d7158, but I think it did not help.

shivammathur · 2020-06-29T07:12:44Z

@localheinz Try this, I missed sprintf

phpunit/src/Util/XdebugFilterScriptGenerator.php

Lines 67 to 70 in 081dcb4

    
           $files[] = sprintf( 
        
               addslashes('%s' . DIRECTORY_SEPARATOR), 
        
               $path 
        
           );

- $expectedDirectory = __DIR__ . DIRECTORY_SEPARATOR; 
+ $expectedDirectory = sprintf(addslashes('%s' . DIRECTORY_SEPARATOR), __DIR__);

dvdoug · 2020-06-29T12:25:17Z

On Windows, chmod() can set the read only flag but that's about it, the filesystem is simply too different in the way it works.

Thus unless you want to try and use shell scripting to set up ACLs, I'd suggest simply skipping PHPUnit\Framework\AssertTest::testAssertFileIsNotReadable on Windows.

dvdoug · 2020-06-29T12:38:02Z

The last failing test tests columns=max which is an implicitly variable number, but has a hard-coded result? I don't think that's a safe expectation as this is now showing.

tests/end-to-end/cli/columns-max.phpt

localheinz · 2020-06-29T13:22:06Z

Thank you, @dvdoug, @sebastianbergmann, and @shivammathur!

localheinz self-assigned this Jun 28, 2020

localheinz force-pushed the fix/windows branch 3 times, most recently from 45ac914 to 2c85b6b Compare June 28, 2020 11:16

localheinz changed the title ~~Fix: Run phpunit in debug mode~~ Fix: Run commands through PHP binary to ensure they are run on Windows Jun 28, 2020

localheinz commented Jun 28, 2020

View reviewed changes

localheinz force-pushed the fix/windows branch from 2c85b6b to 1e0d2f6 Compare June 28, 2020 11:19

localheinz marked this pull request as ready for review June 28, 2020 12:07

localheinz marked this pull request as draft June 28, 2020 12:08

localheinz force-pushed the fix/windows branch from c764be5 to 87e3bdb Compare June 28, 2020 17:08

localheinz force-pushed the fix/windows branch from 87e3bdb to d8310a5 Compare June 29, 2020 05:51

localheinz marked this pull request as ready for review June 29, 2020 05:51

localheinz force-pushed the fix/windows branch 3 times, most recently from b2ef482 to 6f90153 Compare June 29, 2020 07:01

localheinz force-pushed the fix/windows branch from 77d7158 to 83a3886 Compare June 29, 2020 07:20

localheinz force-pushed the fix/windows branch 2 times, most recently from fac581f to f49b4d1 Compare June 29, 2020 12:43

localheinz commented Jun 29, 2020

View reviewed changes

tests/end-to-end/cli/columns-max.phpt Outdated Show resolved Hide resolved

localheinz force-pushed the fix/windows branch from f49b4d1 to 6fa45a3 Compare June 29, 2020 12:49

localheinz and others added 4 commits June 29, 2020 14:51

Fix: Explicitly run commands through PHP binary

98630bf

Fix: Configure git to avoid issues with line endings

3b3df6c

Fix: Add slashes

874639b

Fix: Skip test on Windows

b162354

localheinz force-pushed the fix/windows branch from 81f1544 to b162354 Compare June 29, 2020 12:51

localheinz requested a review from sebastianbergmann June 29, 2020 12:55

sebastianbergmann merged commit 37d02f0 into sebastianbergmann:8.5 Jun 29, 2020

localheinz deleted the fix/windows branch June 29, 2020 13:21

localheinz mentioned this pull request Jun 29, 2020

Fix: Make tests failing on Windows portable or skip them #4343

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Run commands through PHP binary to ensure they are run on Windows #4335

Fix: Run commands through PHP binary to ensure they are run on Windows #4335

localheinz commented Jun 28, 2020 •

edited

codecov bot commented Jun 28, 2020 •

edited

localheinz Jun 28, 2020

shivammathur Jun 28, 2020 •

edited

localheinz Jun 28, 2020

localheinz commented Jun 28, 2020 •

edited

dvdoug commented Jun 28, 2020

localheinz commented Jun 28, 2020

localheinz commented Jun 29, 2020

shivammathur commented Jun 29, 2020

localheinz commented Jun 29, 2020 •

edited

shivammathur commented Jun 29, 2020 •

edited

dvdoug commented Jun 29, 2020

dvdoug commented Jun 29, 2020

localheinz commented Jun 29, 2020

Fix: Run commands through PHP binary to ensure they are run on Windows #4335

Fix: Run commands through PHP binary to ensure they are run on Windows #4335

Conversation

localheinz commented Jun 28, 2020 • edited

codecov bot commented Jun 28, 2020 • edited

Codecov Report

localheinz Jun 28, 2020

Choose a reason for hiding this comment

shivammathur Jun 28, 2020 • edited

Choose a reason for hiding this comment

localheinz Jun 28, 2020

Choose a reason for hiding this comment

localheinz commented Jun 28, 2020 • edited

dvdoug commented Jun 28, 2020

localheinz commented Jun 28, 2020

localheinz commented Jun 29, 2020

shivammathur commented Jun 29, 2020

localheinz commented Jun 29, 2020 • edited

shivammathur commented Jun 29, 2020 • edited

dvdoug commented Jun 29, 2020

dvdoug commented Jun 29, 2020

localheinz commented Jun 29, 2020

localheinz commented Jun 28, 2020 •

edited

codecov bot commented Jun 28, 2020 •

edited

shivammathur Jun 28, 2020 •

edited

localheinz commented Jun 28, 2020 •

edited

localheinz commented Jun 29, 2020 •

edited

shivammathur commented Jun 29, 2020 •

edited