PHP開発でのモックテストにPHPUnitを使用する方法

PHP 開発において、テストは非常に重要なリンクであり、テストによりエラーの発生を大幅に減らし、コードの品質を向上させることができます。モック テストは、コードの特定の機能やシナリオをテストするために、偽のオブジェクトやデータをシミュレートできるテスト形式です。

PHPUnit は PHP で非常に人気のあるテスト フレームワークであり、モック テストをサポートします。この記事では、PHPUnit を模擬テストに使用する方法を検討します。

1. モック テストとは

始める前に、まずモック テストの概念を理解しましょう。モック テストは、実際の依存関係なしでテストできるシミュレーション テストの一種です。

たとえば、ショッピング カート機能を備えた電子商取引 Web サイトを開発しています。ショッピングカートのテストでは、商品の追加や削除、価格計算などの機能をテストする必要があります。ただし、これらの機能は他のモジュールまたは外部 API に依存する場合があります。このため、テストが非常に困難になり、実際にテストを行う必要がある場合、テストのコストが非常に高くなります。

模擬テストを使用すると、実際の依存関係なしでテストできます。ショッピングカートテストでは、モックテストフレームワークを使用して模擬商品を作成し、それをテストに使用して商品の追加、削除、価格計算などの機能をテストできます。このようにして、実際の商品や外部 API を必要とせずに、ショッピング カートの機能を簡単にテストできます。

2. PHPUnit をモック テストに使用する

次に、PHPUnit テスト フレームワークをモック テストに使用します。 PHPUnit では、PHPUnitFrameworkMockObjectMockBuilder クラスを使用してモック オブジェクトを作成できます。 MockBuilder は、Mock オブジェクトの作成に役立つ PHPUnit のクラスです。

1. モック オブジェクトの作成

PHPUnit では、MockBuilder を使用してモック オブジェクトを作成できます。 MockBuilder を通じてモック オブジェクトを作成し、そのメソッドとプロパティを定義できます。その後、Mock オブジェクトを使用してコードをテストできます。

たとえば、ショッピング カートのテストで製品オブジェクトをシミュレートする必要があります。 MockBuilder を使用して、モック商品オブジェクトを作成できます。

コード例:

use PHPUnitFrameworkTestCase;

class ShoppingCartTest extends TestCase
{
    public function testAddProduct()
    {
        // 创建 MockBuilder 对象
        $product = $this->getMockBuilder(Product::class)
            ->getMock();

        // 测试真实代码，使用假对象
        $cart = new ShoppingCart();
        $cart->addProduct($product);

        // 断言购物车中包含模拟的商品
        $this->assertTrue($cart->hasProduct($product));
    }
}

このコード例では、MockBuilder オブジェクトを作成して、シミュレートされた製品オブジェクト (Product) を構築します。次に、このオブジェクトを使用して、ショッピング カートの製品追加機能を実行します。最後に、assertTrue() アサーションを使用して、構築した製品オブジェクトがショッピング カートに含まれているかどうかを確認しました。

2. メソッドの定義と戻り値の設定

Mock オブジェクトのメソッドとプロパティを設定することで、実際のオブジェクトやデータをシミュレートできます。

たとえば、文字列「Hello」を返す SayHello() メソッドを持つ Person クラスがあります。

コード例:

class Person {
    public function sayHello() {
        return "Hello";
    }
}

これで、メソッドが Person クラスの SayHello() メソッドに依存する Greeting クラスができました。 MockBuilder を使用してモック Person オブジェクトを作成し、テストで Greeting メソッドを呼び出すことができます。

コード例:

use PHPUnitFrameworkTestCase;

class GreetingTest extends TestCase
{
    public function testSayHello()
    {
        // 创建 MockBuilder 对象
        $person = $this->getMockBuilder(Person::class)
            ->getMock();

        // 定义方法返回值
        $person->expects($this->any())
            ->method('sayHello')
            ->willReturn('Hello, Mock');

        // 测试真实代码，使用假对象
        $greeting = new Greeting($person);
        $this->assertEquals('Hello, Mock', $greeting->sayHello());
    }
}

このコード例では、MockBuilder オブジェクトを作成して、モック Person オブジェクトを構築します。次に、Person オブジェクトのsayHello() メソッドの戻り値を「Hello, Mock」と定義します。最後に、オブジェクトを使用して Greeting の SayHello() メソッドを実行し、assertEquals() を使用してメソッドが「Hello, Mock」を返したかどうかをアサートしました。

3. メソッド呼び出しの検証

PHPUnit では、Mock オブジェクトを使用してメソッド呼び出しを検証できます。 PHPUnit の期待 API を使用して、メソッドが呼び出されたことを確認できます。

たとえば、文字列「Hello」を返す SayHello() メソッドを持つ Person クラスがあります。

コード例:

class Person {
    public function sayHello() {
        return "Hello";
    }
}

これで、Greeting クラスができました。このクラスのコンストラクターには Person オブジェクトが必要で、そのコンストラクターには、Person クラスの SayHello() メソッドに依存する SayHello() メソッドがあります。 Expectation API を使用して、greeting クラスのsayHello() メソッドが Person クラスのsayHello() メソッドを正常に呼び出すかどうかをテストできます。

コード例:

use PHPUnitFrameworkTestCase;

class GreetingTest extends TestCase
{
    public function testSayHello()
    {
        // 创建 MockBuilder 对象
        $person = $this->getMockBuilder(Person::class)
            ->getMock();

        // 验证方法是否被调用
        $person->expects($this->once())
            ->method('sayHello');

        // 测试真实代码，使用假对象
        $greeting = new Greeting($person);
        $greeting->sayHello();
    }
}

このコード例では、MockBuilder オブジェクトを作成して、モック Person オブジェクトを構築します。次に、Expectation API を使用して、Person クラスの SayHello() メソッドが正常に呼び出されたかどうかを確認します。

4. コンストラクターの模擬テスト

PHPUnit では、getMock() メソッドを使用してクラスのインスタンス化プロセスをシミュレートし、コンストラクターとコンストラクター パラメーターをそれぞれ設定できます。

たとえば、コンストラクターと add メソッドを持つ Calculator クラスがあります。コンストラクターでは、数値 $a と $b を渡す必要があります。 add メソッドは a と b を加算し、結果を返します。

コード例:

class Calculator
{
    public function __construct($a, $b)
    {
        $this->a = $a;
        $this->b = $b;
    }

    public function add()
    {
        return $this->a + $this->b;
    }
}

これで、Calculator クラスの add メソッドをテストする必要がある CalculatorTest クラスができました。 getMock() メソッドを使用して、Calculator オブジェクトの作成プロセスをシミュレートし、コンストラクターのパラメーターを設定できます。

コード例:

use PHPUnitFrameworkTestCase;

class CalculatorTest extends TestCase
{
    public function testAdd()
    {
        // 创建 Mock 对象
        $calculator = $this->getMockBuilder(Calculator::class)
            ->disableOriginalConstructor()
            ->getMock();

        // 手动设置构造函数参数
        $calculator->expects($this->any())
            ->method('__construct')
            ->with(2, 3)
            ->willReturn(5);

        // 测试真实代码，使用假对象
        $this->assertEquals(5, $calculator->add());
    }
}

在这个示例代码中，我们创建了一个MockBuilder对象来构建一个模拟Calculator对象。然后，我们使用getMock()方法来模拟Calculator对象的创建过程，并使用disableOriginalConstructor()方法来禁用原始构造函数。接着，我们使用expects()方法来设置构造函数的参数，并在willReturn()方法中返回我们的期望值。

最后，我们使用assertEquals()断言来验证add()方法是否返回我们预期的值。

三、总结

Mock测试可以轻松地帮助我们在不需要真实依赖的情况下进行测试。在PHPUnit中，PHPUnitFrameworkMockObjectMockBuilder类可以帮助我们创建Mock对象并进行Mock测试。

在使用MockBuilder创建Mock对象时，我们可以设置需要模拟的属性和方法，包括方法的返回值和调用次数，甚至模拟构造函数。Mock测试可以使我们的测试更加简单和高效，并且隔离了我们的代码与外部依赖的测试。

以上がPHP開発でのモックテストにPHPUnitを使用する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。