laravel - 在功能测试中模拟类实例化
问题描述
我目前正在处理我的第一个 Laravel 项目——一个服务端点,它根据保存在 S3 中的记录返回资源。该服务不需要数据库,但我的想法是,我可以通过将逻辑移动到“模型”来保持控制器的瘦身。然后我可以通过模仿一些标准的活动记录调用来访问资源。
从功能上讲,实现按预期工作,但我遇到了模拟问题。
我正在使用库来创建签名的 CloudFront URL,但它是作为静态方法访问的。当我第一次开始编写我的功能测试时,我发现我无法对静态方法进行存根。我用Mockery尝试了类别名,但没有运气——我仍然在使用静态方法。因此,我尝试将静态方法包装在一个小类中,假设模拟该类会更容易。不幸的是,我遇到了同样的问题。我试图嘲笑的东西被击中,就好像我不是在嘲笑它一样。
这个堆栈溢出帖子给出了一个如何使用类别名的例子,但我无法让它工作。 Mockery 中的重载和别名有什么区别?
我究竟做错了什么?我更愿意让嘲弄别名工作,但实例模拟会很好。请指出我正确的方向。预先感谢您的帮助。
控制器
// app/Http/Controllers/API/V1/RecordingController.php
class RecordingController extends Controller {
public function show($id){
return json_encode(Recording::findOrFail($id));
}
}
模型
// app/Models/Recording.php
namespace App\Models;
use Mockery;
use Carbon\Carbon;
use CloudFrontUrlSigner;
use Storage;
use Illuminate\Support\Arr;
class Recording
{
public $id;
public $url;
private function __construct($array)
{
$this->id = $array['id'];
$this->url = $this->signedURL($array['filename']);
}
// imitates the behavior of the findOrFail function
public static function findOrFail($id): Recording
{
$filename = self::filenameFromId($id);
if (!Storage::disk('s3')->exists($filename)) {
abort(404, "Recording not found with id $id");
}
$array = [
'id' => $id,
'filename' => $filename,
];
return new self($array);
}
// imitate the behavior of the find function
public static function find($id): ?Recording
{
$filename = self::filenameFromId($id);
if (!Storage::disk('s3')->exists($filename)){
return null;
}
$array = [
'id' => $id,
'filename' => $filename,
];
return new self($array);
}
protected function signedURL($key) : string
{
$url = Storage::url($key);
$signedUrl = new cloudFrontSignedURL($url);
return $signedUrl->getUrl($url);
}
}
/**
* wrapper for static method for testing purposes
*/
class cloudFrontSignedURL {
protected $url;
public function __construct($url) {
$this->url = CloudFrontUrlSigner::sign($url);
}
public function getUrl($url) {
return $this->url;
}
}
测试
// tests/Feature/RecordingsTest.php
namespace Tests\Feature;
use Mockery;
use Faker;
use Tests\TestCase;
use Illuminate\Http\File;
use Illuminate\Support\Facades\Storage;
use Illuminate\Foundation\Testing\WithFaker;
/* The following is what my test looked like when I wrapped CloudFrontUrlSigner
* in a class and attempted to mock the class
*/
class RecordingsTest extends TestCase
{
/** @test */
public function if_a_recording_exists_with_provided_id_it_will_return_a_URL()
{
$recordingMock = \Mockery::mock(Recording::class);
$faker = Faker\Factory::create();
$id = $faker->numberBetween($min = 1000, $max = 9999);
$filename = "$id.mp3";
$path = '/api/v1/recordings/';
$returnValue = 'abc.1234.com';
$urlMock
->shouldReceive('getURL')
->once()
->andReturn($returnValue);
$this->app->instance(Recording::class, $urlMock);
Storage::fake('s3');
Storage::disk('s3')->put($filename, 'this is an mp3');
Storage::disk('s3')->exists($filename);
$response = $this->call('GET', "$path$id");
$response->assertStatus(200);
}
}
// The following is what my test looked like when I was trying to alias CloudFrontUrlSigner
{
/** @test */
public function if_a_recording_exists_with_provided_id_it_will_return_a_URL1()
{
$urlMock = \Mockery::mock('alias:Dreamonkey\cloudFrontSignedURL');
$faker = Faker\Factory::create();
$id = $faker->numberBetween($min = 1000, $max = 9999);
$filename = "$id.mp3";
$path = '/api/v1/recordings/';
$returnValue = 'abc.1234.com';
$urlMock
->shouldReceive('sign')
->once()
->andReturn($returnValue);
$this->app->instance('Dreamonkey\cloudFrontSignedURL', $urlMock);
Storage::fake('s3');
Storage::disk('s3')->put($filename, 'this is an mp3');
Storage::disk('s3')->exists($filename);
$response = $this->call('GET', "$path$id");
$response->assertStatus(200);
}
}
phpunit
$ phpunit tests/Feature/RecordingsTest.php --verbose
...
There was 1 failure:
1) Tests\Feature\RecordingsTest::if_a_recording_exists_with_provided_id_it_will_return_a_URL
Expected status code 200 but received 500.
Failed asserting that false is true.
/Users/stevereilly/Projects/media-service/vendor/laravel/framework/src/Illuminate/Foundation/Testing/TestResponse.php:133
/Users/stevereilly/Projects/media-service/tests/Feature/RecordingsTest.php:85
/Users/stevereilly/.composer/vendor/phpunit/phpunit/src/TextUI/Command.php:206
/Users/stevereilly/.composer/vendor/phpunit/phpunit/src/TextUI/Command.php:162
解决方案
你得到一个 500,这意味着代码有问题。只是通过扫描它,我注意到你在类上缺少一个filenameFromId
方法Recordings
,并且测试正在创建一个名为 的模拟$recordingMock
,但你尝试使用$urlMock
. 尝试先解决这些问题。
然后你在嘲笑这个类,但你从来没有在你的应用程序中替换它(你显然是在旧测试中做到的)。
一般来说,你在模拟时要遵循以下步骤:
1. 模拟一个类
2. 告诉 Laravel 在有人请求时用你的模拟替换该类
3. 对模拟做一些断言
推荐阅读
- tensorflow - 运行 tensorflow-gpu 设备时几乎没有可用的 1080 ti 内存分配
- matlab - Matlab如何切换多维图像尺寸
- c++ - 在 linux 中,如何在 bash 或 c 或 c++ 中观察窗口创建事件
- python - csv.DictReader 错误“_csv.Error:行包含 NULL 字节”
- vb.net - VB.NET 多线程
- mysql - 如何使用来自另一个数据库的数据来选择数据?
- powershell - 用于设置 ms 访问的属性 PriorityClass 的 powershell 脚本
- batch-file - 如何使用命令提示符添加一行文本并保存?
- monaco-editor - Monaco Editor 中的类型检查
- java - 在 sqlite 文件夹中找不到 sqlite 数据库