【技术博客】关于laravel5.1中文件上传测试的若干尝试

2024-02-19 23:21:40

关于laravel5.1中文件上传测试的若干尝试

作者：ZGJ

版本：v1.0

PM注：本人这两天也正在尝试解决这一问题，如有进展将及时更新这一博客

在我们的软工第二阶段中，我开始着手进行后端控制器的单元测试，然而一个阶段下来，其中的一个涉及文件上传的控制器方法始终没能覆盖完全，这里总结我在此测试上进行的若干尝试（均未获得成功），先附上被测试控制器方法代码：

public function uploadPreparePdf()
{
 $exists = Auth::check() && ((Console::where('email', '=', Auth::user()->email)->get()->count()) > 0);
 $isAdmin = $exists;
 if (!$isAdmin) {
     return redirect('/index');
 }
 $data = ["status"=>"","message"=>""];

 if (Request::hasFile('prepare-pdf'))
 {
     $pdfFile = Request::file('prepare-pdf');
     $labID = $_POST['labID'];
     if (preg_match('/^pdf$/', $pdfFile->getClientOriginalExtension()) &&
             $pdfFile->getSize() < Config::get('phylab.maxUploadSize'))
     {
         $fname = $labID . '.pdf'; //TODO use lab id instead
         $pdfFile->move(Config::get('phylab.preparePath'), $fname);
         $data['status']=SUCCESS_MESSAGE;
         $data['message']="上传成功";
     }
     else
     {
         $data["status"]=FAIL_MESSAGE;
         $data["message"] = "上传失败，文件格式或大小不符合要求！";
     }
 }
 else
 {
     $data["status"]=FAIL_MESSAGE;
     $data["message"] = "上传失败，没有找到文件！";
 }

 return response()->json($data);
}

测试失败的原因是第二个if语句hasFile()的判定始终为false……也就是这一句：

if (Request::hasFile('prepare-pdf'))

另外附上前端代码，这里有一点需要注意的是，前端文件输入的元素并未包含在form表单中，这也导致了其中一种测试方法的失败，后面在尝试2中会提及。

<div class="form-group">
<input type="file" id="input-prepare-pdf" name="prepare-pdf">
<p class="help-block">请务必先选择一个实验，文件类型限制为PDF，大小不能超过5M</p>
</div>

<div class="modal-footer" style="margin-top: 0;padding-bottom: 0">
<div style="float:right">
 <button type="submit" id="btn-upload-preview" class="btn btn-large btn-danger">上传</button>
</div>
</div>

以下开始详细阐述我为了解决该问题进行的若干思路和尝试：

尝试1：伪造存储

通过查阅相关资料，我了解到laravel对于文件上传测试有较为便利的原生支持，可通过“伪造”磁盘和文件的方式进行文件上传的测试，像这样：

Storage::fake('avatars');
$response = $this->json('POST', '/avatar', [
'avatar' => UploadedFile::fake()->image('avatar.jpg')]);

然而尴尬的是，这个原生支持仅针对laravel5.4以上的版本，而我们的……则是上古版本5.1……

（要不是时间关系，我真的好想进行一次升级并重构，这5.1的版本实在是太老，无奈……）

这种最为实用而且简单的测试方法宣告失败。

尝试2：表单交互

通过查看laravel5.1的文档，可以发现文件上传测试还可以通过表单交互的方式进行，如这样：

public function testPhotoCanBeUploaded()
{
$this->visit('/upload')
->name('File Name', 'name')
->attach($absolutePathToFile, 'photo')
->press('Upload')
->see('Upload Successful!');
}

文档中对于attach和press函数的介绍是这样的：

Method	Description
$this->attach($pathToFile, $elementName)	"Attach" a file to the form.
$this->press($buttonTextOrElementName)	"Press" a button with the given text or name.

很浅显，不多做解释，这两个函数在其他测试中我亦使用过，然而在这里进行测试时，会产生如下报错：

报错行显示在press函数，原因是前端文件输入并未包含在form表单中（见上文中的前端代码），但是由于对前端修改还需要牵扯到其他的一些部分，何况我认为为了方便测试而修改代码并不是一个好习惯（个人理解）。

所以这一种尝试也宣告失败……

以上两种测试是通过查阅资料和阅读官方文档能找到的两种主流测试方法，未能成功，不甘失败的我开始围绕Request::hasFile()方法阅读laravel5.1的底层代码，希望通过其他途径解决该问题：

尝试3：修改预定义全局变量$_FILE

为什么进行这一项尝试，这就涉及到laravel请求生命周期的相关知识。

这里仅阐述请求实例化的部分，laravel中请求实例化位于文件Illuminate\Http\Request.php中

/**
 * Create a new Illuminate HTTP request from server variables.
*
 * @return static
*/
public static function capture()
{
 static::enableHttpMethodParameterOverride();

 return static::createFromBase(SymfonyRequest::createFromGlobals());
}

而通过createFromBase方法的代码（这里就不贴了）又能发现laravel框架的请求实例是在Symfony请求实例的基础上创建的。

对此，我又找到vendor\symfony\http-foundation\Request.php文件

其中关于请求的实例化有一句关键代码：

$request = self::createRequestFromFactory($_GET, $_POST, array(), $_COOKIE, $_FILES, $server);

也就是说，这是通过PHP的全局变量创建一个新的请求实例，如果没有laravel框架，PHP对于文件上传以及测试可以直接操作$_FILE全局变量是肯定没有问题的，laravel对其封装在Request实例中，故我想到可否在发送post请求之前修改$_FILE，即这样：

（多提及一点，$_FILE全局变量的结构是一个二维数组，每一个元素有五个字段，具体可查阅相关PHP文档）

$pdf_info = [
 'name' => public_path().'/prepare_pdf/phylab_test.pdf' ,
 'error' => 0 ,
 'type' => 'pdf' ,
 'size' => 100000000 ,
 'tmp_name' => public_path().'/prepare_pdf/phylab_test.pdf' ,
] ;
$_FILES["prepare-pdf"]["name"] = $pdf_info['name'] ;
$_FILES["prepare-pdf"]['error'] = $pdf_info['error'] ;
$_FILES["prepare-pdf"]['type'] = $pdf_info['type'] ;
$_FILES["prepare-pdf"]['tmp_name'] = $pdf_info['tmp_name'] ;
$_FILES["prepare-pdf"]['size'] = $pdf_info['size'] ;
//Request::capture() ;
//self::assertTrue(Request::hasFile('prepare-pdf')) ;
$this->post('/console/uploadPre')
   ->seeJson([

为了验证之前对于请求实例化代码的理解，可见当中有两句注释代码：

//Request::capture() ;
//self::assertTrue(Request::hasFile('prepare-pdf')) ;

这两句代码（取消注释后）是可以正常通过测试的。

遗憾的是，测试中提交post请求后，后端控制器方法中fasFile()的判定依旧为false。

这一种尝试，失败……

尝试4：构造SplFileInfo类的实例

既然测试始终无法覆盖完全的原因是hasFile方法判断为false，那我就看看这一个函数是如何进行的，故我找到Request.php中hasFile方法的源码：

public function hasFile($key)
{
 if (! is_array($files = $this->file($key))) {
     $files = [$files];
 }

 foreach ($files as $file) {
     if ($this->isValidFile($file)) {
         return true;
     }
 }

 return false;
}

首先我看到的是返回条件即$this->isValidFile($file)这一句：

在此找到isValidFile()这个方法：

protected function isValidFile($file)
{
 return $file instanceof SplFileInfo && $file->getPath() != '';
}

所以我想到了构造SplFileInfo类的实例并作为post请求的数据发送一个post请求：

$pdf = new SplFileInfo('prepare_pdf/phylab_test.pdf') ;
$this->post('/console/uploadPre' , [
         'prepare-pdf' => $pdf ,
     ])->seeJson([

很遗憾，这一种尝试依旧失败……

尝试5：构造UploadedFile类的实例

先提及一句，Request::file 方法返回来的对象是 Symfony\Component\HttpFoundation\File\UploadedFile 类的一个实例，这个类继承了 PHP 的 SplFileInfo 类，当然进行这个尝试更重要的原因在后面：

在上一项尝试中，我发现hasFile()方法在进行返回判断之前，有这样一句代码：

$files = $this->file($key)

找到file()方法：

public function file($key = null, $default = null)
{
 return Arr::get($this->files->all(), $key, $default)；
}

在返回调用Arr::get方法时第一个参数比较重要，即$this->files->all() ，

这里又需要了解Request实例中的$files属性，找到其源头，位于文件vendor\symfony\http-foundation\Request.php中，而$file的初始化是这样的：

$this->files = new FileBag($files);

传入的参数即为PHP中的$_FILE全局变量，这也就和我前面所说的请求实例化联系到了一起，对此，我再次找到FileBag类的源码，其中对于FileBag类的构造进行了多层调用，一层层找到其根源，有这样一句：

parent::set($key, $this->convertFileInformation($value));

而通过对convertFileInformation()函数的解读：

protected function convertFileInformation($file)
{
 if ($file instanceof UploadedFile) {
     return $file;
 }

 $file = $this->fixPhpFilesArray($file);
 if (is_array($file)) {

可以发现，这个函数接收的参数有两种，一种是UploadedFile实例，另一种是一个文件信息的数组，并通过这个数组创建一个UploadedFile实例:

$file = new UploadedFile($file['tmp_name'], $file['name'], $file['type'],             $file['size'], $file['error']);

**这也就和$_FILE全局变量的结构联系到了一起。**

通过改变$_FILE的方式前面已经试过，失败，那么我能不能通过传入UploadedFile实例的方式提交post请求，即这样：

$pdf = new UploadedFile($pdf_info['tmp_name'], $pdf_info['name'], $pdf_info['type'], $pdf_info['size'], $pdf_info['error']);
$this->post('/console/uploadPre' , [
         'prepare-pdf' => $pdf ,
     ])->seeJson([

失望的是，这种尝试，仍然失败……

以上便是我针对laravel5.1文件上传进行的几项主要尝试的过程，当然实际上还有一些看似就不靠谱的小尝试（抱着幻想还是要试一下），那些就不拿出来献丑了哈哈…

虽然有一些综合的原因，但是终究还是自己学术不精。如果有大佬知道解决的方案，或者是我以上部分的理解存在一些问题，欢迎指正，感激不尽！

码农公寓