测试 Laravel 存储中的临时 URL

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

Laravel 提供了一个强大且灵活的 Storage facade 用于文件存储和操作。一个值得注意的功能是 temporaryUrl()，它可以为存储在 Amazon S3 或 DigitalOcean Spaces 等服务上的文件生成临时 URL。但是，Laravel 的文档没有涵盖如何有效地测试此方法。测试它可能会带来挑战，尤其是在使用 Storage::fake 时，因为模拟存储驱动程序不支持 temporaryUrl() 并会抛出以下错误：

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

在本文中，我们将通过一个实际示例演示两种测试 Storage::temporaryUrl() 的方法。这些方法包括模拟文件系统和使用模拟存储。两种方法都能确保您的测试保持隔离和可靠。

示例设置

我们将使用 PriceExport 模型、相应的控制器和测试用例来说明测试过程。以下是设置：

模型

<code class="language-php">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);
    }
}</code>

控制器

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

<code class="language-php">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);
        $diskS3 = Storage::disk(StorageDiskName::DO_S3->value);

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

        $downloadFileDTO = new DownloadFileDTO($url, $fileName);

        return DownloadFileResource::make($downloadFileDTO);
    }
}</code>

测试 temporaryUrl()

测试用例 1：使用 Storage::fake

虽然 Storage::fake 本身不支持 temporaryUrl，但我们可以模拟模拟存储来模拟该方法的行为。这种方法确保您可以在无需真实存储服务的情况下进行测试。

<code class="language-php">final class PriceExportTest extends TestCase
{
    public function test_price_export_download_fake(): void
    {
        // 安排
        $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);

        // 模拟模拟文件系统
        $proxyMockedFakeFilesystem = Mockery::mock($fakeFilesystem);
        $proxyMockedFakeFilesystem->shouldReceive('temporaryUrl')->andReturn($expectedUrl);
        Storage::set(StorageDiskName::DO_S3->value, $proxyMockedFakeFilesystem);

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

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

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

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

<code class="language-php">final class PriceExportTest extends TestCase
{
    public function test_price_export_download_mock(): void
    {
        // 安排
        $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')->andReturn($expectedUrl);

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

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

---

关键要点

1. Storage::fake 的限制: 模拟存储驱动程序不支持 temporaryUrl。使用模拟存储的模拟版本来解决此问题。
2. 模拟存储: Laravel 的 Storage::shouldReceive 简化了在测试控制器时模拟 temporaryUrl 等方法的过程。
3. 隔离: 这两种方法都能确保您的测试不依赖于外部服务，从而保持测试快速且可靠。

通过结合这些技术，您可以有效地测试 Storage::temporaryUrl() 并确保您的应用程序功能得到充分验证。

以上是测试 Laravel 存储中的临时 URL的详细内容。更多信息请关注PHP中文网其他相关文章！