如何在 Windows 环境下可靠测试 PHP 目录创建失败场景-php教程-PHP中文网

如何在 Windows 环境下可靠测试 PHP 目录创建失败场景

本文介绍使用 vfsStream 虚拟文件系统在 PHPUnit 中模拟 Windows 下 mkdir() 失败的完整方案，规避真实文件系统权限限制，实现对目录创建异常逻辑（如只读父目录导致创建失败）的精准、可重复、跨平台单元测试。

本文介绍使用 vfsstream 虚拟文件系统在 phpunit 中模拟 windows 下 `mkdir()` 失败的完整方案，规避真实文件系统权限限制，实现对目录创建异常逻辑（如只读父目录导致创建失败）的精准、可重复、跨平台单元测试。

在 Windows 平台上对文件系统操作进行单元测试尤为棘手——不同于 Linux 可通过 chmod 精细控制目录权限，Windows 的 ACL 机制难以在测试中稳定复现 mkdir($path, $mode, true) 返回 false 的场景。直接操作真实磁盘不仅破坏测试隔离性，还易受环境权限、路径占用、防病毒软件干扰，导致测试不可靠或无法运行。

推荐的工业级解决方案是采用 bovigo/vfsStream ——一个纯内存实现的虚拟文件系统流封装库。它完全绕过操作系统底层，允许你在测试中自由定义目录结构、权限、存在性与可写性，并让 PHP 的标准文件函数（包括 is_dir() 和 mkdir()）无缝与其交互。

✅ 正确实践步骤

安装依赖
```
composer require --dev bovigo/vfsstream
```

编写可测试代码（保持原逻辑）

btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理：站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载

private function createCacheDir(string $cacheDir): void
{
    if (!is_dir($cacheDir)) {
        if (!mkdir($cacheDir, 0755, true)) {
            throw new \RuntimeException(sprintf('Dir %s cannot be created.', $cacheDir));
        }
    }
}

PHPUnit 测试用例（关键：模拟只读父目录）

use org\bovigo\vfs\vfsStream;

class CacheServiceTest extends TestCase
{
    private $baseCacheDir;

    protected function setUp(): void
    {
        // 初始化虚拟根目录
        $this->baseCacheDir = vfsStream::setup('baseCacheDir');
    }

    public function testCreateCacheDirThrowsOnNonWritableParent(): void
    {
        // 1. 获取虚拟根目录 URL（如 'vfs://baseCacheDir'）
        $baseUrl = vfsStream::url('baseCacheDir');
        // 2. 将根设为只读（0444 = 只读，无写/执行权限）
        $this->baseCacheDir->chmod(0444);
        // 3. 构造目标缓存路径（子目录）
        $cacheDir = $baseUrl . '/cacheDir';

        // 4. 断言异常：mkdir 将因父目录不可写而失败
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionMessage('Dir ' . $cacheDir . ' cannot be created.');

        // 5. 调用被测方法（需确保其内部调用的是 vfsStream 路径）
        $service = $this->getObjectUnderTest($cacheDir); // 替换为你的构造逻辑
        // 假设该对象在构造时或方法中调用了 createCacheDir($cacheDir)
    }
}

⚠️ 注意事项与最佳实践

路径必须使用 vfsStream::url()：mkdir() 仅识别 vfs:// 协议路径；传入本地绝对路径（如 C:\temp）将绕过虚拟文件系统，导致测试失效。
权限设置时机很重要：chmod() 必须在 mkdir() 调用前执行，且作用于父目录（如 baseCacheDir），因为 mkdir($cacheDir, 0755, true) 需要父目录具备写权限才能创建子目录。
避免 true 递归陷阱：vfsStream 支持 mkdir(..., ..., true)，但若父目录不可写，递归创建会立即失败——这正是我们期望的行为。
不依赖 Windows 特有行为：该方案在 Linux/macOS 下同样有效，真正实现跨平台可测试性。
清理无需手动干预：vfsStream 完全运行于内存，测试结束后自动释放，无残留风险。