Skip to content

docs: clarify integration vs e2e test boundaries and add e2e README#1111

Merged
jariy17 merged 2 commits intomainfrom
docs/testing-philosophy-and-e2e-readme
May 4, 2026
Merged

docs: clarify integration vs e2e test boundaries and add e2e README#1111
jariy17 merged 2 commits intomainfrom
docs/testing-philosophy-and-e2e-readme

Conversation

@jariy17
Copy link
Copy Markdown
Contributor

@jariy17 jariy17 commented May 4, 2026

Summary

  • Rewrites 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 on agentcore.json and stdout, no AWS required.
  • Adds e2e-tests/README.md — new README documenting the AWS boundary, prerequisites, the createE2ESuite() factory pattern, key test patterns, file naming conventions, and cleanup requirements.
  • Updates 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

  • Verify integ-tests/README.md no longer mentions AWS credentials, CloudFormation, or costs
  • Verify e2e-tests/README.md exists and accurately describes the e2e pattern
  • Verify docs/TESTING.md links to both READMEs and the integration tests section no longer says AWS credentials are required

@jariy17 jariy17 requested a review from a team May 4, 2026 18:54
@github-actions github-actions Bot added size/m PR size: M agentcore-harness-reviewing AgentCore Harness review in progress labels May 4, 2026
- 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
@jariy17 jariy17 force-pushed the docs/testing-philosophy-and-e2e-readme branch from 73f3d47 to 38c45f4 Compare May 4, 2026 18:55
@github-actions github-actions Bot added size/m PR size: M and removed size/m PR size: M labels May 4, 2026
@agentcore-cli-automation
Copy link
Copy Markdown

Reviewed — docs-only PR. Spot-checked the claims against the repo:

  • e2e-tests/e2e-helper.ts exports createE2ESuite, teardownE2EProject, writeAwsTargets, runAgentCoreCLI, cleanupStaleCredentialProviders, baseCanRun, and hasAws
  • src/test-utils/index.ts exports createTestProject, runCLI, readProjectConfig, and TestProject — matches the integ-tests example imports ✅
  • createTestProject({ noAgent: true }) is a real option ✅
  • npm run test:e2e and npm run test:integ scripts both exist in package.json ✅
  • Integ-tests contain no references to AWS credentials / STS / profiles, so the "no AWS required" claim is accurate ✅
  • The lifecycle description for createE2ESuite() (create → deploy → invoke → status → logs → traces → destroy) matches the actual it.skipIf blocks in the helper ✅

No serious issues — LGTM.

@github-actions github-actions Bot removed the agentcore-harness-reviewing AgentCore Harness review in progress label May 4, 2026
@github-actions github-actions Bot added size/m PR size: M and removed size/m PR size: M labels May 4, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 42.89% 8936 / 20830
🔵 Statements 42.17% 9485 / 22491
🔵 Functions 39.66% 1537 / 3875
🔵 Branches 39.82% 5769 / 14486
Generated in workflow #2368 for commit 2863378 by the Vitest Coverage Report Action

@notgitika notgitika self-requested a review May 4, 2026 19:23
@jariy17 jariy17 merged commit bb69aa5 into main May 4, 2026
25 checks passed
@jariy17 jariy17 deleted the docs/testing-philosophy-and-e2e-readme branch May 4, 2026 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/m PR size: M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants