在Symfony控制器中测试模拟服务

// src/Controller/WebhookController.php
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")
     */
    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'];
            // MyService 可能会调用外部API
            $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
services:
    # ... 其他配置
    App\Service\MyService: # 替换为你要模拟的服务的完整类名
        public: true

// tests/Controller/WebhookControllerTest.php
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use App\Service\MyService;
use Symfony\Component\BrowserKit\KernelBrowser;

class WebhookControllerTest extends WebTestCase
{
    public function testNewWebhookWithResourceId(): void
    {
        // 确保每次测试都在干净的内核状态下运行
        self::ensureKernelShutdown();
        /** @var KernelBrowser $client */
        $client = static::createClient(); // 使用 static::createClient() 创建客户端

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

        // 2. 定义模拟对象的行为
        // 模拟 getInfos 方法返回一个包含 infoId 和 owners 的匿名对象
        // 确保返回的数据结构与控制器中对 $event 对象的访问方式匹配
        $myServiceMock->expects($this->once())
                      ->method("getInfos")
                      ->with(1111) // 期望接收到参数 1111
                      ->willReturn((object)['infoId' => 'mocked_info_id', 'owners' => [456]]);

        // 3. 将模拟对象注入到测试容器中，替换掉真实的 MyService
        // 必须在发起请求之前完成
        self::$container->set(MyService::class, $myServiceMock);

        // 4. 发起 HTTP 请求
        $client->request('GET', '/webhook/new/?RessourceId=1111');

        // 5. 进行断言，验证控制器行为
        $this->assertResponseIsSuccessful();
        $this->assertJsonStringEqualsJsonString('{}', $client->getResponse()->getContent());
        // 可以在此处添加更多断言，例如检查日志、邮件是否被模拟服务调用等
    }

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

        // 对于不涉及 MyService 的情况，可能不需要模拟，或者模拟其他服务
        // 比如 AdminMailer，但此处我们只关注 MyService 的模拟

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

        $this->assertResponseIsSuccessful();
        $this->assertJsonStringEqualsJsonString('{}', $client->getResponse()->getContent());
    }
}