Move the API test suite off Behat to PHPUnit
维护者通常 1 天内回复
已经有一个关联 PR 被合并了。
- #518 来自 @silverbackdan —— 已合并
评估
调研方向
Start by reading CLAUDE.md and the testing configuration, then inventory the 69 feature files, 12 contexts, and their step definitions. The first step is to agree on the PHPUnit setup and porting guide with Daniel, then pilot the health and purge endpoint features with coverage, mutation, and behavior equivalence checks. Done means all scenarios are ported or deliberately dropped with reasons, Behat and its dependencies are removed, and the Symfony 8 functional suite runs.
由索引模型根据 Issue 内容生成。
描述
Why
- Symfony 8 is untested.
behat/behat3 andfriends-of-behat/mink-extension2 cap six Symfony components at^7.0, so every Behat leg runs the test app on Symfony 7.4's framework, the ones named 8.1 included. The bundle claims Symfony 8 support that its API tests never exercise. - It depends on a fork. behatch/contexts is abandoned upstream; we depend on a fork. That fork pins
justinrainbow/json-schema ^5, which is why Infection can't be a Composer dependency, and it needs theno-apirepository workaround. Behat 4 waits on mink-extension 3 and the fork. - Mutation testing is blind to it. Infection scores only PHPUnit, so code reached only by Behat gets no mutation scrutiny, and every PR adds unit tests for the gate alone.
- It runs without debug. The Behat app runs
debug: false. The alpha.29 stopwatch 500 (#501) was invisible to it; the template's PHPUnit suite caught it. - API Platform left it. API Platform, the reason we adopted Behat, moved its own suite to PHPUnit's
ApiTestCase.
Scale: 69 feature files, about 1078 scenarios, 12 contexts, about 9,850 lines of context code.
Goals
- Every Behat scenario is ported to PHPUnit, or deliberately dropped with a reason. Behat, Mink and behatch are removed.
- The tests read as well as the scenarios did: the test method name carries the behaviour (CLAUDE.md already says the reason belongs in the test name), with a small helper vocabulary.
- A clear structure: unit tests stay small and isolated; functional tests describe behaviour through HTTP and console, in terms we can state and check.
- Every ported area proves it catches what the old scenarios caught (see Equivalence).
- At the end, two lists:
- scenarios whose intent or result we're unsure of;
- behaviour we should be testing and aren't.
Phase 1: choose and set up the replacement (with Daniel, before any porting)
Decide and write down, in CLAUDE.md and a porting guide:
- Framework: API Platform's
ApiTestCase(its HTTP client, JSON and JSON-schema assertions) for API behaviour, andKernelTestCasewithCommandTesterfor console commands. - Kernels in PHPUnit. CLAUDE.md forbids booting a kernel in PHPUnit today: a debug boot registers Symfony's ErrorHandler, PHPUnit reports Risky, and Infection's initial run fails. Choose:
- a separate functional suite that Infection doesn't run; or
- solve it (e.g.
debug: falsefor most tests, plus a debug-kernel suite for stopwatch and profiler behaviour). Prove the choice in the pilot.
- Structure and naming: e.g.
tests/Unit/<Area>andtests/Functional/<Area>mirroring the feature areas, one test class per feature, andtest_<behaviour>names. - Helpers: replace the contexts with traits or fixtures: login as admin or user, Doctrine fixtures, profiler, purged tags, Mercure messages, cookies, console runs, the static test doubles. List each step definition and its replacement.
- Running: keep per-process isolation for parallel runs, as
BEHAT_SHARDdoes now (AppKernel::shardSuffix()), plus coverage and Codecov uploads, and Infection's view of the new tests. - Pilot: port two small features end to end, e.g.
health.featureand the purge endpoints, with the equivalence check below. Daniel reviews the result as the template every later port follows.
Phase 2: port as a team
Once Phase 1 is agreed:
- Work units: one feature file each, grouped into areas with a lead per area (
mainsplit by topic,user,fixtures,uploads,publishableand the rest), under one coordinator. - The coordinator keeps a tracker, assigns areas, merges in order, and resolves shared-helper changes.
- Each port is one PR that:
- adds the PHPUnit tests and deletes the scenarios it replaces;
- passes the equivalence check;
- lists anything the porter was unsure of.
- Leads review their area's PRs against the porting guide before the coordinator merges. Daniel approves the guide and samples PRs, and doesn't need to review every one.
Equivalence: the new tests catch what the old ones caught
For each ported feature:
- Coverage. Record the old scenarios' line coverage (per-feature clover from
CoverageContext) and require the new tests to cover at least those lines ofsrc/. Any shortfall is listed and explained. - Mutation. Run Infection with the new tests over the lines the old feature covered. Surviving mutants are fixed or listed. This is the gate Behat never had.
- Behaviour. Every assertion the scenarios made has a counterpart; the PR maps scenarios to tests.
Phase 3: finish
- Remove Behat, Mink, the behatch fork, the
no-apirepository andbin/behat-parallel; move CI to PHPUnit suites; update CLAUDE.md's testing section. - Lift the Symfony 7.4 test pin and run the functional suite on Symfony 8.
- Publish the two lists (unsure results; missing behaviour) as follow-up issues.
- 主要语言
- PHP
- 星标
- 32
- 派生
- 8
- 平均合并
- 1 小时
- 30 天内合并 PR
- 196
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
components-web-app/api-components-bundle 的其他 Issue
-
难度 5/5 一周以上 新手友好度 35/100
components-web-app/api-components-bundle#556 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 30/100
components-web-app/api-components-bundle#333 · 3 条评论 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 48/100
components-web-app/api-components-bundle#325 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 52/100
components-web-app/api-components-bundle#259 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 48/100
components-web-app/api-components-bundle#186 ·
维护者通常 1 天内回复
查看 components-web-app/api-components-bundle 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 79/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 69/100
bagisto/bagisto-api#54 ·
-
难度 2/5 1-3 小时 新手友好度 64/100
维护者通常 5 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
grokability/snipe-it#19869 · 2 条评论 ·
维护者通常 1 天内回复
-
regression
难度 2/5 1-3 小时 新手友好度 70/100