CC-39888 Document the API Platform test harness - #3857
Draft
stereomon wants to merge 4 commits into
Draft
Conversation
The existing testing page predates the harness: it describes neither the two tiers, nor running the suites without Docker, nor the umbrella helpers that own the load-bearing module order, nor the stand-ins for the infrastructure the host lane does not have. Extends it with all of that, and adds a sibling page for contract coverage — the CoversApiOperation / CoversApiValidation model, the rule that responses come from the resource schema rather than being derived, why a response the router cannot reach must not be declared, and the api:contract:coverage workflow. This is the external home for information that until now lived only in code comments and in-repo READMEs.
✅ Deploy Preview for spryker-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The existing testing page predates the harness — it covers neither the two test tiers, nor running the suites without Docker, nor the umbrella helpers that own the load-bearing module order, nor the stand-ins for infrastructure the host lane does not have.
This is the external home for information that until now lived only in code comments and in-repo READMEs, so the suite PRs can drop those comments.
testing.mdgains: the two tiers and how to choose between them; the docker-free run path with the code-generation order and its caveats; suite wiring through the umbrella helpers with the three ordering rules; the fast-path config keys and thesetService()ordering constraint; the infrastructure stand-in helpers; and fixture conventions.contract-coverage.mdis new: theCoversApiOperation/CoversApiValidationmodel, validation coverage per operation via validation groups, responses coming from the resource schema rather than being derived, why a response the router cannot reach must not be declared, non-servable operations, and theapi:contract:coverageworkflow.Detail on CC-39888.
Notes for review
\SprykerTest\ApiPlatform\Helper\StorefrontApiIntegrationHelper/…\StorefrontApiLogicHelper). They currently sit underPyzTest\Shared\Testify\Helperon the suite side and move to core as part of suite#943, so this page should land with that.404is derived per item operation (it is schema-declared since the response-declaration change), and that the coverage command is registered fromspryker_api_platform_contract_coverage.php(merged intospryker_api_platform.php).Test plan
vale --minAlertLevel=error— 0 errors on both pages.markdownlint-cli2— 0 errors on both pages.sidebar_checker.sh— the new page is registered; the 65 entries it reports are pre-existing DG Dev debt.last_updatedbumped ontesting.md.