模拟数据库查询 laravel 嘲笑
mocking out database queries laravel mockery
我正在尝试使用 PhpUnit / Mockery / Laravel 进行单元测试。
这并不容易。看了几十本教程,还是不能应用到实际场景中。
我将展示一段我想测试的代码。谁能告诉我如何测试 class SoldProductModifier 的方法 modifyBasedOnItemCode()?
先解释几句:
我希望用户能够输入产品代码(项目代码)和数量,我希望系统自动更新 SoldProduct 模型的 product_id 和 category_id 属性。为此,我创建了 class 我现在想测试。
另请参阅:
simplified diagram for my database (only tables related to my question)
现在相关代码:
Class待测
use App\Models\Product;
class SoldProductModifier
{
private $sold_product;
public function __construct(SoldProduct $sold_product)
{
$this->sold_product = $sold_product;
}
public function 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;
}
}
return $this->sold_product;
}
}
产品型号
...
public static function 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->save();
...
我的测试class
class SoldProductModifierTest extends TestCase {
public function setUp()
{
parent::setUp();
$this->soldProductMock = $this->mock('App\Models\SoldProduct');
$this->productMock = $this->mock('App\Models\Product');
}
public function tearDown()
{
Mockery::close();
}
public function testDoesNotModifyIfItemCodeEmpty()
{
$soldProductModifier = new SoldProductModifier($this->soldProductMock);
$modifiedSoldProduct = $soldProductModifier->modifyBasedOnItemCode('');
$this->assertEquals($this->soldProductMock, $modifiedSoldProduct);
}
public function testModifiesBasedOnItemCode()
{
// how do I test positive case scenario ?
...
我粘贴了我的第一个测试,以防有人认为这不是应该的方式,并且很乐意建议另一种方法来解决这个问题。
但现在我的问题是:
如何在此处模拟对数据库的调用:Product::findByItemCode($item_code) ?
我是否应该在我的 SoldProductModifier 中创建一个 $product 属性 并使用为此目的创建的 setter 方法对其进行设置,例如:
public function setProduct(Product $product)
{
$this->product = $product;
}
然后在我的控制器中添加额外的行:
...
$modifier = new SoldProductModifier($sold_product);
$modifier->setProduct(Product::findByItemCode($item_code)); // --- extra line
$sold_product = $modifier->modifyBasedOnItemCode(); // --- parameter removed
...
?
我试图让我的控制器尽可能纤薄,所以想避免这种情况?
那么解决这种情况的最佳方法是什么?
谢谢
您应该通过构造函数注入 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;
}
}
现在需要通过函数为每个"path"写一个单元测试。
// 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
return 不同的东西,直到覆盖所有代码行。例如,您可能想要执行以下操作...
$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,以便您可以更轻松地从测试中查看它们的值。
编辑
关于您的评论,您将使用以下内容。
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 为您处理注入。这样,当您进行测试时,您可以创建模拟对象,然后让 Laravel 通过 $this->app->instance()
了解它们,这样它就会注入那些代替真实的对象。
我正在尝试使用 PhpUnit / Mockery / Laravel 进行单元测试。 这并不容易。看了几十本教程,还是不能应用到实际场景中。
我将展示一段我想测试的代码。谁能告诉我如何测试 class SoldProductModifier 的方法 modifyBasedOnItemCode()?
先解释几句: 我希望用户能够输入产品代码(项目代码)和数量,我希望系统自动更新 SoldProduct 模型的 product_id 和 category_id 属性。为此,我创建了 class 我现在想测试。
另请参阅: simplified diagram for my database (only tables related to my question)
现在相关代码:
Class待测
use App\Models\Product; class SoldProductModifier { private $sold_product; public function __construct(SoldProduct $sold_product) { $this->sold_product = $sold_product; } public function 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; } } return $this->sold_product; } }
产品型号
... public static function 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->save(); ...
我的测试class
class SoldProductModifierTest extends TestCase { public function setUp() { parent::setUp(); $this->soldProductMock = $this->mock('App\Models\SoldProduct'); $this->productMock = $this->mock('App\Models\Product'); } public function tearDown() { Mockery::close(); } public function testDoesNotModifyIfItemCodeEmpty() { $soldProductModifier = new SoldProductModifier($this->soldProductMock); $modifiedSoldProduct = $soldProductModifier->modifyBasedOnItemCode(''); $this->assertEquals($this->soldProductMock, $modifiedSoldProduct); } public function testModifiesBasedOnItemCode() { // how do I test positive case scenario ? ...
我粘贴了我的第一个测试,以防有人认为这不是应该的方式,并且很乐意建议另一种方法来解决这个问题。
但现在我的问题是:
如何在此处模拟对数据库的调用:Product::findByItemCode($item_code) ?
我是否应该在我的 SoldProductModifier 中创建一个 $product 属性 并使用为此目的创建的 setter 方法对其进行设置,例如:
public function setProduct(Product $product) { $this->product = $product; }
然后在我的控制器中添加额外的行:
... $modifier = new SoldProductModifier($sold_product); $modifier->setProduct(Product::findByItemCode($item_code)); // --- extra line $sold_product = $modifier->modifyBasedOnItemCode(); // --- parameter removed ...
?
我试图让我的控制器尽可能纤薄,所以想避免这种情况? 那么解决这种情况的最佳方法是什么?
谢谢
您应该通过构造函数注入 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;
}
}
现在需要通过函数为每个"path"写一个单元测试。
// 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
return 不同的东西,直到覆盖所有代码行。例如,您可能想要执行以下操作...
$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,以便您可以更轻松地从测试中查看它们的值。
编辑
关于您的评论,您将使用以下内容。
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 为您处理注入。这样,当您进行测试时,您可以创建模拟对象,然后让 Laravel 通过 $this->app->instance()
了解它们,这样它就会注入那些代替真实的对象。