Shorten long CLI E2E test names and improve recording comment table#17830
Conversation
…ormat - Shorten 11 test method names exceeding 70 chars to ~55-60 chars - Update recording comment workflow to use compact 3-column table (Status | Test | Detail) with links combined via <br /> separators - Update troubleshooting.md reference to renamed test
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17830Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 17830" |
There was a problem hiding this comment.
Pull request overview
This PR improves CLI E2E test ergonomics by shortening overly long xUnit test method names (which also affect recording filenames) and by compacting the GitHub Actions PR comment that summarizes uploaded CLI E2E recordings.
Changes:
- Shortened several CLI E2E test method names to reduce noise in CI logs and recording tables.
- Updated the
cli-e2e-recording-commentworkflow to emit a 3-column table and combine related links into a single “Detail” cell using<br />. - Updated the CLI E2E troubleshooting guide to reference the renamed test method.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/Aspire.Cli.EndToEnd.Tests/UpdateChannelNuGetConfigOrderingTests.cs | Renames the regression test method to a shorter identifier (affects recording filename). |
| tests/Aspire.Cli.EndToEnd.Tests/TypeScriptPolyglotTests.cs | Renames a TypeScript polyglot E2E test method to a shorter identifier. |
| tests/Aspire.Cli.EndToEnd.Tests/ResourceCommandTests.cs | Renames a resource-command E2E test method to a shorter identifier. |
| tests/Aspire.Cli.EndToEnd.Tests/PlaywrightCliInstallTests.cs | Renames the Playwright agent-init regression test method to a shorter identifier. |
| tests/Aspire.Cli.EndToEnd.Tests/CSharpProjectModeInitTests.cs | Renames two aspire init project-mode E2E test methods to shorter identifiers. |
| tests/Aspire.Cli.EndToEnd.Tests/ChannelUpdateWorkflowTests.cs | Renames the channel-update workflow tests to shorter identifiers. |
| tests/Aspire.Cli.EndToEnd.Tests/AgentCommandTests.cs | Renames the bundle-only skills installability E2E test method to a shorter identifier. |
| .github/workflows/cli-e2e-recording-comment.yml | Compacts the PR comment recording table and combines links into a single Detail cell. |
| .agents/skills/cli-e2e-testing/troubleshooting.md | Updates documentation to reference the renamed test method. |
| # Build the detail cell with links separated by <br /> | ||
| DETAIL_PARTS="" | ||
| if [ -n "$ASCIINEMA_URL" ]; then |
|
❓ CLI E2E Tests unknown — 110 passed, 0 failed, 2 unknown (commit View all recordings
📹 Recordings uploaded automatically from CI run #26813217987 |
|
✅ No documentation update needed. docs_optional → |
Summary
Two related improvements to CLI E2E test ergonomics:
1. Shorten long test method names
The longest test name (
UpdateProjectChannelToStable_TypeScript_PreviewsStablePackagesAndPreservesChannelat 81 chars) caused readability issues in CI logs, PR comments, and the recording table. Shortened 11 test names exceeding 70 chars to ~55-60 chars while preserving meaning.2. Compact recording comment table format
Changed the PR recording comment from a 5-column table (
Status | Test | Recording | Job | Artifacts) to a more compact 3-column table (- | Test | Detail) where links are combined in the Detail cell with<br />separators. This reduces horizontal scrolling on narrower views.Example output:
Job
CLI logs