模拟数据库查询 laravel 嘲弄

Posted 2023-03-25

【中文标题】模拟数据库查询 laravel 嘲弄

【英文标题】：mocking out database queries laravel mockery

【发布时间】：2016-08-03 04:41:19

【问题描述】：

我正在尝试使用 phpUnit / Mockery / Laravel 进行单元测试。 这并不容易。看了几十篇教程，还是无法应用到现实生活场景中。

我将展示一段我想测试的代码。谁能告诉我如何测试SoldProductModifier类的方法modifyBasedOnItemCode()？

先解释几句： 我希望用户能够输入产品代码（项目代码）和数量，并且我希望系统自动更新 SoldProduct 模型的 product_id 和 category_id 属性。为此，我创建了我现在要测试的类。

另请参阅： simplified diagram for my database (only tables related to my question)

现在相关代码：

要测试的类

使用应用\模型\产品； 类SoldProductModifier 私人 $sold_product; 公共函数 __construct(SoldProduct $sold_product) $this->sold_product = $sold_product; 公共函数 modifyBasedOnItemCode($item_code) if (!isset($item_code) || $item_code == '') $product = Product::findByItemCode($item_code); if (isset($product) && $product != false) $this->sold_product->category_id = $product->category->id; $this->sold_product->product_id = $product->id; 返回 $this->sold_product;

产品型号

... 公共静态函数 findByItemCode($item_code) return self::where('item_code', $item_code)->first(); ...

我的控制器引用了 SUT

... $sold_product = new SoldProduct($request->all()); $modifier = new SoldProductModifier($sold_product); $sold_product = $modifier->modifyBasedOnItemCode($request->item_code); $sold_product->保存（）； ...

我的测试课

类 SoldProductModifierTest 扩展 TestCase 公共函数设置（） 父::setUp(); $this->soldProductMock = $this->mock('App\Models\SoldProduct'); $this->productMock = $this->mock('App\Models\Product'); 公共函数拆解（） 嘲弄::close(); 公共函数 testDoesNotModifyIfItemCodeEmpty() $soldProductModifier = new SoldProductModifier($this->soldProductMock); $modifiedSoldProduct = $soldProductModifier->modifyBasedOnItemCode(''); $this->assertEquals($this->soldProductMock, $modifiedSoldProduct); 公共函数 testModifiesBasedOnItemCode() // 我如何测试积极的情况？ ...

我粘贴了我的第一个测试，以防有人认为它不应该这样做，并且愿意建议另一种解决方法。

但现在我的问题是：

如何在此处模拟对数据库的调用：Product::findByItemCode($item_code)？

我是否应该在我的 SoldProductModifier 中创建一个 $product 属性并使用为此目的创建的 setter 方法设置它，例如：

公共函数 setProduct(Product $product) $this->product = $product;

然后在我的控制器中添加额外的行：

... $modifier = new SoldProductModifier($sold_product); $modifier->setProduct(Product::findByItemCode($item_code)); // --- 额外的行 $sold_product = $modifier->modifyBasedOnItemCode(); // --- 参数被移除 ...

?

我尽量让我的控制器保持纤薄，所以想避免这种情况？ 那么解决这种情况的最佳方法是什么？

谢谢

【参考方案1】：

您应该通过构造函数注入 Product，以便 Laravel 可以为您处理。

use App\Models\Product;

class SoldProductModifier 

    private $sold_product;

    protected $product;

    public function __construct(SoldProduct $sold_product, Product $product) 
    
        $this->sold_product = $sold_product;

        $this->product = $product;
    

现在你需要为通过函数的每个“路径”编写一个单元测试。

// Build your mock object.
$mockProduct = Mockery::mock(new App\Models\Product);

// Have Laravel return the mocked object instead of the actual model.
$this->app->instance('App\Models\Product', $mockProduct);

// Tell your mocked instance what methods it should receive.
$mockProduct
    ->shouldReceive('findByItemCode')
    ->once()
    ->andReturn(false);

// Now you can instantiate your class and call the methods on it to be sure it's returning items and setting class properties correctly.

您应该多次编写此测试并让您的$mockProduct 返回不同的内容，直到所有代码行都被覆盖。例如，您可能想要执行以下操作...

$product = new stdClass;
$product->id = 45;

$category = new stdClass;
$category-id = 60;

$product->category = $category;

$mockProduct
    ->shouldReceive('findByItemCode')
    ->once()
    ->andReturn($product);

现在函数运行后，您需要确保 sold_product->category_id 等于 60 和 sold_product->product_id 等于 45。如果它们是私有的并且您无法从测试中检查它们，您可能需要为这些对象编写一个 getter，以便您可以更轻松地从测试中查看它们的值。

编辑

关于您的 cmets，您将使用以下内容。

new SoldProductModifier($sold_product, new Product);

然后你的函数应该看起来像......

public function modifyBasedOnItemCode($item_code)

    if (! isset($item_code) || $item_code == '')
    
        $product = $this->product->findByItemCode($item_code);

        if (isset($product) && $product != false)
        
            $this->sold_product->category_id = $product->category->id;
            $this->sold_product->product_id = $product->id;
        
    

    return $this->sold_product;

我看到它是一个静态函数，因此您可能希望以不同的方式处理它。如果只是因为这个原因它是静态的，那么你就不能让它成为静态的。如果其他事情取决于它，您可能会创建一个不是静态的新函数，它通过self::findByItemCode($id)调用静态函数

这里的一般经验法则是，除非它是在您的 config.php 文件中设置的外观，否则您应该允许 Laravel 为您处理注入它。这样，当你在测试时，你可以创建模拟对象，然后通过$this->app->instance() 让 Laravel 知道它们，这样它就会注入这些模拟对象来代替真实的对象。

【讨论】：

非常感谢您的关注！但我仍然很困惑。如果$mockProduct->shouldReceive('findByItemCode')，那么我猜您建议将Product::findByItemCode($item_code) 留在我的CUT 中，而不是将其移至控制器？如果是这样，那么我应该通过构造函数传递Product 类的哪个实例？

我不确定“我应该通过什么实例”是什么意思。应该只传递一个实例，而 Laravel 会为您完成。

我的意思是你会把什么放在这里（在控制器中）作为我的构造函数$modifier = new SoldProductModifier($sold_product, ???); 的第二个参数？ Product 是在 modifyBasedOnItemCode 函数内部“构建”的，基于 $item_code 值，所以我不需要通过构造函数传递任何这种类型的对象？无论如何，我接受了你的回答，因为你指出了我正确的方向，我终于让我的测试工作了！如果有人感兴趣，我会将其作为另一个答案发布...干杯！