Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix flaky vreplication tests: correct logic that checks for workflow state in test helper #17498

Merged

Conversation

rohit-nayak-ps
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps commented Jan 9, 2025

Description

The current check for a workflow to reach a state (typically Running) was only checking for the first stream while parsing the json result of a workflow status check. This causes flakiness when there are multiple streams and the first one has reached Running but others are, say, Copying.

This PR fixes the logic to indeed iterate over all streams.

The flakiness was introduced by #17441 in v22, so no need to backport.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Jan 9, 2025

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Jan 9, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Jan 9, 2025
@rohit-nayak-ps rohit-nayak-ps added Component: VReplication Type: Testing Backport to: release-19.0 Needs to be back ported to release-19.0 Backport to: release-20.0 Needs to be backport to release-20.0 Backport to: release-21.0 Needs to be backport to release-21.0 and removed NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Jan 9, 2025
Signed-off-by: Rohit Nayak <[email protected]>
@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review January 9, 2025 16:42
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.68%. Comparing base (aabf1c9) to head (aed783e).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #17498   +/-   ##
=======================================
  Coverage   67.68%   67.68%           
=======================================
  Files        1584     1584           
  Lines      254466   254466           
=======================================
+ Hits       172235   172244    +9     
+ Misses      82231    82222    -9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment on lines +371 to +373
shardStreams := gjson.Get(output, "workflows.0.shard_streams")
// We need to wait for all streams in all shard streams to have the desired state.
shardStreams.ForEach(func(shardStreamId, shardStream gjson.Result) bool {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you used https://gjson.dev with sample outputs to be sure that this is different? I thought that this would get all streams, but maybe not:

streams := gjson.Get(output, "workflows.0.shard_streams.*.streams")
streams.ForEach(func(streamId, stream gjson.Result) bool { // For each stream

Just a note that there's no need to backport this PR as the code you're modifying here is new from this recent PR: #17441

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I confirmed that workflows.0.shard_streams.*.streams only returns 1 stream. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I had tested the json parsing locally and that is how I figured out the problem and the fix. The gjson document is quite confusing with regard to wildcard filtering!

Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @rohit-nayak-ps !

Comment on lines +371 to +373
shardStreams := gjson.Get(output, "workflows.0.shard_streams")
// We need to wait for all streams in all shard streams to have the desired state.
shardStreams.ForEach(func(shardStreamId, shardStream gjson.Result) bool {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I confirmed that workflows.0.shard_streams.*.streams only returns 1 stream. Thanks!

@mattlord mattlord removed Backport to: release-19.0 Needs to be back ported to release-19.0 Backport to: release-20.0 Needs to be backport to release-20.0 Backport to: release-21.0 Needs to be backport to release-21.0 labels Jan 9, 2025
@harshit-gangal harshit-gangal merged commit 555f1d7 into vitessio:main Jan 10, 2025
106 checks passed
@harshit-gangal harshit-gangal deleted the rohit/fix-state-check-in-test-helper branch January 10, 2025 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants