如何组织存在依赖关系的OpenSearch集成测试类？

问题场景 #

我正在为OpenSearch编写集成测试，有多个测试类，类中的测试用例存在跨类依赖。比如CreatePostTest负责测试OpenSearch文档创建，UpdatePostTest负责测试已有文档更新，后者需要先运行CreatePostTest的用例并拿到新生成的文档ID才能执行。

测试代码示例：

class CreatePostTest
{
    public function testCreateDocument(): string
    {
        $postMock = $this->getBaseMockData();
        $response = $this->getCreatePostRequest($postMock);
        self::assertResponseSuccessful($response);
        $post = $response['data']['createPost']['post'];

        return $post['_id'];
    }

    //Other test cases
}

class UpdatePostTest
{
    public function testUpdateDocument(string $postId)
    {
        $postMock = $this->getBaseMockData();
        $postMock['postId'] = $postId;
        $response = $this->getUpdatePostRequest($postMock);
        self::assertResponseSuccessful($response);
    }

    //Other test cases
}

我试过用@depends注解，但报错："This test depends on \"App\\Tests\\Integration\\Api\\Post\\UpdatePostTest::CreatePostTest\" which does not exist."

我的需求是不想把所有用例都塞进同一个测试类，想知道这种跨类依赖的测试该怎么组织才最合适？

解决方案 #

首先明确：PHPUnit的@depends注解仅支持同一个测试类内的用例依赖，跨类使用必然报错，这是你之前问题的核心原因。下面是几种可行的组织方案：

方案1：共享前置数据基类 #

创建一个独立的基类，专门处理测试数据的前置生成与清理，所有依赖该数据的测试类都继承它，既保证职责单一，又能共享数据：

class PostTestSetup extends TestCase
{
    protected static string $postId;

    public static function setUpBeforeClass(): void
    {
        parent::setUpBeforeClass();
        // 复用CreatePostTest中的创建逻辑
        $postMock = self::getBaseMockData();
        $response = self::getCreatePostRequest($postMock);
        self::assertResponseSuccessful($response);
        $post = $response['data']['createPost']['post'];
        self::$postId = $post['_id'];
    }

    public static function tearDownAfterClass(): void
    {
        // 测试结束后清理生成的文档，避免污染测试环境
        self::deletePostRequest(self::$postId);
        parent::tearDownAfterClass();
    }

    // 将getBaseMockData、getCreatePostRequest等通用方法移到这里
}

修改原有测试类：

class CreatePostTest extends PostTestSetup
{
    public function testCreateDocument()
    {
        // 直接验证前置生成的ID有效性，或补充其他创建相关断言
        self::assertNotNull(self::$postId);
    }

    // 其他测试用例
}

class UpdatePostTest extends PostTestSetup
{
    public function testUpdateDocument()
    {
        $postMock = $this->getBaseMockData();
        $postMock['postId'] = self::$postId;
        $response = $this->getUpdatePostRequest($postMock);
        self::assertResponseSuccessful($response);
    }

    // 其他测试用例
}

方案2：测试套件控制执行顺序+静态变量共享 #

如果不想用继承，可以通过phpunit.xml配置测试套件，强制指定测试类的执行顺序，再用静态变量传递数据：

1. 在phpunit.xml中定义测试套件：

<testsuites>
    <testsuite name="PostTests">
        <file>tests/Integration/Api/Post/CreatePostTest.php</file>
        <file>tests/Integration/Api/Post/UpdatePostTest.php</file>
    </testsuite>
</testsuites>

2. 修改CreatePostTest，将生成的ID存入静态变量：

class CreatePostTest extends TestCase
{
    public static string $postId;

    public function testCreateDocument(): void
    {
        $postMock = $this->getBaseMockData();
        $response = $this->getCreatePostRequest($postMock);
        self::assertResponseSuccessful($response);
        $post = $response['data']['createPost']['post'];
        self::$postId = $post['_id'];
    }

    // 其他测试用例
}

3. 在UpdatePostTest中直接引用静态变量：

class UpdatePostTest extends TestCase
{
    public function testUpdateDocument(): void
    {
        $postId = CreatePostTest::$postId;
        self::assertNotNull($postId, "必须先运行CreatePostTest生成文档ID");
        
        $postMock = $this->getBaseMockData();
        $postMock['postId'] = $postId;
        $response = $this->getUpdatePostRequest($postMock);
        self::assertResponseSuccessful($response);
    }

    // 其他测试用例
}

注意：这种方式必须依赖测试套件的执行顺序，否则UpdatePostTest会拿到空ID。

方案3：独立数据工厂类（高隔离性） #

创建一个专门的工厂类封装测试数据的生成逻辑，每个需要的测试类直接调用，保证测试用例之间的独立性：

class PostTestDataFactory
{
    public static function createTestPost(): string
    {
        // 复用创建文档的逻辑
        $postMock = self::getBaseMockData();
        $response = self::getCreatePostRequest($postMock);
        self::assertResponseSuccessful($response);
        $post = $response['data']['createPost']['post'];
        return $post['_id'];
    }

    // 通用方法与清理方法
}

修改UpdatePostTest：

class UpdatePostTest extends TestCase
{
    private string $postId;

    protected function setUp(): void
    {
        parent::setUp();
        // 每个测试用例独立生成测试数据
        $this->postId = PostTestDataFactory::createTestPost();
    }

    protected function tearDown(): void
    {
        // 每个测试用例结束后清理自己的数据
        self::deletePostRequest($this->postId);
        parent::tearDown();
    }

    public function testUpdateDocument(): void
    {
        $postMock = $this->getBaseMockData();
        $postMock['postId'] = $this->postId;
        $response = $this->getUpdatePostRequest($postMock);
        self::assertResponseSuccessful($response);
    }
}

这种方式的优点是测试隔离性好，单个用例失败不会影响其他用例；缺点是会额外创建一些测试文档，适合对隔离性要求高的场景。

内容的提问来源于stack exchange，提问作者fahad shaikh