嘲笑数据库查询laravel嘲弄

时间:2016-04-12 13:56:23

标签: php unit-testing laravel mockery

我正试着用PhpUnit / Mockery / Laravel来完成单元测试。 它并不容易。我已经阅读了几十个教程,仍然无法在现实生活中应用它。

我将展示一段我想测试的代码。谁能指点我如何测试 SoldProductModifier modifyBasedOnItemCode()的方法?

首先解释几句: 我希望用户能够输入产品代码(项目代码)和数量,我希望系统自动更新product_id以及SoldProduct模型的category_id属性。为此我创建了我现在要测试的类。

还请看: simplified diagram for my database (only tables related to my question)

现在相关代码:

要测试的课程



    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 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


    ...

我尽量让控制器保持苗条,所以想避免这种情况? 那么解决这种情况的最佳方法是什么?

谢谢

1 个答案:

答案 0 :(得分:7)

您应该通过构造函数注入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,这样你就可以更容易地从测试中看到它们的值。

修改

关于您的评论,您将使用以下内容。

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()了解它们,这样就可以用真实的方式注入它们。