docs: clarify integration vs e2e test boundaries and add e2e README#1111
Merged
docs: clarify integration vs e2e test boundaries and add e2e README#1111
Conversation
- Rewrite integ-tests/README.md to accurately describe what integration tests do (local file/stdout assertions, no AWS required) — the old README described e2e behavior (CloudFormation, credentials, costs) - Add e2e-tests/README.md documenting the AWS boundary, prerequisites, createE2ESuite() pattern, key patterns, and cleanup requirements - Update docs/TESTING.md to add an E2E Tests section with a link to the new README, fix the stale integration tests section that incorrectly listed AWS credentials as a prerequisite, and add link to integ README
73f3d47 to
38c45f4
Compare
|
Reviewed — docs-only PR. Spot-checked the claims against the repo:
No serious issues — LGTM. |
Contributor
Coverage Report
|
aidandaly24
approved these changes
May 4, 2026
notgitika
approved these changes
May 4, 2026
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
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.
Summary
integ-tests/README.md— the old README described e2e behavior (AWS credentials, CloudFormation stacks, real resource costs) when the actual tests do none of that. Now correctly describes what integration tests do: run the CLI locally, assert onagentcore.jsonand stdout, no AWS required.e2e-tests/README.md— new README documenting the AWS boundary, prerequisites, thecreateE2ESuite()factory pattern, key test patterns, file naming conventions, and cleanup requirements.docs/TESTING.md— adds an E2E Tests section with a link to the new README, fixes the stale integration tests section that incorrectly listed AWS credentials as a prerequisite.Test plan
integ-tests/README.mdno longer mentions AWS credentials, CloudFormation, or costse2e-tests/README.mdexists and accurately describes the e2e patterndocs/TESTING.mdlinks to both READMEs and the integration tests section no longer says AWS credentials are required