Symfony控制器中外部服务Mock测试指南

final class WebhookController extends AbstractController
{
    private CustomLoggerService $customLogger;
    private EntityManagerInterface $entityManager;
    private MyService $myService; // 外部服务依赖
    private UserMailer $userMailer;
    private AdminMailer $adminMailer;

    public function __construct(
        CustomLoggerService $customLogger,
        EntityManagerInterface $entityManager,
        MyService $myService,
        UserMailer $userMailer,
        AdminMailer $adminMailer
    ) {
        $this->customLogger = $customLogger;
        $this->myService = $myService;
        $this->userMailer = $userMailer;
        $this->adminMailer = $adminMailer;
        $this->entityManager = $entityManager;
    }

    /**
     * @Route("/webhook/new", name="webhook_new")
     * @param Request $request
     * @return Response
     */
    public function new(Request $request): Response
    {
        $uri = $request->getUri();
        $this->customLogger->info("new event uri ".$uri);
        $query = $request->query->all();

        if (isset($query['RessourceId'])) {
            $id = $query['RessourceId'];
            // 调用外部服务
            $event = $this->myService->getInfos($id); 
            $infoId = $event->infoId;
            $this->customLogger->info("new info id ".$infoId);

            $userRepo = $this->entityManager->getRepository(User::class);
            $user = $userRepo->findOneByEventUserId((int)$event->owners[0]);

            $this->userMailer->sendAdminEvent($event, $user);
            $this->customLogger->info("new mail sent");
        } else {
            $this->adminMailer->sendSimpleMessageToAdmin("no ressource id", "no ressource id");
        }
        return new JsonResponse();
    }
}

# config/services_test.yaml
App\Service\MyService:
  public: true # 将MyService设置为public，以便在测试中访问和替换

use App\Service\MyService;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Component\BrowserKit\KernelBrowser;

class WebhookControllerTest extends WebTestCase
{
    // ... 其他测试方法或trait

    public function testNewWebhookWithResourceId(): void
    {
        // 确保内核已关闭，以便重新启动并获取干净的服务容器
        self::ensureKernelShutdown(); 

        /** @var KernelBrowser $client */
        $client = static::createClient(); // 使用static::createClient()创建客户端
        $client->enableProfiler(); // 启用Profiler，便于调试

        // 1. 创建MyService的Mock对象
        $myServiceMock = $this->createMock(MyService::class);

        // 2. 定义Mock对象的行为：当getInfos方法被调用一次时，返回指定数据
        $myServiceMock->expects($this->once())
                      ->method("getInfos")
                      ->willReturn((object)[ // 返回一个对象以匹配控制器中的 $event->infoId 访问
                          'infoId' => 'mocked_info_123',
                          'owners' => ['mocked_owner_id']
                      ]);

        // ... 后续步骤
    }
}

// ... 承接上一步的 testNewWebhookWithResourceId 方法

        // 3. 将Mock对象注入到测试容器中，替换掉原有的MyService实例
        self::$container->set(MyService::class, $myServiceMock);

        // ... 后续步骤

// ... 承接上一步的 testNewWebhookWithResourceId 方法

        // 4. 发起HTTP请求，触发控制器逻辑
        $client->request('GET', '/webhook/new/?RessourceId=1111');

        // 5. 进行断言，验证控制器行为
        $this->assertResponseIsSuccessful();
        // 进一步断言，例如检查日志、数据库状态或响应内容
        // 假设控制器返回JsonResponse，可以检查其内容
        $responseContent = json_decode($client->getResponse()->getContent(), true);
        $this->assertNotNull($responseContent); // 确保返回了有效的JSON
        // ... 更多针对控制器逻辑的断言
    }
}

<?php

namespace App\Tests\Controller;

use App\Service\MyService; // 引入MyService
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Component\BrowserKit\KernelBrowser;

class WebhookControllerTest extends WebTestCase
{
    // 假设有LoginTrait，根据实际项目情况决定是否需要
    // use LoginTrait; 

    public function testNewWebhookWithResourceId(): void
    {
        // 确保内核已关闭，以便重新启动并获取干净的服务容器
        self::ensureKernelShutdown(); 

        /** @var KernelBrowser $client */
        $client = static::createClient(); // 使用static::createClient()创建客户端
        $client->enableProfiler(); // 启用Profiler，便于调试

        // 1. 创建MyService的Mock对象
        $myServiceMock = $this->createMock(MyService::class);

        // 2. 定义Mock对象的行为：当getInfos方法被调用一次时，返回指定数据
        // 确保返回的数据结构与控制器中对 $event 对象的访问方式匹配
        $myServiceMock->expects($this->once())
                      ->method("getInfos")
                      ->with(1111) // 假设getInfos接收RessourceId作为参数
                      ->willReturn((object)[ 
                          'infoId' => 'mocked_info_123',
                          'owners' => [123] // 假设owner ID是整数
                      ]);

        // 3. 将Mock对象注入到测试容器中，替换掉原有的MyService实例
        self::$container->set(MyService::class, $myServiceMock);

        // 4. 发起HTTP请求，触发控制器逻辑
        $client->request('GET', '/webhook/new/?RessourceId=1111');

        // 5. 进行断言，验证控制器行为
        $this->assertResponseIsSuccessful('控制器应成功响应');

        // 假设控制器在成功处理后返回空JsonResponse，我们可以验证状态码
        $this->assertEquals(200, $client->getResponse()->getStatusCode());

        // 如果控制器有其他可观察的副作用（如日志、数据库更新、邮件发送），
        // 可以在这里通过检查Profiler或Mock其他服务来断言这些副作用。

        // 例如，如果CustomLoggerService也被Mock了，可以断言其info方法被调用
        // $customLoggerMock->expects($this->atLeastOnce())->method('info');

        // 如果UserMailerService也被Mock了，可以断言其sendAdminEvent方法被调用
        // $userMailerMock->expects($this->once())->method('sendAdminEvent');
    }

    public function testNewWebhookWithoutResourceId(): void
    {
        self::ensureKernelShutdown();
        $client = static::createClient();
        $client->enableProfiler();

        // 对于不依赖MyService的路径，通常不需要Mock MyService
        // 但如果控制器中其他路径也依赖，且我们想确保其不被调用，也可以Mock

        $client->request('GET', '/webhook/new/'); // 不带RessourceId

        $this->assertResponseIsSuccessful('控制器应成功响应');
        $this->assertEquals(200, $client->getResponse()->getStatusCode());

        // 在这种情况下，我们可能期望AdminMailer被调用，如果AdminMailer也被Mock了，可以断言
        // $adminMailerMock->expects($this->once())->method('sendSimpleMessageToAdmin');
    }
}