test: improve waypoint e2e diagnostics#1685
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request improves the observability of waypoint-related end-to-end test failures. By integrating a diagnostic collection mechanism into the test framework, the system now provides detailed state information and logs when waypoint operations fail, significantly reducing the time required to diagnose issues in automated testing pipelines. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. When tests go dark and waypoints fail, We need a light to blaze the trail. With logs and status now in sight, We debug fast and sleep at night. Footnotes
|
08e85a8 to
ad9f3bc
Compare
|
/cc @hzxuzhonghu |
There was a problem hiding this comment.
Code Review
This pull request enhances E2E tests by adding a diagnostic collection utility for waypoint proxies, which gathers Gateway status, pod conditions, and logs upon failure. The review feedback correctly identifies that t.Fatal was used with format specifiers, which are not supported; it should be replaced with t.Fatalf to ensure the error messages and diagnostics are properly formatted in the test output.
I am having trouble creating individual review comments. Click here to see my feedback.
test/e2e/main_test.go (271)
The Fatal method does not support format specifiers like %v or %s. It treats all arguments as items to be printed (similar to fmt.Print). To correctly format the error message and the collected diagnostics, you should use Fatalf instead.
t.Fatalf("create new waypoint proxy failed: %v\n%s", err, diagnostics)
test/e2e/main_test.go (327)
The Fatal method does not support format specifiers. Use Fatalf to ensure the error and diagnostics are properly formatted in the test failure output, otherwise the specifiers will be printed literally.
t.Fatalf("delete waypoint proxy failed: %v\n%s", err, diagnostics)
Codecov Report✅ All modified and coverable lines are covered by tests. Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
f3ebc84 to
f07059f
Compare
Signed-off-by: Rishi Jat <rishijat2002@gmail.com> Signed-off-by: Rishi Jat <rishijat098@gmail.com>
f07059f to
1834011
Compare
What type of PR is this?
/kind enhancement
What this PR does / why we need it:
Improves waypoint E2E failure diagnostics by surfacing gateway conditions,
pod readiness state, and recent waypoint logs when waypoint creation or
deletion fails.
This makes waypoint-related E2E failures significantly easier to debug in CI
and local test environments.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
test/e2e/main_test.go.