Repository navigation
Fix test runner failure on PHP tutorials #630
Description
Describe the bug
Getting a Test Runner Failed message on a PHP project.
To Reproduce
Requires PHP 8.2+ and Composer.
Steps to reproduce the behavior:
- Open an empty folder in VS Code
mkdir empty-project1 code empty-project1 - Run CodeRoad: Start from the Command Pallete.
- Hit Start New Tutorial
- Choose URL, and supply https://raw.githubusercontent.com/jcandan/learn-php-basics/refs/heads/main/tutorial.json
- Open terminal, and in this empty project folder, run
git init. - Hit Start on the tutorial
- Supply an empty
index.htmlfile, and hit Run
See the Test Runner Failed message.
Expected behavior
To see that the solution should have passed:
- Clone the https://github.com/jcandan/learn-php-basics project locally
- Checkout the v0.1.0 branch, you'll be on the 1.1S solution commit
- Run
cd .stack-elevate/ && composer install && ./vendor/bin/phpunitto prove the test runner should have worked
The TAP output shows that the test does pass.
Desktop (please complete the following information):
- Platfrom: MacBook Pro
- OS: macOS Sequoia
- Version 15.3
Node:
- Version v20.16.0
Git:
- Version 2.40.0
PHP:
- Version 8.4.3
Composer:
- Version 2.8.5
PHPUnit:
- Version 11.5.6
- nikeee/phpunit-tap TAP Package required by INIT commit
- The
phpunit.xmlconfiguration ensures the the TAP output - The
config.testRunner.args.taprequired configuration is blank since it is handled by the XML configuration.
Activity
jcandan commentedon Feb 9, 2025
The nikeee/phpunit-tap outputs TAP compliant reporting. However, it currently does include PHPUnit output as well. I suspect this may be causing the test runner to fail.
According to nikeee/phpunit-tap/issues/31,
In that case, the consumer in CodeRoad VS Code extension should be able to parse the combined PHPUnit and TAP compliant output.
However, I have responded to that claim to say that the TAP output stream should be entirely valid TAP. Awaiting his response.
But, in the interrim, we might want to at least confirm via debugging that this is the reason for the test runner failure.
jcandan commentedon Feb 10, 2025
Okay, nikeee/phpunit-tap#31 (comment) makes a fairly good case that TAP should be able to deal with other output. So, if we do find this to be the cause of the failure, perhaps the TAP handling should be updated to deal with that.
jcandan commentedon Feb 10, 2025
I've updated the example https://github.com/jcandan/learn-php-basics project with a patch from nikeee/phpunit-tap#32 to ensure the first line of the TAP output is on a new line. So, we definitely should be able to run the test without failure.
Also, I noticed that the Run click returns the Test Runner Failed message fairly quickly. So, I don't think it is even getting to the point of reading the TAP output anyway.
Would really appreciate eyes on this one. Thanks!