7

我正在尝试使用 vfsStream 对文件系统交互进行单元测试,并且很快遇到了一个主要障碍。被测代码所做的验证检查之一是在提供的输入路径上执行 realpath() 以测试它是实际路径而不是废话。但是,realpath 在 vfsstream 路径上总是失败。

以下代码演示了任何特定类之外的问题。

$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));

输出如下:

string(27) "vfs://FileClassMap/text.txt"
bool(false)
string(61) "It rubs the lotion on its skin or else it gets the hose again"

显然 vfsStream 创建了文件并将给定的内容写入其中,但我无法使用 realpath 验证它的路径是否正确。由于在实际代码中使用了 realpath,我需要一种解决此问题的方法。

我真的不认为删除 realpath 是一种明智的方法,因为它在代码中执行了一个重要的功能,并且仅仅为了使代码可测试而消除一个重要的检查似乎是一个非常糟糕的解决方案。我还可以在测试周围放置一个 if 以便可以禁用它以进行测试,但我再次认为这也不是一个好主意。此外,我不想在代码中可能调用 realpath() 的每个点都这样做。第三种选择是为文件系统单元测试设置一个 RAM 磁盘,但这也不理想。您必须自己清理(这是 vfsstream 应该帮助您避免需要的),并且实际执行方式因操作系统而异,因此单元测试将不再与操作系统无关。

那么有没有办法以实际适用于 realpath 的格式获取 vfsstream 路径?

为了完整起见,以下是我正在尝试实际测试的类的代码片段。

if (($fullPath = realpath ($unvalidatedPath))
&& (is_file ($fullPath))
&& (is_writable ($fullPath))) {

对以下内容的重构(根据潜在的解决方案 2)允许我使用 vfsStream 进行测试,但我认为这在生产中可能会出现问题:

// 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))) {
4

2 回答 2

6

如果您使用命名空间,则只能在测试类中覆盖 realpath 函数。我总是在我的 vfsStream 测试用例中使用规范路径,因为我不想测试 realpath() 函数本身。

namespace my\namespace;

/**
 * Override realpath() in current namespace for testing
 *
 * @param string $path     the file path
 *
 * @return string
 */
function realpath($path)
{
    return $path;
}

这里描述得很好:http ://www.schmengler-se.de/en/2011/03/php-mocking-built-in-functions-like-time-in-unit-tests/

于 2014-03-16T21:39:10.947 回答
0

我在 vfsStream 上使用 Sebkrueger 方法的实现打开了一个错误:https ://github.com/bovigo/vfsStream/issues/207

等待他们的反馈,这是我的工作 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;
}
于 2019-12-06T00:55:33.373 回答