vfsstream paths and realpath - php

Question

I'm experimenting with vfsStream for unit testing filesystem interactions and have very quickly run into a major hurdle. One of the validation checks the code under test does is execute realpath() on a supplied input path to test that it's an actual path and not nonsense. However, realpath always fails on a vfsstream path.
The following code demonstrates the problem outside of any particular class.
$content = "It rubs the lotion on its skin or else it gets the hose again";
$url = vfsStream::url ('test/text.txt');
file_put_contents ($url, $content);
var_dump ($url);
var_dump (realpath ($url));
var_dump (file_get_contents ($url));
The output is as follows:
string(27) "vfs://FileClassMap/text.txt"
bool(false)
string(61) "It rubs the lotion on its skin or else it gets the hose again"
Obviously the vfsStream created the file and wrote the given content to it, but I can't verify that the path to it is correct with realpath. As realpath is being used inside the actual code I need a way of working about this.
I really don't think removing realpath is a sensible approach because it performs an important function inside the code, and eliminating an important check just to make the code testable seems a pretty poor solution. I could also put an if around the test to make it possible to disable it for testing purposes, but again I don't think that's a good idea either. Also I'd hate to have to do that at every point in the code where I might make a call to realpath (). The third option would be to set up a RAM disk for filesystem unit tests, but that's not ideal either. You have to clean up after yourself (which is what vfsstream is supposed to help you avoid the need for) and how to actually do it will differ from OS to OS, so the unit tests would cease to be OS agnostic.
So is there a way to get a vfsstream path in a format that actually works with realpath?
For completeness, the following is the code fragment from the class I'm trying to actually test.
if (($fullPath = realpath ($unvalidatedPath))
&& (is_file ($fullPath))
&& (is_writable ($fullPath))) {
A refactoring to the following (as per potential solution 2) allows me to test with vfsStream, but I think it could be problematic in production:
// If we can get a canonical path then do so (realpath can fail on URLs, stream wrappers, etc)
$fullPath = realpath ($unvalidatedPath);
if (false === $fullPath) {
$fullPath = $unvalidatedPath;
}
if ((is_file ($fullPath))
&& (is_writable ($fullPath))) {

Answer 1

If you use namespaces you can override the realpath function only in the test class. I always use canonical paths in my vfsStream testcases, beause i don't want to test the realpath() function itself.
namespace my\namespace;
/**
* Override realpath() in current namespace for testing
*
* #param string $path the file path
*
* #return string
*/
function realpath($path)
{
return $path;
}
Good described here: http://www.schmengler-se.de/en/2011/03/php-mocking-built-in-functions-like-time-in-unit-tests/

Answer 2

I opened a bug with an implementation of Sebkrueger's method on vfsStream: https://github.com/bovigo/vfsStream/issues/207
Waiting for their feedback, here is my working realpath():
/**
* This function overrides the native realpath($url) function, removing
* all the "..", ".", "///" of an url. Contrary to the native one,
*
* #param string $url
* #param string|bool The cleaned url or false if it doesn't exist
*/
function realpath(string $url)
{
preg_match("|^(\w+://)?(/)?(.*)$|", $url, $matches);
$protocol = $matches[1];
$root = $matches[2];
$rest = $matches[3];
$split = preg_split("|/|", $rest);
$cleaned = [];
foreach ($split as $item) {
if ($item === '.' || $item === '') {
// If it's a ./ then it's nothing (just that dir) so don't add/delete anything
} elseif ($item === '..') {
// Remove the last item added since .. negates it.
$removed = array_pop($cleaned);
} else {
$cleaned[] = $item;
}
}
$cleaned = $protocol.$root.implode('/', $cleaned);
return file_exists($cleaned) ? $cleaned : false;
}