cleaning filename returned wrongly due to an XDebug bug

[victorgp]

XDebug has a bug which is causing the missing of some files in the php-code-coverage.

When there is an assert or an eval, XDebug returns a wrong file name, something like:

/path/path/path/myClass.php(444) : assert code

They have an open bug since 2007 so it seems that is very low priority for them and they don't have intentions to fix it:

http://bugs.xdebug.org/bug_view_page.php?bug_id=0000331

With the current approach of this coverage tool, if it's not a valid file (checked with $this->filter->isFile($file)), is not included in the coverage report and these files wrongly returned by XDebug, therefore, are missing. So this can be considered a bug.

This change just sanitize the file name returned by XDebug in order to consider them as valid so can be added to the coverage report.

I suppose the $this->filter->isFile($file) won't be necessary but i prefer to let you take the decision of its removal because maybe you prefer to keep it for other cases.

[ruflin]

I have at the moment a similar / same bug with the following line of code:

runkit_function_redefine('time', '', 'return TH::time();');

This throws the following error.

[exec] Generating code coverage report, this may take a moment.ErrorException (0): file_get_contents(../tests/Test.php(65) : runkit created function): failed to open stream: No such file or directory
Thrown in: /usr/share/php/PHP/CodeCoverage/Report/HTML/Renderer/File.php on line 475

[victorgp]

Yes, it's the same problem, my patch should also fix it

[ruflin]

Good to know. I have my own little fix implemented (similar to yours) and it works, but I have to apply it to every installation I make. Did you get any feedback from sebastian?

[victorgp]

No, i'm still waiting... i've applied the patch to all my installations, luckily it's controlled by puppet, so i didn't have major issues with that.

[sebastianbergmann]

That only works for filenames that end in .php.

[victorgp]

That's the intention. Anyway, if you are use to ending the PHP files with another extension, can be added, or even not filtering by any extension.

[sebastianbergmann]

The code should make no assumption on the suffix.

[ruflin]

The fix that I implemented checks in PHP_CodeCoverage_Report_HTML_Renderer_File::loadFile if the file exist, otherwise it returns ''. But this is not at all the nicest fix, especially because Code Coverage has to "fix" a XDebug issue.

[fabriceb]

Hi all,

I propose another fix for this bug here: #89

I tried to improve the current solution in two ways:

• the regexp assumed that PHP files end with ".php", which is quite a strong assumption
• since this code is to bypass an Xdebug bug, it seemed much better to put it in the Xdebug.php driver

[ruflin]

I quite like your approach. Especially because the bug is fixed in the XDebug driver and not the "core" code.