PHP で単體テストを?qū)g行する方法: ツールとベスト プラクティス

単體テストは、アプリケーションの個(gè)々のコンポーネントや機(jī)能が期待どおりに動(dòng)作することを保証する、ソフトウェア開(kāi)発ライフサイクルの重要な部分です。 PHP では、単體テストはコードの正しさを検証するのに役立ち、開(kāi)発者がバグを早期に発見(jiàn)し、コードの信頼性と保守性を向上させることができます。

PHP で単體テストを?qū)g行するには、通常は専用のテスト フレームワークとツールを使用して、機(jī)能の小さく分離された部分 (ユニット) のテストを作成する必要があります。以下では、PHP で単體テストを?qū)g行する方法、一般的に使用されるツールとフレームワーク、従うべきベスト プラクティスについて詳しく説明します。

---

1. PHP の単體テストとは何ですか?

単體テストには、コードの個(gè)々の単位 (関數(shù)またはメソッドと呼ばれます) を分離してテストし、期待どおりに実行されることを確認(rèn)することが含まれます。単體テストの主な目的は、各単體の正確性を検証してバグを早期に発見(jiàn)し、開(kāi)発者が自信を持ってコードをリファクタリングまたは変更できるようにすることです。

単體テストは、特定の入力に対する関數(shù)またはメソッドの動(dòng)作をチェックし、実際の出力と予想される出力を比較します。単體テストは通常??自動(dòng)化されており、継続的に実行して高いコード品質(zhì)を維持できます。

---

2.単體テストの主な利點(diǎn)

• 早期バグ検出: 単體テストはエラーやバグを早期に発見(jiàn)するのに役立ち、アプリケーションの大部分に影響を與える前にそれらを修正しやすくなります。
• リファクタリングの信頼性: 単體テストを?qū)毪工毪取㈤_(kāi)発者はテストであらゆる回帰が検出されることがわかっているため、自信を持ってコードを変更したりリファクタリングしたりできます。
• コード品質(zhì)の向上: 単體テストを作成すると、開(kāi)発者はモジュール化され、保守しやすく、適切に構(gòu)造化されたコードを作成する必要があり、より良い設(shè)計(jì)実踐が促進(jìn)されます。
• ドキュメント: 単體テストは、関數(shù)とメソッドの予想される動(dòng)作の生きたドキュメントとして機(jī)能します。

---

3. PHP での単體テストのためのツールとフレームワーク

PHP のいくつかのツールとフレームワークは、単體テストの作成と実行に役立ちます。最も人気のあるものは、PHPUnit、Mockery、および PHPSpec です。以下はこれらのツールの概要です:

a. PHPUnit

PHPUnit は、PHP で最も広く使用されているテスト フレームワークです。これは、単體テストを簡(jiǎn)単に作成して実行する方法を提供するオープンソース ツールです。 PHPUnit は、xUnit ファミリのフレームワーク (Java の JUnit や .NET の NUnit など) からインスピレーションを得ています。

• インストール: PHPUnit は、PHP 依存関係マネージャーである Composer を介してインストールできます。

composer require --dev phpunit/phpunit

• 基本的な例:

// Example: A simple Calculator class
class Calculator {
    public function add($a, $b) {
        return $a + $b;
    }
}

// PHPUnit test for Calculator class
use PHPUnit\Framework\TestCase;

class CalculatorTest extends TestCase {
    public function testAdd() {
        $calculator = new Calculator();
        $result = $calculator->add(2, 3);
        $this->assertEquals(5, $result);
    }
}

• PHPUnit を?qū)g行中:

PHPUnit を使用してテストを?qū)g行するには、次のコマンドを使用します:

./vendor/bin/phpunit tests/CalculatorTest.php

PHPUnit の機(jī)能:

• アサーション: テスト結(jié)果を検証するために、assertEquals、assertTrue、assertFalse、assertContains などのさまざまなアサーション メソッドを提供します。
• テスト スイート: 複數(shù)のテストをグループ化し、スイートとして実行します。
• モッキング: テスト中に依存関係をシミュレートするためにモック オブジェクトを作成します。
• コード カバレッジ: PHPUnit はコード カバレッジ レポートを生成して、コードのどの程度がテストでカバーされているかを測(cè)定できます。

b.嘲笑

Mockery は、オブジェクトをモックし、依存関係の動(dòng)作をシミュレートするために PHPUnit と一緒に使用されるモック フレームワークです。これにより、データベース接続、API、サービスなどの外部依存関係を持つコンポーネントをテストする際に、よりきめ細(xì)かい制御が可能になります。

• インストール: Mockery は Composer 経由でインストールできます。

composer require --dev mockery/mockery

• 例:

use Mockery;
use PHPUnit\Framework\TestCase;

class UserServiceTest extends TestCase {
    public function testGetUserName() {
        // Create a mock UserRepository
        $userRepository = Mockery::mock(UserRepository::class);
        $userRepository->shouldReceive('find')->with(1)->andReturn(new User('John Doe'));

        $userService = new UserService($userRepository);
        $userName = $userService->getUserName(1);

        $this->assertEquals('John Doe', $userName);
    }

    public function tearDown(): void {
        Mockery::close();  // Clean up mock objects
    }
}

c. PHPスペック

PHPSpec は、PHP 用の動(dòng)作駆動(dòng)開(kāi)発 (BDD) フレームワークです。 PHPUnit はコード単位のテストの作成に重點(diǎn)を置いていますが、PHPSpec はクラスとオブジェクトの動(dòng)作の指定に重點(diǎn)を置いています。これにより、より自然な言語(yǔ)でテストを作成できるようになり、開(kāi)発を外部から內(nèi)部へ推進(jìn)するためによく使用されます。

• インストール:

composer require --dev phpspec/phpspec

• 基本的な例:

// Spec for Calculator class
class CalculatorSpec extends \PhpSpec\ObjectBehavior {
    function it_adds_two_numbers() {
        $this->add(2, 3)->shouldReturn(5);
    }
}

---

4. PHP での単體テストのベスト プラクティス

PHP で単體テストを作成する際に従うべきベスト プラクティスをいくつか示します。

a.一度に 1 つずつテストしてください

各テストでは、1 つの特定の動(dòng)作または機(jī)能のみを検証する必要があります。これにより、テストの理解、保守、デバッグが容易になります。

b.テストを隔離しておきます

単體テストは互いに獨(dú)立している必要があります。信頼性と再現(xiàn)性を確保するには、各テストを他のテストとは獨(dú)立して実行する必要があります。

c.依存関係にモッキングを使用する

コードが外部サービス、データベース、または API に依存している場(chǎng)合は、モックを使用してそれらの動(dòng)作をシミュレートします。これにより、テストが実際の外部システムに依存することがなくなり、テストがより高速かつ確実に実行されます。

d.コードの前にテストを作成する (テスト駆動(dòng)開(kāi)発)

TDD (テスト駆動(dòng)開(kāi)発) に従うと、テスト容易性を念頭に置いてコードを作成することができます。まずテストを作成してから、テストを通過(guò)させるコードを作成します。

e。わかりやすいテスト名を使用してください

テスト対象の動(dòng)作を説明するわかりやすいテスト名を使用します。これは、他の人 (そして將來(lái)のあなた) が各テストの目的を理解するのに役立ちます。

composer require --dev phpunit/phpunit

f.テストを定期的に実行します

テストを継続的インテグレーション (CI) パイプラインに統(tǒng)合して、コミットごとに自動(dòng)的に実行されるようにします。これにより、新しい変更によって既存の機(jī)能が損なわれることがなくなります。

---

5. PHPUnit を使用した完全な単體テストの例

PHPUnit を使用したクラスの単體テストの完全な例を見(jiàn)てみましょう。

テストするクラス (Calculator.php):

// Example: A simple Calculator class
class Calculator {
    public function add($a, $b) {
        return $a + $b;
    }
}

// PHPUnit test for Calculator class
use PHPUnit\Framework\TestCase;

class CalculatorTest extends TestCase {
    public function testAdd() {
        $calculator = new Calculator();
        $result = $calculator->add(2, 3);
        $this->assertEquals(5, $result);
    }
}

単體テスト クラス (CalculatorTest.php):

./vendor/bin/phpunit tests/CalculatorTest.php

テストの実行:

composer require --dev mockery/mockery

---

6.結(jié)論

単體テストは、特に PHP アプリケーションにおいて、ソフトウェアの品質(zhì)を確保するために重要な部分です。 PHPUnit、Mockery、PHPSpec などのテスト フレームワークを使用すると、コードの正確性の検証に役立つ自動(dòng)テストを作成できます。単體テストには、早期のバグ検出、リファクタリング中のコードの信頼性、全體的なソフトウェア品質(zhì)の向上など、いくつかの利點(diǎn)があります。

分離された記述的なテストを作成したり、依存関係をシミュレートするためにモックを使用したりするなどのベスト プラクティスに従うことで、長(zhǎng)期的なプロジェクトの成功に貢獻(xiàn)する効果的で保守可能な単體テストを作成できます。

以上がPHP で単體テストをマスターする: ツール、フレームワーク、ベスト プラクティスの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。