测试 Laravel 存储中的临时 URL

如何测试 Laravel 的 Storage::temporaryUrl() 方法

Laravel 提供了强大的文件存储和操作功能。temporaryUrl() 方法可以为存储在 Amazon S3 或 DigitalOcean Spaces 等云存储服务上的文件生成临时 URL。然而，Laravel 的文档并没有详细说明如何有效地测试此方法。尤其是在使用 Storage::fake() 时，测试会比较棘手，因为模拟存储驱动程序不支持 temporaryUrl()，并会抛出错误：

此驱动程序不支持创建临时 URL。

本文将通过实际示例演示两种测试 Storage::temporaryUrl() 的方法：模拟文件系统和使用模拟存储。这两种方法都能确保测试的隔离性和可靠性。

示例设置

我们将使用 PriceExport 模型、对应的控制器和测试用例来说明测试过程。

模型

final class PriceExport extends Model
{
    protected $fillable = [
        'user_id',
        'supplier_id',
        'path',
        'is_auto',
        'is_ready',
        'is_send',
    ];

    public function user(): BelongsTo
    {
        return $this->belongsTo(User::class);
    }

    public function supplier(): BelongsTo
    {
        return $this->belongsTo(Supplier::class);
    }
}

控制器

控制器使用 temporaryUrl() 方法为文件生成临时 URL：

SecLists

SecLists是最终安全测试人员的伙伴。它是一个包含各种类型列表的集合，这些列表在安全评估过程中经常使用，都在一个地方。SecLists通过方便地提供安全测试人员可能需要的所有列表，帮助提高安全测试的效率和生产力。列表类型包括用户名、密码、URL、模糊测试有效载荷、敏感数据模式、Web shell等等。测试人员只需将此存储库拉到新的测试机上，他就可以访问到所需的每种类型的列表。

下载

final class PriceExportController extends Controller
{
    /**
     * @throws ItemNotFoundException
     */
    public function download(PriceExport $priceExport): DownloadFileResource
    {
        if (!$priceExport->is_ready || empty($priceExport->path)) {
            throw new ItemNotFoundException('price export');
        }

        $filename = basename($priceExport->path);
        $disk = Storage::disk(StorageDiskName::DO_S3->value);

        $url = $disk->temporaryUrl($priceExport->path, Carbon::now()->addHour());

        $downloadFileDto = new DownloadFileDto($url, $filename);

        return DownloadFileResource::make($downloadFileDto);
    }
}

测试 temporaryUrl()

测试用例 1：模拟 Storage::fake()

尽管 Storage::fake() 本身不支持 temporaryUrl()，但我们可以模拟假存储来模拟此方法的行为。这样，测试无需依赖实际的存储服务。

final class PriceExportTest extends TestCase
{
    public function test_price_export_download_fake(): void
    {
        // Arrange
        $user = $this->getDefaultUser();
        $this->actingAsFrontendUser($user);

        $supplier = SupplierFactory::new()->create();
        $priceExport = PriceExportFactory::new()->for($user)->for($supplier)->create([
            'path' => 'price-export/price-2025.xlsx',
        ]);

        $expectedUrl = 'https://temporary-url.com/supplier-price-export-2025.xlsx';
        $expectedFileName = basename($priceExport->path);

        $fakeFilesystem = Storage::fake(StorageDiskName::DO_S3->value);

        // 模拟假文件系统
        $mockedFakeFilesystem = Mockery::mock($fakeFilesystem);
        $mockedFakeFilesystem->shouldReceive('temporaryUrl')->andReturn($expectedUrl);
        Storage::shouldReceive('disk')->with(StorageDiskName::DO_S3->value)->andReturn($mockedFakeFilesystem);


        // Act
        $response = $this->postJson(route('api-v2:price-export.price-exports.download', $priceExport));

        // Assert
        $response->assertOk()->assertJson([
            'data' => [
                'name' => $expectedFileName,
                'url' => $expectedUrl,
            ]
        ]);
    }
}

测试用例 2：使用 Storage::shouldReceive()

此方法利用 Laravel 内置的模拟功能直接模拟 temporaryUrl() 的行为。

final class PriceExportTest extends TestCase
{
    public function test_price_export_download_mock(): void
    {
        // Arrange
        $user = $this->getDefaultUser();
        $this->actingAsFrontendUser($user);

        $supplier = SupplierFactory::new()->create();
        $priceExport = PriceExportFactory::new()->for($user)->for($supplier)->create([
            'path' => 'price-export/price-2025.xlsx',
        ]);

        $expectedUrl = 'https://temporary-url.com/supplier-price-export-2025.xlsx';
        $expectedFileName = basename($priceExport->path);

        // 模拟存储行为
        Storage::shouldReceive('disk')->with(StorageDiskName::DO_S3->value)->andReturnSelf();
        Storage::shouldReceive('temporaryUrl')->with($priceExport->path, Carbon::now()->addHour())->andReturn($expectedUrl);

        // Act
        $response = $this->postJson(route('api-v2:price-export.price-exports.download', $priceExport));

        // Assert
        $response->assertOk()->assertJson([
            'data' => [
                'name' => $expectedFileName,
                'url' => $expectedUrl,
            ]
        ]);
    }
}

关键点

1. Storage::fake() 的限制: 模拟存储驱动程序不支持 temporaryUrl()。需要模拟其行为。
2. 模拟存储: Laravel 的 Storage::shouldReceive() 简化了对控制器方法（如 temporaryUrl()）的模拟。
3. 隔离性: 这两种方法都确保测试不依赖外部服务，从而保持测试的快速和可靠。

通过结合这些技术，您可以有效地测试 Storage::temporaryUrl() 并确保应用程序功能的完整性。