Laravel Artisan命令测试：如何借助vfsStream模拟文件系统？

我之前在做类似的CLI工具测试时，刚好研究过vfsStream和Laravel Artisan的结合用法，给你梳理下可行的方案：

1. 先搞定依赖安装 #

首先确保你的项目里已经安装了必要的包：

composer require --dev mikey179/vfsstream phpunit/phpunit laravel/framework

（注：如果你的CLI工具已经依赖Laravel，那laravel/framework可能已经在主依赖里了，只需要装dev环境的测试包）

2. 用vfsStream搭建模拟的Laravel项目结构 #

在测试的setUp方法里，先创建一个vfs的根目录，然后模拟出Laravel项目必需的目录结构——毕竟Artisan命令需要识别Laravel的项目结构才能正确生成文件。

示例代码：

use org\bovigo\vfs\vfsStream;
use org\bovigo\vfs\vfsStreamDirectory;

protected vfsStreamDirectory $root;

protected function setUp(): void
{
    parent::setUp();

    // 创建vfs根目录，命名为模拟的Laravel项目
    $this->root = vfsStream::setup('laravel-package-dev');

    // 模拟Laravel核心目录及必要文件
    vfsStream::create([
        'app' => [
            'Http' => [
                'Controllers' => []
            ],
            'Models' => []
        ],
        'config' => [
            'app.php' => '<?php return ["name" => "TestApp"];'
        ],
        'routes' => [
            'web.php' => ''
        ],
        'artisan' => '#!/usr/bin/env php' . PHP_EOL . '<?php require __DIR__."/vendor/autoload.php";'
    ], $this->root);
}

3. 初始化Laravel应用并绑定vfs路径 #

接下来要让Laravel的应用实例使用vfs里的路径，而不是真实的文件系统。你可以在创建Application实例时直接指定vfs的根目录作为项目基准路径。

示例：

use Illuminate\Foundation\Application;
use Illuminate\Contracts\Console\Kernel;

protected Application $app;

protected function setUp(): void
{
    // ... 上面的vfs初始化代码

    // 创建Laravel应用实例，将vfs根目录设为项目根路径
    $this->app = new Application($this->root->url());

    // 初始化Artisan控制台内核，确保命令能被调用
    $this->app->make(Kernel::class);

    // 可选：手动加载配置文件，避免部分命令因找不到配置报错
    $this->app->instance('config', require $this->root->url() . '/config/app.php');
}

4. 执行Artisan命令并验证结果 #

现在你可以直接调用Artisan命令，然后用vfsStream的API检查文件是否生成、内容是否符合预期。

比如测试make:model命令：

public function test_make_model_command_creates_file_in_vfs()
{
    // 执行Artisan make命令
    $this->app->make(Kernel::class)->call('make:model', [
        'name' => 'Post'
    ]);

    // 检查vfs中是否生成了目标文件
    $modelPath = $this->root->url() . '/app/Models/Post.php';
    $this->assertFileExists($modelPath);

    // 验证文件内容是否正确
    $modelContent = file_get_contents($modelPath);
    $this->assertStringContainsString('class Post extends Model', $modelContent);
    $this->assertStringContainsString('use Illuminate\Database\Eloquent\Model;', $modelContent);
}

一些需要注意的细节 #

• 命令依赖的资源：有些Artisan命令（比如make:migration）需要数据库配置，你可以在vfs的config/database.php里添加一个空的配置数组，避免报错。
• 自动加载问题：如果你的CLI工具是独立的，可能需要手动把vfs路径添加到Composer的自动加载器中，确保生成的类能被正确识别。
• 权限模拟：vfsStream默认会模拟文件权限，如果遇到权限相关的报错，可以在创建目录/文件时指定权限，比如'app' => ['mode' => 0755, ...]。

内容的提问来源于stack exchange，提问作者Zamerick